SSL_get_peer_tmp_key.pod 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. =pod
  2. =head1 NAME
  3. SSL_get_peer_tmp_key, SSL_get_server_tmp_key, SSL_get_tmp_key - get information
  4. about temporary keys used during a handshake
  5. =head1 SYNOPSIS
  6. #include <openssl/ssl.h>
  7. long SSL_get_peer_tmp_key(SSL *ssl, EVP_PKEY **key);
  8. long SSL_get_server_tmp_key(SSL *ssl, EVP_PKEY **key);
  9. long SSL_get_tmp_key(SSL *ssl, EVP_PKEY **key);
  10. =head1 DESCRIPTION
  11. SSL_get_peer_tmp_key() returns the temporary key provided by the peer and
  12. used during key exchange. For example, if ECDHE is in use, then this represents
  13. the peer's public ECDHE key. On success a pointer to the key is stored in
  14. B<*key>. It is the caller's responsibility to free this key after use using
  15. L<EVP_PKEY_free(3)>.
  16. SSL_get_server_tmp_key() is a backwards compatibility alias for
  17. SSL_get_peer_tmp_key().
  18. Under that name it worked just on the client side of the connection, its
  19. behaviour on the server end is release-dependent.
  20. SSL_get_tmp_key() returns the equivalent information for the local
  21. end of the connection.
  22. =head1 RETURN VALUES
  23. All these functions return 1 on success and 0 otherwise.
  24. =head1 NOTES
  25. This function is implemented as a macro.
  26. =head1 SEE ALSO
  27. L<ssl(7)>, L<EVP_PKEY_free(3)>
  28. =head1 COPYRIGHT
  29. Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
  30. Licensed under the Apache License 2.0 (the "License"). You may not use
  31. this file except in compliance with the License. You can obtain a copy
  32. in the file LICENSE in the source distribution or at
  33. L<https://www.openssl.org/source/license.html>.
  34. =cut