mirror of
https://github.com/openssl/openssl.git
synced 2024-11-21 01:15:20 +08:00
3dbf824380
There was recently an instance where a user was confused by the deprecation warnings in the docs. They believed the warning applied to the immediately preceding function declarations, when it fact it applied to the following function declarations. https://mta.openssl.org/pipermail/openssl-users/2021-December/014665.html We clarify the wording to make it clear that the warning applies to the following functions. Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17180)
79 lines
2.4 KiB
Plaintext
79 lines
2.4 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
RSA_sign_ASN1_OCTET_STRING, RSA_verify_ASN1_OCTET_STRING - RSA signatures
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/rsa.h>
|
|
|
|
The following functions have been deprecated since OpenSSL 3.0, and can be
|
|
hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
|
|
see L<openssl_user_macros(7)>:
|
|
|
|
int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
|
|
unsigned int m_len, unsigned char *sigret,
|
|
unsigned int *siglen, RSA *rsa);
|
|
|
|
int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
|
|
unsigned int m_len, unsigned char *sigbuf,
|
|
unsigned int siglen, RSA *rsa);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
All of the functions described on this page are deprecated.
|
|
Applications should instead use EVP PKEY APIs.
|
|
|
|
RSA_sign_ASN1_OCTET_STRING() signs the octet string B<m> of size
|
|
B<m_len> using the private key B<rsa> represented in DER using PKCS #1
|
|
padding. It stores the signature in B<sigret> and the signature size
|
|
in B<siglen>. B<sigret> must point to B<RSA_size(rsa)> bytes of
|
|
memory.
|
|
|
|
B<dummy> is ignored.
|
|
|
|
The random number generator must be seeded when calling
|
|
RSA_sign_ASN1_OCTET_STRING().
|
|
If the automatic seeding or reseeding of the OpenSSL CSPRNG fails due to
|
|
external circumstances (see L<RAND(7)>), the operation will fail.
|
|
|
|
RSA_verify_ASN1_OCTET_STRING() verifies that the signature B<sigbuf>
|
|
of size B<siglen> is the DER representation of a given octet string
|
|
B<m> of size B<m_len>. B<dummy> is ignored. B<rsa> is the signer's
|
|
public key.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
RSA_sign_ASN1_OCTET_STRING() returns 1 on success, 0 otherwise.
|
|
RSA_verify_ASN1_OCTET_STRING() returns 1 on successful verification, 0
|
|
otherwise.
|
|
|
|
The error codes can be obtained by L<ERR_get_error(3)>.
|
|
|
|
=head1 BUGS
|
|
|
|
These functions serve no recognizable purpose.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<ERR_get_error(3)>,
|
|
L<RAND_bytes(3)>, L<RSA_sign(3)>,
|
|
L<RSA_verify(3)>,
|
|
L<RAND(7)>
|
|
|
|
=head1 HISTORY
|
|
|
|
All of these functions were deprecated in OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|