1.\" $OpenBSD: OPENSSL_config.3,v 1.15 2019/06/14 13:41:31 schwarze Exp $ 2.\" full merge up to: OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 3.\" 4.\" This file is a derived work. 5.\" The changes are covered by the following Copyright and license: 6.\" 7.\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> 8.\" 9.\" Permission to use, copy, modify, and distribute this software for any 10.\" purpose with or without fee is hereby granted, provided that the above 11.\" copyright notice and this permission notice appear in all copies. 12.\" 13.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 14.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 15.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 16.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 17.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 18.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 19.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 20.\" 21.\" The original file was written by Dr. Stephen Henson <steve@openssl.org>. 22.\" Copyright (c) 2004 The OpenSSL Project. All rights reserved. 23.\" 24.\" Redistribution and use in source and binary forms, with or without 25.\" modification, are permitted provided that the following conditions 26.\" are met: 27.\" 28.\" 1. Redistributions of source code must retain the above copyright 29.\" notice, this list of conditions and the following disclaimer. 30.\" 31.\" 2. Redistributions in binary form must reproduce the above copyright 32.\" notice, this list of conditions and the following disclaimer in 33.\" the documentation and/or other materials provided with the 34.\" distribution. 35.\" 36.\" 3. All advertising materials mentioning features or use of this 37.\" software must display the following acknowledgment: 38.\" "This product includes software developed by the OpenSSL Project 39.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 40.\" 41.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 42.\" endorse or promote products derived from this software without 43.\" prior written permission. For written permission, please contact 44.\" openssl-core@openssl.org. 45.\" 46.\" 5. Products derived from this software may not be called "OpenSSL" 47.\" nor may "OpenSSL" appear in their names without prior written 48.\" permission of the OpenSSL Project. 49.\" 50.\" 6. Redistributions of any form whatsoever must retain the following 51.\" acknowledgment: 52.\" "This product includes software developed by the OpenSSL Project 53.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 54.\" 55.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 56.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 57.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 58.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 59.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 60.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 61.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 62.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 63.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 64.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 65.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 66.\" OF THE POSSIBILITY OF SUCH DAMAGE. 67.\" 68.Dd $Mdocdate: June 14 2019 $ 69.Dt OPENSSL_CONFIG 3 70.Os 71.Sh NAME 72.Nm OPENSSL_config , 73.Nm OPENSSL_no_config 74.Nd simple crypto and ssl library configuration 75.Sh SYNOPSIS 76.In openssl/conf.h 77.Ft void 78.Fo OPENSSL_config 79.Fa "const char *appname" 80.Fc 81.Ft void 82.Fn OPENSSL_no_config void 83.Sh DESCRIPTION 84.Fn OPENSSL_config 85initializes the crypto library and calls 86.Xr CONF_modules_load_file 3 87with the standard configuration file and the given 88.Fa appname . 89If 90.Fa appname 91is 92.Dv NULL , 93then the default name 94.Sy openssl_conf 95is used. 96Any errors are ignored. 97Further calls to 98.Fn OPENSSL_config 99have no effect. 100.Pp 101.Fn OPENSSL_no_config 102suppresses the loading of the standard configuration file, so that any 103future calls to 104.Fn OPENSSL_config 105or to 106.Xr OPENSSL_init_crypto 3 107will ensure the library is initialized but no configuration 108file will be loaded. 109.Pp 110Calling these functions is optional. 111All required initialization of the crypto libraries happens 112automatically when needed. 113.Pp 114To use a non-standard configuration file, refer to 115.Xr CONF_modules_load_file 3 . 116.Pp 117Internally, 118.Fn OPENSSL_config 119calls 120.Xr OPENSSL_init_crypto 3 , 121.Xr OPENSSL_load_builtin_modules 3 , 122and 123.Xr ENGINE_load_builtin_engines 3 . 124.Pp 125If an application is compiled with the preprocessor symbol 126.Dv OPENSSL_LOAD_CONF 127#define'd, 128.Xr OpenSSL_add_all_algorithms 3 129automatically calls 130.Fn OPENSSL_config . 131.Pp 132Applications should free up configuration at application closedown by 133calling 134.Xr CONF_modules_free 3 . 135.Sh FILES 136.Bl -tag -width /etc/ssl/openssl.cnf -compact 137.It Pa /etc/ssl/openssl.cnf 138standard configuration file 139.El 140.Sh SEE ALSO 141.Xr CONF_modules_free 3 , 142.Xr CONF_modules_load_file 3 , 143.Xr crypto 3 , 144.Xr OPENSSL_load_builtin_modules 3 , 145.Xr OPENSSL_VERSION_NUMBER 3 , 146.Xr openssl.cnf 5 , 147.Xr x509v3.cnf 5 148.Sh HISTORY 149.Fn OPENSSL_config 150and 151.Fn OPENSSL_no_config 152first appeared in OpenSSL 0.9.7 and have been available since 153.Ox 3.2 . 154