Debian Codegraph @

upstream/debian-unstable/man3/OPENSSL_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 "OPENSSL_CONFIG 3SSL"
58 .TH OPENSSL_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 OPENSSL_config, OPENSSL_no_config \- simple OpenSSL configuration functions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/conf.h>
69 .Ve
70 .PP
71 The following functions have been deprecated since OpenSSL 1.1.0, and can be
72 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
73 see \fBopenssl_user_macros\fR\|(7):
74 .PP
75 .Vb 2
76 \& void OPENSSL_config(const char *appname);
77 \& void OPENSSL_no_config(void);
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 \&\fBOPENSSL_config()\fR configures OpenSSL using the standard \fBopenssl.cnf\fR and
82 reads from the application section \fBappname\fR. If \fBappname\fR is NULL then
83 the default section, \fBopenssl_conf\fR, will be used.
84 Errors are silently ignored.
85 Multiple calls have no effect.
86 .PP
87 \&\fBOPENSSL_no_config()\fR disables configuration. If called before \fBOPENSSL_config()\fR
88 no configuration takes place.
89 .PP
90 If the application is built with \fBOPENSSL_LOAD_CONF\fR defined, then a
91 call to \fBOpenSSL_add_all_algorithms()\fR will implicitly call \fBOPENSSL_config()\fR
92 first.
93 .SH NOTES
94 .IX Header "NOTES"
95 The \fBOPENSSL_config()\fR function is designed to be a very simple "call it and
96 forget it" function.
97 It is however \fBmuch\fR better than nothing. Applications which need finer
98 control over their configuration functionality should use the configuration
99 functions such as \fBCONF_modules_load()\fR directly. This function is deprecated
100 and its use should be avoided.
101 Applications should instead call \fBCONF_modules_load()\fR during
102 initialization (that is before starting any threads).
103 .PP
104 There are several reasons why calling the OpenSSL configuration routines is
105 advisable. For example, to load dynamic ENGINEs from shared libraries (DSOs).
106 However, very few applications currently support the control interface and so
107 very few can load and use dynamic ENGINEs. Equally in future more sophisticated
108 ENGINEs will require certain control operations to customize them. If an
109 application calls \fBOPENSSL_config()\fR it doesn't need to know or care about
110 ENGINE control operations because they can be performed by editing a
111 configuration file.
112 .SH ENVIRONMENT
113 .IX Header "ENVIRONMENT"
114 .IP \fBOPENSSL_CONF\fR 4
115 .IX Item "OPENSSL_CONF"
116 The path to the config file.
117 Ignored in set-user-ID and set-group-ID programs.
118 .SH "RETURN VALUES"
119 .IX Header "RETURN VALUES"
120 Neither \fBOPENSSL_config()\fR nor \fBOPENSSL_no_config()\fR return a value.
121 .SH "SEE ALSO"
122 .IX Header "SEE ALSO"
123 \&\fBconfig\fR\|(5),
124 \&\fBCONF_modules_load_file\fR\|(3)
125 .SH HISTORY
126 .IX Header "HISTORY"
127 The \fBOPENSSL_no_config()\fR and \fBOPENSSL_config()\fR functions were
128 deprecated in OpenSSL 1.1.0 by \fBOPENSSL_init_crypto()\fR.
129 .SH COPYRIGHT
130 .IX Header "COPYRIGHT"
131 Copyright 2004\-2020 The OpenSSL Project Authors. All Rights Reserved.
132 .PP
133 Licensed under the Apache License 2.0 (the "License"). You may not use
134 this file except in compliance with the License. You can obtain a copy
135 in the file LICENSE in the source distribution or at
136 <https://www.openssl.org/source/license.html>.