SSL_get_server_tmp_key.pod 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. =pod
  2. =head1 NAME
  3. SSL_get_server_tmp_key - get information about the server's temporary key used
  4. during a handshake
  5. =head1 SYNOPSIS
  6. #include <openssl/ssl.h>
  7. long SSL_get_server_tmp_key(SSL *ssl, EVP_PKEY **key);
  8. =head1 DESCRIPTION
  9. SSL_get_server_tmp_key() returns the temporary key provided by the server and
  10. used during key exchange. For example, if ECDHE is in use, then this represents
  11. the server's public ECDHE key. On success a pointer to the key is stored in
  12. B<*key>. It is the caller's responsibility to free this key after use using
  13. L<EVP_PKEY_free(3)>. This function may only be called by the client.
  14. =head1 RETURN VALUES
  15. SSL_get_server_tmp_key() returns 1 on success or 0 otherwise.
  16. =head1 NOTES
  17. This function is implemented as a macro.
  18. =head1 SEE ALSO
  19. L<ssl(7)>, L<EVP_PKEY_free(3)>
  20. =head1 COPYRIGHT
  21. Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
  22. Licensed under the OpenSSL license (the "License"). You may not use
  23. this file except in compliance with the License. You can obtain a copy
  24. in the file LICENSE in the source distribution or at
  25. L<https://www.openssl.org/source/license.html>.
  26. =cut