Blame doc/man3/SSL_SESSION_get0_id_context.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_SESSION_get0_id_context,
Packit c4476c
SSL_SESSION_set1_id_context
Packit c4476c
- get and set the SSL ID context associated with a session
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
Packit c4476c
                                                  unsigned int *len)
Packit c4476c
 int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
Packit c4476c
                                unsigned int sid_ctx_len);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
See L<SSL_CTX_set_session_id_context(3)> for further details on session ID
Packit c4476c
contexts.
Packit c4476c
Packit c4476c
SSL_SESSION_get0_id_context() returns the ID context associated with
Packit c4476c
the SSL/TLS session B<s>. The length of the ID context is written to
Packit c4476c
B<*len> if B<len> is not NULL.
Packit c4476c
Packit c4476c
The value returned is a pointer to an object maintained within B<s> and
Packit c4476c
should not be released.
Packit c4476c
Packit c4476c
SSL_SESSION_set1_id_context() takes a copy of the provided ID context given in
Packit c4476c
B<sid_ctx> and associates it with the session B<s>. The length of the ID context
Packit c4476c
is given by B<sid_ctx_len> which must not exceed SSL_MAX_SID_CTX_LENGTH bytes.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
SSL_SESSION_set1_id_context() returns 1 on success or 0 on error.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<ssl(7)>,
Packit c4476c
L<SSL_set_session_id_context(3)>
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
The SSL_SESSION_get0_id_context() 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