2ac3fc4dd024795196cd7a6836388d511c4d7742
[openssl.git] / doc / man3 / SSL_SESSION_get0_id_context.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_SESSION_get0_id_context - get the SSL ID context associated with a session
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
12                                                   unsigned int *len)
13
14 =head1 DESCRIPTION
15
16 SSL_SESSION_get0_id_context() returns the ID context associated with
17 the SSL/TLS session B<s>. The length of the ID context is written to
18 B<*len> if B<len> is not NULL.
19
20 The value returned is a pointer to an object maintained within B<s> and
21 should not be released.
22
23 =head1 SEE ALSO
24
25 L<ssl(3)>,
26 L<SSL_set_session_id_context(3)>
27
28 =head1 HISTORY
29
30 SSL_SESSION_get0_id_context() was first added to OpenSSL 1.1.0
31
32 =head1 COPYRIGHT
33
34 Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
35
36 Licensed under the OpenSSL license (the "License").  You may not use
37 this file except in compliance with the License.  You can obtain a copy
38 in the file LICENSE in the source distribution or at
39 L<https://www.openssl.org/source/license.html>.
40
41 =cut