.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Crypt::RSA::Key 3"
.TH Crypt::RSA::Key 3 "2009-06-06" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Crypt::RSA::Key \- RSA Key Pair Generator.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&    my $keychain = new Crypt::RSA::Key;
\&    my ($public, $private) = $keychain->generate ( 
\&                              Identity  => 'Lord Macbeth <macbeth@glamis.com>',
\&                              Size      => 2048,  
\&                              Password  => 'A day so foul & fair', 
\&                              Verbosity => 1,
\&                             ) or die $keychain->errstr();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a method to generate an \s-1RSA\s0 key pair.
.SH "METHODS"
.IX Header "METHODS"
.Sh "\fInew()\fP"
.IX Subsection "new()"
Constructor.  
.Sh "\fIgenerate()\fP"
.IX Subsection "generate()"
\&\fIgenerate()\fR generates an \s-1RSA\s0 key of specified bitsize. It returns a list of
two elements, a Crypt::RSA::Key::Public object that holds the public part
of the key pair and a Crypt::RSA::Key::Private object that holds that
private part. On failure, it returns undef and sets \f(CW$self\fR\->errstr to
appropriate error string. \fIgenerate()\fR takes a hash argument with the
following keys:
.IP "\fBSize\fR" 4
.IX Item "Size"
Bitsize of the key to be generated. This should be an even integer > 48.
Bitsize is a mandatory argument.
.IP "\fBPassword\fR" 4
.IX Item "Password"
String with which the private key will be encrypted. If Password is not
provided the key will be stored unencrypted.
.IP "\fBIdentity\fR" 4
.IX Item "Identity"
A string that identifies the owner of the key. This string usually takes
the form of a name and an email address. The identity is not bound to the
key with a signature. However, a future release or another module will
provide this facility. 
.IP "\fBCipher\fR" 4
.IX Item "Cipher"
The block cipher which is used for encrypting the private key. Defaults to
`Blowfish'. Cipher could be set to any value that works with \fICrypt::CBC\fR\|(3)
and \fITie::EncryptedHash\fR\|(3).
.IP "\fBVerbosity\fR" 4
.IX Item "Verbosity"
When set to 1, \fIgenerate()\fR will draw a progress display on \s-1STDOUT\s0.
.IP "\fBFilename\fR" 4
.IX Item "Filename"
The generated key pair will be written to disk, in \f(CW$Filename\fR.public and
\&\f(CW$Filename\fR.private files, if this argument is provided. Disk writes can be
deferred by skipping this argument and achieved later with the \fIwrite()\fR
method of \fICrypt::RSA::Key::Public\fR\|(3) and \fICrypt::RSA::Key::Private\fR\|(3).
.IP "\fB\s-1KF\s0\fR" 4
.IX Item "KF"
A string that specifies the key format. As of this writing, two key
formats, `Native' and `\s-1SSH\s0', are supported. \s-1KF\s0 defaults to `Native'.
.IP "\fB\s-1SKF\s0\fR" 4
.IX Item "SKF"
Secret (Private) Key Format. Instead of specifying \s-1KF\s0, the user could
choose to specify secret and public key formats separately. The value for
\&\s-1SKF\s0 can be a string (\*(L"Native\*(R" or \*(L"\s-1SSH\s0\*(R") or a hash reference that specifies
a module name, its constructor and constructor arguments. The specified
module is loaded with \fIClass::Loader\fR\|(3) and must be interface compatible
with \fICrypt::RSA::Key::Private\fR\|(3).
.IP "\fB\s-1PKF\s0\fR" 4
.IX Item "PKF"
Public Key Format. This option is like \s-1SKF\s0 but for the public key.
.SH "ERROR HANDLING"
.IX Header "ERROR HANDLING"
See \fB\s-1ERROR\s0 \s-1HANDLING\s0\fR in \fICrypt::RSA\fR\|(3) manpage.
.SH "BUGS"
.IX Header "BUGS"
There's an inefficiency in the way \fIgenerate()\fR ensures the key pair is
exactly Size bits long. This will be fixed in a future release.
.SH "AUTHOR"
.IX Header "AUTHOR"
Vipul Ved Prakash, <mail@vipul.net>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fICrypt::RSA\fR\|(3), \fICrypt::RSA::Key::Public\fR\|(3), \fICrypt::RSA::Key::Private\fR\|(3), 
\&\fICrypt::Primes\fR\|(3), \fITie::EncryptedHash\fR\|(3), \fIClass::Loader\fR\|(3)