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