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