Merge branch 'vendor/OPENSSL'
[dragonfly.git] / secure / lib / libcrypto / man / RSA_padding_add_PKCS1_type_1.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_padding_add_PKCS1_type_1 3"
18ed9402 132.TH RSA_padding_add_PKCS1_type_1 3 "2008-09-27" "0.9.8i" "OpenSSL"
984263bc
MD
133.SH "NAME"
134RSA_padding_add_PKCS1_type_1, RSA_padding_check_PKCS1_type_1,
135RSA_padding_add_PKCS1_type_2, RSA_padding_check_PKCS1_type_2,
136RSA_padding_add_PKCS1_OAEP, RSA_padding_check_PKCS1_OAEP,
137RSA_padding_add_SSLv23, RSA_padding_check_SSLv23,
138RSA_padding_add_none, RSA_padding_check_none \- asymmetric encryption
139padding
140.SH "SYNOPSIS"
8b0cefbb 141.IX Header "SYNOPSIS"
984263bc
MD
142.Vb 1
143\& #include <openssl/rsa.h>
aac4ff6f
PA
144.Ve
145.PP
146.Vb 2
984263bc
MD
147\& int RSA_padding_add_PKCS1_type_1(unsigned char *to, int tlen,
148\& unsigned char *f, int fl);
aac4ff6f
PA
149.Ve
150.PP
151.Vb 2
984263bc
MD
152\& int RSA_padding_check_PKCS1_type_1(unsigned char *to, int tlen,
153\& unsigned char *f, int fl, int rsa_len);
aac4ff6f
PA
154.Ve
155.PP
156.Vb 2
984263bc
MD
157\& int RSA_padding_add_PKCS1_type_2(unsigned char *to, int tlen,
158\& unsigned char *f, int fl);
aac4ff6f
PA
159.Ve
160.PP
161.Vb 2
984263bc
MD
162\& int RSA_padding_check_PKCS1_type_2(unsigned char *to, int tlen,
163\& unsigned char *f, int fl, int rsa_len);
aac4ff6f
PA
164.Ve
165.PP
166.Vb 2
984263bc
MD
167\& int RSA_padding_add_PKCS1_OAEP(unsigned char *to, int tlen,
168\& unsigned char *f, int fl, unsigned char *p, int pl);
aac4ff6f
PA
169.Ve
170.PP
171.Vb 2
984263bc
MD
172\& int RSA_padding_check_PKCS1_OAEP(unsigned char *to, int tlen,
173\& unsigned char *f, int fl, int rsa_len, unsigned char *p, int pl);
aac4ff6f
PA
174.Ve
175.PP
176.Vb 2
984263bc
MD
177\& int RSA_padding_add_SSLv23(unsigned char *to, int tlen,
178\& unsigned char *f, int fl);
aac4ff6f
PA
179.Ve
180.PP
181.Vb 2
984263bc
MD
182\& int RSA_padding_check_SSLv23(unsigned char *to, int tlen,
183\& unsigned char *f, int fl, int rsa_len);
aac4ff6f
PA
184.Ve
185.PP
186.Vb 2
984263bc
MD
187\& int RSA_padding_add_none(unsigned char *to, int tlen,
188\& unsigned char *f, int fl);
aac4ff6f
PA
189.Ve
190.PP
191.Vb 2
984263bc
MD
192\& int RSA_padding_check_none(unsigned char *to, int tlen,
193\& unsigned char *f, int fl, int rsa_len);
194.Ve
195.SH "DESCRIPTION"
8b0cefbb
JR
196.IX Header "DESCRIPTION"
197The \fIRSA_padding_xxx_xxx()\fR functions are called from the \s-1RSA\s0 encrypt,
984263bc
MD
198decrypt, sign and verify functions. Normally they should not be called
199from application programs.
200.PP
201However, they can also be called directly to implement padding for other
202asymmetric ciphers. \fIRSA_padding_add_PKCS1_OAEP()\fR and
8b0cefbb
JR
203\&\fIRSA_padding_check_PKCS1_OAEP()\fR may be used in an application combined
204with \fB\s-1RSA_NO_PADDING\s0\fR in order to implement \s-1OAEP\s0 with an encoding
984263bc
MD
205parameter.
206.PP
8b0cefbb
JR
207\&\fIRSA_padding_add_xxx()\fR encodes \fBfl\fR bytes from \fBf\fR so as to fit into
208\&\fBtlen\fR bytes and stores the result at \fBto\fR. An error occurs if \fBfl\fR
984263bc
MD
209does not meet the size requirements of the encoding method.
210.PP
211The following encoding methods are implemented:
8b0cefbb
JR
212.IP "PKCS1_type_1" 4
213.IX Item "PKCS1_type_1"
214\&\s-1PKCS\s0 #1 v2.0 EMSA\-PKCS1\-v1_5 (\s-1PKCS\s0 #1 v1.5 block type 1); used for signatures
215.IP "PKCS1_type_2" 4
216.IX Item "PKCS1_type_2"
217\&\s-1PKCS\s0 #1 v2.0 EME\-PKCS1\-v1_5 (\s-1PKCS\s0 #1 v1.5 block type 2)
218.IP "\s-1PKCS1_OAEP\s0" 4
219.IX Item "PKCS1_OAEP"
220\&\s-1PKCS\s0 #1 v2.0 EME-OAEP
221.IP "SSLv23" 4
222.IX Item "SSLv23"
223\&\s-1PKCS\s0 #1 EME\-PKCS1\-v1_5 with SSL-specific modification
224.IP "none" 4
225.IX Item "none"
984263bc
MD
226simply copy the data
227.PP
228The random number generator must be seeded prior to calling
8b0cefbb 229\&\fIRSA_padding_add_xxx()\fR.
984263bc 230.PP
8b0cefbb 231\&\fIRSA_padding_check_xxx()\fR verifies that the \fBfl\fR bytes at \fBf\fR contain
984263bc
MD
232a valid encoding for a \fBrsa_len\fR byte \s-1RSA\s0 key in the respective
233encoding method and stores the recovered data of at most \fBtlen\fR bytes
234(for \fB\s-1RSA_NO_PADDING\s0\fR: of size \fBtlen\fR)
235at \fBto\fR.
236.PP
237For \fIRSA_padding_xxx_OAEP()\fR, \fBp\fR points to the encoding parameter
238of length \fBpl\fR. \fBp\fR may be \fB\s-1NULL\s0\fR if \fBpl\fR is 0.
239.SH "RETURN VALUES"
8b0cefbb 240.IX Header "RETURN VALUES"
984263bc
MD
241The \fIRSA_padding_add_xxx()\fR functions return 1 on success, 0 on error.
242The \fIRSA_padding_check_xxx()\fR functions return the length of the
243recovered data, \-1 on error. Error codes can be obtained by calling
8b0cefbb 244\&\fIERR_get_error\fR\|(3).
984263bc 245.SH "SEE ALSO"
8b0cefbb
JR
246.IX Header "SEE ALSO"
247\&\fIRSA_public_encrypt\fR\|(3),
248\&\fIRSA_private_decrypt\fR\|(3),
249\&\fIRSA_sign\fR\|(3), \fIRSA_verify\fR\|(3)
984263bc 250.SH "HISTORY"
8b0cefbb
JR
251.IX Header "HISTORY"
252\&\fIRSA_padding_add_PKCS1_type_1()\fR, \fIRSA_padding_check_PKCS1_type_1()\fR,
253\&\fIRSA_padding_add_PKCS1_type_2()\fR, \fIRSA_padding_check_PKCS1_type_2()\fR,
254\&\fIRSA_padding_add_SSLv23()\fR, \fIRSA_padding_check_SSLv23()\fR,
255\&\fIRSA_padding_add_none()\fR and \fIRSA_padding_check_none()\fR appeared in
984263bc
MD
256SSLeay 0.9.0.
257.PP
8b0cefbb 258\&\fIRSA_padding_add_PKCS1_OAEP()\fR and \fIRSA_padding_check_PKCS1_OAEP()\fR were
984263bc 259added in OpenSSL 0.9.2b.