Fix some SSL_export_keying_material() issues
[openssl.git] / doc / man3 / SSL_SESSION_set1_id.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_SESSION_get_id,
6 SSL_SESSION_set1_id
7 - get and set the SSL session ID
8
9 =head1 SYNOPSIS
10
11  #include <openssl/ssl.h>
12
13  const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
14                                          unsigned int *len)
15  int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
16                          unsigned int sid_len);
17
18 =head1 DESCRIPTION
19
20 SSL_SESSION_get_id() returns a pointer to the internal session id value for the
21 session B<s>. The length of the id in bytes is stored in B<*len>. The length may
22 be 0. The caller should not free the returned pointer directly.
23
24 SSL_SESSION_set1_id() sets the session ID for the B<ssl> SSL/TLS session
25 to B<sid> of length B<sid_len>.
26
27 =head1 RETURN VALUES
28
29 SSL_SESSION_get_id() returns a pointer to the session id value.
30 SSL_SESSION_set1_id() returns 1 for success and 0 for failure, for example
31 if the supplied session ID length exceeds B<SSL_MAX_SSL_SESSION_ID_LENGTH>.
32
33 =head1 SEE ALSO
34
35 L<ssl(7)>
36
37 =head1 HISTORY
38
39 SSL_SESSION_set1_id() was first added to OpenSSL 1.1.0
40
41 =head1 COPYRIGHT
42
43 Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
44
45 Licensed under the OpenSSL license (the "License").  You may not use
46 this file except in compliance with the License.  You can obtain a copy
47 in the file LICENSE in the source distribution or at
48 L<https://www.openssl.org/source/license.html>.
49
50 =cut