Blame doc/man3/SSL_SESSION_set1_id.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_SESSION_get_id,
Packit c4476c
SSL_SESSION_set1_id
Packit c4476c
- get and set the SSL session ID
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
Packit c4476c
                                         unsigned int *len)
Packit c4476c
 int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
Packit c4476c
                         unsigned int sid_len);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
SSL_SESSION_get_id() returns a pointer to the internal session id value for the
Packit c4476c
session B<s>. The length of the id in bytes is stored in B<*len>. The length may
Packit c4476c
be 0. The caller should not free the returned pointer directly.
Packit c4476c
Packit c4476c
SSL_SESSION_set1_id() sets the session ID for the B<ssl> SSL/TLS session
Packit c4476c
to B<sid> of length B<sid_len>.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
SSL_SESSION_get_id() returns a pointer to the session id value.
Packit c4476c
SSL_SESSION_set1_id() returns 1 for success and 0 for failure, for example
Packit c4476c
if the supplied session ID length exceeds B<SSL_MAX_SSL_SESSION_ID_LENGTH>.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<ssl(7)>
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
The SSL_SESSION_set1_id() function was added in OpenSSL 1.1.0.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut