blob: fd22d828994d3fd6b463a285ac789527428e7527 [file] [log] [blame]
Dr. Stephen Hensonf82bb9c2004-03-02 13:31:32 +00001=pod
2
3=head1 NAME
4
Rich Salz1bc74512016-05-20 08:11:46 -04005CONF_modules_free, CONF_modules_finish, CONF_modules_unload -
6OpenSSL configuration cleanup functions
Dr. Stephen Hensonf82bb9c2004-03-02 13:31:32 +00007
8=head1 SYNOPSIS
9
10 #include <openssl/conf.h>
11
Dr. Stephen Hensonf82bb9c2004-03-02 13:31:32 +000012 void CONF_modules_finish(void);
Nils Larschfec38ca2006-12-21 21:13:27 +000013 void CONF_modules_unload(int all);
Dr. Stephen Hensonf82bb9c2004-03-02 13:31:32 +000014
Matt Caswell3dbf8242021-12-02 11:33:49 +000015The following functions have been deprecated since OpenSSL 1.1.0, and can be
16hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
17see L<openssl_user_macros(7)>:
Matt Caswellcbf69592016-04-04 17:00:04 +010018
Shane Lontisf64f17c2020-07-15 18:26:35 +100019 void CONF_modules_free(void);
Matt Caswellcbf69592016-04-04 17:00:04 +010020
Dr. Stephen Hensonf82bb9c2004-03-02 13:31:32 +000021=head1 DESCRIPTION
22
23CONF_modules_free() closes down and frees up all memory allocated by all
Rich Salzb3696a52017-09-02 09:35:50 -040024configuration modules. Normally, in versions of OpenSSL prior to 1.1.0,
25applications called
26CONF_modules_free() at exit to tidy up any configuration performed.
Dr. Stephen Hensonf82bb9c2004-03-02 13:31:32 +000027
28CONF_modules_finish() calls each configuration modules B<finish> handler
29to free up any configuration that module may have performed.
30
31CONF_modules_unload() finishes and unloads configuration modules. If
32B<all> is set to B<0> only modules loaded from DSOs will be unloads. If
Rich Salz9c0586d2019-09-27 13:17:09 -040033B<all> is B<1> all modules, including built-in modules will be unloaded.
Dr. Stephen Hensonf82bb9c2004-03-02 13:31:32 +000034
Paul Yang1f13ad32017-12-25 17:50:39 +080035=head1 RETURN VALUES
Dr. Stephen Hensonf82bb9c2004-03-02 13:31:32 +000036
37None of the functions return a value.
38
39=head1 SEE ALSO
40
Richard Levitteb97fdb52016-11-11 09:33:09 +010041L<config(5)>, L<OPENSSL_config(3)>,
Matt Caswelld8652be2020-09-24 10:42:23 +010042L<CONF_modules_load_file_ex(3)>
Dr. Stephen Hensonf82bb9c2004-03-02 13:31:32 +000043
Matt Caswellcbf69592016-04-04 17:00:04 +010044=head1 HISTORY
45
Rich Salzb3696a52017-09-02 09:35:50 -040046CONF_modules_free() was deprecated in OpenSSL 1.1.0; do not use it.
47For more information see L<OPENSSL_init_crypto(3)>.
Matt Caswellcbf69592016-04-04 17:00:04 +010048
Rich Salze2f92612016-05-18 11:44:05 -040049=head1 COPYRIGHT
50
Matt Caswell33388b42020-04-23 13:55:52 +010051Copyright 2004-2020 The OpenSSL Project Authors. All Rights Reserved.
Rich Salze2f92612016-05-18 11:44:05 -040052
Richard Levitte4746f252018-12-06 14:04:44 +010053Licensed under the Apache License 2.0 (the "License"). You may not use
Rich Salze2f92612016-05-18 11:44:05 -040054this file except in compliance with the License. You can obtain a copy
55in the file LICENSE in the source distribution or at
56L<https://www.openssl.org/source/license.html>.
57
58=cut