xref: /freebsd/crypto/openssl/doc/man3/CONF_modules_free.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1e71b7053SJung-uk Kim=pod
2e71b7053SJung-uk Kim
3e71b7053SJung-uk Kim=head1 NAME
4e71b7053SJung-uk Kim
5e71b7053SJung-uk KimCONF_modules_free, CONF_modules_finish, CONF_modules_unload -
6e71b7053SJung-uk KimOpenSSL configuration cleanup functions
7e71b7053SJung-uk Kim
8e71b7053SJung-uk Kim=head1 SYNOPSIS
9e71b7053SJung-uk Kim
10e71b7053SJung-uk Kim #include <openssl/conf.h>
11e71b7053SJung-uk Kim
12e71b7053SJung-uk Kim void CONF_modules_finish(void);
13e71b7053SJung-uk Kim void CONF_modules_unload(int all);
14e71b7053SJung-uk Kim
15*b077aed3SPierre ProncheryThe following functions have been deprecated since OpenSSL 1.1.0, and can be
16*b077aed3SPierre Proncheryhidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
17*b077aed3SPierre Proncherysee L<openssl_user_macros(7)>:
18e71b7053SJung-uk Kim
19*b077aed3SPierre Pronchery void CONF_modules_free(void);
20e71b7053SJung-uk Kim
21e71b7053SJung-uk Kim=head1 DESCRIPTION
22e71b7053SJung-uk Kim
23e71b7053SJung-uk KimCONF_modules_free() closes down and frees up all memory allocated by all
24e71b7053SJung-uk Kimconfiguration modules.  Normally, in versions of OpenSSL prior to 1.1.0,
25e71b7053SJung-uk Kimapplications called
26e71b7053SJung-uk KimCONF_modules_free() at exit to tidy up any configuration performed.
27e71b7053SJung-uk Kim
28e71b7053SJung-uk KimCONF_modules_finish() calls each configuration modules B<finish> handler
29e71b7053SJung-uk Kimto free up any configuration that module may have performed.
30e71b7053SJung-uk Kim
31e71b7053SJung-uk KimCONF_modules_unload() finishes and unloads configuration modules. If
32e71b7053SJung-uk KimB<all> is set to B<0> only modules loaded from DSOs will be unloads. If
33*b077aed3SPierre ProncheryB<all> is B<1> all modules, including built-in modules will be unloaded.
34e71b7053SJung-uk Kim
35e71b7053SJung-uk Kim=head1 RETURN VALUES
36e71b7053SJung-uk Kim
37e71b7053SJung-uk KimNone of the functions return a value.
38e71b7053SJung-uk Kim
39e71b7053SJung-uk Kim=head1 SEE ALSO
40e71b7053SJung-uk Kim
41e71b7053SJung-uk KimL<config(5)>, L<OPENSSL_config(3)>,
42*b077aed3SPierre ProncheryL<CONF_modules_load_file_ex(3)>
43e71b7053SJung-uk Kim
44e71b7053SJung-uk Kim=head1 HISTORY
45e71b7053SJung-uk Kim
46e71b7053SJung-uk KimCONF_modules_free() was deprecated in OpenSSL 1.1.0; do not use it.
47e71b7053SJung-uk KimFor more information see L<OPENSSL_init_crypto(3)>.
48e71b7053SJung-uk Kim
49e71b7053SJung-uk Kim=head1 COPYRIGHT
50e71b7053SJung-uk Kim
51*b077aed3SPierre ProncheryCopyright 2004-2021 The OpenSSL Project Authors. All Rights Reserved.
52e71b7053SJung-uk Kim
53*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
54e71b7053SJung-uk Kimthis file except in compliance with the License.  You can obtain a copy
55e71b7053SJung-uk Kimin the file LICENSE in the source distribution or at
56e71b7053SJung-uk KimL<https://www.openssl.org/source/license.html>.
57e71b7053SJung-uk Kim
58e71b7053SJung-uk Kim=cut
59