1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
54 .\" Avoid warning from groff about undefined register 'F'.
60 . tm Index:\\$1\t\\n%\t"\\$2"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
132 .TH rsa 3 "2017-01-26" "1.0.2k" "OpenSSL"
133 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
134 .\" way too many mistakes in technical documents.
138 rsa \- RSA public key cryptosystem
140 .IX Header "SYNOPSIS"
142 \& #include <openssl/rsa.h>
143 \& #include <openssl/engine.h>
145 \& RSA * RSA_new(void);
146 \& void RSA_free(RSA *rsa);
148 \& int RSA_public_encrypt(int flen, unsigned char *from,
149 \& unsigned char *to, RSA *rsa, int padding);
150 \& int RSA_private_decrypt(int flen, unsigned char *from,
151 \& unsigned char *to, RSA *rsa, int padding);
152 \& int RSA_private_encrypt(int flen, unsigned char *from,
153 \& unsigned char *to, RSA *rsa,int padding);
154 \& int RSA_public_decrypt(int flen, unsigned char *from,
155 \& unsigned char *to, RSA *rsa,int padding);
157 \& int RSA_sign(int type, unsigned char *m, unsigned int m_len,
158 \& unsigned char *sigret, unsigned int *siglen, RSA *rsa);
159 \& int RSA_verify(int type, unsigned char *m, unsigned int m_len,
160 \& unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
162 \& int RSA_size(const RSA *rsa);
164 \& RSA *RSA_generate_key(int num, unsigned long e,
165 \& void (*callback)(int,int,void *), void *cb_arg);
167 \& int RSA_check_key(RSA *rsa);
169 \& int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
170 \& void RSA_blinding_off(RSA *rsa);
172 \& void RSA_set_default_method(const RSA_METHOD *meth);
173 \& const RSA_METHOD *RSA_get_default_method(void);
174 \& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
175 \& const RSA_METHOD *RSA_get_method(const RSA *rsa);
176 \& RSA_METHOD *RSA_PKCS1_SSLeay(void);
177 \& RSA_METHOD *RSA_null_method(void);
178 \& int RSA_flags(const RSA *rsa);
179 \& RSA *RSA_new_method(ENGINE *engine);
181 \& int RSA_print(BIO *bp, RSA *x, int offset);
182 \& int RSA_print_fp(FILE *fp, RSA *x, int offset);
184 \& int RSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
185 \& int (*dup_func)(), void (*free_func)());
186 \& int RSA_set_ex_data(RSA *r,int idx,char *arg);
187 \& char *RSA_get_ex_data(RSA *r, int idx);
189 \& int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
190 \& unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
192 \& int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
193 \& unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
197 .IX Header "DESCRIPTION"
198 These functions implement \s-1RSA\s0 public key encryption and signatures
199 as defined in \s-1PKCS\s0 #1 v2.0 [\s-1RFC 2437\s0].
201 The \fB\s-1RSA\s0\fR structure consists of several \s-1BIGNUM\s0 components. It can
202 contain public as well as private \s-1RSA\s0 keys:
207 \& BIGNUM *n; // public modulus
208 \& BIGNUM *e; // public exponent
209 \& BIGNUM *d; // private exponent
210 \& BIGNUM *p; // secret prime factor
211 \& BIGNUM *q; // secret prime factor
212 \& BIGNUM *dmp1; // d mod (p\-1)
213 \& BIGNUM *dmq1; // d mod (q\-1)
214 \& BIGNUM *iqmp; // q^\-1 mod p
220 In public keys, the private exponent and the related secret values are
223 \&\fBp\fR, \fBq\fR, \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR may be \fB\s-1NULL\s0\fR in private
224 keys, but the \s-1RSA\s0 operations are much faster when these values are
227 Note that \s-1RSA\s0 keys may use non-standard \fB\s-1RSA_METHOD\s0\fR implementations,
228 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
229 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
230 will not be used by the implementation or may be used for alternative data
231 storage. For this reason, applications should generally avoid using \s-1RSA\s0
232 structure elements directly and instead use \s-1API\s0 functions to query or
235 .IX Header "CONFORMING TO"
236 \&\s-1SSL, PKCS\s0 #1 v2.0
239 \&\s-1RSA\s0 was covered by a \s-1US\s0 patent which expired in September 2000.
241 .IX Header "SEE ALSO"
242 \&\fIrsa\fR\|(1), \fIbn\fR\|(3), \fIdsa\fR\|(3), \fIdh\fR\|(3),
243 \&\fIrand\fR\|(3), \fIengine\fR\|(3), \fIRSA_new\fR\|(3),
244 \&\fIRSA_public_encrypt\fR\|(3),
245 \&\fIRSA_sign\fR\|(3), \fIRSA_size\fR\|(3),
246 \&\fIRSA_generate_key\fR\|(3),
247 \&\fIRSA_check_key\fR\|(3),
248 \&\fIRSA_blinding_on\fR\|(3),
249 \&\fIRSA_set_method\fR\|(3), \fIRSA_print\fR\|(3),
250 \&\fIRSA_get_ex_new_index\fR\|(3),
251 \&\fIRSA_private_encrypt\fR\|(3),
252 \&\fIRSA_sign_ASN1_OCTET_STRING\fR\|(3),
253 \&\fIRSA_padding_add_PKCS1_type_1\fR\|(3)