From 383199997606691c59175599225178d45afd9856 Mon Sep 17 00:00:00 2001 From: schwarze Date: Tue, 3 Aug 2021 18:49:30 +0000 Subject: [PATCH] Document X509_get_default_cert_area(3). Put it into this page because this is the code actually using it. Despite its name and include file, it is unrelated to X.509 and unrelated to certificates: it is just the default directory containing the library configuration file, openssl.cnf(5). --- lib/libcrypto/man/CONF_modules_load_file.3 | 48 ++++++++++++++++++---- 1 file changed, 41 insertions(+), 7 deletions(-) diff --git a/lib/libcrypto/man/CONF_modules_load_file.3 b/lib/libcrypto/man/CONF_modules_load_file.3 index 972752f7a3c..bd419ef3e31 100644 --- a/lib/libcrypto/man/CONF_modules_load_file.3 +++ b/lib/libcrypto/man/CONF_modules_load_file.3 @@ -1,7 +1,25 @@ -.\" $OpenBSD: CONF_modules_load_file.3,v 1.9 2019/06/14 13:41:31 schwarze Exp $ -.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 +.\" $OpenBSD: CONF_modules_load_file.3,v 1.10 2021/08/03 18:49:30 schwarze Exp $ +.\" full merge up to: e9b77246 Jan 20 19:58:49 2017 +0100 +.\" selective merge up to: d090fc00 Feb 26 13:11:10 2019 +0800 .\" -.\" This file was written by Dr. Stephen Henson . +.\" This file is a derived work. +.\" The changes are covered by the following Copyright and license: +.\" +.\" Copyright (c) 2021 Ingo Schwarze +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" The original file was written by Dr. Stephen Henson . .\" Copyright (c) 2000, 2015 The OpenSSL Project. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without @@ -48,12 +66,13 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED .\" OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd $Mdocdate: June 14 2019 $ +.Dd $Mdocdate: August 3 2021 $ .Dt CONF_MODULES_LOAD_FILE 3 .Os .Sh NAME .Nm CONF_modules_load_file , -.Nm CONF_modules_load +.Nm CONF_modules_load , +.Nm X509_get_default_cert_area .Nd OpenSSL configuration functions .Sh SYNOPSIS .In openssl/conf.h @@ -69,6 +88,9 @@ .Fa "const char *appname" .Fa "unsigned long flags" .Fc +.In openssl/x509.h +.Ft const char * +.Fn X509_get_default_cert_area void .Sh DESCRIPTION The function .Fn CONF_modules_load_file @@ -156,12 +178,20 @@ Applications can use the function if they wish to load a configuration file themselves and have finer control over how errors are treated. .Sh RETURN VALUES -These functions return 1 for success and zero or a negative value for -failure. +.Fn CONF_modules_load_file +and +.Fn CONF_modules_load +return 1 for success and zero or a negative value for failure. If module errors are not ignored, the return code will reflect the return value of the failing module (this will always be zero or negative). +.Pp +.Fn X509_get_default_cert_area +returns a pointer to the constant string +.Qq "/etc/ssl" . .Sh FILES .Bl -tag -width /etc/ssl/openssl.cnf -compact +.It Pa /etc/ssl +standard configuration directory .It Pa /etc/ssl/openssl.cnf standard configuration file .El @@ -244,6 +274,10 @@ if (fp == NULL) { .Xr OPENSSL_config 3 , .Xr OPENSSL_load_builtin_modules 3 .Sh HISTORY +.Fn X509_get_default_cert_area +first appeared in SSLeay 0.4.1 and has been available since +.Ox 2.4 . +.Pp .Fn CONF_modules_load_file and .Fn CONF_modules_load -- 2.20.1