1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Wed Feb 19 16:43:06 2003
5 .\" ======================================================================
6 .de Sh \" Subsection heading
14 .de Sp \" Vertical space (when we can't use .PP)
20 .ie \\n(.$>=3 .ne \\$3
24 .de Vb \" Begin verbatim text
29 .de Ve \" End verbatim text
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
65 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
79 . \" fudge factors for nroff and troff
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
94 . \" simple accents for nroff and troff
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
138 .\" ======================================================================
141 .TH rsa 3 "0.9.7a" "2003-02-19" "OpenSSL"
144 rsa \- \s-1RSA\s0 public key cryptosystem
146 .IX Header "SYNOPSIS"
148 \& #include <openssl/rsa.h>
149 \& #include <openssl/engine.h>
152 \& RSA * RSA_new(void);
153 \& void RSA_free(RSA *rsa);
156 \& int RSA_public_encrypt(int flen, unsigned char *from,
157 \& unsigned char *to, RSA *rsa, int padding);
158 \& int RSA_private_decrypt(int flen, unsigned char *from,
159 \& unsigned char *to, RSA *rsa, int padding);
160 \& int RSA_private_encrypt(int flen, unsigned char *from,
161 \& unsigned char *to, RSA *rsa,int padding);
162 \& int RSA_public_decrypt(int flen, unsigned char *from,
163 \& unsigned char *to, RSA *rsa,int padding);
166 \& int RSA_sign(int type, unsigned char *m, unsigned int m_len,
167 \& unsigned char *sigret, unsigned int *siglen, RSA *rsa);
168 \& int RSA_verify(int type, unsigned char *m, unsigned int m_len,
169 \& unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
172 \& int RSA_size(const RSA *rsa);
175 \& RSA *RSA_generate_key(int num, unsigned long e,
176 \& void (*callback)(int,int,void *), void *cb_arg);
179 \& int RSA_check_key(RSA *rsa);
182 \& int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
183 \& void RSA_blinding_off(RSA *rsa);
186 \& void RSA_set_default_method(const RSA_METHOD *meth);
187 \& const RSA_METHOD *RSA_get_default_method(void);
188 \& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
189 \& const RSA_METHOD *RSA_get_method(const RSA *rsa);
190 \& RSA_METHOD *RSA_PKCS1_SSLeay(void);
191 \& RSA_METHOD *RSA_null_method(void);
192 \& int RSA_flags(const RSA *rsa);
193 \& RSA *RSA_new_method(ENGINE *engine);
196 \& int RSA_print(BIO *bp, RSA *x, int offset);
197 \& int RSA_print_fp(FILE *fp, RSA *x, int offset);
200 \& int RSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
201 \& int (*dup_func)(), void (*free_func)());
202 \& int RSA_set_ex_data(RSA *r,int idx,char *arg);
203 \& char *RSA_get_ex_data(RSA *r, int idx);
206 \& int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
207 \& unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
209 \& int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
210 \& unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
214 .IX Header "DESCRIPTION"
215 These functions implement \s-1RSA\s0 public key encryption and signatures
216 as defined in \s-1PKCS\s0 #1 v2.0 [\s-1RFC\s0 2437].
218 The \fB\s-1RSA\s0\fR structure consists of several \s-1BIGNUM\s0 components. It can
219 contain public as well as private \s-1RSA\s0 keys:
224 \& BIGNUM *n; // public modulus
225 \& BIGNUM *e; // public exponent
226 \& BIGNUM *d; // private exponent
227 \& BIGNUM *p; // secret prime factor
228 \& BIGNUM *q; // secret prime factor
229 \& BIGNUM *dmp1; // d mod (p-1)
230 \& BIGNUM *dmq1; // d mod (q-1)
231 \& BIGNUM *iqmp; // q^-1 mod p
236 In public keys, the private exponent and the related secret values are
239 \&\fBp\fR, \fBq\fR, \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR may be \fB\s-1NULL\s0\fR in private
240 keys, but the \s-1RSA\s0 operations are much faster when these values are
243 Note that \s-1RSA\s0 keys may use non-standard \fB\s-1RSA_METHOD\s0\fR implementations,
244 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
245 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
246 will not be used by the implementation or may be used for alternative data
247 storage. For this reason, applications should generally avoid using \s-1RSA\s0
248 structure elements directly and instead use \s-1API\s0 functions to query or
251 .IX Header "CONFORMING TO"
252 \&\s-1SSL\s0, \s-1PKCS\s0 #1 v2.0
255 \&\s-1RSA\s0 was covered by a \s-1US\s0 patent which expired in September 2000.
257 .IX Header "SEE ALSO"
258 rsa(1), bn(3), dsa(3), dh(3),
259 rand(3), engine(3), RSA_new(3),
260 RSA_public_encrypt(3),
261 RSA_sign(3), RSA_size(3),
265 RSA_set_method(3), RSA_print(3),
266 RSA_get_ex_new_index(3),
267 RSA_private_encrypt(3),
268 RSA_sign_ASN1_OCTET_STRING(3),
269 RSA_padding_add_PKCS1_type_1(3)