doc/man3/RSA_sign.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_sign, RSA_verify - RSA signatures
   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_sign(int type, const unsigned char *m, unsigned int m_len,
  16               unsigned char *sigret, unsigned int *siglen, RSA *rsa);
  17
  18  int RSA_verify(int type, const unsigned char *m, unsigned int m_len,
  19                 unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
  20
  21 =head1 DESCRIPTION
  22
  23 All of the functions described on this page are deprecated.
  24 Applications should instead use L<EVP_PKEY_sign_init(3)>, L<EVP_PKEY_sign(3)>,
  25 L<EVP_PKEY_verify_init(3)> and L<EVP_PKEY_verify(3)>.
  26
  27 RSA_sign() signs the message digest B<m> of size B<m_len> using the
  28 private key B<rsa> using RSASSA-PKCS1-v1_5 as specified in RFC 3447. It
  29 stores the signature in B<sigret> and the signature size in B<siglen>.
  30 B<sigret> must point to RSA_size(B<rsa>) bytes of memory.
  31 Note that PKCS #1 adds meta-data, placing limits on the size of the
  32 key that can be used.
  33 See L<RSA_private_encrypt(3)> for lower-level
  34 operations.
  35
  36 B<type> denotes the message digest algorithm that was used to generate
  37 B<m>.
  38 If B<type> is B<NID_md5_sha1>,
  39 an SSL signature (MD5 and SHA1 message digests with PKCS #1 padding
  40 and no algorithm identifier) is created.
  41
  42 RSA_verify() verifies that the signature B<sigbuf> of size B<siglen>
  43 matches a given message digest B<m> of size B<m_len>. B<type> denotes
  44 the message digest algorithm that was used to generate the signature.
  45 B<rsa> is the signer's public key.
  46
  47 =head1 RETURN VALUES
  48
  49 RSA_sign() returns 1 on success.
  50 RSA_verify() returns 1 on successful verification.
  51
  52 The error codes can be obtained by L<ERR_get_error(3)>.
  53
  54 =head1 CONFORMING TO
  55
  56 SSL, PKCS #1 v2.0
  57
  58 =head1 SEE ALSO
  59
  60 L<ERR_get_error(3)>,
  61 L<RSA_private_encrypt(3)>,
  62 L<RSA_public_decrypt(3)>
  63
  64 =head1 HISTORY
  65
  66 All of these functions were deprecated in OpenSSL 3.0.
  67
  68 =head1 COPYRIGHT
  69
  70 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
  71
  72 Licensed under the Apache License 2.0 (the "License").  You may not use
  73 this file except in compliance with the License.  You can obtain a copy
  74 in the file LICENSE in the source distribution or at
  75 L<https://www.openssl.org/source/license.html>.
  76
  77 =cut