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