secure/lib/libcrypto/man/RSA_padding_add_PKCS1_type_1.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:42:58 2003
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "RSA_padding_add_PKCS1_type_1 3"
 141 .TH RSA_padding_add_PKCS1_type_1 3 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 RSA_padding_add_PKCS1_type_1, RSA_padding_check_PKCS1_type_1,
 145 RSA_padding_add_PKCS1_type_2, RSA_padding_check_PKCS1_type_2,
 146 RSA_padding_add_PKCS1_OAEP, RSA_padding_check_PKCS1_OAEP,
 147 RSA_padding_add_SSLv23, RSA_padding_check_SSLv23,
 148 RSA_padding_add_none, RSA_padding_check_none \- asymmetric encryption
 149 padding
 150 .SH "SYNOPSIS"
 151 .IX Header "SYNOPSIS"
 152 .Vb 1
 153 \& #include <openssl/rsa.h>
 154 .Ve
 155 .Vb 2
 156 \& int RSA_padding_add_PKCS1_type_1(unsigned char *to, int tlen,
 157 \&    unsigned char *f, int fl);
 158 .Ve
 159 .Vb 2
 160 \& int RSA_padding_check_PKCS1_type_1(unsigned char *to, int tlen,
 161 \&    unsigned char *f, int fl, int rsa_len);
 162 .Ve
 163 .Vb 2
 164 \& int RSA_padding_add_PKCS1_type_2(unsigned char *to, int tlen,
 165 \&    unsigned char *f, int fl);
 166 .Ve
 167 .Vb 2
 168 \& int RSA_padding_check_PKCS1_type_2(unsigned char *to, int tlen,
 169 \&    unsigned char *f, int fl, int rsa_len);
 170 .Ve
 171 .Vb 2
 172 \& int RSA_padding_add_PKCS1_OAEP(unsigned char *to, int tlen,
 173 \&    unsigned char *f, int fl, unsigned char *p, int pl);
 174 .Ve
 175 .Vb 2
 176 \& int RSA_padding_check_PKCS1_OAEP(unsigned char *to, int tlen,
 177 \&    unsigned char *f, int fl, int rsa_len, unsigned char *p, int pl);
 178 .Ve
 179 .Vb 2
 180 \& int RSA_padding_add_SSLv23(unsigned char *to, int tlen,
 181 \&    unsigned char *f, int fl);
 182 .Ve
 183 .Vb 2
 184 \& int RSA_padding_check_SSLv23(unsigned char *to, int tlen,
 185 \&    unsigned char *f, int fl, int rsa_len);
 186 .Ve
 187 .Vb 2
 188 \& int RSA_padding_add_none(unsigned char *to, int tlen,
 189 \&    unsigned char *f, int fl);
 190 .Ve
 191 .Vb 2
 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"
 196 .IX Header "DESCRIPTION"
 197 The \fIRSA_padding_xxx_xxx()\fR functions are called from the \s-1RSA\s0 encrypt,
 198 decrypt, sign and verify functions. Normally they should not be called
 199 from application programs.
 200 .PP
 201 However, they can also be called directly to implement padding for other
 202 asymmetric ciphers. \fIRSA_padding_add_PKCS1_OAEP()\fR and
 203 \&\fIRSA_padding_check_PKCS1_OAEP()\fR may be used in an application combined
 204 with \fB\s-1RSA_NO_PADDING\s0\fR in order to implement \s-1OAEP\s0 with an encoding
 205 parameter.
 206 .PP
 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
 209 does not meet the size requirements of the encoding method.
 210 .PP
 211 The following encoding methods are implemented:
 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 \s-1EME-OAEP\s0
 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"
 226 simply copy the data
 227 .PP
 228 The random number generator must be seeded prior to calling
 229 \&\fIRSA_padding_add_xxx()\fR.
 230 .PP
 231 \&\fIRSA_padding_check_xxx()\fR verifies that the \fBfl\fR bytes at \fBf\fR contain
 232 a valid encoding for a \fBrsa_len\fR byte \s-1RSA\s0 key in the respective
 233 encoding 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)
 235 at \fBto\fR.
 236 .PP
 237 For \fIRSA_padding_xxx_OAEP()\fR, \fBp\fR points to the encoding parameter
 238 of length \fBpl\fR. \fBp\fR may be \fB\s-1NULL\s0\fR if \fBpl\fR is 0.
 239 .SH "RETURN VALUES"
 240 .IX Header "RETURN VALUES"
 241 The \fIRSA_padding_add_xxx()\fR functions return 1 on success, 0 on error.
 242 The \fIRSA_padding_check_xxx()\fR functions return the length of the
 243 recovered data, \-1 on error. Error codes can be obtained by calling
 244 ERR_get_error(3).
 245 .SH "SEE ALSO"
 246 .IX Header "SEE ALSO"
 247 RSA_public_encrypt(3),
 248 RSA_private_decrypt(3),
 249 RSA_sign(3), RSA_verify(3)
 250 .SH "HISTORY"
 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
 256 SSLeay 0.9.0.
 257 .PP
 258 \&\fIRSA_padding_add_PKCS1_OAEP()\fR and \fIRSA_padding_check_PKCS1_OAEP()\fR were
 259 added in OpenSSL 0.9.2b.