Blame doc/man3/SSL_CTX_get0_param.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_CTX_get0_param, SSL_get0_param, SSL_CTX_set1_param, SSL_set1_param -
Packit c4476c
get and set verification parameters
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx)
Packit c4476c
 X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl)
Packit c4476c
 int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm)
Packit c4476c
 int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm)
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
SSL_CTX_get0_param() and SSL_get0_param() retrieve an internal pointer to
Packit c4476c
the verification parameters for B<ctx> or B<ssl> respectively. The returned
Packit c4476c
pointer must not be freed by the calling application.
Packit c4476c
Packit c4476c
SSL_CTX_set1_param() and SSL_set1_param() set the verification parameters
Packit c4476c
to B<vpm> for B<ctx> or B<ssl>.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
Typically parameters are retrieved from an B<SSL_CTX> or B<SSL> structure
Packit c4476c
using SSL_CTX_get0_param() or SSL_get0_param() and an application modifies
Packit c4476c
them to suit its needs: for example to add a hostname check.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
SSL_CTX_get0_param() and SSL_get0_param() return a pointer to an
Packit c4476c
B<X509_VERIFY_PARAM> structure.
Packit c4476c
Packit c4476c
SSL_CTX_set1_param() and SSL_set1_param() return 1 for success and 0
Packit c4476c
for failure.
Packit c4476c
Packit c4476c
=head1 EXAMPLES
Packit c4476c
Packit c4476c
Check hostname matches "www.foo.com" in peer certificate:
Packit c4476c
Packit c4476c
 X509_VERIFY_PARAM *vpm = SSL_get0_param(ssl);
Packit c4476c
 X509_VERIFY_PARAM_set1_host(vpm, "www.foo.com", 0);
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<X509_VERIFY_PARAM_set_flags(3)>
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
These functions were added in OpenSSL 1.0.2.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2015-2019 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