]>
Commit | Line | Data |
---|---|---|
3db935a9 DSH |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
5 | SSL_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 | ||
15 | The function SSL_CONF_CTX_set1_prefix() sets the command prefix of B<cctx> | |
16 | to B<prefix>. If B<prefix> is B<NULL> it is restored to the default value. | |
17 | ||
18 | =head1 NOTES | |
19 | ||
f5f85f75 | 20 | Command prefixes alter the commands recognised by subsequent SSL_CONF_cmd() |
c7b7984a DSH |
21 | calls. For example for files, if the prefix "SSL" is set then command names |
22 | such as "SSLProtocol", "SSLOptions" etc. are recognised instead of "Protocol" | |
1bc74519 | 23 | and "Options". Similarly for command lines if the prefix is "--ssl-" then |
3db935a9 DSH |
24 | "--ssl-no_tls1_2" is recognised instead of "-no_tls1_2". |
25 | ||
26 | If the B<SSL_CONF_FLAG_CMDLINE> flag is set then prefix checks are case | |
27 | sensitive and "-" is the default. In the unlikely even an application | |
28 | explicitly wants to set no prefix it must be explicitly set to "". | |
29 | ||
30 | If the B<SSL_CONF_FLAG_FILE> flag is set then prefix checks are case | |
31 | insensitive and no prefix is the default. | |
32 | ||
33 | =head1 RETURN VALUES | |
34 | ||
35 | SSL_CONF_CTX_set1_prefix() returns 1 for success and 0 for failure. | |
36 | ||
37 | =head1 SEE ALSO | |
38 | ||
9b86974e RS |
39 | L<SSL_CONF_CTX_new(3)>, |
40 | L<SSL_CONF_CTX_set_flags(3)>, | |
41 | L<SSL_CONF_CTX_set_ssl_ctx(3)>, | |
42 | L<SSL_CONF_cmd(3)>, | |
43 | L<SSL_CONF_cmd_argv(3)> | |
3db935a9 DSH |
44 | |
45 | =head1 HISTORY | |
46 | ||
fc5ecadd | 47 | These functions were added in OpenSSL 1.0.2. |
3db935a9 | 48 | |
e2f92610 RS |
49 | =head1 COPYRIGHT |
50 | ||
51 | Copyright 2012-2016 The OpenSSL Project Authors. All Rights Reserved. | |
52 | ||
4746f25a | 53 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
54 | this file except in compliance with the License. You can obtain a copy |
55 | in the file LICENSE in the source distribution or at | |
56 | L<https://www.openssl.org/source/license.html>. | |
57 | ||
58 | =cut |