lib/libssl/man/SSL_get_server_tmp_key.3

   1 .\"     $OpenBSD: SSL_get_server_tmp_key.3,v 1.3 2018/03/24 00:55:37 schwarze Exp $
   2 .\"     OpenSSL SSL_get_server_tmp_key.pod 508fafd8 Apr 3 15:41:21 2017 +0100
   3 .\"
   4 .\" This file was written by Matt Caswell <matt@openssl.org>
   5 .\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: March 24 2018 $
  52 .Dt SSL_GET_SERVER_TMP_KEY 3
  53 .Os
  54 .Sh NAME
  55 .Nm SSL_get_server_tmp_key
  56 .Nd temporary server key during a handshake
  57 .Sh SYNOPSIS
  58 .In openssl/ssl.h
  59 .Ft long
  60 .Fo SSL_get_server_tmp_key
  61 .Fa "SSL *ssl"
  62 .Fa "EVP_PKEY **key"
  63 .Fc
  64 .Sh DESCRIPTION
  65 .Fn SSL_get_server_tmp_key
  66 retrieves the temporary key provided by the server
  67 and used during key exchange.
  68 For example, if ECDHE is in use,
  69 this represents the server's public ECDHE key.
  70 .Pp
  71 In case of success, a copy of the key is stored in
  72 .Pf * Fa key .
  73 It is the caller's responsibility to free this key after use using
  74 .Xr EVP_PKEY_free 3 .
  75 .Pp
  76 This function may only be called by the client.
  77 .Pp
  78 This function is implemented as a macro.
  79 .Sh RETURN VALUES
  80 .Fn SSL_get_server_tmp_key
  81 returns 1 on success or 0 on failure.
  82 .Sh SEE ALSO
  83 .Xr EVP_PKEY_free 3 ,
  84 .Xr SSL_ctrl 3
  85 .Sh HISTORY
  86 .Fn SSL_get_server_tmp_key
  87 first appeared in OpenSSL 1.0.2 and has been available since
  88 .Ox 6.1 .