OPENSSL_config.pod revision 296341 
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 void OPENSSL_config(const char *config_name);
12 void OPENSSL_no_config(void);
13
14=head1 DESCRIPTION
15
16OPENSSL_config() configures OpenSSL using the standard B<openssl.cnf>
17configuration file name using B<config_name>. If B<config_name> is NULL then
18the file specified in the environment variable B<OPENSSL_CONF> will be used,
19and if that is not set then a system default location is used.
20Errors are silently ignored.
21Multiple calls have no effect.
22
23OPENSSL_no_config() disables configuration. If called before OPENSSL_config()
24no configuration takes place.
25
26=head1 NOTES
27
28The OPENSSL_config() function is designed to be a very simple "call it and
29forget it" function.
30It is however B<much> better than nothing. Applications which need finer
31control over their configuration functionality should use the configuration
32functions such as CONF_modules_load() directly. This function is deprecated
33and its use should be avoided.
34Applications should instead call CONF_modules_load() during
35initialization (that is before starting any threads).
36
37There are several reasons why calling the OpenSSL configuration routines is
38advisable. For example new ENGINE functionality was added to OpenSSL 0.9.7.
39In OpenSSL 0.9.7 control functions can be supported by ENGINEs, this can be
40used (among other things) to load dynamic ENGINEs from shared libraries (DSOs).
41However very few applications currently support the control interface and so
42very few can load and use dynamic ENGINEs. Equally in future more sophisticated
43ENGINEs will require certain control operations to customize them. If an
44application calls OPENSSL_config() it doesn't need to know or care about
45ENGINE control operations because they can be performed by editing a
46configuration file.
47
48Applications should free up configuration at application closedown by calling
49CONF_modules_free().
50
51=head1 RESTRICTIONS
52
53The OPENSSL_config() function is designed to be a very simple "call it and
54forget it" function. As a result its behaviour is somewhat limited. It ignores
55all errors silently and it can only load from the standard configuration file
56location for example.
57
58It is however B<much> better than nothing. Applications which need finer
59control over their configuration functionality should use the configuration
60functions such as CONF_load_modules() directly.
61
62=head1 RETURN VALUES
63
64Neither OPENSSL_config() nor OPENSSL_no_config() return a value.
65
66=head1 SEE ALSO
67
68L<conf(5)|conf(5)>, L<CONF_load_modules_file(3)|CONF_load_modules_file(3)>,
69L<CONF_modules_free(3)|CONF_modules_free(3)>
70
71=head1 HISTORY
72
73OPENSSL_config() and OPENSSL_no_config() first appeared in OpenSSL 0.9.7
74
75=cut
76