secure/lib/libcrypto/man/OPENSSL_config.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "OPENSSL_CONFIG 3"
 132 .TH OPENSSL_CONFIG 3 "2018-09-11" "1.1.1" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 OPENSSL_config, OPENSSL_no_config \- simple OpenSSL configuration functions
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/conf.h>
 143 \&
 144 \& #if OPENSSL_API_COMPAT < 0x10100000L
 145 \& void OPENSSL_config(const char *appname);
 146 \& void OPENSSL_no_config(void);
 147 \& #endif
 148 .Ve
 149 .SH "DESCRIPTION"
 150 .IX Header "DESCRIPTION"
 151 \&\fIOPENSSL_config()\fR configures OpenSSL using the standard \fBopenssl.cnf\fR and
 152 reads from the application section \fBappname\fR. If \fBappname\fR is \s-1NULL\s0 then
 153 the default section, \fBopenssl_conf\fR, will be used.
 154 Errors are silently ignored.
 155 Multiple calls have no effect.
 156 .PP
 157 \&\fIOPENSSL_no_config()\fR disables configuration. If called before \fIOPENSSL_config()\fR
 158 no configuration takes place.
 159 .PP
 160 If the application is built with \fB\s-1OPENSSL_LOAD_CONF\s0\fR defined, then a
 161 call to \fIOpenSSL_add_all_algorithms()\fR will implicitly call \fIOPENSSL_config()\fR
 162 first.
 163 .SH "NOTES"
 164 .IX Header "NOTES"
 165 The \fIOPENSSL_config()\fR function is designed to be a very simple \*(L"call it and
 166 forget it\*(R" function.
 167 It is however \fBmuch\fR better than nothing. Applications which need finer
 168 control over their configuration functionality should use the configuration
 169 functions such as \fICONF_modules_load()\fR directly. This function is deprecated
 170 and its use should be avoided.
 171 Applications should instead call \fICONF_modules_load()\fR during
 172 initialization (that is before starting any threads).
 173 .PP
 174 There are several reasons why calling the OpenSSL configuration routines is
 175 advisable. For example, to load dynamic ENGINEs from shared libraries (DSOs).
 176 However very few applications currently support the control interface and so
 177 very few can load and use dynamic ENGINEs. Equally in future more sophisticated
 178 ENGINEs will require certain control operations to customize them. If an
 179 application calls \fIOPENSSL_config()\fR it doesn't need to know or care about
 180 \&\s-1ENGINE\s0 control operations because they can be performed by editing a
 181 configuration file.
 182 .SH "ENVIRONMENT"
 183 .IX Header "ENVIRONMENT"
 184 .IP "\fB\s-1OPENSSL_CONF\s0\fR" 4
 185 .IX Item "OPENSSL_CONF"
 186 The path to the config file.
 187 Ignored in set-user-ID and set-group-ID programs.
 188 .SH "RETURN VALUES"
 189 .IX Header "RETURN VALUES"
 190 Neither \fIOPENSSL_config()\fR nor \fIOPENSSL_no_config()\fR return a value.
 191 .SH "SEE ALSO"
 192 .IX Header "SEE ALSO"
 193 \&\fIconfig\fR\|(5),
 194 \&\fICONF_modules_load_file\fR\|(3)
 195 .SH "HISTORY"
 196 .IX Header "HISTORY"
 197 The \fIOPENSSL_no_config()\fR and \fIOPENSSL_config()\fR functions were
 198 deprecated in OpenSSL 1.1.0 by \fIOPENSSL_init_crypto()\fR.
 199 .SH "COPYRIGHT"
 200 .IX Header "COPYRIGHT"
 201 Copyright 2004\-2018 The OpenSSL Project Authors. All Rights Reserved.
 202 .PP
 203 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 204 this file except in compliance with the License.  You can obtain a copy
 205 in the file \s-1LICENSE\s0 in the source distribution or at
 206 <https://www.openssl.org/source/license.html>.