xref: /freebsd-src/crypto/openssl/doc/man3/OPENSSL_load_builtin_modules.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1e71b7053SJung-uk Kim=pod
2e71b7053SJung-uk Kim
3e71b7053SJung-uk Kim=head1 NAME
4e71b7053SJung-uk Kim
5e71b7053SJung-uk KimOPENSSL_load_builtin_modules, ASN1_add_oid_module, ENGINE_add_conf_module - add standard configuration modules
6e71b7053SJung-uk Kim
7e71b7053SJung-uk Kim=head1 SYNOPSIS
8e71b7053SJung-uk Kim
9e71b7053SJung-uk Kim #include <openssl/conf.h>
10e71b7053SJung-uk Kim
11e71b7053SJung-uk Kim void OPENSSL_load_builtin_modules(void);
12e71b7053SJung-uk Kim void ASN1_add_oid_module(void);
13e71b7053SJung-uk Kim void ENGINE_add_conf_module(void);
14e71b7053SJung-uk Kim
15e71b7053SJung-uk Kim=head1 DESCRIPTION
16e71b7053SJung-uk Kim
17e71b7053SJung-uk KimThe function OPENSSL_load_builtin_modules() adds all the standard OpenSSL
18e71b7053SJung-uk Kimconfiguration modules to the internal list. They can then be used by the
19e71b7053SJung-uk KimOpenSSL configuration code.
20e71b7053SJung-uk Kim
21e71b7053SJung-uk KimASN1_add_oid_module() adds just the ASN1 OBJECT module.
22e71b7053SJung-uk Kim
23e71b7053SJung-uk KimENGINE_add_conf_module() adds just the ENGINE configuration module.
24e71b7053SJung-uk Kim
25e71b7053SJung-uk Kim=head1 NOTES
26e71b7053SJung-uk Kim
27e71b7053SJung-uk KimIf the simple configuration function OPENSSL_config() is called then
28e71b7053SJung-uk KimOPENSSL_load_builtin_modules() is called automatically.
29e71b7053SJung-uk Kim
30e71b7053SJung-uk KimApplications which use the configuration functions directly will need to
31e71b7053SJung-uk Kimcall OPENSSL_load_builtin_modules() themselves I<before> any other
32e71b7053SJung-uk Kimconfiguration code.
33e71b7053SJung-uk Kim
34e71b7053SJung-uk KimApplications should call OPENSSL_load_builtin_modules() to load all
35e71b7053SJung-uk Kimconfiguration modules instead of adding modules selectively: otherwise
36e71b7053SJung-uk Kimfunctionality may be missing from the application if an when new
37e71b7053SJung-uk Kimmodules are added.
38e71b7053SJung-uk Kim
39e71b7053SJung-uk Kim=head1 RETURN VALUES
40e71b7053SJung-uk Kim
41e71b7053SJung-uk KimNone of the functions return a value.
42e71b7053SJung-uk Kim
43e71b7053SJung-uk Kim=head1 SEE ALSO
44e71b7053SJung-uk Kim
45e71b7053SJung-uk KimL<config(5)>, L<OPENSSL_config(3)>
46e71b7053SJung-uk Kim
47*b077aed3SPierre Pronchery=head1 HISTORY
48*b077aed3SPierre Pronchery
49*b077aed3SPierre ProncheryENGINE_add_conf_module() was deprecated in OpenSSL 3.0.
50*b077aed3SPierre Pronchery
51e71b7053SJung-uk Kim=head1 COPYRIGHT
52e71b7053SJung-uk Kim
53*b077aed3SPierre ProncheryCopyright 2004-2020 The OpenSSL Project Authors. All Rights Reserved.
54e71b7053SJung-uk Kim
55*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
56e71b7053SJung-uk Kimthis file except in compliance with the License.  You can obtain a copy
57e71b7053SJung-uk Kimin the file LICENSE in the source distribution or at
58e71b7053SJung-uk KimL<https://www.openssl.org/source/license.html>.
59e71b7053SJung-uk Kim
60e71b7053SJung-uk Kim=cut
61