doc/man3/SSL_SESSION_get0_cipher.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_SESSION_get0_cipher,
   6 SSL_SESSION_set_cipher
   7 - set and retrieve the SSL cipher associated with a session
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/ssl.h>
  12
  13  const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s);
  14  int SSL_SESSION_set_cipher(SSL_SESSION *s, const SSL_CIPHER *cipher);
  15
  16 =head1 DESCRIPTION
  17
  18 SSL_SESSION_get0_cipher() retrieves the cipher that was used by the
  19 connection when the session was created, or NULL if it cannot be determined.
  20
  21 The value returned is a pointer to an object maintained within B<s> and
  22 should not be released.
  23
  24 SSL_SESSION_set_cipher() can be used to set the ciphersuite associated with the
  25 SSL_SESSION B<s> to B<cipher>. For example, this could be used to set up a
  26 session based PSK (see L<SSL_CTX_set_psk_use_session_callback(3)>).
  27
  28 =head1 RETURN VALUES
  29
  30 SSL_SESSION_get0_cipher() returns the SSL_CIPHER associated with the SSL_SESSION
  31 or NULL if it cannot be determined.
  32
  33 SSL_SESSION_set_cipher() returns 1 on success or 0 on failure.
  34
  35 =head1 SEE ALSO
  36
  37 L<ssl(7)>,
  38 L<d2i_SSL_SESSION(3)>,
  39 L<SSL_SESSION_get_time(3)>,
  40 L<SSL_SESSION_get0_hostname(3)>,
  41 L<SSL_SESSION_free(3)>,
  42 L<SSL_CTX_set_psk_use_session_callback(3)>
  43
  44 =head1 HISTORY
  45
  46 The SSL_SESSION_get0_cipher() function was added in OpenSSL 1.1.0.
  47 The SSL_SESSION_set_cipher() function was added in OpenSSL 1.1.1.
  48
  49 =head1 COPYRIGHT
  50
  51 Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.
  52
  53 Licensed under the Apache License 2.0 (the "License").  You may not use
  54 this file except in compliance with the License.  You can obtain a copy
  55 in the file LICENSE in the source distribution or at
  56 L<https://www.openssl.org/source/license.html>.
  57
  58 =cut