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