Add cpanfile, better README.md and remove default XS module generated README

Author: timlegge

MANIFEST

@@ -1,12 +1,13 @@
 Changes
-typemap
+cpanfile
 Makefile.PL
-MANIFEST
+MANIFEST			This list of files
+META.json
+META.yml
+PKCS10.pm
 PKCS10.xs
 ppport.h
-README
-t/Mytest.t
+README.md
 t/CSR.csr
-PKCS10.pm
-META.yml                                 Module meta-data (added by MakeMaker)
-META.json                                Module JSON meta-data (added by MakeMaker)
+t/Mytest.t
+typemap

README

@@ -0,0 +1,214 @@
+# NAME
+
+Crypt::OpenSSL::PKCS10 - Perl extension to OpenSSL's PKCS10 API.
+
+# SYNOPSIS
+
+```perl
+use Crypt::OpenSSL::PKCS10 qw( :const );
+
+my $req = Crypt::OpenSSL::PKCS10->new;
+$req->set_subject("/C=RO/O=UTI/OU=ssi");
+$req->add_ext(Crypt::OpenSSL::PKCS10::NID_key_usage,"critical,digitalSignature,keyEncipherment");
+$req->add_ext(Crypt::OpenSSL::PKCS10::NID_ext_key_usage,"serverAuth, nsSGC, msSGC, 1.3.4");
+$req->add_ext(Crypt::OpenSSL::PKCS10::NID_subject_alt_name,"email:steve@openssl.org");
+$req->add_custom_ext('1.2.3.3',"My new extension");
+$req->add_ext_final();
+$req->sign();
+$req->write_pem_req('request.pem');
+$req->write_pem_pk('pk.pem');
+print $req->get_pem_pubkey();
+print $req->pubkey_type();
+print $req->get_pem_req();
+```
+
+# ABSTRACT
+
+```
+Crypt::OpenSSL::PKCS10 - Perl extension to OpenSSL's PKCS10 API.
+```
+
+# DESCRIPTION
+
+Crypt::OpenSSL::PKCS10 provides the ability to create PKCS10 certificate requests using RSA key pairs.
+
+# Class Methods
+
+- new
+
+    Create a new Crypt::OpenSSL::PKCS10 object by generating a new RSA key pair. There is one optional argument, the key size,
+    which has the default value of 1024 if omitted.
+
+- new\_from\_rsa( $rsa\_object )
+
+    Create a new Crypt::OpenSSL::PKCS10 object by using key information from a Crypt::OpenSSL::RSA object. Here is an example:
+
+    ```perl
+    my $rsa = Crypt::OpenSSL::RSA->generate_key(512);
+    my $req = Crypt::OpenSSL::PKCS10->new_from_rsa($rsa);
+    ```
+
+    OpenSSL 3.0 has deprecated the RSA object which Crypt::OpenSSL::RSA creates.  new\_from\_rsa() is now a perl sub which obtains the private key as a string that is also passed to the \_new\_from\_rsa() XS function.
+
+- new\_from\_file( $filename )
+
+    Create a new Crypt::OpenSSL::PKCS10 object by reading the request and key information from a PEM formatted file. Here is an example:
+
+    ```perl
+    my $req = Crypt::OpenSSL::PKCS10->new_from_file("CSR.csr");
+    ```
+
+# Instance Methods
+
+- set\_subject($subject, \[ $utf8 \])
+
+    Sets the subject DN of the request.
+    Note: $subject is expected to be in the format /type0=value0/type1=value1/type2=... where characters may be escaped by \\.
+    If $utf8 is non-zero integer, $subject is interpreted as UTF-8 string.
+
+- add\_ext($nid, $extension)
+
+    Adds a new extension to the request. The first argument $nid is one of the exported constants (see below).
+    The second one $extension is a string (for more info read `openssl(3)`).
+
+    ```perl
+    $req->add_ext(Crypt::OpenSSL::PKCS10::NID_key_usage,"critical,digitalSignature,keyEncipherment");
+    $req->add_ext(Crypt::OpenSSL::PKCS10::NID_ext_key_usage,"serverAuth, nsSGC, msSGC, 1.3.4");
+    $req->add_ext(Crypt::OpenSSL::PKCS10::NID_subject_alt_name,"email:steve@openssl.org");
+    ```
+
+- add\_custom\_ext($oid, $desc)
+
+    Adds a new custom extension to the request. The value is added as a text string, using ASN.1 encoding rules inherited from the Netscape Comment OID. 
+
+    ```
+    $req->add_custom_ext('1.2.3.3',"My new extension");
+    ```
+
+- add\_custom\_ext\_raw($oid, $bytes)
+
+    Adds a new custom extension to the request. The value is added as a raw DER octet string. Use this if you are packing your own ASN.1 structures and need to set the extension value directly.
+
+    ```
+    $req->add_custom_ext_raw($oid, pack('H*','1E06006100620063')) # BMPString 'abc'
+    ```
+
+- add\_ext\_final()
+
+    This must be called after all extensions has been added. It actually copies the extension stack to request structure.
+
+    ```perl
+    $req->add_ext(Crypt::OpenSSL::PKCS10::NID_subject_alt_name,"email:my@email.org");
+    $req->add_ext_final();
+    ```
+
+- sign()
+
+    This adds the signature to the PKCS10 request.
+
+    ```
+    $req->sign();
+    ```
+
+- pubkey\_type()
+
+    Returns the type of the PKCS10 public key - one of (rsa|dsa|ec).
+
+    ```
+    $req->pubkey_type();
+    ```
+
+- get\_pubkey()
+
+    Returns the PEM encoding of the PKCS10 public key.
+
+    ```
+    $req->get_pubkey();
+    ```
+
+- get\_pem\_req()
+
+    Returns the PEM encoding of the PKCS10 request.
+
+    ```
+    $req->get_pem_req();
+    ```
+
+- write\_pem\_req($filename)
+
+    Writes the PEM encoding of the PKCS10 request to a given file.
+
+    ```
+    $req->write_pem_req('request.pem');
+    ```
+
+- get\_pem\_pk()
+
+    Returns the PEM encoding of the private key.
+
+    ```
+    $req->get_pem_pk();
+    ```
+
+- write\_pem\_pk($filename)
+
+    Writes the PEM encoding of the private key to a given file.
+
+    ```
+    $req->write_pem_pk('request.pem');
+    ```
+
+- subject()
+
+    returns the subject of the PKCS10 request
+
+    ```perl
+    $subject = $req->subject();
+    ```
+
+- keyinfo()
+
+    returns the human readable info about the key of the PKCS10 request
+
+    ```
+    $keyinfo = $req->keyinfo();
+    ```
+
+## EXPORT
+
+None by default.
+
+On request:
+
+```perl
+    NID_key_usage NID_subject_alt_name NID_netscape_cert_type NID_netscape_comment
+    NID_ext_key_usage
+```
+
+# BUGS
+
+If you destroy $req object that is linked to a Crypt::OpenSSL::RSA object, the RSA private key is also freed, 
+thus you can't use latter object anymore. Avoid this:
+
+```perl
+my $rsa = Crypt::OpenSSL::RSA->generate_key(512);
+my $req = Crypt::OpenSSL::PKCS10->new_from_rsa($rsa);
+undef $req;
+print $rsa->get_private_key_string();
+```
+
+# SEE ALSO
+
+`Crypt::OpenSSL::RSA`, `Crypt::OpenSSL::X509`.
+
+# AUTHOR
+
+JoNO, <jonozzz@yahoo.com>
+
+# COPYRIGHT AND LICENSE
+
+Copyright (C) 2006 by JoNO
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.8.2 or,
+at your option, any later version of Perl 5 you may have available.

README.md

@@ -0,0 +1,24 @@
+# This file is generated by Dist::Zilla::Plugin::CPANFile v6.030
+# Do not edit this file directly. To change prereqs, edit the `dist.ini` file.
+
+requires "perl" => "5.008";
+
+on 'build' => sub {
+  requires "Crypt::OpenSSL::Guess" => "0";
+};
+
+on 'test' => sub {
+  requires "Crypt::OpenSSL::RSA" => "0";
+  requires "Test::More" => "0";
+};
+
+on 'configure' => sub {
+  requires "Crypt::OpenSSL::Guess" => "0";
+};
+
+on 'develop' => sub {
+  requires "Test::CPAN::Meta::JSON" => "0.16";
+  requires "Test::Kwalitee" => "1.21";
+  requires "Test::Pod" => "1.41";
+  requires "Test::Spelling" => "0.12";
+};