1=pod
2
3=head1 NAME
4
5SSL_get_peer_signature_nid, SSL_get_peer_signature_type_nid,
6SSL_get_signature_nid, SSL_get_signature_type_nid - get TLS message signing
7types
8
9=head1 SYNOPSIS
10
11 #include <openssl/ssl.h>
12
13 int SSL_get_peer_signature_nid(SSL *ssl, int *psig_nid);
14 int SSL_get_peer_signature_type_nid(const SSL *ssl, int *psigtype_nid);
15 int SSL_get_signature_nid(SSL *ssl, int *psig_nid);
16 int SSL_get_signature_type_nid(const SSL *ssl, int *psigtype_nid);
17
18=head1 DESCRIPTION
19
20SSL_get_peer_signature_nid() sets B<*psig_nid> to the NID of the digest used
21by the peer to sign TLS messages. It is implemented as a macro.
22
23SSL_get_peer_signature_type_nid() sets B<*psigtype_nid> to the signature
24type used by the peer to sign TLS messages. Currently the signature type
25is the NID of the public key type used for signing except for PSS signing
26where it is B<EVP_PKEY_RSA_PSS>. To differentiate between
27B<rsa_pss_rsae_*> and B<rsa_pss_pss_*> signatures, it's necessary to check
28the type of public key in the peer's certificate.
29
30SSL_get_signature_nid() and SSL_get_signature_type_nid() return the equivalent
31information for the local end of the connection.
32
33=head1 RETURN VALUES
34
35These functions return 1 for success and 0 for failure. There are several
36possible reasons for failure: the cipher suite has no signature (e.g. it
37uses RSA key exchange or is anonymous), the TLS version is below 1.2 or
38the functions were called too early, e.g. before the peer signed a message.
39
40=head1 SEE ALSO
41
42L<ssl(7)>, L<SSL_get_peer_certificate(3)>,
43
44=head1 COPYRIGHT
45
46Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
47
48Licensed under the OpenSSL license (the "License").  You may not use
49this file except in compliance with the License.  You can obtain a copy
50in the file LICENSE in the source distribution or at
51L<https://www.openssl.org/source/license.html>.
52
53=cut
54