Dr. Stephen Henson | f82bb9c | 2004-03-02 13:31:32 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
Rich Salz | 1bc7451 | 2016-05-20 08:11:46 -0400 | [diff] [blame] | 5 | CONF_modules_free, CONF_modules_finish, CONF_modules_unload - |
| 6 | OpenSSL configuration cleanup functions |
Dr. Stephen Henson | f82bb9c | 2004-03-02 13:31:32 +0000 | [diff] [blame] | 7 | |
| 8 | =head1 SYNOPSIS |
| 9 | |
| 10 | #include <openssl/conf.h> |
| 11 | |
Dr. Stephen Henson | f82bb9c | 2004-03-02 13:31:32 +0000 | [diff] [blame] | 12 | void CONF_modules_finish(void); |
Nils Larsch | fec38ca | 2006-12-21 21:13:27 +0000 | [diff] [blame] | 13 | void CONF_modules_unload(int all); |
Dr. Stephen Henson | f82bb9c | 2004-03-02 13:31:32 +0000 | [diff] [blame] | 14 | |
Matt Caswell | 3dbf824 | 2021-12-02 11:33:49 +0000 | [diff] [blame] | 15 | The following functions have been deprecated since OpenSSL 1.1.0, and can be |
| 16 | hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value, |
| 17 | see L<openssl_user_macros(7)>: |
Matt Caswell | cbf6959 | 2016-04-04 17:00:04 +0100 | [diff] [blame] | 18 | |
Shane Lontis | f64f17c | 2020-07-15 18:26:35 +1000 | [diff] [blame] | 19 | void CONF_modules_free(void); |
Matt Caswell | cbf6959 | 2016-04-04 17:00:04 +0100 | [diff] [blame] | 20 | |
Dr. Stephen Henson | f82bb9c | 2004-03-02 13:31:32 +0000 | [diff] [blame] | 21 | =head1 DESCRIPTION |
| 22 | |
| 23 | CONF_modules_free() closes down and frees up all memory allocated by all |
Rich Salz | b3696a5 | 2017-09-02 09:35:50 -0400 | [diff] [blame] | 24 | configuration modules. Normally, in versions of OpenSSL prior to 1.1.0, |
| 25 | applications called |
| 26 | CONF_modules_free() at exit to tidy up any configuration performed. |
Dr. Stephen Henson | f82bb9c | 2004-03-02 13:31:32 +0000 | [diff] [blame] | 27 | |
| 28 | CONF_modules_finish() calls each configuration modules B<finish> handler |
| 29 | to free up any configuration that module may have performed. |
| 30 | |
| 31 | CONF_modules_unload() finishes and unloads configuration modules. If |
| 32 | B<all> is set to B<0> only modules loaded from DSOs will be unloads. If |
Rich Salz | 9c0586d | 2019-09-27 13:17:09 -0400 | [diff] [blame] | 33 | B<all> is B<1> all modules, including built-in modules will be unloaded. |
Dr. Stephen Henson | f82bb9c | 2004-03-02 13:31:32 +0000 | [diff] [blame] | 34 | |
Paul Yang | 1f13ad3 | 2017-12-25 17:50:39 +0800 | [diff] [blame] | 35 | =head1 RETURN VALUES |
Dr. Stephen Henson | f82bb9c | 2004-03-02 13:31:32 +0000 | [diff] [blame] | 36 | |
| 37 | None of the functions return a value. |
| 38 | |
| 39 | =head1 SEE ALSO |
| 40 | |
Richard Levitte | b97fdb5 | 2016-11-11 09:33:09 +0100 | [diff] [blame] | 41 | L<config(5)>, L<OPENSSL_config(3)>, |
Matt Caswell | d8652be | 2020-09-24 10:42:23 +0100 | [diff] [blame] | 42 | L<CONF_modules_load_file_ex(3)> |
Dr. Stephen Henson | f82bb9c | 2004-03-02 13:31:32 +0000 | [diff] [blame] | 43 | |
Matt Caswell | cbf6959 | 2016-04-04 17:00:04 +0100 | [diff] [blame] | 44 | =head1 HISTORY |
| 45 | |
Rich Salz | b3696a5 | 2017-09-02 09:35:50 -0400 | [diff] [blame] | 46 | CONF_modules_free() was deprecated in OpenSSL 1.1.0; do not use it. |
| 47 | For more information see L<OPENSSL_init_crypto(3)>. |
Matt Caswell | cbf6959 | 2016-04-04 17:00:04 +0100 | [diff] [blame] | 48 | |
Rich Salz | e2f9261 | 2016-05-18 11:44:05 -0400 | [diff] [blame] | 49 | =head1 COPYRIGHT |
| 50 | |
Matt Caswell | 33388b4 | 2020-04-23 13:55:52 +0100 | [diff] [blame] | 51 | Copyright 2004-2020 The OpenSSL Project Authors. All Rights Reserved. |
Rich Salz | e2f9261 | 2016-05-18 11:44:05 -0400 | [diff] [blame] | 52 | |
Richard Levitte | 4746f25 | 2018-12-06 14:04:44 +0100 | [diff] [blame] | 53 | Licensed under the Apache License 2.0 (the "License"). You may not use |
Rich Salz | e2f9261 | 2016-05-18 11:44:05 -0400 | [diff] [blame] | 54 | this file except in compliance with the License. You can obtain a copy |
| 55 | in the file LICENSE in the source distribution or at |
| 56 | L<https://www.openssl.org/source/license.html>. |
| 57 | |
| 58 | =cut |