Commit manual pages after running 'man-update' and add new manual pages.
[dragonfly.git] / secure / lib / libcrypto / man / rsa.3
1 .rn '' }`
2 ''' $RCSfile$$Revision$$Date$
3 '''
4 ''' $Log$
5 '''
6 .de Sh
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Ip
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
23 ..
24 .de Vb
25 .ft CW
26 .nf
27 .ne \\$1
28 ..
29 .de Ve
30 .ft R
31
32 .fi
33 ..
34 '''
35 '''
36 '''     Set up \*(-- to give an unbreakable dash;
37 '''     string Tr holds user defined translation string.
38 '''     Bell System Logo is used as a dummy character.
39 '''
40 .tr \(*W-|\(bv\*(Tr
41 .ie n \{\
42 .ds -- \(*W-
43 .ds PI pi
44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
46 .ds L" ""
47 .ds R" ""
48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
50 '''   such as .IP and .SH, which do another additional levels of
51 '''   double-quote interpretation
52 .ds M" """
53 .ds S" """
54 .ds N" """""
55 .ds T" """""
56 .ds L' '
57 .ds R' '
58 .ds M' '
59 .ds S' '
60 .ds N' '
61 .ds T' '
62 'br\}
63 .el\{\
64 .ds -- \(em\|
65 .tr \*(Tr
66 .ds L" ``
67 .ds R" ''
68 .ds M" ``
69 .ds S" ''
70 .ds N" ``
71 .ds T" ''
72 .ds L' `
73 .ds R' '
74 .ds M' `
75 .ds S' '
76 .ds N' `
77 .ds T' '
78 .ds PI \(*p
79 'br\}
80 .\"     If the F register is turned on, we'll generate
81 .\"     index entries out stderr for the following things:
82 .\"             TH      Title 
83 .\"             SH      Header
84 .\"             Sh      Subsection 
85 .\"             Ip      Item
86 .\"             X<>     Xref  (embedded
87 .\"     Of course, you have to process the output yourself
88 .\"     in some meaninful fashion.
89 .if \nF \{
90 .de IX
91 .tm Index:\\$1\t\\n%\t"\\$2"
92 ..
93 .nr % 0
94 .rr F
95 .\}
96 .TH rsa 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
97 .UC
98 .if n .hy 0
99 .if n .na
100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
101 .de CQ          \" put $1 in typewriter font
102 .ft CW
103 'if n "\c
104 'if t \\&\\$1\c
105 'if n \\&\\$1\c
106 'if n \&"
107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
108 '.ft R
109 ..
110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
111 .       \" AM - accent mark definitions
112 .bd B 3
113 .       \" fudge factors for nroff and troff
114 .if n \{\
115 .       ds #H 0
116 .       ds #V .8m
117 .       ds #F .3m
118 .       ds #[ \f1
119 .       ds #] \fP
120 .\}
121 .if t \{\
122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
123 .       ds #V .6m
124 .       ds #F 0
125 .       ds #[ \&
126 .       ds #] \&
127 .\}
128 .       \" simple accents for nroff and troff
129 .if n \{\
130 .       ds ' \&
131 .       ds ` \&
132 .       ds ^ \&
133 .       ds , \&
134 .       ds ~ ~
135 .       ds ? ?
136 .       ds ! !
137 .       ds /
138 .       ds q
139 .\}
140 .if t \{\
141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
150 .\}
151 .       \" troff and (daisy-wheel) nroff accents
152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
163 .ds ae a\h'-(\w'a'u*4/10)'e
164 .ds Ae A\h'-(\w'A'u*4/10)'E
165 .ds oe o\h'-(\w'o'u*4/10)'e
166 .ds Oe O\h'-(\w'O'u*4/10)'E
167 .       \" corrections for vroff
168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
170 .       \" for low resolution devices (crt and lpr)
171 .if \n(.H>23 .if \n(.V>19 \
172 \{\
173 .       ds : e
174 .       ds 8 ss
175 .       ds v \h'-1'\o'\(aa\(ga'
176 .       ds _ \h'-1'^
177 .       ds . \h'-1'.
178 .       ds 3 3
179 .       ds o a
180 .       ds d- d\h'-1'\(ga
181 .       ds D- D\h'-1'\(hy
182 .       ds th \o'bp'
183 .       ds Th \o'LP'
184 .       ds ae ae
185 .       ds Ae AE
186 .       ds oe oe
187 .       ds Oe OE
188 .\}
189 .rm #[ #] #H #V #F C
190 .SH "NAME"
191 rsa \- RSA public key cryptosystem
192 .SH "SYNOPSIS"
193 .PP
194 .Vb 2
195 \& #include <openssl/rsa.h>
196 \& #include <openssl/engine.h>
197 .Ve
198 .Vb 2
199 \& RSA * RSA_new(void);
200 \& void RSA_free(RSA *rsa);
201 .Ve
202 .Vb 8
203 \& int RSA_public_encrypt(int flen, unsigned char *from,
204 \&    unsigned char *to, RSA *rsa, int padding);
205 \& int RSA_private_decrypt(int flen, unsigned char *from,
206 \&    unsigned char *to, RSA *rsa, int padding);
207 \& int RSA_private_encrypt(int flen, unsigned char *from,
208 \&    unsigned char *to, RSA *rsa,int padding);
209 \& int RSA_public_decrypt(int flen, unsigned char *from, 
210 \&    unsigned char *to, RSA *rsa,int padding);
211 .Ve
212 .Vb 4
213 \& int RSA_sign(int type, unsigned char *m, unsigned int m_len,
214 \&    unsigned char *sigret, unsigned int *siglen, RSA *rsa);
215 \& int RSA_verify(int type, unsigned char *m, unsigned int m_len,
216 \&    unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
217 .Ve
218 .Vb 1
219 \& int RSA_size(const RSA *rsa);
220 .Ve
221 .Vb 2
222 \& RSA *RSA_generate_key(int num, unsigned long e,
223 \&    void (*callback)(int,int,void *), void *cb_arg);
224 .Ve
225 .Vb 1
226 \& int RSA_check_key(RSA *rsa);
227 .Ve
228 .Vb 2
229 \& int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
230 \& void RSA_blinding_off(RSA *rsa);
231 .Ve
232 .Vb 8
233 \& void RSA_set_default_method(const RSA_METHOD *meth);
234 \& const RSA_METHOD *RSA_get_default_method(void);
235 \& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
236 \& const RSA_METHOD *RSA_get_method(const RSA *rsa);
237 \& RSA_METHOD *RSA_PKCS1_SSLeay(void);
238 \& RSA_METHOD *RSA_null_method(void);
239 \& int RSA_flags(const RSA *rsa);
240 \& RSA *RSA_new_method(ENGINE *engine);
241 .Ve
242 .Vb 2
243 \& int RSA_print(BIO *bp, RSA *x, int offset);
244 \& int RSA_print_fp(FILE *fp, RSA *x, int offset);
245 .Ve
246 .Vb 4
247 \& int RSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
248 \&    int (*dup_func)(), void (*free_func)());
249 \& int RSA_set_ex_data(RSA *r,int idx,char *arg);
250 \& char *RSA_get_ex_data(RSA *r, int idx);
251 .Ve
252 .Vb 6
253 \& int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
254 \&    unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
255 \&    RSA *rsa);
256 \& int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
257 \&    unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
258 \&    RSA *rsa);
259 .Ve
260 .SH "DESCRIPTION"
261 These functions implement RSA public key encryption and signatures
262 as defined in PKCS #1 v2.0 [RFC 2437].
263 .PP
264 The \fBRSA\fR structure consists of several BIGNUM components. It can
265 contain public as well as private RSA keys:
266 .PP
267 .Vb 13
268 \& struct
269 \&        {
270 \&        BIGNUM *n;              // public modulus
271 \&        BIGNUM *e;              // public exponent
272 \&        BIGNUM *d;              // private exponent
273 \&        BIGNUM *p;              // secret prime factor
274 \&        BIGNUM *q;              // secret prime factor
275 \&        BIGNUM *dmp1;           // d mod (p-1)
276 \&        BIGNUM *dmq1;           // d mod (q-1)
277 \&        BIGNUM *iqmp;           // q^-1 mod p
278 \&        // ...
279 \&        };
280 \& RSA
281 .Ve
282 In public keys, the private exponent and the related secret values are
283 \fBNULL\fR.
284 .PP
285 \fBp\fR, \fBq\fR, \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR may be \fBNULL\fR in private
286 keys, but the RSA operations are much faster when these values are
287 available.
288 .PP
289 Note that RSA keys may use non-standard \fBRSA_METHOD\fR implementations,
290 either directly or by the use of \fBENGINE\fR modules. In some cases (eg. an
291 ENGINE providing support for hardware-embedded keys), these BIGNUM values
292 will not be used by the implementation or may be used for alternative data
293 storage. For this reason, applications should generally avoid using RSA
294 structure elements directly and instead use API functions to query or
295 modify keys.
296 .SH "CONFORMING TO"
297 SSL, PKCS #1 v2.0
298 .SH "PATENTS"
299 RSA was covered by a US patent which expired in September 2000.
300 .SH "SEE ALSO"
301 rsa(1), bn(3), dsa(3), dh(3),
302 rand(3), engine(3), RSA_new(3),
303 RSA_public_encrypt(3),
304 RSA_sign(3), RSA_size(3),
305 RSA_generate_key(3),
306 RSA_check_key(3),
307 RSA_blinding_on(3),
308 RSA_set_method(3), RSA_print(3),
309 RSA_get_ex_new_index(3),
310 RSA_private_encrypt(3),
311 RSA_sign_ASN1_OCTET_STRING(3),
312 RSA_padding_add_PKCS1_type_1(3) 
313
314 .rn }` ''
315 .IX Title "rsa 3"
316 .IX Name "rsa - RSA public key cryptosystem"
317
318 .IX Header "NAME"
319
320 .IX Header "SYNOPSIS"
321
322 .IX Header "DESCRIPTION"
323
324 .IX Header "CONFORMING TO"
325
326 .IX Header "PATENTS"
327
328 .IX Header "SEE ALSO"
329