Merge from vendor branch OPENSSL:
[dragonfly.git] / secure / lib / libcrypto / man / RSA_padding_add_PKCS1_type_1.3
CommitLineData
2eaa1526 1.\" Automatically generated by Pod::Man 2.12 (Pod::Simple 3.05)
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
2eaa1526
PA
28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" nothing in troff, for use with C<>.
32.tr \(*W-
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.\"
8b0cefbb
JR
63.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64.\" Fear. Run. Save yourself. No user-serviceable parts.
65. \" fudge factors for nroff and troff
984263bc 66.if n \{\
8b0cefbb
JR
67. ds #H 0
68. ds #V .8m
69. ds #F .3m
70. ds #[ \f1
71. ds #] \fP
984263bc
MD
72.\}
73.if t \{\
8b0cefbb
JR
74. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75. ds #V .6m
76. ds #F 0
77. ds #[ \&
78. ds #] \&
984263bc 79.\}
8b0cefbb 80. \" simple accents for nroff and troff
984263bc 81.if n \{\
8b0cefbb
JR
82. ds ' \&
83. ds ` \&
84. ds ^ \&
85. ds , \&
86. ds ~ ~
87. ds /
984263bc
MD
88.\}
89.if t \{\
8b0cefbb
JR
90. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 96.\}
8b0cefbb 97. \" troff and (daisy-wheel) nroff accents
984263bc
MD
98.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105.ds ae a\h'-(\w'a'u*4/10)'e
106.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 107. \" corrections for vroff
984263bc
MD
108.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 110. \" for low resolution devices (crt and lpr)
984263bc
MD
111.if \n(.H>23 .if \n(.V>19 \
112\{\
8b0cefbb
JR
113. ds : e
114. ds 8 ss
115. ds o a
116. ds d- d\h'-1'\(ga
117. ds D- D\h'-1'\(hy
118. ds th \o'bp'
119. ds Th \o'LP'
120. ds ae ae
121. ds Ae AE
984263bc
MD
122.\}
123.rm #[ #] #H #V #F C
8b0cefbb
JR
124.\" ========================================================================
125.\"
126.IX Title "RSA_padding_add_PKCS1_type_1 3"
2eaa1526
PA
127.TH RSA_padding_add_PKCS1_type_1 3 "2007-10-24" "0.9.8g" "OpenSSL"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents.
130.if n .ad l
131.nh
984263bc
MD
132.SH "NAME"
133RSA_padding_add_PKCS1_type_1, RSA_padding_check_PKCS1_type_1,
134RSA_padding_add_PKCS1_type_2, RSA_padding_check_PKCS1_type_2,
135RSA_padding_add_PKCS1_OAEP, RSA_padding_check_PKCS1_OAEP,
136RSA_padding_add_SSLv23, RSA_padding_check_SSLv23,
137RSA_padding_add_none, RSA_padding_check_none \- asymmetric encryption
138padding
139.SH "SYNOPSIS"
8b0cefbb 140.IX Header "SYNOPSIS"
984263bc
MD
141.Vb 1
142\& #include <openssl/rsa.h>
2eaa1526 143\&
984263bc
MD
144\& int RSA_padding_add_PKCS1_type_1(unsigned char *to, int tlen,
145\& unsigned char *f, int fl);
2eaa1526 146\&
984263bc
MD
147\& int RSA_padding_check_PKCS1_type_1(unsigned char *to, int tlen,
148\& unsigned char *f, int fl, int rsa_len);
2eaa1526 149\&
984263bc
MD
150\& int RSA_padding_add_PKCS1_type_2(unsigned char *to, int tlen,
151\& unsigned char *f, int fl);
2eaa1526 152\&
984263bc
MD
153\& int RSA_padding_check_PKCS1_type_2(unsigned char *to, int tlen,
154\& unsigned char *f, int fl, int rsa_len);
2eaa1526 155\&
984263bc
MD
156\& int RSA_padding_add_PKCS1_OAEP(unsigned char *to, int tlen,
157\& unsigned char *f, int fl, unsigned char *p, int pl);
2eaa1526 158\&
984263bc
MD
159\& int RSA_padding_check_PKCS1_OAEP(unsigned char *to, int tlen,
160\& unsigned char *f, int fl, int rsa_len, unsigned char *p, int pl);
2eaa1526 161\&
984263bc
MD
162\& int RSA_padding_add_SSLv23(unsigned char *to, int tlen,
163\& unsigned char *f, int fl);
2eaa1526 164\&
984263bc
MD
165\& int RSA_padding_check_SSLv23(unsigned char *to, int tlen,
166\& unsigned char *f, int fl, int rsa_len);
2eaa1526 167\&
984263bc
MD
168\& int RSA_padding_add_none(unsigned char *to, int tlen,
169\& unsigned char *f, int fl);
2eaa1526 170\&
984263bc
MD
171\& int RSA_padding_check_none(unsigned char *to, int tlen,
172\& unsigned char *f, int fl, int rsa_len);
173.Ve
174.SH "DESCRIPTION"
8b0cefbb
JR
175.IX Header "DESCRIPTION"
176The \fIRSA_padding_xxx_xxx()\fR functions are called from the \s-1RSA\s0 encrypt,
984263bc
MD
177decrypt, sign and verify functions. Normally they should not be called
178from application programs.
179.PP
180However, they can also be called directly to implement padding for other
181asymmetric ciphers. \fIRSA_padding_add_PKCS1_OAEP()\fR and
8b0cefbb
JR
182\&\fIRSA_padding_check_PKCS1_OAEP()\fR may be used in an application combined
183with \fB\s-1RSA_NO_PADDING\s0\fR in order to implement \s-1OAEP\s0 with an encoding
984263bc
MD
184parameter.
185.PP
8b0cefbb
JR
186\&\fIRSA_padding_add_xxx()\fR encodes \fBfl\fR bytes from \fBf\fR so as to fit into
187\&\fBtlen\fR bytes and stores the result at \fBto\fR. An error occurs if \fBfl\fR
984263bc
MD
188does not meet the size requirements of the encoding method.
189.PP
190The following encoding methods are implemented:
8b0cefbb
JR
191.IP "PKCS1_type_1" 4
192.IX Item "PKCS1_type_1"
193\&\s-1PKCS\s0 #1 v2.0 EMSA\-PKCS1\-v1_5 (\s-1PKCS\s0 #1 v1.5 block type 1); used for signatures
194.IP "PKCS1_type_2" 4
195.IX Item "PKCS1_type_2"
196\&\s-1PKCS\s0 #1 v2.0 EME\-PKCS1\-v1_5 (\s-1PKCS\s0 #1 v1.5 block type 2)
197.IP "\s-1PKCS1_OAEP\s0" 4
198.IX Item "PKCS1_OAEP"
199\&\s-1PKCS\s0 #1 v2.0 EME-OAEP
200.IP "SSLv23" 4
201.IX Item "SSLv23"
202\&\s-1PKCS\s0 #1 EME\-PKCS1\-v1_5 with SSL-specific modification
203.IP "none" 4
204.IX Item "none"
984263bc
MD
205simply copy the data
206.PP
207The random number generator must be seeded prior to calling
8b0cefbb 208\&\fIRSA_padding_add_xxx()\fR.
984263bc 209.PP
8b0cefbb 210\&\fIRSA_padding_check_xxx()\fR verifies that the \fBfl\fR bytes at \fBf\fR contain
984263bc
MD
211a valid encoding for a \fBrsa_len\fR byte \s-1RSA\s0 key in the respective
212encoding method and stores the recovered data of at most \fBtlen\fR bytes
213(for \fB\s-1RSA_NO_PADDING\s0\fR: of size \fBtlen\fR)
214at \fBto\fR.
215.PP
216For \fIRSA_padding_xxx_OAEP()\fR, \fBp\fR points to the encoding parameter
217of length \fBpl\fR. \fBp\fR may be \fB\s-1NULL\s0\fR if \fBpl\fR is 0.
218.SH "RETURN VALUES"
8b0cefbb 219.IX Header "RETURN VALUES"
984263bc
MD
220The \fIRSA_padding_add_xxx()\fR functions return 1 on success, 0 on error.
221The \fIRSA_padding_check_xxx()\fR functions return the length of the
222recovered data, \-1 on error. Error codes can be obtained by calling
8b0cefbb 223\&\fIERR_get_error\fR\|(3).
984263bc 224.SH "SEE ALSO"
8b0cefbb
JR
225.IX Header "SEE ALSO"
226\&\fIRSA_public_encrypt\fR\|(3),
227\&\fIRSA_private_decrypt\fR\|(3),
228\&\fIRSA_sign\fR\|(3), \fIRSA_verify\fR\|(3)
984263bc 229.SH "HISTORY"
8b0cefbb
JR
230.IX Header "HISTORY"
231\&\fIRSA_padding_add_PKCS1_type_1()\fR, \fIRSA_padding_check_PKCS1_type_1()\fR,
232\&\fIRSA_padding_add_PKCS1_type_2()\fR, \fIRSA_padding_check_PKCS1_type_2()\fR,
233\&\fIRSA_padding_add_SSLv23()\fR, \fIRSA_padding_check_SSLv23()\fR,
234\&\fIRSA_padding_add_none()\fR and \fIRSA_padding_check_none()\fR appeared in
984263bc
MD
235SSLeay 0.9.0.
236.PP
8b0cefbb 237\&\fIRSA_padding_add_PKCS1_OAEP()\fR and \fIRSA_padding_check_PKCS1_OAEP()\fR were
984263bc 238added in OpenSSL 0.9.2b.