lib/libssl/man/SSL_copy_session_id.3

   1 .\"     $OpenBSD: SSL_copy_session_id.3,v 1.3 2018/03/21 05:07:04 schwarze Exp $
   2 .\"
   3 .\" Copyright (c) 2016 Ingo Schwarze <schwarze@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate: March 21 2018 $
  18 .Dt SSL_COPY_SESSION_ID 3
  19 .Os
  20 .Sh NAME
  21 .Nm SSL_copy_session_id
  22 .Nd copy session details between SSL objects
  23 .Sh SYNOPSIS
  24 .In openssl/ssl.h
  25 .Ft void
  26 .Fo SSL_copy_session_id
  27 .Fa "SSL *to"
  28 .Fa "const SSL *from"
  29 .Fc
  30 .Sh DESCRIPTION
  31 .Fn SSL_copy_session_id
  32 copies the following data from
  33 .Fa from
  34 to
  35 .Fa to :
  36 .Bl -dash
  37 .It
  38 the pointer to the
  39 .Vt SSL_SESSION
  40 object, incrementing its reference count by 1
  41 .It
  42 the pointer to the
  43 .Vt SSL_METHOD
  44 object; if that changes the method, protocol-specific data is
  45 reinitialized
  46 .It
  47 the pointer to the
  48 .Vt CERT
  49 object, incrementing its reference count by 1
  50 .It
  51 the session ID context
  52 .El
  53 .Pp
  54 This function is used internally by
  55 .Xr SSL_dup 3
  56 and by
  57 .Xr BIO_ssl_copy_session_id 3 .
  58 .Sh SEE ALSO
  59 .Xr BIO_ssl_copy_session_id 3 ,
  60 .Xr SSL_dup 3 ,
  61 .Xr SSL_get_session 3 ,
  62 .Xr SSL_SESSION_get_id 3 ,
  63 .Xr SSL_SESSION_new 3 ,
  64 .Xr SSL_set_session 3 ,
  65 .Xr SSL_set_session_id_context 3
  66 .Sh HISTORY
  67 .Fn SSL_copy_session_id
  68 appeared before SSLeay 0.8 and has been available since
  69 .Ox 2.4 .
  70 .Sh BUGS
  71 Failures of
  72 .Xr SSL_set_session 3 ,
  73 .Xr SSL_set_session_id_context 3 ,
  74 .Xr CRYPTO_add 3 ,
  75 and reinitialization of protocol-specific data are silently ignored
  76 and may leave
  77 .Fa to
  78 in an invalid or inconsistent state.
  79 An improved version reporting failure is available in OpenSSL 1.1.0.