Debian Codegraph @

upstream/debian-unstable/man3/SSL_CONF_CTX_set_flags.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_CONF_CTX_SET_FLAGS 3SSL"
58 .TH SSL_CONF_CTX_SET_FLAGS 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_CONF_CTX_set_flags, SSL_CONF_CTX_clear_flags \- Set or clear SSL configuration context flags
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& unsigned int SSL_CONF_CTX_set_flags(SSL_CONF_CTX *cctx, unsigned int flags);
71 \& unsigned int SSL_CONF_CTX_clear_flags(SSL_CONF_CTX *cctx, unsigned int flags);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 The function \fBSSL_CONF_CTX_set_flags()\fR sets \fBflags\fR in the context \fBcctx\fR.
76 .PP
77 The function \fBSSL_CONF_CTX_clear_flags()\fR clears \fBflags\fR in the context \fBcctx\fR.
78 .SH NOTES
79 .IX Header "NOTES"
80 The flags set affect how subsequent calls to \fBSSL_CONF_cmd()\fR or
81 \&\fBSSL_CONF_argv()\fR behave.
82 .PP
83 Currently the following \fBflags\fR values are recognised:
84 .IP "SSL_CONF_FLAG_CMDLINE, SSL_CONF_FLAG_FILE" 4
85 .IX Item "SSL_CONF_FLAG_CMDLINE, SSL_CONF_FLAG_FILE"
86 recognise options intended for command line or configuration file use. At
87 least one of these flags must be set.
88 .IP "SSL_CONF_FLAG_CLIENT, SSL_CONF_FLAG_SERVER" 4
89 .IX Item "SSL_CONF_FLAG_CLIENT, SSL_CONF_FLAG_SERVER"
90 recognise options intended for use in SSL/TLS clients or servers. One or
91 both of these flags must be set.
92 .IP SSL_CONF_FLAG_CERTIFICATE 4
93 .IX Item "SSL_CONF_FLAG_CERTIFICATE"
94 recognise certificate and private key options.
95 .IP SSL_CONF_FLAG_REQUIRE_PRIVATE 4
96 .IX Item "SSL_CONF_FLAG_REQUIRE_PRIVATE"
97 If this option is set then if a private key is not specified for a certificate
98 it will attempt to load a private key from the certificate file when
99 \&\fBSSL_CONF_CTX_finish()\fR is called. If a key cannot be loaded from the certificate
100 file an error occurs.
101 .IP SSL_CONF_FLAG_SHOW_ERRORS 4
102 .IX Item "SSL_CONF_FLAG_SHOW_ERRORS"
103 indicate errors relating to unrecognised options or missing arguments in
104 the error queue. If this option isn't set such errors are only reflected
105 in the return values of \fBSSL_CONF_set_cmd()\fR or \fBSSL_CONF_set_argv()\fR
106 .SH "RETURN VALUES"
107 .IX Header "RETURN VALUES"
108 \&\fBSSL_CONF_CTX_set_flags()\fR and \fBSSL_CONF_CTX_clear_flags()\fR returns the new flags
109 value after setting or clearing flags.
110 .SH "SEE ALSO"
111 .IX Header "SEE ALSO"
112 \&\fBssl\fR\|(7),
113 \&\fBSSL_CONF_CTX_new\fR\|(3),
114 \&\fBSSL_CONF_CTX_set_ssl_ctx\fR\|(3),
115 \&\fBSSL_CONF_CTX_set1_prefix\fR\|(3),
116 \&\fBSSL_CONF_cmd\fR\|(3),
117 \&\fBSSL_CONF_cmd_argv\fR\|(3)
118 .SH HISTORY
119 .IX Header "HISTORY"
120 These functions were added in OpenSSL 1.0.2.
121 .SH COPYRIGHT
122 .IX Header "COPYRIGHT"
123 Copyright 2012\-2016 The OpenSSL Project Authors. All Rights Reserved.
124 .PP
125 Licensed under the Apache License 2.0 (the "License"). You may not use
126 this file except in compliance with the License. You can obtain a copy
127 in the file LICENSE in the source distribution or at
128 <https://www.openssl.org/source/license.html>.