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
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.
20
Errors are silently ignored.
R
Rich Salz 已提交
21
Multiple calls have no effect.
22 23 24 25

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

R
Rich Salz 已提交
26 27 28
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.
29

R
Rich Salz 已提交
30
=head1 NOTES
31

R
Rich Salz 已提交
32 33 34 35
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
36 37 38
functions such as CONF_modules_load() directly. This function is deprecated
and its use should be avoided.
Applications should instead call CONF_modules_load() during
R
Rich Salz 已提交
39
initialization (that is before starting any threads).
40 41

There are several reasons why calling the OpenSSL configuration routines is
R
Rich Salz 已提交
42
advisable. For example, to load dynamic ENGINEs from shared libraries (DSOs).
43 44 45 46 47 48 49 50 51 52 53 54 55
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 已提交
56
L<conf(5)>,
57
L<CONF_modules_load_file(3)>
58

59 60 61 62 63
=head1 HISTORY

The OPENSSL_no_config() and OPENSSL_config() functions were
deprecated in OpenSSL 1.1.0 by OPENSSL_init_crypto().

64
=cut
R
Rich Salz 已提交
65 66 67 68 69 70 71 72 73 74 75

=head1 COPYRIGHT

Copyright 2004-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut