doc/man3/SSL_get_server_tmp_key.pod

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