xref: /freebsd/crypto/openssl/doc/man3/OPENSSL_config.pod (revision ebacd8013fe5f7fdf9f6a5b286f6680dd2891036)
1=pod
2
3=head1 NAME
4
5OPENSSL_config, OPENSSL_no_config - simple OpenSSL configuration functions
6
7=head1 SYNOPSIS
8
9 #include <openssl/conf.h>
10
11 #if OPENSSL_API_COMPAT < 0x10100000L
12 void OPENSSL_config(const char *appname);
13 void OPENSSL_no_config(void);
14 #endif
15
16=head1 DESCRIPTION
17
18OPENSSL_config() configures OpenSSL using the standard B<openssl.cnf> and
19reads from the application section B<appname>. If B<appname> is NULL then
20the default section, B<openssl_conf>, will be used.
21Errors are silently ignored.
22Multiple calls have no effect.
23
24OPENSSL_no_config() disables configuration. If called before OPENSSL_config()
25no configuration takes place.
26
27If the application is built with B<OPENSSL_LOAD_CONF> defined, then a
28call to OpenSSL_add_all_algorithms() will implicitly call OPENSSL_config()
29first.
30
31=head1 NOTES
32
33The OPENSSL_config() function is designed to be a very simple "call it and
34forget it" function.
35It is however B<much> better than nothing. Applications which need finer
36control over their configuration functionality should use the configuration
37functions such as CONF_modules_load() directly. This function is deprecated
38and its use should be avoided.
39Applications should instead call CONF_modules_load() during
40initialization (that is before starting any threads).
41
42There are several reasons why calling the OpenSSL configuration routines is
43advisable. For example, to load dynamic ENGINEs from shared libraries (DSOs).
44However, very few applications currently support the control interface and so
45very few can load and use dynamic ENGINEs. Equally in future more sophisticated
46ENGINEs will require certain control operations to customize them. If an
47application calls OPENSSL_config() it doesn't need to know or care about
48ENGINE control operations because they can be performed by editing a
49configuration file.
50
51=head1 ENVIRONMENT
52
53=over 4
54
55=item B<OPENSSL_CONF>
56
57The path to the config file.
58Ignored in set-user-ID and set-group-ID programs.
59
60=back
61
62=head1 RETURN VALUES
63
64Neither OPENSSL_config() nor OPENSSL_no_config() return a value.
65
66=head1 SEE ALSO
67
68L<config(5)>,
69L<CONF_modules_load_file(3)>
70
71=head1 HISTORY
72
73The OPENSSL_no_config() and OPENSSL_config() functions were
74deprecated in OpenSSL 1.1.0 by OPENSSL_init_crypto().
75
76=head1 COPYRIGHT
77
78Copyright 2004-2020 The OpenSSL Project Authors. All Rights Reserved.
79
80Licensed under the OpenSSL license (the "License").  You may not use
81this file except in compliance with the License.  You can obtain a copy
82in the file LICENSE in the source distribution or at
83L<https://www.openssl.org/source/license.html>.
84
85=cut
86