Skip to content

Commit 37b7988

Browse files
author
schwarze
committed
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).
1 parent 9b4f382 commit 37b7988

File tree

1 file changed

+41
-7
lines changed

1 file changed

+41
-7
lines changed

src/lib/libcrypto/man/CONF_modules_load_file.3

Lines changed: 41 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
1-
.\" $OpenBSD: CONF_modules_load_file.3,v 1.9 2019/06/14 13:41:31 schwarze Exp $
2-
.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
1+
.\" $OpenBSD: CONF_modules_load_file.3,v 1.10 2021/08/03 18:49:30 schwarze Exp $
2+
.\" full merge up to: e9b77246 Jan 20 19:58:49 2017 +0100
3+
.\" selective merge up to: d090fc00 Feb 26 13:11:10 2019 +0800
34
.\"
4-
.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
5+
.\" This file is a derived work.
6+
.\" The changes are covered by the following Copyright and license:
7+
.\"
8+
.\" Copyright (c) 2021 Ingo Schwarze <schwarze@openbsd.org>
9+
.\"
10+
.\" Permission to use, copy, modify, and distribute this software for any
11+
.\" purpose with or without fee is hereby granted, provided that the above
12+
.\" copyright notice and this permission notice appear in all copies.
13+
.\"
14+
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
15+
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
16+
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
17+
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
18+
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
19+
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
20+
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21+
.\"
22+
.\" The original file was written by Dr. Stephen Henson <steve@openssl.org>.
523
.\" Copyright (c) 2000, 2015 The OpenSSL Project. All rights reserved.
624
.\"
725
.\" Redistribution and use in source and binary forms, with or without
@@ -48,12 +66,13 @@
4866
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
4967
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
5068
.\"
51-
.Dd $Mdocdate: June 14 2019 $
69+
.Dd $Mdocdate: August 3 2021 $
5270
.Dt CONF_MODULES_LOAD_FILE 3
5371
.Os
5472
.Sh NAME
5573
.Nm CONF_modules_load_file ,
56-
.Nm CONF_modules_load
74+
.Nm CONF_modules_load ,
75+
.Nm X509_get_default_cert_area
5776
.Nd OpenSSL configuration functions
5877
.Sh SYNOPSIS
5978
.In openssl/conf.h
@@ -69,6 +88,9 @@
6988
.Fa "const char *appname"
7089
.Fa "unsigned long flags"
7190
.Fc
91+
.In openssl/x509.h
92+
.Ft const char *
93+
.Fn X509_get_default_cert_area void
7294
.Sh DESCRIPTION
7395
The function
7496
.Fn CONF_modules_load_file
@@ -156,12 +178,20 @@ Applications can use the
156178
function if they wish to load a configuration file themselves and
157179
have finer control over how errors are treated.
158180
.Sh RETURN VALUES
159-
These functions return 1 for success and zero or a negative value for
160-
failure.
181+
.Fn CONF_modules_load_file
182+
and
183+
.Fn CONF_modules_load
184+
return 1 for success and zero or a negative value for failure.
161185
If module errors are not ignored, the return code will reflect the return
162186
value of the failing module (this will always be zero or negative).
187+
.Pp
188+
.Fn X509_get_default_cert_area
189+
returns a pointer to the constant string
190+
.Qq "/etc/ssl" .
163191
.Sh FILES
164192
.Bl -tag -width /etc/ssl/openssl.cnf -compact
193+
.It Pa /etc/ssl
194+
standard configuration directory
165195
.It Pa /etc/ssl/openssl.cnf
166196
standard configuration file
167197
.El
@@ -244,6 +274,10 @@ if (fp == NULL) {
244274
.Xr OPENSSL_config 3 ,
245275
.Xr OPENSSL_load_builtin_modules 3
246276
.Sh HISTORY
277+
.Fn X509_get_default_cert_area
278+
first appeared in SSLeay 0.4.1 and has been available since
279+
.Ox 2.4 .
280+
.Pp
247281
.Fn CONF_modules_load_file
248282
and
249283
.Fn CONF_modules_load

0 commit comments

Comments
 (0)