doc/man3/RSA_sign_ASN1_OCTET_STRING.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_sign_ASN1_OCTET_STRING, RSA_verify_ASN1_OCTET_STRING - 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_ASN1_OCTET_STRING(int dummy, unsigned char *m,
  16                                 unsigned int m_len, unsigned char *sigret,
  17                                 unsigned int *siglen, RSA *rsa);
  18
  19  int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
  20                                   unsigned int m_len, unsigned char *sigbuf,
  21                                   unsigned int siglen, RSA *rsa);
  22
  23 =head1 DESCRIPTION
  24
  25 All of the functions described on this page are deprecated.
  26 Applications should instead use EVP PKEY APIs.
  27
  28 RSA_sign_ASN1_OCTET_STRING() signs the octet string B<m> of size
  29 B<m_len> using the private key B<rsa> represented in DER using PKCS #1
  30 padding. It stores the signature in B<sigret> and the signature size
  31 in B<siglen>. B<sigret> must point to B<RSA_size(rsa)> bytes of
  32 memory.
  33
  34 B<dummy> is ignored.
  35
  36 The random number generator must be seeded when calling
  37 RSA_sign_ASN1_OCTET_STRING().
  38 If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
  39 external circumstances (see L<RAND(7)>), the operation will fail.
  40
  41 RSA_verify_ASN1_OCTET_STRING() verifies that the signature B<sigbuf>
  42 of size B<siglen> is the DER representation of a given octet string
  43 B<m> of size B<m_len>. B<dummy> is ignored. B<rsa> is the signer's
  44 public key.
  45
  46 =head1 RETURN VALUES
  47
  48 RSA_sign_ASN1_OCTET_STRING() returns 1 on success, 0 otherwise.
  49 RSA_verify_ASN1_OCTET_STRING() returns 1 on successful verification, 0
  50 otherwise.
  51
  52 The error codes can be obtained by L<ERR_get_error(3)>.
  53
  54 =head1 BUGS
  55
  56 These functions serve no recognizable purpose.
  57
  58 =head1 SEE ALSO
  59
  60 L<ERR_get_error(3)>,
  61 L<RAND_bytes(3)>, L<RSA_sign(3)>,
  62 L<RSA_verify(3)>,
  63 L<RAND(7)>
  64
  65 =head1 HISTORY
  66
  67 All of these functions were deprecated in OpenSSL 3.0.
  68
  69 =head1 COPYRIGHT
  70
  71 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  72
  73 Licensed under the Apache License 2.0 (the "License").  You may not use
  74 this file except in compliance with the License.  You can obtain a copy
  75 in the file LICENSE in the source distribution or at
  76 L<https://www.openssl.org/source/license.html>.
  77
  78 =cut