Blame doc/man3/SSL_CTX_set_ex_data.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
SSL_CTX_get_ex_data, SSL_CTX_set_ex_data,
Packit Service 084de1
SSL_get_ex_data, SSL_set_ex_data
Packit Service 084de1
- Store and retrieve extra data from the SSL_CTX, SSL or SSL_SESSION
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/ssl.h>
Packit Service 084de1
Packit Service 084de1
 void *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx);
Packit Service 084de1
Packit Service 084de1
 int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, void *arg);
Packit Service 084de1
Packit Service 084de1
 void *SSL_get_ex_data(const SSL *s, int idx);
Packit Service 084de1
Packit Service 084de1
 int SSL_set_ex_data(SSL *s, int idx, void *arg);
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
SSL*_set_ex_data() functions can be used to store arbitrary user data into the
Packit Service 084de1
B<SSL_CTX>, or B<SSL> object. The user must supply a unique index
Packit Service 084de1
which they can subsequently use to retrieve the data using SSL*_get_ex_data().
Packit Service 084de1
Packit Service 084de1
For more detailed information see L<CRYPTO_get_ex_data(3)> and
Packit Service 084de1
L<CRYPTO_set_ex_data(3)> which implement these functions and
Packit Service 084de1
L<CRYPTO_get_ex_new_index(3)> for generating a unique index.
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
The SSL*_set_ex_data() functions return 1 if the item is successfully stored
Packit Service 084de1
and 0 if it is not.
Packit Service 084de1
The SSL*_get_ex_data() functions return the ex_data pointer if successful,
Packit Service 084de1
otherwise NULL.
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<CRYPTO_get_ex_data(3)>, L<CRYPTO_set_ex_data(3)>,
Packit Service 084de1
L<CRYPTO_get_ex_new_index(3)>
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut