lib/libssl/man/SSL_SESSION_new.3

   1 .\"     $OpenBSD: SSL_SESSION_new.3,v 1.5 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_SESSION_NEW 3
  19 .Os
  20 .Sh NAME
  21 .Nm SSL_SESSION_new
  22 .Nd construct a new SSL_SESSION object
  23 .Sh SYNOPSIS
  24 .In openssl/ssl.h
  25 .Ft SSL_SESSION *
  26 .Fn SSL_SESSION_new void
  27 .Sh DESCRIPTION
  28 .Fn SSL_SESSION_new
  29 allocates and initializes an new
  30 .Vt SSL_SESSION
  31 object.
  32 The reference count is set to 1, the time to the current time, and
  33 the timeout to five minutes.
  34 .Pp
  35 When the object is no longer needed, it can be destructed with
  36 .Xr SSL_SESSION_free 3 .
  37 .Pp
  38 .Fn SSL_SESSION_new
  39 is used internally, for example by
  40 .Xr SSL_connect 3 .
  41 .Sh RETURN VALUES
  42 .Fn SSL_SESSION_new
  43 returns the new
  44 .Vt SSL_SESSION
  45 object or
  46 .Dv NULL
  47 if insufficient memory is available.
  48 .Pp
  49 After failure,
  50 .Xr ERR_get_error 3
  51 returns
  52 .Dv ERR_R_MALLOC_FAILURE .
  53 .Sh SEE ALSO
  54 .Xr d2i_SSL_SESSION 3 ,
  55 .Xr PEM_read_SSL_SESSION 3 ,
  56 .Xr SSL_connect 3 ,
  57 .Xr SSL_copy_session_id 3 ,
  58 .Xr SSL_CTX_add_session 3 ,
  59 .Xr SSL_CTX_sess_set_get_cb 3 ,
  60 .Xr SSL_get_session 3 ,
  61 .Xr SSL_SESSION_free 3 ,
  62 .Xr SSL_SESSION_get0_peer 3 ,
  63 .Xr SSL_SESSION_get_compress_id 3 ,
  64 .Xr SSL_SESSION_get_ex_new_index 3 ,
  65 .Xr SSL_SESSION_get_id 3 ,
  66 .Xr SSL_SESSION_get_master_key 3 ,
  67 .Xr SSL_SESSION_get_protocol_version 3 ,
  68 .Xr SSL_SESSION_get_time 3 ,
  69 .Xr SSL_SESSION_has_ticket 3 ,
  70 .Xr SSL_SESSION_print 3 ,
  71 .Xr SSL_SESSION_set1_id_context 3 ,
  72 .Xr SSL_set_session 3
  73 .Sh HISTORY
  74 .Fn SSL_SESSION_new
  75 appeared before SSLeay 0.8 and has been available since
  76 .Ox 2.4 .