]> git.ipfire.org Git - thirdparty/openssl.git/blob - doc/ssl/SSL_CONF_CTX_set_flags.pod
add SSL_CONF functions and documentation
[thirdparty/openssl.git] / doc / ssl / SSL_CONF_CTX_set_flags.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CONF_CTX_set_flags, SSL_CONF_CTX_clear_flags - Set of clear SSL configuration context flags
6
7 =head1 SYNOPSIS
8
9 #include <openssl/ssl.h>
10
11 unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags);
12 unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx, unsigned int flags);
13
14 =head1 DESCRIPTION
15
16 The function SSL_CONF_CTX_set_flags() sets B<flags> in the context B<cctx>.
17
18 The function SSL_CONF_CTX_clear_flags() clears B<flags> in the context B<cctx>.
19
20 =head1 NOTES
21
22 The flags how subsequent calls to SSL_CONF_set_cmd() or SSL_CONF_set_argv()
23 behave.
24
25 Currently the following B<flags> values are recognised:
26
27 =over 4
28
29 =item SSL_CONF_FLAG_FLAG_CMDLINE, SSL_CONF_FLAG_FLAG_FILE
30
31 recognise options intended for command line or configuration file use. At
32 least one of these flags must be set.
33
34 =item SSL_CONF_FLAG_CLIENT, SSL_CONF_FLAG_SERVER
35
36 recognise options intended for use in SSL/TLS clients or servers. One or
37 both of these flags must be set.
38
39 =item SSL_CONF_FLAG_SHOW_ERRORS
40
41 indicate errors relating to unrecognised options or missing arguments in
42 the error queue. If this option isn't set such errors are only reflected
43 in the return values of SSL_CONF_set_cmd() or SSL_CONF_set_argv()
44
45 =head1 RETURN VALUES
46
47 SSL_CONF_CTX_set_flags() and SSL_CONF_CTX_clear_flags() returns the new flags
48 value after setting or clearing flags.
49
50 =head1 SEE ALSO
51
52 L<SSL_CONF_CTX_new(3)|SSL_CONF_CTX_new(3)>,
53 L<SSL_CONF_CTX_set_ssl_ctx(3)|SSL_CONF_CTX_set_ssl_ctx(3)>,
54 L<SSL_CONF_cmd(3)|SSL_CONF_cmd(3)>,
55 L<SSL_CONF_cmd_argv(3)|SSL_CONF_cmd_argv(3)>
56
57 =head1 HISTORY
58
59 These functions were first added to OpenSSL 1.1.0
60
61 =cut