Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libcrypto / man / rsa.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "rsa 3"
127 .TH rsa 3 "2012-01-04" "1.0.0f" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 rsa \- RSA public key cryptosystem
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 2
137 \& #include <openssl/rsa.h>
138 \& #include <openssl/engine.h>
139 \&
140 \& RSA * RSA_new(void);
141 \& void RSA_free(RSA *rsa);
142 \&
143 \& int RSA_public_encrypt(int flen, unsigned char *from,
144 \&    unsigned char *to, RSA *rsa, int padding);
145 \& int RSA_private_decrypt(int flen, unsigned char *from,
146 \&    unsigned char *to, RSA *rsa, int padding);
147 \& int RSA_private_encrypt(int flen, unsigned char *from,
148 \&    unsigned char *to, RSA *rsa,int padding);
149 \& int RSA_public_decrypt(int flen, unsigned char *from, 
150 \&    unsigned char *to, RSA *rsa,int padding);
151 \&
152 \& int RSA_sign(int type, unsigned char *m, unsigned int m_len,
153 \&    unsigned char *sigret, unsigned int *siglen, RSA *rsa);
154 \& int RSA_verify(int type, unsigned char *m, unsigned int m_len,
155 \&    unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
156 \&
157 \& int RSA_size(const RSA *rsa);
158 \&
159 \& RSA *RSA_generate_key(int num, unsigned long e,
160 \&    void (*callback)(int,int,void *), void *cb_arg);
161 \&
162 \& int RSA_check_key(RSA *rsa);
163 \&
164 \& int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
165 \& void RSA_blinding_off(RSA *rsa);
166 \&
167 \& void RSA_set_default_method(const RSA_METHOD *meth);
168 \& const RSA_METHOD *RSA_get_default_method(void);
169 \& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
170 \& const RSA_METHOD *RSA_get_method(const RSA *rsa);
171 \& RSA_METHOD *RSA_PKCS1_SSLeay(void);
172 \& RSA_METHOD *RSA_null_method(void);
173 \& int RSA_flags(const RSA *rsa);
174 \& RSA *RSA_new_method(ENGINE *engine);
175 \&
176 \& int RSA_print(BIO *bp, RSA *x, int offset);
177 \& int RSA_print_fp(FILE *fp, RSA *x, int offset);
178 \&
179 \& int RSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
180 \&    int (*dup_func)(), void (*free_func)());
181 \& int RSA_set_ex_data(RSA *r,int idx,char *arg);
182 \& char *RSA_get_ex_data(RSA *r, int idx);
183 \&
184 \& int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
185 \&    unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
186 \&    RSA *rsa);
187 \& int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
188 \&    unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
189 \&    RSA *rsa);
190 .Ve
191 .SH "DESCRIPTION"
192 .IX Header "DESCRIPTION"
193 These functions implement \s-1RSA\s0 public key encryption and signatures
194 as defined in \s-1PKCS\s0 #1 v2.0 [\s-1RFC\s0 2437].
195 .PP
196 The \fB\s-1RSA\s0\fR structure consists of several \s-1BIGNUM\s0 components. It can
197 contain public as well as private \s-1RSA\s0 keys:
198 .PP
199 .Vb 10
200 \& struct
201 \&        {
202 \&        BIGNUM *n;              // public modulus
203 \&        BIGNUM *e;              // public exponent
204 \&        BIGNUM *d;              // private exponent
205 \&        BIGNUM *p;              // secret prime factor
206 \&        BIGNUM *q;              // secret prime factor
207 \&        BIGNUM *dmp1;           // d mod (p\-1)
208 \&        BIGNUM *dmq1;           // d mod (q\-1)
209 \&        BIGNUM *iqmp;           // q^\-1 mod p
210 \&        // ...
211 \&        };
212 \& RSA
213 .Ve
214 .PP
215 In public keys, the private exponent and the related secret values are
216 \&\fB\s-1NULL\s0\fR.
217 .PP
218 \&\fBp\fR, \fBq\fR, \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR may be \fB\s-1NULL\s0\fR in private
219 keys, but the \s-1RSA\s0 operations are much faster when these values are
220 available.
221 .PP
222 Note that \s-1RSA\s0 keys may use non-standard \fB\s-1RSA_METHOD\s0\fR implementations,
223 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
224 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
225 will not be used by the implementation or may be used for alternative data
226 storage. For this reason, applications should generally avoid using \s-1RSA\s0
227 structure elements directly and instead use \s-1API\s0 functions to query or
228 modify keys.
229 .SH "CONFORMING TO"
230 .IX Header "CONFORMING TO"
231 \&\s-1SSL\s0, \s-1PKCS\s0 #1 v2.0
232 .SH "PATENTS"
233 .IX Header "PATENTS"
234 \&\s-1RSA\s0 was covered by a \s-1US\s0 patent which expired in September 2000.
235 .SH "SEE ALSO"
236 .IX Header "SEE ALSO"
237 \&\fIrsa\fR\|(1), \fIbn\fR\|(3), \fIdsa\fR\|(3), \fIdh\fR\|(3),
238 \&\fIrand\fR\|(3), \fIengine\fR\|(3), \fIRSA_new\fR\|(3),
239 \&\fIRSA_public_encrypt\fR\|(3),
240 \&\fIRSA_sign\fR\|(3), \fIRSA_size\fR\|(3),
241 \&\fIRSA_generate_key\fR\|(3),
242 \&\fIRSA_check_key\fR\|(3),
243 \&\fIRSA_blinding_on\fR\|(3),
244 \&\fIRSA_set_method\fR\|(3), \fIRSA_print\fR\|(3),
245 \&\fIRSA_get_ex_new_index\fR\|(3),
246 \&\fIRSA_private_encrypt\fR\|(3),
247 \&\fIRSA_sign_ASN1_OCTET_STRING\fR\|(3),
248 \&\fIRSA_padding_add_PKCS1_type_1\fR\|(3)