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