| blob | 0e274b4f756403001aff01cbcf55242430b32818 |
1 .\" $NetBSD: CONF_modules_load_file.3,v 1.14 2015/06/12 17:01:13 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
10 ..
11 .de Vb \" Begin verbatim text
12 .ft CW
13 .nf
14 .ne \\$1
15 ..
16 .de Ve \" End verbatim text
17 .ft R
18 .fi
19 ..
20 .\" Set up some character translations and predefined strings. \*(-- will
21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
22 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
23 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
24 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
25 .\" nothing in troff, for use with C<>.
26 .tr \(*W-
27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
28 .ie n \{\
29 . ds -- \(*W-
30 . ds PI pi
31 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
32 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
33 . ds L" ""
34 . ds R" ""
35 . ds C` ""
36 . ds C' ""
37 'br\}
38 .el\{\
39 . ds -- \|\(em\|
40 . ds PI \(*p
41 . ds L" ``
42 . ds R" ''
43 . ds C`
44 . ds C'
45 'br\}
46 .\"
47 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .ie \n(.g .ds Aq \(aq
49 .el .ds Aq '
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .\"
56 .\" Avoid warning from groff about undefined register 'F'.
57 .de IX
58 ..
59 .nr rF 0
60 .if \n(.g .if rF .nr rF 1
61 .if (\n(rF:(\n(.g==0)) \{
62 . if \nF \{
63 . de IX
64 . tm Index:\\$1\t\\n%\t"\\$2"
65 ..
66 . if !\nF==2 \{
67 . nr % 0
68 . nr F 2
69 . \}
70 . \}
71 .\}
72 .rr rF
73 .\"
74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
75 .\" Fear. Run. Save yourself. No user-serviceable parts.
76 . \" fudge factors for nroff and troff
77 .if n \{\
78 . ds #H 0
79 . ds #V .8m
80 . ds #F .3m
81 . ds #[ \f1
82 . ds #] \fP
83 .\}
84 .if t \{\
85 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
86 . ds #V .6m
87 . ds #F 0
88 . ds #[ \&
89 . ds #] \&
90 .\}
91 . \" simple accents for nroff and troff
92 .if n \{\
93 . ds ' \&
94 . ds ` \&
95 . ds ^ \&
96 . ds , \&
97 . ds ~ ~
98 . ds /
99 .\}
100 .if t \{\
101 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
102 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
103 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
104 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
105 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
106 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
107 .\}
108 . \" troff and (daisy-wheel) nroff accents
109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
116 .ds ae a\h'-(\w'a'u*4/10)'e
117 .ds Ae A\h'-(\w'A'u*4/10)'E
118 . \" corrections for vroff
119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
121 . \" for low resolution devices (crt and lpr)
122 .if \n(.H>23 .if \n(.V>19 \
123 \{\
124 . ds : e
125 . ds 8 ss
126 . ds o a
127 . ds d- d\h'-1'\(ga
128 . ds D- D\h'-1'\(hy
129 . ds th \o'bp'
130 . ds Th \o'LP'
131 . ds ae ae
132 . ds Ae AE
133 .\}
134 .rm #[ #] #H #V #F C
135 .\" ========================================================================
136 .\"
137 .IX Title "CONF_modules_load_file 3"
138 .TH CONF_modules_load_file 3 "2015-03-23" "1.0.1n" "OpenSSL"
139 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
140 .\" way too many mistakes in technical documents.
141 .if n .ad l
142 .nh
143 .SH "NAME"
144 .Vb 1
145 \& CONF_modules_load_file, CONF_modules_load \- OpenSSL configuration functions
146 .Ve
147 .SH "LIBRARY"
148 libcrypto, -lcrypto
149 .SH "SYNOPSIS"
150 .IX Header "SYNOPSIS"
151 .Vb 1
152 \& #include <openssl/conf.h>
153 \&
154 \& int CONF_modules_load_file(const char *filename, const char *appname,
155 \& unsigned long flags);
156 \& int CONF_modules_load(const CONF *cnf, const char *appname,
157 \& unsigned long flags);
158 .Ve
159 .SH "DESCRIPTION"
160 .IX Header "DESCRIPTION"
161 The function \fICONF_modules_load_file()\fR configures OpenSSL using file
162 \&\fBfilename\fR and application name \fBappname\fR. If \fBfilename\fR is \s-1NULL\s0
163 the standard OpenSSL configuration file is used. If \fBappname\fR is
164 \&\s-1NULL\s0 the standard OpenSSL application name \fBopenssl_conf\fR is used.
165 The behaviour can be cutomized using \fBflags\fR.
166 .PP
167 \&\fICONF_modules_load()\fR is idential to \fICONF_modules_load_file()\fR except it
168 reads configuration information from \fBcnf\fR.
169 .SH "NOTES"
170 .IX Header "NOTES"
171 The following \fBflags\fR are currently recognized:
172 .PP
173 \&\fB\s-1CONF_MFLAGS_IGNORE_ERRORS\s0\fR if set errors returned by individual
174 configuration modules are ignored. If not set the first module error is
175 considered fatal and no further modules are loaded.
176 .PP
177 Normally any modules errors will add error information to the error queue. If
178 \&\fB\s-1CONF_MFLAGS_SILENT\s0\fR is set no error information is added.
179 .PP
180 If \fB\s-1CONF_MFLAGS_NO_DSO\s0\fR is set configuration module loading from DSOs is
181 disabled.
182 .PP
183 \&\fB\s-1CONF_MFLAGS_IGNORE_MISSING_FILE\s0\fR if set will make \fICONF_load_modules_file()\fR
184 ignore missing configuration files. Normally a missing configuration file
185 return an error.
186 .PP
187 \&\fB\s-1CONF_MFLAGS_DEFAULT_SECTION\s0\fR if set and \fBappname\fR is not \s-1NULL\s0 will use the
188 default section pointed to by \fBopenssl_conf\fR if \fBappname\fR does not exist.
189 .PP
190 Applications should call these functions after loading builtin modules using
191 \&\fIOPENSSL_load_builtin_modules()\fR, any ENGINEs for example using
192 \&\fIENGINE_load_builtin_engines()\fR, any algorithms for example
193 \&\fIOPENSSL_add_all_algorithms()\fR and (if the application uses libssl)
194 \&\fISSL_library_init()\fR.
195 .PP
196 By using \fICONF_modules_load_file()\fR with appropriate flags an application can
197 customise application configuration to best suit its needs. In some cases the
198 use of a configuration file is optional and its absence is not an error: in
199 this case \fB\s-1CONF_MFLAGS_IGNORE_MISSING_FILE\s0\fR would be set.
200 .PP
201 Errors during configuration may also be handled differently by different
202 applications. For example in some cases an error may simply print out a warning
203 message and the application continue. In other cases an application might
204 consider a configuration file error as fatal and exit immediately.
205 .PP
206 Applications can use the \fICONF_modules_load()\fR function if they wish to load a
207 configuration file themselves and have finer control over how errors are
208 treated.
209 .SH "EXAMPLES"
210 .IX Header "EXAMPLES"
211 Load a configuration file and print out any errors and exit (missing file
212 considered fatal):
213 .PP
214 .Vb 5
215 \& if (CONF_modules_load_file(NULL, NULL, 0) <= 0) {
216 \& fprintf(stderr, "FATAL: error loading configuration file\en");
217 \& ERR_print_errors_fp(stderr);
218 \& exit(1);
219 \& }
220 .Ve
221 .PP
222 Load default configuration file using the section indicated by \*(L"myapp\*(R",
223 tolerate missing files, but exit on other errors:
224 .PP
225 .Vb 6
226 \& if (CONF_modules_load_file(NULL, "myapp",
227 \& CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) {
228 \& fprintf(stderr, "FATAL: error loading configuration file\en");
229 \& ERR_print_errors_fp(stderr);
230 \& exit(1);
231 \& }
232 .Ve
233 .PP
234 Load custom configuration file and section, only print warnings on error,
235 missing configuration file ignored:
236 .PP
237 .Vb 5
238 \& if (CONF_modules_load_file("/something/app.cnf", "myapp",
239 \& CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) {
240 \& fprintf(stderr, "WARNING: error loading configuration file\en");
241 \& ERR_print_errors_fp(stderr);
242 \& }
243 .Ve
244 .PP
245 Load and parse configuration file manually, custom error handling:
246 .PP
247 .Vb 10
248 \& FILE *fp;
249 \& CONF *cnf = NULL;
250 \& long eline;
251 \& fp = fopen("/somepath/app.cnf", "r");
252 \& if (fp == NULL) {
253 \& fprintf(stderr, "Error opening configuration file\en");
254 \& /* Other missing configuration file behaviour */
255 \& } else {
256 \& cnf = NCONF_new(NULL);
257 \& if (NCONF_load_fp(cnf, fp, &eline) == 0) {
258 \& fprintf(stderr, "Error on line %ld of configuration file\en", eline);
259 \& ERR_print_errors_fp(stderr);
260 \& /* Other malformed configuration file behaviour */
261 \& } else if (CONF_modules_load(cnf, "appname", 0) <= 0) {
262 \& fprintf(stderr, "Error configuring application\en");
263 \& ERR_print_errors_fp(stderr);
264 \& /* Other configuration error behaviour */
265 \& }
266 \& fclose(fp);
267 \& NCONF_free(cnf);
268 \& }
269 .Ve
270 .SH "RETURN VALUES"
271 .IX Header "RETURN VALUES"
272 These functions return 1 for success and a zero or negative value for
273 failure. If module errors are not ignored the return code will reflect the
274 return value of the failing module (this will always be zero or negative).
275 .SH "SEE ALSO"
276 .IX Header "SEE ALSO"
277 \&\fIconf\fR\|(5), \fIOPENSSL_config\fR\|(3),
278 \&\fICONF_free\fR\|(3), \fIopenssl_err\fR\|(3)
279 .SH "HISTORY"
280 .IX Header "HISTORY"
281 CONF_modules_load_file and CONF_modules_load first appeared in OpenSSL 0.9.7.