new manual page SSL_get_server_tmp_key(3)

from Matt Caswell <matt@openssl.org>, OpenSSL commit 508fafd8

1 files changed, 84 insertions, 0 deletions

diff --git a/lib/libssl/man/SSL_get_server_tmp_key.3 b/lib/libssl/man/SSL_get_server_tmp_key.3
new file mode 100644
index 00000000000..66e362f6e99
--- /dev/null
+++ b/lib/libssl/man/SSL_get_server_tmp_key.3
@@ -0,0 +1,84 @@
+.\"	$OpenBSD: SSL_get_server_tmp_key.3,v 1.1 2017/04/10 15:54:46 schwarze Exp $
+.\"	OpenSSL SSL_get_server_tmp_key.pod 508fafd8 Apr 3 15:41:21 2017 +0100
+.\"
+.\" This file was written by Matt Caswell <matt@openssl.org>
+.\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in
+.\"    the documentation and/or other materials provided with the
+.\"    distribution.
+.\"
+.\" 3. All advertising materials mentioning features or use of this
+.\"    software must display the following acknowledgment:
+.\"    "This product includes software developed by the OpenSSL Project
+.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+.\"
+.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+.\"    endorse or promote products derived from this software without
+.\"    prior written permission. For written permission, please contact
+.\"    openssl-core@openssl.org.
+.\"
+.\" 5. Products derived from this software may not be called "OpenSSL"
+.\"    nor may "OpenSSL" appear in their names without prior written
+.\"    permission of the OpenSSL Project.
+.\"
+.\" 6. Redistributions of any form whatsoever must retain the following
+.\"    acknowledgment:
+.\"    "This product includes software developed by the OpenSSL Project
+.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
+.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+.\" OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: April 10 2017 $
+.Dt SSL_GET_SERVER_TMP_KEY 3
+.Os
+.Sh NAME
+.Nm SSL_get_server_tmp_key
+.Nd temporary server key during a handshake
+.Sh SYNOPSIS
+.In openssl/ssl.h
+.Ft long
+.Fo SSL_get_server_tmp_key
+.Fa "SSL *ssl"
+.Fa "EVP_PKEY **key"
+.Fc
+.Sh DESCRIPTION
+.Fn SSL_get_server_tmp_key
+retrieves the temporary key provided by the server
+and used during key exchange.
+For example, if ECDHE is in use,
+this represents the server's public ECDHE key.
+.Pp
+In case of success, a copy of the key is stored in
+.Pf * Fa key .
+It is the caller's responsibility to free this key after use using
+.Xr EVP_PKEY_free 3 .
+.Pp
+This function may only be called by the client.
+.Pp
+This function is implemented as a macro.
+.Sh RETURN VALUES
+.Fn SSL_get_server_tmp_key
+returns 1 on success or 0 on failure.
+.Sh SEE ALSO
+.Xr EVP_PKEY_free 3 ,
+.Xr SSL_ctrl 3