doc/man3/SSL_get_peer_signature_nid.pod

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