doc/man3/RSA_private_encrypt.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_private_encrypt, RSA_public_decrypt - low level signature operations
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rsa.h>
  10
  11 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  12 B<OPENSSL_API_COMPAT> with a suitable version value, see
  13 L<openssl_user_macros(7)>:
  14
  15  int RSA_private_encrypt(int flen, unsigned char *from,
  16                          unsigned char *to, RSA *rsa, int padding);
  17
  18  int RSA_public_decrypt(int flen, unsigned char *from,
  19                         unsigned char *to, RSA *rsa, int padding);
  20
  21 =head1 DESCRIPTION
  22
  23 Both of the functions described on this page are deprecated.
  24 Applications should instead use L<EVP_PKEY_encrypt_init(3)>,
  25 L<EVP_PKEY_encrypt(3)>, L<EVP_PKEY_decrypt_init(3)> and L<EVP_PKEY_decrypt(3)>.
  26
  27 These functions handle RSA signatures at a low level.
  28
  29 RSA_private_encrypt() signs the B<flen> bytes at B<from> (usually a
  30 message digest with an algorithm identifier) using the private key
  31 B<rsa> and stores the signature in B<to>. B<to> must point to
  32 B<RSA_size(rsa)> bytes of memory.
  33
  34 B<padding> denotes one of the following modes:
  35
  36 =over 4
  37
  38 =item RSA_PKCS1_PADDING
  39
  40 PKCS #1 v1.5 padding. This function does not handle the
  41 B<algorithmIdentifier> specified in PKCS #1. When generating or
  42 verifying PKCS #1 signatures, L<RSA_sign(3)> and L<RSA_verify(3)> should be
  43 used.
  44
  45 =item RSA_NO_PADDING
  46
  47 Raw RSA signature. This mode should I<only> be used to implement
  48 cryptographically sound padding modes in the application code.
  49 Signing user data directly with RSA is insecure.
  50
  51 =back
  52
  53 RSA_public_decrypt() recovers the message digest from the B<flen>
  54 bytes long signature at B<from> using the signer's public key
  55 B<rsa>. B<to> must point to a memory section large enough to hold the
  56 message digest (which is smaller than B<RSA_size(rsa) -
  57 11>). B<padding> is the padding mode that was used to sign the data.
  58
  59 =head1 RETURN VALUES
  60
  61 RSA_private_encrypt() returns the size of the signature (i.e.,
  62 RSA_size(rsa)). RSA_public_decrypt() returns the size of the
  63 recovered message digest.
  64
  65 On error, -1 is returned; the error codes can be
  66 obtained by L<ERR_get_error(3)>.
  67
  68 =head1 SEE ALSO
  69
  70 L<ERR_get_error(3)>,
  71 L<RSA_sign(3)>, L<RSA_verify(3)>
  72
  73 =head1 HISTORY
  74
  75 Both of these functions were deprecated in OpenSSL 3.0.
  76
  77 =head1 COPYRIGHT
  78
  79 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  80
  81 Licensed under the Apache License 2.0 (the "License").  You may not use
  82 this file except in compliance with the License.  You can obtain a copy
  83 in the file LICENSE in the source distribution or at
  84 L<https://www.openssl.org/source/license.html>.
  85
  86 =cut