xref: /freebsd/crypto/openssl/doc/man3/SSL_CONF_CTX_set1_prefix.pod (revision cfd6422a5217410fbd66f7a7a8a64d9d85e61229)
1=pod
2
3=head1 NAME
4
5SSL_CONF_CTX_set1_prefix - Set configuration context command prefix
6
7=head1 SYNOPSIS
8
9 #include <openssl/ssl.h>
10
11 unsigned int SSL_CONF_CTX_set1_prefix(SSL_CONF_CTX *cctx, const char *prefix);
12
13=head1 DESCRIPTION
14
15The function SSL_CONF_CTX_set1_prefix() sets the command prefix of B<cctx>
16to B<prefix>. If B<prefix> is B<NULL> it is restored to the default value.
17
18=head1 NOTES
19
20Command prefixes alter the commands recognised by subsequent SSL_CONF_cmd()
21calls. For example for files, if the prefix "SSL" is set then command names
22such as "SSLProtocol", "SSLOptions" etc. are recognised instead of "Protocol"
23and "Options". Similarly for command lines if the prefix is "--ssl-" then
24"--ssl-no_tls1_2" is recognised instead of "-no_tls1_2".
25
26If the B<SSL_CONF_FLAG_CMDLINE> flag is set then prefix checks are case
27sensitive and "-" is the default. In the unlikely even an application
28explicitly wants to set no prefix it must be explicitly set to "".
29
30If the B<SSL_CONF_FLAG_FILE> flag is set then prefix checks are case
31insensitive and no prefix is the default.
32
33=head1 RETURN VALUES
34
35SSL_CONF_CTX_set1_prefix() returns 1 for success and 0 for failure.
36
37=head1 SEE ALSO
38
39L<SSL_CONF_CTX_new(3)>,
40L<SSL_CONF_CTX_set_flags(3)>,
41L<SSL_CONF_CTX_set_ssl_ctx(3)>,
42L<SSL_CONF_cmd(3)>,
43L<SSL_CONF_cmd_argv(3)>
44
45=head1 HISTORY
46
47These functions were added in OpenSSL 1.0.2.
48
49=head1 COPYRIGHT
50
51Copyright 2012-2016 The OpenSSL Project Authors. All Rights Reserved.
52
53Licensed under the OpenSSL license (the "License").  You may not use
54this file except in compliance with the License.  You can obtain a copy
55in the file LICENSE in the source distribution or at
56L<https://www.openssl.org/source/license.html>.
57
58=cut
59