276 lines
8.3 KiB
Groff
276 lines
8.3 KiB
Groff
.\" $NetBSD: openssl_rsa.3,v 1.15 2007/11/27 22:19:53 christos Exp $
|
|
.\"
|
|
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
|
|
.\"
|
|
.\" 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 "rsa 3"
|
|
.TH rsa 3 "2003-07-24" "0.9.8e" "OpenSSL"
|
|
.SH "NAME"
|
|
rsa \- RSA public key cryptosystem
|
|
.SH "LIBRARY"
|
|
libcrypto, -lcrypto
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 2
|
|
\& #include <openssl/rsa.h>
|
|
\& #include <openssl/engine.h>
|
|
.Ve
|
|
.PP
|
|
.Vb 2
|
|
\& RSA * RSA_new(void);
|
|
\& void RSA_free(RSA *rsa);
|
|
.Ve
|
|
.PP
|
|
.Vb 8
|
|
\& int RSA_public_encrypt(int flen, unsigned char *from,
|
|
\& unsigned char *to, RSA *rsa, int padding);
|
|
\& int RSA_private_decrypt(int flen, unsigned char *from,
|
|
\& unsigned char *to, RSA *rsa, int padding);
|
|
\& int RSA_private_encrypt(int flen, unsigned char *from,
|
|
\& unsigned char *to, RSA *rsa,int padding);
|
|
\& int RSA_public_decrypt(int flen, unsigned char *from,
|
|
\& unsigned char *to, RSA *rsa,int padding);
|
|
.Ve
|
|
.PP
|
|
.Vb 4
|
|
\& int RSA_sign(int type, unsigned char *m, unsigned int m_len,
|
|
\& unsigned char *sigret, unsigned int *siglen, RSA *rsa);
|
|
\& int RSA_verify(int type, unsigned char *m, unsigned int m_len,
|
|
\& unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
|
|
.Ve
|
|
.PP
|
|
.Vb 1
|
|
\& int RSA_size(const RSA *rsa);
|
|
.Ve
|
|
.PP
|
|
.Vb 2
|
|
\& RSA *RSA_generate_key(int num, unsigned long e,
|
|
\& void (*callback)(int,int,void *), void *cb_arg);
|
|
.Ve
|
|
.PP
|
|
.Vb 1
|
|
\& int RSA_check_key(RSA *rsa);
|
|
.Ve
|
|
.PP
|
|
.Vb 2
|
|
\& int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
|
|
\& void RSA_blinding_off(RSA *rsa);
|
|
.Ve
|
|
.PP
|
|
.Vb 8
|
|
\& void RSA_set_default_method(const RSA_METHOD *meth);
|
|
\& const RSA_METHOD *RSA_get_default_method(void);
|
|
\& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
|
|
\& const RSA_METHOD *RSA_get_method(const RSA *rsa);
|
|
\& RSA_METHOD *RSA_PKCS1_SSLeay(void);
|
|
\& RSA_METHOD *RSA_null_method(void);
|
|
\& int RSA_flags(const RSA *rsa);
|
|
\& RSA *RSA_new_method(ENGINE *engine);
|
|
.Ve
|
|
.PP
|
|
.Vb 2
|
|
\& int RSA_print(BIO *bp, RSA *x, int offset);
|
|
\& int RSA_print_fp(FILE *fp, RSA *x, int offset);
|
|
.Ve
|
|
.PP
|
|
.Vb 4
|
|
\& int RSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
|
|
\& int (*dup_func)(), void (*free_func)());
|
|
\& int RSA_set_ex_data(RSA *r,int idx,char *arg);
|
|
\& char *RSA_get_ex_data(RSA *r, int idx);
|
|
.Ve
|
|
.PP
|
|
.Vb 6
|
|
\& int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
|
|
\& unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
|
|
\& RSA *rsa);
|
|
\& int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
|
|
\& unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
|
|
\& RSA *rsa);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
These functions implement \s-1RSA\s0 public key encryption and signatures
|
|
as defined in \s-1PKCS\s0 #1 v2.0 [\s-1RFC\s0 2437].
|
|
.PP
|
|
The \fB\s-1RSA\s0\fR structure consists of several \s-1BIGNUM\s0 components. It can
|
|
contain public as well as private \s-1RSA\s0 keys:
|
|
.PP
|
|
.Vb 13
|
|
\& struct
|
|
\& {
|
|
\& BIGNUM *n; // public modulus
|
|
\& BIGNUM *e; // public exponent
|
|
\& BIGNUM *d; // private exponent
|
|
\& BIGNUM *p; // secret prime factor
|
|
\& BIGNUM *q; // secret prime factor
|
|
\& BIGNUM *dmp1; // d mod (p-1)
|
|
\& BIGNUM *dmq1; // d mod (q-1)
|
|
\& BIGNUM *iqmp; // q^-1 mod p
|
|
\& // ...
|
|
\& };
|
|
\& RSA
|
|
.Ve
|
|
.PP
|
|
In public keys, the private exponent and the related secret values are
|
|
\&\fB\s-1NULL\s0\fR.
|
|
.PP
|
|
\&\fBp\fR, \fBq\fR, \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR may be \fB\s-1NULL\s0\fR in private
|
|
keys, but the \s-1RSA\s0 operations are much faster when these values are
|
|
available.
|
|
.PP
|
|
Note that \s-1RSA\s0 keys may use non-standard \fB\s-1RSA_METHOD\s0\fR implementations,
|
|
either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
|
|
\&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
|
|
will not be used by the implementation or may be used for alternative data
|
|
storage. For this reason, applications should generally avoid using \s-1RSA\s0
|
|
structure elements directly and instead use \s-1API\s0 functions to query or
|
|
modify keys.
|
|
.SH "CONFORMING TO"
|
|
.IX Header "CONFORMING TO"
|
|
\&\s-1SSL\s0, \s-1PKCS\s0 #1 v2.0
|
|
.SH "PATENTS"
|
|
.IX Header "PATENTS"
|
|
\&\s-1RSA\s0 was covered by a \s-1US\s0 patent which expired in September 2000.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIopenssl_rsa\fR\|(1), \fIopenssl_bn\fR\|(3), \fIopenssl_dsa\fR\|(3), \fIopenssl_dh\fR\|(3),
|
|
\&\fIopenssl_rand\fR\|(3), \fIengine\fR\|(3), \fIRSA_new\fR\|(3),
|
|
\&\fIRSA_public_encrypt\fR\|(3),
|
|
\&\fIRSA_sign\fR\|(3), \fIRSA_size\fR\|(3),
|
|
\&\fIRSA_generate_key\fR\|(3),
|
|
\&\fIRSA_check_key\fR\|(3),
|
|
\&\fIRSA_blinding_on\fR\|(3),
|
|
\&\fIRSA_set_method\fR\|(3), \fIRSA_print\fR\|(3),
|
|
\&\fIRSA_get_ex_new_index\fR\|(3),
|
|
\&\fIRSA_private_encrypt\fR\|(3),
|
|
\&\fIRSA_sign_ASN1_OCTET_STRING\fR\|(3),
|
|
\&\fIRSA_padding_add_PKCS1_type_1\fR\|(3)
|