doc/man3/RSA_padding_add_PKCS1_type_1.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_padding_add_PKCS1_type_1, RSA_padding_check_PKCS1_type_1,
   6 RSA_padding_add_PKCS1_type_2, RSA_padding_check_PKCS1_type_2,
   7 RSA_padding_add_PKCS1_OAEP, RSA_padding_check_PKCS1_OAEP,
   8 RSA_padding_add_PKCS1_OAEP_mgf1, RSA_padding_check_PKCS1_OAEP_mgf1,
   9 RSA_padding_add_SSLv23, RSA_padding_check_SSLv23,
  10 RSA_padding_add_none, RSA_padding_check_none - asymmetric encryption
  11 padding
  12
  13 =head1 SYNOPSIS
  14
  15  #include <openssl/rsa.h>
  16
  17  int RSA_padding_add_PKCS1_type_1(unsigned char *to, int tlen,
  18                                   const unsigned char *f, int fl);
  19
  20  int RSA_padding_check_PKCS1_type_1(unsigned char *to, int tlen,
  21                                     const unsigned char *f, int fl, int rsa_len);
  22
  23  int RSA_padding_add_PKCS1_type_2(unsigned char *to, int tlen,
  24                                   const unsigned char *f, int fl);
  25
  26  int RSA_padding_check_PKCS1_type_2(unsigned char *to, int tlen,
  27                                     const unsigned char *f, int fl, int rsa_len);
  28
  29  int RSA_padding_add_PKCS1_OAEP(unsigned char *to, int tlen,
  30                                 const unsigned char *f, int fl,
  31                                 const unsigned char *p, int pl);
  32
  33  int RSA_padding_check_PKCS1_OAEP(unsigned char *to, int tlen,
  34                                   const unsigned char *f, int fl, int rsa_len,
  35                                   const unsigned char *p, int pl);
  36
  37  int RSA_padding_add_PKCS1_OAEP_mgf1(unsigned char *to, int tlen,
  38                                      const unsigned char *f, int fl,
  39                                      const unsigned char *p, int pl,
  40                                      const EVP_MD *md, const EVP_MD *mgf1md);
  41
  42  int RSA_padding_check_PKCS1_OAEP_mgf1(unsigned char *to, int tlen,
  43                                        const unsigned char *f, int fl, int rsa_len,
  44                                        const unsigned char *p, int pl,
  45                                        const EVP_MD *md, const EVP_MD *mgf1md);
  46
  47  int RSA_padding_add_SSLv23(unsigned char *to, int tlen,
  48                             const unsigned char *f, int fl);
  49
  50  int RSA_padding_check_SSLv23(unsigned char *to, int tlen,
  51                               const unsigned char *f, int fl, int rsa_len);
  52
  53  int RSA_padding_add_none(unsigned char *to, int tlen,
  54                           const unsigned char *f, int fl);
  55
  56  int RSA_padding_check_none(unsigned char *to, int tlen,
  57                             const unsigned char *f, int fl, int rsa_len);
  58
  59 =head1 DESCRIPTION
  60
  61 The RSA_padding_xxx_xxx() functions are called from the RSA encrypt,
  62 decrypt, sign and verify functions. Normally they should not be called
  63 from application programs.
  64
  65 However, they can also be called directly to implement padding for other
  66 asymmetric ciphers. RSA_padding_add_PKCS1_OAEP() and
  67 RSA_padding_check_PKCS1_OAEP() may be used in an application combined
  68 with B<RSA_NO_PADDING> in order to implement OAEP with an encoding
  69 parameter.
  70
  71 RSA_padding_add_xxx() encodes B<fl> bytes from B<f> so as to fit into
  72 B<tlen> bytes and stores the result at B<to>. An error occurs if B<fl>
  73 does not meet the size requirements of the encoding method.
  74
  75 The following encoding methods are implemented:
  76
  77 =over 4
  78
  79 =item PKCS1_type_1
  80
  81 PKCS #1 v2.0 EMSA-PKCS1-v1_5 (PKCS #1 v1.5 block type 1); used for signatures
  82
  83 =item PKCS1_type_2
  84
  85 PKCS #1 v2.0 EME-PKCS1-v1_5 (PKCS #1 v1.5 block type 2)
  86
  87 =item PKCS1_OAEP
  88
  89 PKCS #1 v2.0 EME-OAEP
  90
  91 =item SSLv23
  92
  93 PKCS #1 EME-PKCS1-v1_5 with SSL-specific modification
  94
  95 =item none
  96
  97 simply copy the data
  98
  99 =back
 100
 101 The random number generator must be seeded prior to calling
 102 RSA_padding_add_xxx().
 103
 104 RSA_padding_check_xxx() verifies that the B<fl> bytes at B<f> contain
 105 a valid encoding for a B<rsa_len> byte RSA key in the respective
 106 encoding method and stores the recovered data of at most B<tlen> bytes
 107 (for B<RSA_NO_PADDING>: of size B<tlen>)
 108 at B<to>.
 109
 110 For RSA_padding_xxx_OAEP(), B<p> points to the encoding parameter
 111 of length B<pl>. B<p> may be B<NULL> if B<pl> is 0.
 112
 113 For RSA_padding_xxx_OAEP_mgf1(), B<md> points to the md hash,
 114 if B<md> is B<NULL> that means md=sha1, and B<mgf1md> points to
 115 the mgf1 hash, if B<mgf1md> is B<NULL> that means mgf1md=md.
 116
 117 =head1 RETURN VALUES
 118
 119 The RSA_padding_add_xxx() functions return 1 on success, 0 on error.
 120 The RSA_padding_check_xxx() functions return the length of the
 121 recovered data, -1 on error. Error codes can be obtained by calling
 122 L<ERR_get_error(3)>.
 123
 124 =head1 WARNING
 125
 126 The result of RSA_padding_check_PKCS1_type_2() is a very sensitive
 127 information which can potentially be used to mount a Bleichenbacher
 128 padding oracle attack. This is an inherent weakness in the PKCS #1
 129 v1.5 padding design. Prefer PKCS1_OAEP padding. If that is not
 130 possible, the result of RSA_padding_check_PKCS1_type_2() should be
 131 checked in constant time if it matches the expected length of the
 132 plaintext and additionally some application specific consistency
 133 checks on the plaintext need to be performed in constant time.
 134 If the plaintext is rejected it must be kept secret which of the
 135 checks caused the application to reject the message.
 136 Do not remove the zero-padding from the decrypted raw RSA data
 137 which was computed by RSA_private_decrypt() with B<RSA_NO_PADDING>,
 138 as this would create a small timing side channel which could be
 139 used to mount a Bleichenbacher attack against any padding mode
 140 including PKCS1_OAEP.
 141
 142 =head1 SEE ALSO
 143
 144 L<RSA_public_encrypt(3)>,
 145 L<RSA_private_decrypt(3)>,
 146 L<RSA_sign(3)>, L<RSA_verify(3)>
 147
 148 =head1 COPYRIGHT
 149
 150 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 151
 152 Licensed under the Apache License 2.0 (the "License").  You may not use
 153 this file except in compliance with the License.  You can obtain a copy
 154 in the file LICENSE in the source distribution or at
 155 L<https://www.openssl.org/source/license.html>.
 156
 157 =cut