OPENSSL_config.pod 2.4 KB
Newer Older
1 2 3 4
=pod

=head1 NAME

D
Dr. Stephen Henson 已提交
5
OPENSSL_config, OPENSSL_no_config - simple OpenSSL configuration functions
6 7 8 9 10 11 12 13 14 15 16 17

=head1 SYNOPSIS

 #include <openssl/conf.h>

 void OPENSSL_config(const char *config_name);
 void OPENSSL_no_config(void);

=head1 DESCRIPTION

OPENSSL_config() configures OpenSSL using the standard B<openssl.cnf>
configuration file name using B<config_name>. If B<config_name> is NULL then
R
Rich Salz 已提交
18 19 20 21 22
the file specified in the environment variable B<OPENSSL_CONF> will be used,
and if that is not set then a system default location is used.
In case of error, a message is printed to B<stderr> and the routine
exit's.
Multiple calls have no effect.
23 24 25 26

OPENSSL_no_config() disables configuration. If called before OPENSSL_config()
no configuration takes place.

R
Rich Salz 已提交
27 28
Applications should free up configuration at application closedown by calling
CONF_modules_free().
29

R
Rich Salz 已提交
30 31 32
If the application is built with B<OPENSSL_LOAD_CONF> defined, then a
call to OpenSSL_add_all_algorithms() will implicitly call OPENSSL_config()
first.
33

R
Rich Salz 已提交
34
=head1 NOTES
35

R
Rich Salz 已提交
36 37 38 39 40 41 42 43 44
The OPENSSL_config() function is designed to be a very simple "call it and
forget it" function.
It is however B<much> better than nothing. Applications which need finer
control over their configuration functionality should use the configuration
functions such as CONF_modules_load() directly.

It is B<strongly> recommended that B<all> new applications call
CONF_modules_load() during
initialization (that is before starting any threads).
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

There are several reasons why calling the OpenSSL configuration routines is
advisable. For example new ENGINE functionality was added to OpenSSL 0.9.7.
In OpenSSL 0.9.7 control functions can be supported by ENGINEs, this can be
used (among other things) to load dynamic ENGINEs from shared libraries (DSOs).
However very few applications currently support the control interface and so
very few can load and use dynamic ENGINEs. Equally in future more sophisticated
ENGINEs will require certain control operations to customize them. If an
application calls OPENSSL_config() it doesn't need to know or care about
ENGINE control operations because they can be performed by editing a
configuration file.

=head1 RETURN VALUES

Neither OPENSSL_config() nor OPENSSL_no_config() return a value.

=head1 SEE ALSO

R
Rich Salz 已提交
63 64
L<conf(5)|conf(5)>,
L<CONF_modules_load_file(3)|CONF_modules_load_file(3)>,
65
L<CONF_modules_free(3)|CONF_modules_free(3)>
66 67 68 69 70 71

=head1 HISTORY

OPENSSL_config() and OPENSSL_no_config() first appeared in OpenSSL 0.9.7

=cut