c75bb4be903dded81049dc13713527391769570a
[openssl.git] / doc / man3 / SSL_SESSION_set1_id.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_SESSION_set1_id - set the SSL session ID
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
12                          unsigned int sid_len);
13
14 =head1 DESCRIPTION
15
16 SSL_SESSION_set1_id() sets the the session ID for the B<ssl> SSL/TLS session
17 to B<sid> of length B<sid_len>.
18
19 =head1 RETURN VALUES
20
21 SSL_SESSION_set1_id() returns 1 for success and 0 for failure, for example
22 if the supplied session ID length exceeds B<SSL_MAX_SSL_SESSION_ID_LENGTH>.
23
24 =head1 SEE ALSO
25
26 L<ssl(7)>
27
28 =head1 HISTORY
29
30 SSL_SESSION_set1_id() 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