secure/lib/libcrypto/man/OPENSSL_config.3

   1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" Escape single quotes in literal strings from groff's Unicode transform.
  52 .ie \n(.g .ds Aq \(aq
  53 .el       .ds Aq '
  54 .\"
  55 .\" If the F register is turned on, we'll generate index entries on stderr for
  56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  58 .\" output yourself in some meaningful fashion.
  59 .ie \nF \{\
  60 .    de IX
  61 .    tm Index:\\$1\t\\n%\t"\\$2"
  62 ..
  63 .    nr % 0
  64 .    rr F
  65 .\}
  66 .el \{\
  67 .    de IX
  68 ..
  69 .\}
  70 .\"
  71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  73 .    \" fudge factors for nroff and troff
  74 .if n \{\
  75 .    ds #H 0
  76 .    ds #V .8m
  77 .    ds #F .3m
  78 .    ds #[ \f1
  79 .    ds #] \fP
  80 .\}
  81 .if t \{\
  82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  83 .    ds #V .6m
  84 .    ds #F 0
  85 .    ds #[ \&
  86 .    ds #] \&
  87 .\}
  88 .    \" simple accents for nroff and troff
  89 .if n \{\
  90 .    ds ' \&
  91 .    ds ` \&
  92 .    ds ^ \&
  93 .    ds , \&
  94 .    ds ~ ~
  95 .    ds /
  96 .\}
  97 .if t \{\
  98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 104 .\}
 105 .    \" troff and (daisy-wheel) nroff accents
 106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 113 .ds ae a\h'-(\w'a'u*4/10)'e
 114 .ds Ae A\h'-(\w'A'u*4/10)'E
 115 .    \" corrections for vroff
 116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 118 .    \" for low resolution devices (crt and lpr)
 119 .if \n(.H>23 .if \n(.V>19 \
 120 \{\
 121 .    ds : e
 122 .    ds 8 ss
 123 .    ds o a
 124 .    ds d- d\h'-1'\(ga
 125 .    ds D- D\h'-1'\(hy
 126 .    ds th \o'bp'
 127 .    ds Th \o'LP'
 128 .    ds ae ae
 129 .    ds Ae AE
 130 .\}
 131 .rm #[ #] #H #V #F C
 132 .\" ========================================================================
 133 .\"
 134 .IX Title "OPENSSL_config 3"
 135 .TH OPENSSL_config 3 "2009-11-06" "0.9.8l" "OpenSSL"
 136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 137 .\" way too many mistakes in technical documents.
 138 .if n .ad l
 139 .nh
 140 .SH "NAME"
 141 OPENSSL_config, OPENSSL_no_config \- simple OpenSSL configuration functions
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 .Vb 1
 145 \& #include <openssl/conf.h>
 146 \&
 147 \& void OPENSSL_config(const char *config_name);
 148 \& void OPENSSL_no_config(void);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fIOPENSSL_config()\fR configures OpenSSL using the standard \fBopenssl.cnf\fR
 153 configuration file name using \fBconfig_name\fR. If \fBconfig_name\fR is \s-1NULL\s0 then
 154 the default name \fBopenssl_conf\fR will be used. Any errors are ignored. Further
 155 calls to \fIOPENSSL_config()\fR will have no effect. The configuration file format
 156 is documented in the \fIconf\fR\|(5) manual page.
 157 .PP
 158 \&\fIOPENSSL_no_config()\fR disables configuration. If called before \fIOPENSSL_config()\fR
 159 no configuration takes place.
 160 .SH "NOTES"
 161 .IX Header "NOTES"
 162 It is \fBstrongly\fR recommended that \fBall\fR new applications call \fIOPENSSL_config()\fR
 163 or the more sophisticated functions such as \fICONF_modules_load()\fR during
 164 initialization (that is before starting any threads). By doing this
 165 an application does not need to keep track of all configuration options
 166 and some new functionality can be supported automatically.
 167 .PP
 168 It is also possible to automatically call \fIOPENSSL_config()\fR when an application
 169 calls \fIOPENSSL_add_all_algorithms()\fR by compiling an application with the
 170 preprocessor symbol \fB\s-1OPENSSL_LOAD_CONF\s0\fR #define'd. In this way configuration
 171 can be added without source changes.
 172 .PP
 173 The environment variable \fB\s-1OPENSSL_CONF\s0\fR can be set to specify the location
 174 of the configuration file.
 175 .PP
 176 Currently \s-1ASN1\s0 OBJECTs and \s-1ENGINE\s0 configuration can be performed future
 177 versions of OpenSSL will add new configuration options.
 178 .PP
 179 There are several reasons why calling the OpenSSL configuration routines is
 180 advisable. For example new \s-1ENGINE\s0 functionality was added to OpenSSL 0.9.7.
 181 In OpenSSL 0.9.7 control functions can be supported by ENGINEs, this can be
 182 used (among other things) to load dynamic ENGINEs from shared libraries (DSOs).
 183 However very few applications currently support the control interface and so
 184 very few can load and use dynamic ENGINEs. Equally in future more sophisticated
 185 ENGINEs will require certain control operations to customize them. If an
 186 application calls \fIOPENSSL_config()\fR it doesn't need to know or care about
 187 \&\s-1ENGINE\s0 control operations because they can be performed by editing a
 188 configuration file.
 189 .PP
 190 Applications should free up configuration at application closedown by calling
 191 \&\fICONF_modules_free()\fR.
 192 .SH "RESTRICTIONS"
 193 .IX Header "RESTRICTIONS"
 194 The \fIOPENSSL_config()\fR function is designed to be a very simple \*(L"call it and
 195 forget it\*(R" function. As a result its behaviour is somewhat limited. It ignores
 196 all errors silently and it can only load from the standard configuration file
 197 location for example.
 198 .PP
 199 It is however \fBmuch\fR better than nothing. Applications which need finer
 200 control over their configuration functionality should use the configuration
 201 functions such as \fICONF_load_modules()\fR directly.
 202 .SH "RETURN VALUES"
 203 .IX Header "RETURN VALUES"
 204 Neither \fIOPENSSL_config()\fR nor \fIOPENSSL_no_config()\fR return a value.
 205 .SH "SEE ALSO"
 206 .IX Header "SEE ALSO"
 207 \&\fIconf\fR\|(5), \fICONF_load_modules_file\fR\|(3),
 208 \&\fICONF_modules_free\fR\|(3),\fICONF_modules_free\fR\|(3)
 209 .SH "HISTORY"
 210 .IX Header "HISTORY"
 211 \&\fIOPENSSL_config()\fR and \fIOPENSSL_no_config()\fR first appeared in OpenSSL 0.9.7