]>
Commit | Line | Data |
---|---|---|
5a8922ae DSH |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
f82bb9cb | 5 | OPENSSL_config, OPENSSL_no_config - simple OpenSSL configuration functions |
5a8922ae DSH |
6 | |
7 | =head1 SYNOPSIS | |
8 | ||
9 | #include <openssl/conf.h> | |
10 | ||
fcd2d5a6 RL |
11 | Deprecated since OpenSSL 1.1.0, can be hidden entirely by defining |
12 | B<OPENSSL_API_COMPAT> with a suitable version value, see | |
13 | L<openssl_user_macros(7)>: | |
14 | ||
cda3ae5b | 15 | void OPENSSL_config(const char *appname); |
5a8922ae DSH |
16 | void OPENSSL_no_config(void); |
17 | ||
18 | =head1 DESCRIPTION | |
19 | ||
cda3ae5b RS |
20 | OPENSSL_config() configures OpenSSL using the standard B<openssl.cnf> and |
21 | reads from the application section B<appname>. If B<appname> is NULL then | |
22 | the default section, B<openssl_conf>, will be used. | |
abdd6771 | 23 | Errors are silently ignored. |
14d3b76b | 24 | Multiple calls have no effect. |
5a8922ae DSH |
25 | |
26 | OPENSSL_no_config() disables configuration. If called before OPENSSL_config() | |
27 | no configuration takes place. | |
28 | ||
14d3b76b RS |
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. | |
5a8922ae | 32 | |
14d3b76b | 33 | =head1 NOTES |
5a8922ae | 34 | |
14d3b76b RS |
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 | |
abdd6771 RS |
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 | |
14d3b76b | 42 | initialization (that is before starting any threads). |
5a8922ae DSH |
43 | |
44 | There are several reasons why calling the OpenSSL configuration routines is | |
a528d4f0 | 45 | advisable. For example, to load dynamic ENGINEs from shared libraries (DSOs). |
5a8922ae DSH |
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 | ||
284f4f6b BE |
53 | =head1 ENVIRONMENT |
54 | ||
55 | =over 4 | |
56 | ||
57 | =item B<OPENSSL_CONF> | |
58 | ||
59 | The path to the config file. | |
60 | Ignored in set-user-ID and set-group-ID programs. | |
61 | ||
62 | =back | |
63 | ||
5a8922ae DSH |
64 | =head1 RETURN VALUES |
65 | ||
66 | Neither OPENSSL_config() nor OPENSSL_no_config() return a value. | |
67 | ||
68 | =head1 SEE ALSO | |
69 | ||
b97fdb57 | 70 | L<config(5)>, |
cbf6959f | 71 | L<CONF_modules_load_file(3)> |
5a8922ae | 72 | |
f672aee4 RS |
73 | =head1 HISTORY |
74 | ||
75 | The OPENSSL_no_config() and OPENSSL_config() functions were | |
76 | deprecated in OpenSSL 1.1.0 by OPENSSL_init_crypto(). | |
77 | ||
e2f92610 RS |
78 | =head1 COPYRIGHT |
79 | ||
28428130 | 80 | Copyright 2004-2018 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 81 | |
4746f25a | 82 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
83 | this file except in compliance with the License. You can obtain a copy |
84 | in the file LICENSE in the source distribution or at | |
85 | L<https://www.openssl.org/source/license.html>. | |
86 | ||
87 | =cut |