doc/man3/SSL_SESSION_get0_id_context.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_SESSION_get0_id_context,
   6 SSL_SESSION_set1_id_context
   7 - get and set the SSL ID context associated with a session
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/ssl.h>
  12
  13  const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
  14                                                   unsigned int *len)
  15  int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
  16                                 unsigned int sid_ctx_len);
  17
  18 =head1 DESCRIPTION
  19
  20 See L<SSL_CTX_set_session_id_context(3)> for further details on session ID
  21 contexts.
  22
  23 SSL_SESSION_get0_id_context() returns the ID context associated with
  24 the SSL/TLS session B<s>. The length of the ID context is written to
  25 B<*len> if B<len> is not NULL.
  26
  27 The value returned is a pointer to an object maintained within B<s> and
  28 should not be released.
  29
  30 SSL_SESSION_set1_id_context() takes a copy of the provided ID context given in
  31 B<sid_ctx> and associates it with the session B<s>. The length of the ID context
  32 is given by B<sid_ctx_len> which must not exceed SSL_MAX_SID_CTX_LENGTH bytes.
  33
  34 =head1 RETURN VALUES
  35
  36 SSL_SESSION_set1_id_context() returns 1 on success or 0 on error.
  37
  38 =head1 SEE ALSO
  39
  40 L<ssl(7)>,
  41 L<SSL_set_session_id_context(3)>
  42
  43 =head1 HISTORY
  44
  45 The SSL_SESSION_get0_id_context() function was added in OpenSSL 1.1.0.
  46
  47 =head1 COPYRIGHT
  48
  49 Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
  50
  51 Licensed under the Apache License 2.0 (the "License").  You may not use
  52 this file except in compliance with the License.  You can obtain a copy
  53 in the file LICENSE in the source distribution or at
  54 L<https://www.openssl.org/source/license.html>.
  55
  56 =cut