secure/lib/libcrypto/man/man3/OPENSSL_config.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.41)
   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 >0, 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 "OPENSSL_CONFIG 3"
 136 .TH OPENSSL_CONFIG 3 "2020-12-08" "1.1.1i" "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 OPENSSL_config, OPENSSL_no_config \- simple OpenSSL configuration functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/conf.h>
 147 \&
 148 \& #if OPENSSL_API_COMPAT < 0x10100000L
 149 \& void OPENSSL_config(const char *appname);
 150 \& void OPENSSL_no_config(void);
 151 \& #endif
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 \&\fBOPENSSL_config()\fR configures OpenSSL using the standard \fBopenssl.cnf\fR and
 156 reads from the application section \fBappname\fR. If \fBappname\fR is \s-1NULL\s0 then
 157 the default section, \fBopenssl_conf\fR, will be used.
 158 Errors are silently ignored.
 159 Multiple calls have no effect.
 160 .PP
 161 \&\fBOPENSSL_no_config()\fR disables configuration. If called before \fBOPENSSL_config()\fR
 162 no configuration takes place.
 163 .PP
 164 If the application is built with \fB\s-1OPENSSL_LOAD_CONF\s0\fR defined, then a
 165 call to \fBOpenSSL_add_all_algorithms()\fR will implicitly call \fBOPENSSL_config()\fR
 166 first.
 167 .SH "NOTES"
 168 .IX Header "NOTES"
 169 The \fBOPENSSL_config()\fR function is designed to be a very simple \*(L"call it and
 170 forget it\*(R" function.
 171 It is however \fBmuch\fR better than nothing. Applications which need finer
 172 control over their configuration functionality should use the configuration
 173 functions such as \fBCONF_modules_load()\fR directly. This function is deprecated
 174 and its use should be avoided.
 175 Applications should instead call \fBCONF_modules_load()\fR during
 176 initialization (that is before starting any threads).
 177 .PP
 178 There are several reasons why calling the OpenSSL configuration routines is
 179 advisable. For example, to load dynamic ENGINEs from shared libraries (DSOs).
 180 However, very few applications currently support the control interface and so
 181 very few can load and use dynamic ENGINEs. Equally in future more sophisticated
 182 ENGINEs will require certain control operations to customize them. If an
 183 application calls \fBOPENSSL_config()\fR it doesn't need to know or care about
 184 \&\s-1ENGINE\s0 control operations because they can be performed by editing a
 185 configuration file.
 186 .SH "ENVIRONMENT"
 187 .IX Header "ENVIRONMENT"
 188 .IP "\fB\s-1OPENSSL_CONF\s0\fR" 4
 189 .IX Item "OPENSSL_CONF"
 190 The path to the config file.
 191 Ignored in set-user-ID and set-group-ID programs.
 192 .SH "RETURN VALUES"
 193 .IX Header "RETURN VALUES"
 194 Neither \fBOPENSSL_config()\fR nor \fBOPENSSL_no_config()\fR return a value.
 195 .SH "SEE ALSO"
 196 .IX Header "SEE ALSO"
 197 \&\fBconfig\fR\|(5),
 198 \&\fBCONF_modules_load_file\fR\|(3)
 199 .SH "HISTORY"
 200 .IX Header "HISTORY"
 201 The \fBOPENSSL_no_config()\fR and \fBOPENSSL_config()\fR functions were
 202 deprecated in OpenSSL 1.1.0 by \fBOPENSSL_init_crypto()\fR.
 203 .SH "COPYRIGHT"
 204 .IX Header "COPYRIGHT"
 205 Copyright 2004\-2020 The OpenSSL Project Authors. All Rights Reserved.
 206 .PP
 207 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 208 this file except in compliance with the License.  You can obtain a copy
 209 in the file \s-1LICENSE\s0 in the source distribution or at
 210 <https://www.openssl.org/source/license.html>.