summaryrefslogtreecommitdiff
path: root/lib/libcrypto/man/CONF_modules_load_file.3
blob: b5de94411d93eca5b13f3a0b0556594d63e71172 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
.Dd $Mdocdate: November 11 2015 $
.Dt CONF_MODULES_LOAD_FILE 3
.Os
.Sh NAME
.Nm CONF_modules_load_file ,
.Nm CONF_modules_load
.Nd OpenSSL configuration functions
.Sh SYNOPSIS
.In openssl/conf.h
.Ft int
.Fo CONF_modules_load_file
.Fa "const char *filename"
.Fa "const char *appname"
.Fa "unsigned long flags"
.Fc
.Ft int
.Fo CONF_modules_load
.Fa "const CONF *cnf"
.Fa "const char *appname"
.Fa "unsigned long flags"
.Fc
.Sh DESCRIPTION
The function
.Fn CONF_modules_load_file
configures OpenSSL using file
.Fa filename
and application name
.Fa appname .
If
.Fa filename
is
.Dv NULL ,
the standard OpenSSL configuration file is used.
If
.Fa appname
is
.Dv NULL ,
the standard OpenSSL application name
.Qq openssl_conf
is used.
The behaviour can be cutomized using
.Fa flags .
.Pp
.Fn CONF_modules_load
is idential to
.Fn CONF_modules_load_file
except it reads configuration information from
.Fa cnf .
.Pp
The following
.Fa flags
are currently recognized:
.Bl -tag -width Ds
.It Dv CONF_MFLAGS_IGNORE_ERRORS
Ignore errors returned by individual configuration modules.
By default, the first module error is considered fatal and no further
modules are loaded.
.It Dv CONF_MFLAGS_SILENT
Do not add any error information.
By default, all module errors add error information to the error queue.
.It Dv CONF_MFLAGS_NO_DSO
Disable loading of configuration modules from DSOs.
.It Dv CONF_MFLAGS_IGNORE_MISSING_FILE
Let
.Fn CONF_modules_load_file
ignore missing configuration files.
By default, a missing configuration file returns an error.
.El
.Sh RETURN VALUES
These functions 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).
.Sh SEE ALSO
.Xr CONF_free 3 ,
.Xr ERR 3 ,
.Xr OPENSSL_config 3
.Sh HISTORY
.Fn CONF_modules_load_file
and
.Fn CONF_modules_load
first appeared in OpenSSL 0.9.7.