Blame doc/man3/SSL_CTX_set_ex_data.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_CTX_get_ex_data, SSL_CTX_set_ex_data,
Packit c4476c
SSL_get_ex_data, SSL_set_ex_data
Packit c4476c
- Store and retrieve extra data from the SSL_CTX, SSL or SSL_SESSION
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx);
Packit c4476c
Packit c4476c
 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg);
Packit c4476c
Packit c4476c
 void *SSL_get_ex_data(const SSL *s, int idx);
Packit c4476c
Packit c4476c
 int SSL_set_ex_data(SSL *s, int idx, void *arg);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
SSL*_set_ex_data() functions can be used to store arbitrary user data into the
Packit c4476c
B<SSL_CTX>, or B<SSL> object. The user must supply a unique index
Packit c4476c
which they can subsequently use to retrieve the data using SSL*_get_ex_data().
Packit c4476c
Packit c4476c
For more detailed information see L<CRYPTO_get_ex_data(3)> and
Packit c4476c
L<CRYPTO_set_ex_data(3)> which implement these functions and
Packit c4476c
L<CRYPTO_get_ex_new_index(3)> for generating a unique index.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
The SSL*_set_ex_data() functions return 1 if the item is successfully stored
Packit c4476c
and 0 if it is not.
Packit c4476c
The SSL*_get_ex_data() functions return the ex_data pointer if successful,
Packit c4476c
otherwise NULL.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<CRYPTO_get_ex_data(3)>, L<CRYPTO_set_ex_data(3)>,
Packit c4476c
L<CRYPTO_get_ex_new_index(3)>
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2017 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