274 lines
9.1 KiB
Groff
274 lines
9.1 KiB
Groff
.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
. ds C`
|
|
. ds C'
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is >0, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.\"
|
|
.\" Avoid warning from groff about undefined register 'F'.
|
|
.de IX
|
|
..
|
|
.if !\nF .nr F 0
|
|
.if \nF>0 \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. if !\nF==2 \{\
|
|
. nr % 0
|
|
. nr F 2
|
|
. \}
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "CONF_modules_load_file 3"
|
|
.TH CONF_modules_load_file 3 "2017-01-26" "1.0.2k" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
.Vb 1
|
|
\& CONF_modules_load_file, CONF_modules_load \- OpenSSL configuration functions
|
|
.Ve
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/conf.h>
|
|
\&
|
|
\& int CONF_modules_load_file(const char *filename, const char *appname,
|
|
\& unsigned long flags);
|
|
\& int CONF_modules_load(const CONF *cnf, const char *appname,
|
|
\& unsigned long flags);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
The function \fICONF_modules_load_file()\fR configures OpenSSL using file
|
|
\&\fBfilename\fR and application name \fBappname\fR. If \fBfilename\fR is \s-1NULL\s0
|
|
the standard OpenSSL configuration file is used. If \fBappname\fR is
|
|
\&\s-1NULL\s0 the standard OpenSSL application name \fBopenssl_conf\fR is used.
|
|
The behaviour can be cutomized using \fBflags\fR.
|
|
.PP
|
|
\&\fICONF_modules_load()\fR is idential to \fICONF_modules_load_file()\fR except it
|
|
reads configuration information from \fBcnf\fR.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
The following \fBflags\fR are currently recognized:
|
|
.PP
|
|
\&\fB\s-1CONF_MFLAGS_IGNORE_ERRORS\s0\fR if set errors returned by individual
|
|
configuration modules are ignored. If not set the first module error is
|
|
considered fatal and no further modules are loaded.
|
|
.PP
|
|
Normally any modules errors will add error information to the error queue. If
|
|
\&\fB\s-1CONF_MFLAGS_SILENT\s0\fR is set no error information is added.
|
|
.PP
|
|
If \fB\s-1CONF_MFLAGS_NO_DSO\s0\fR is set configuration module loading from DSOs is
|
|
disabled.
|
|
.PP
|
|
\&\fB\s-1CONF_MFLAGS_IGNORE_MISSING_FILE\s0\fR if set will make \fICONF_load_modules_file()\fR
|
|
ignore missing configuration files. Normally a missing configuration file
|
|
return an error.
|
|
.PP
|
|
\&\fB\s-1CONF_MFLAGS_DEFAULT_SECTION\s0\fR if set and \fBappname\fR is not \s-1NULL\s0 will use the
|
|
default section pointed to by \fBopenssl_conf\fR if \fBappname\fR does not exist.
|
|
.PP
|
|
Applications should call these functions after loading builtin modules using
|
|
\&\fIOPENSSL_load_builtin_modules()\fR, any ENGINEs for example using
|
|
\&\fIENGINE_load_builtin_engines()\fR, any algorithms for example
|
|
\&\fIOPENSSL_add_all_algorithms()\fR and (if the application uses libssl)
|
|
\&\fISSL_library_init()\fR.
|
|
.PP
|
|
By using \fICONF_modules_load_file()\fR with appropriate flags an application can
|
|
customise application configuration to best suit its needs. In some cases the
|
|
use of a configuration file is optional and its absence is not an error: in
|
|
this case \fB\s-1CONF_MFLAGS_IGNORE_MISSING_FILE\s0\fR would be set.
|
|
.PP
|
|
Errors during configuration may also be handled differently by different
|
|
applications. For example in some cases an error may simply print out a warning
|
|
message and the application continue. In other cases an application might
|
|
consider a configuration file error as fatal and exit immediately.
|
|
.PP
|
|
Applications can use the \fICONF_modules_load()\fR function if they wish to load a
|
|
configuration file themselves and have finer control over how errors are
|
|
treated.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
Load a configuration file and print out any errors and exit (missing file
|
|
considered fatal):
|
|
.PP
|
|
.Vb 5
|
|
\& if (CONF_modules_load_file(NULL, NULL, 0) <= 0) {
|
|
\& fprintf(stderr, "FATAL: error loading configuration file\en");
|
|
\& ERR_print_errors_fp(stderr);
|
|
\& exit(1);
|
|
\& }
|
|
.Ve
|
|
.PP
|
|
Load default configuration file using the section indicated by \*(L"myapp\*(R",
|
|
tolerate missing files, but exit on other errors:
|
|
.PP
|
|
.Vb 6
|
|
\& if (CONF_modules_load_file(NULL, "myapp",
|
|
\& CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) {
|
|
\& fprintf(stderr, "FATAL: error loading configuration file\en");
|
|
\& ERR_print_errors_fp(stderr);
|
|
\& exit(1);
|
|
\& }
|
|
.Ve
|
|
.PP
|
|
Load custom configuration file and section, only print warnings on error,
|
|
missing configuration file ignored:
|
|
.PP
|
|
.Vb 5
|
|
\& if (CONF_modules_load_file("/something/app.cnf", "myapp",
|
|
\& CONF_MFLAGS_IGNORE_MISSING_FILE) <= 0) {
|
|
\& fprintf(stderr, "WARNING: error loading configuration file\en");
|
|
\& ERR_print_errors_fp(stderr);
|
|
\& }
|
|
.Ve
|
|
.PP
|
|
Load and parse configuration file manually, custom error handling:
|
|
.PP
|
|
.Vb 10
|
|
\& FILE *fp;
|
|
\& CONF *cnf = NULL;
|
|
\& long eline;
|
|
\& fp = fopen("/somepath/app.cnf", "r");
|
|
\& if (fp == NULL) {
|
|
\& fprintf(stderr, "Error opening configuration file\en");
|
|
\& /* Other missing configuration file behaviour */
|
|
\& } else {
|
|
\& cnf = NCONF_new(NULL);
|
|
\& if (NCONF_load_fp(cnf, fp, &eline) == 0) {
|
|
\& fprintf(stderr, "Error on line %ld of configuration file\en", eline);
|
|
\& ERR_print_errors_fp(stderr);
|
|
\& /* Other malformed configuration file behaviour */
|
|
\& } else if (CONF_modules_load(cnf, "appname", 0) <= 0) {
|
|
\& fprintf(stderr, "Error configuring application\en");
|
|
\& ERR_print_errors_fp(stderr);
|
|
\& /* Other configuration error behaviour */
|
|
\& }
|
|
\& fclose(fp);
|
|
\& NCONF_free(cnf);
|
|
\& }
|
|
.Ve
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
These functions return 1 for success and a zero or 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"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIconf\fR\|(5), \fIOPENSSL_config\fR\|(3),
|
|
\&\fICONF_free\fR\|(3), \fIerr\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
CONF_modules_load_file and CONF_modules_load first appeared in OpenSSL 0.9.7.
|