Deprecate ENGINE_cleanup() and make it a no-op
[openssl.git] / doc / crypto / OPENSSL_config.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_config, OPENSSL_no_config - simple OpenSSL configuration functions
6
7 =head1 SYNOPSIS
8
9  #include <openssl/conf.h>
10
11  void OPENSSL_config(const char *config_name);
12  void OPENSSL_no_config(void);
13
14 =head1 DESCRIPTION
15
16 OPENSSL_config() configures OpenSSL using the standard B<openssl.cnf>
17 configuration file name using B<config_name>. If B<config_name> is NULL then
18 the file specified in the environment variable B<OPENSSL_CONF> will be used,
19 and if that is not set then a system default location is used.
20 Errors are silently ignored.
21 Multiple calls have no effect.
22
23 OPENSSL_no_config() disables configuration. If called before OPENSSL_config()
24 no configuration takes place.
25
26 Applications should free up configuration at application closedown by calling
27 CONF_modules_free().
28
29 If the application is built with B<OPENSSL_LOAD_CONF> defined, then a
30 call to OpenSSL_add_all_algorithms() will implicitly call OPENSSL_config()
31 first.
32
33 =head1 NOTES
34
35 The OPENSSL_config() function is designed to be a very simple "call it and
36 forget it" function.
37 It is however B<much> better than nothing. Applications which need finer
38 control over their configuration functionality should use the configuration
39 functions such as CONF_modules_load() directly. This function is deprecated
40 and its use should be avoided.
41 Applications should instead call CONF_modules_load() during
42 initialization (that is before starting any threads).
43
44 There are several reasons why calling the OpenSSL configuration routines is
45 advisable. For example, to load dynamic ENGINEs from shared libraries (DSOs).
46 However very few applications currently support the control interface and so
47 very few can load and use dynamic ENGINEs. Equally in future more sophisticated
48 ENGINEs will require certain control operations to customize them. If an
49 application calls OPENSSL_config() it doesn't need to know or care about
50 ENGINE control operations because they can be performed by editing a
51 configuration file.
52
53 =head1 RETURN VALUES
54
55 Neither OPENSSL_config() nor OPENSSL_no_config() return a value.
56
57 =head1 SEE ALSO
58
59 L<conf(5)>,
60 L<CONF_modules_load_file(3)>,
61 L<CONF_modules_free(3)>
62
63 =head1 HISTORY
64
65 The OPENSSL_no_config() and OPENSSL_config() functions were
66 deprecated in OpenSSL 1.1.0 by OPENSSL_init_crypto().
67
68 =cut