Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libcrypto / man / rsa.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
aac4ff6f
PA
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
8b0cefbb
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
984263bc
MD
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
8b0cefbb
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 58..
8b0cefbb
JR
59. nr % 0
60. rr F
984263bc 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
8b0cefbb
JR
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
984263bc 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
8b0cefbb
JR
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'
984263bc 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 112. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "rsa 3"
aac4ff6f 132.TH rsa 3 "2008-09-06" "0.9.8h" "OpenSSL"
984263bc 133.SH "NAME"
74dab6c2 134rsa \- RSA public key cryptosystem
984263bc 135.SH "SYNOPSIS"
8b0cefbb 136.IX Header "SYNOPSIS"
984263bc
MD
137.Vb 2
138\& #include <openssl/rsa.h>
139\& #include <openssl/engine.h>
aac4ff6f
PA
140.Ve
141.PP
142.Vb 2
984263bc
MD
143\& RSA * RSA_new(void);
144\& void RSA_free(RSA *rsa);
aac4ff6f
PA
145.Ve
146.PP
147.Vb 8
984263bc
MD
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);
aac4ff6f
PA
156.Ve
157.PP
158.Vb 4
984263bc
MD
159\& int RSA_sign(int type, unsigned char *m, unsigned int m_len,
160\& unsigned char *sigret, unsigned int *siglen, RSA *rsa);
161\& int RSA_verify(int type, unsigned char *m, unsigned int m_len,
162\& unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
aac4ff6f
PA
163.Ve
164.PP
165.Vb 1
984263bc 166\& int RSA_size(const RSA *rsa);
aac4ff6f
PA
167.Ve
168.PP
169.Vb 2
984263bc
MD
170\& RSA *RSA_generate_key(int num, unsigned long e,
171\& void (*callback)(int,int,void *), void *cb_arg);
aac4ff6f
PA
172.Ve
173.PP
174.Vb 1
984263bc 175\& int RSA_check_key(RSA *rsa);
aac4ff6f
PA
176.Ve
177.PP
178.Vb 2
984263bc
MD
179\& int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
180\& void RSA_blinding_off(RSA *rsa);
aac4ff6f
PA
181.Ve
182.PP
183.Vb 8
984263bc
MD
184\& void RSA_set_default_method(const RSA_METHOD *meth);
185\& const RSA_METHOD *RSA_get_default_method(void);
186\& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
187\& const RSA_METHOD *RSA_get_method(const RSA *rsa);
188\& RSA_METHOD *RSA_PKCS1_SSLeay(void);
189\& RSA_METHOD *RSA_null_method(void);
190\& int RSA_flags(const RSA *rsa);
191\& RSA *RSA_new_method(ENGINE *engine);
aac4ff6f
PA
192.Ve
193.PP
194.Vb 2
984263bc
MD
195\& int RSA_print(BIO *bp, RSA *x, int offset);
196\& int RSA_print_fp(FILE *fp, RSA *x, int offset);
aac4ff6f
PA
197.Ve
198.PP
199.Vb 4
984263bc
MD
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);
aac4ff6f
PA
204.Ve
205.PP
206.Vb 6
984263bc
MD
207\& int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
208\& unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
209\& RSA *rsa);
210\& int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
211\& unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
212\& RSA *rsa);
213.Ve
214.SH "DESCRIPTION"
8b0cefbb
JR
215.IX Header "DESCRIPTION"
216These functions implement \s-1RSA\s0 public key encryption and signatures
217as defined in \s-1PKCS\s0 #1 v2.0 [\s-1RFC\s0 2437].
984263bc 218.PP
8b0cefbb
JR
219The \fB\s-1RSA\s0\fR structure consists of several \s-1BIGNUM\s0 components. It can
220contain public as well as private \s-1RSA\s0 keys:
984263bc 221.PP
aac4ff6f 222.Vb 13
984263bc
MD
223\& struct
224\& {
225\& BIGNUM *n; // public modulus
226\& BIGNUM *e; // public exponent
227\& BIGNUM *d; // private exponent
228\& BIGNUM *p; // secret prime factor
229\& BIGNUM *q; // secret prime factor
aac4ff6f
PA
230\& BIGNUM *dmp1; // d mod (p-1)
231\& BIGNUM *dmq1; // d mod (q-1)
232\& BIGNUM *iqmp; // q^-1 mod p
984263bc
MD
233\& // ...
234\& };
235\& RSA
236.Ve
8b0cefbb 237.PP
984263bc 238In public keys, the private exponent and the related secret values are
8b0cefbb 239\&\fB\s-1NULL\s0\fR.
984263bc 240.PP
8b0cefbb
JR
241\&\fBp\fR, \fBq\fR, \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR may be \fB\s-1NULL\s0\fR in private
242keys, but the \s-1RSA\s0 operations are much faster when these values are
984263bc
MD
243available.
244.PP
8b0cefbb
JR
245Note that \s-1RSA\s0 keys may use non-standard \fB\s-1RSA_METHOD\s0\fR implementations,
246either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
247\&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
984263bc 248will not be used by the implementation or may be used for alternative data
8b0cefbb
JR
249storage. For this reason, applications should generally avoid using \s-1RSA\s0
250structure elements directly and instead use \s-1API\s0 functions to query or
984263bc
MD
251modify keys.
252.SH "CONFORMING TO"
74dab6c2 253.IX Header "CONFORMING TO"
8b0cefbb
JR
254\&\s-1SSL\s0, \s-1PKCS\s0 #1 v2.0
255.SH "PATENTS"
74dab6c2 256.IX Header "PATENTS"
8b0cefbb
JR
257\&\s-1RSA\s0 was covered by a \s-1US\s0 patent which expired in September 2000.
258.SH "SEE ALSO"
74dab6c2 259.IX Header "SEE ALSO"
8b0cefbb
JR
260\&\fIrsa\fR\|(1), \fIbn\fR\|(3), \fIdsa\fR\|(3), \fIdh\fR\|(3),
261\&\fIrand\fR\|(3), \fIengine\fR\|(3), \fIRSA_new\fR\|(3),
262\&\fIRSA_public_encrypt\fR\|(3),
263\&\fIRSA_sign\fR\|(3), \fIRSA_size\fR\|(3),
264\&\fIRSA_generate_key\fR\|(3),
265\&\fIRSA_check_key\fR\|(3),
266\&\fIRSA_blinding_on\fR\|(3),
267\&\fIRSA_set_method\fR\|(3), \fIRSA_print\fR\|(3),
268\&\fIRSA_get_ex_new_index\fR\|(3),
269\&\fIRSA_private_encrypt\fR\|(3),
270\&\fIRSA_sign_ASN1_OCTET_STRING\fR\|(3),
aac4ff6f 271\&\fIRSA_padding_add_PKCS1_type_1\fR\|(3)