Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_config.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_CTX_CONFIG 3SSL"
58 .TH SSL_CTX_CONFIG 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_CTX_config, SSL_config \- configure SSL_CTX or SSL structure
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_CTX_config(SSL_CTX *ctx, const char *name);
71 \& int SSL_config(SSL *s, const char *name);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 The functions \fBSSL_CTX_config()\fR and \fBSSL_config()\fR configure an \fBSSL_CTX\fR or
76 \&\fBSSL\fR structure using the configuration \fBname\fR.
77 .PP
78 By calling \fBSSL_CTX_config()\fR or \fBSSL_config()\fR an application can perform many
79 complex tasks based on the contents of the configuration file: greatly
80 simplifying application configuration code. A degree of future proofing
81 can also be achieved: an application can support configuration features
82 in newer versions of OpenSSL automatically.
83 .PP
84 A configuration file must have been previously loaded, for example using
85 \&\fBCONF_modules_load_file()\fR. See \fBconfig\fR\|(5) for details of the configuration
86 file syntax.
87 .SH "RETURN VALUES"
88 .IX Header "RETURN VALUES"
89 \&\fBSSL_CTX_config()\fR and \fBSSL_config()\fR return 1 for success or 0 if an error
90 occurred.
91 .SH EXAMPLES
92 .IX Header "EXAMPLES"
93 If the file "config.cnf" contains the following:
94 .PP
95 .Vb 1
96 \& testapp = test_sect
97 \&
98 \& [test_sect]
99 \& # list of configuration modules
100 \&
101 \& ssl_conf = ssl_sect
102 \&
103 \& [ssl_sect]
104 \& server = server_section
105 \&
106 \& [server_section]
107 \& RSA.Certificate = server\-rsa.pem
108 \& ECDSA.Certificate = server\-ecdsa.pem
109 \& Ciphers = ALL:!RC4
110 .Ve
111 .PP
112 An application could call:
113 .PP
114 .Vb 4
115 \& if (CONF_modules_load_file("config.cnf", "testapp", 0) <= 0) {
116 \& fprintf(stderr, "Error processing config file\en");
117 \& goto err;
118 \& }
119 \&
120 \& ctx = SSL_CTX_new(TLS_server_method());
121 \&
122 \& if (SSL_CTX_config(ctx, "server") == 0) {
123 \& fprintf(stderr, "Error configuring server.\en");
124 \& goto err;
125 \& }
126 .Ve
127 .PP
128 In this example two certificates and the cipher list are configured without
129 the need for any additional application code.
130 .SH "SEE ALSO"
131 .IX Header "SEE ALSO"
132 \&\fBssl\fR\|(7),
133 \&\fBconfig\fR\|(5),
134 \&\fBSSL_CONF_cmd\fR\|(3),
135 \&\fBCONF_modules_load_file\fR\|(3)
136 .SH HISTORY
137 .IX Header "HISTORY"
138 The \fBSSL_CTX_config()\fR and \fBSSL_config()\fR functions were added in OpenSSL 1.1.0.
139 .SH COPYRIGHT
140 .IX Header "COPYRIGHT"
141 Copyright 2015\-2020 The OpenSSL Project Authors. All Rights Reserved.
142 .PP
143 Licensed under the Apache License 2.0 (the "License"). You may not use
144 this file except in compliance with the License. You can obtain a copy
145 in the file LICENSE in the source distribution or at
146 <https://www.openssl.org/source/license.html>.