Blame doc/man3/SSL_CONF_CTX_set1_prefix.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_CONF_CTX_set1_prefix - Set configuration context command prefix
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 unsigned int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *prefix);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
The function SSL_CONF_CTX_set1_prefix() sets the command prefix of B<cctx>
Packit c4476c
to B<prefix>. If B<prefix> is B<NULL> it is restored to the default value.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
Command prefixes alter the commands recognised by subsequent SSL_CONF_cmd()
Packit c4476c
calls. For example for files, if the prefix "SSL" is set then command names
Packit c4476c
such as "SSLProtocol", "SSLOptions" etc. are recognised instead of "Protocol"
Packit c4476c
and "Options". Similarly for command lines if the prefix is "--ssl-" then
Packit c4476c
"--ssl-no_tls1_2" is recognised instead of "-no_tls1_2".
Packit c4476c
Packit c4476c
If the B<SSL_CONF_FLAG_CMDLINE> flag is set then prefix checks are case
Packit c4476c
sensitive and "-" is the default. In the unlikely even an application
Packit c4476c
explicitly wants to set no prefix it must be explicitly set to "".
Packit c4476c
Packit c4476c
If the B<SSL_CONF_FLAG_FILE> flag is set then prefix checks are case
Packit c4476c
insensitive and no prefix is the default.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
SSL_CONF_CTX_set1_prefix() returns 1 for success and 0 for failure.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<SSL_CONF_CTX_new(3)>,
Packit c4476c
L<SSL_CONF_CTX_set_flags(3)>,
Packit c4476c
L<SSL_CONF_CTX_set_ssl_ctx(3)>,
Packit c4476c
L<SSL_CONF_cmd(3)>,
Packit c4476c
L<SSL_CONF_cmd_argv(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 2012-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