SSL_get_peer_signature_nid.pod 1.4 KB

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