secure/lib/libcrypto/man/OPENSSL_config.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
   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.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  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 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  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 "2007-03-28" "0.9.8e" "OpenSSL"
 133 .SH "NAME"
 134 OPENSSL_config, OPENSSL_no_config \- simple OpenSSL configuration functions
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& #include <openssl/conf.h>
 139 .Ve
 140 .PP
 141 .Vb 2
 142 \& void OPENSSL_config(const char *config_name);
 143 \& void OPENSSL_no_config(void);
 144 .Ve
 145 .SH "DESCRIPTION"
 146 .IX Header "DESCRIPTION"
 147 \&\fIOPENSSL_config()\fR configures OpenSSL using the standard \fBopenssl.cnf\fR
 148 configuration file name using \fBconfig_name\fR. If \fBconfig_name\fR is \s-1NULL\s0 then
 149 the default name \fBopenssl_conf\fR will be used. Any errors are ignored. Further
 150 calls to \fIOPENSSL_config()\fR will have no effect. The configuration file format
 151 is documented in the \fIconf\fR\|(5) manual page.
 152 .PP
 153 \&\fIOPENSSL_no_config()\fR disables configuration. If called before \fIOPENSSL_config()\fR
 154 no configuration takes place.
 155 .SH "NOTES"
 156 .IX Header "NOTES"
 157 It is \fBstrongly\fR recommended that \fBall\fR new applications call \fIOPENSSL_config()\fR
 158 or the more sophisticated functions such as \fICONF_modules_load()\fR during
 159 initialization (that is before starting any threads). By doing this
 160 an application does not need to keep track of all configuration options
 161 and some new functionality can be supported automatically.
 162 .PP
 163 It is also possible to automatically call \fIOPENSSL_config()\fR when an application
 164 calls \fIOPENSSL_add_all_algorithms()\fR by compiling an application with the
 165 preprocessor symbol \fB\s-1OPENSSL_LOAD_CONF\s0\fR #define'd. In this way configuration
 166 can be added without source changes.
 167 .PP
 168 The environment variable \fB\s-1OPENSSL_CONF\s0\fR can be set to specify the location
 169 of the configuration file.
 170 .PP
 171 Currently \s-1ASN1\s0 OBJECTs and \s-1ENGINE\s0 configuration can be performed future
 172 versions of OpenSSL will add new configuration options.
 173 .PP
 174 There are several reasons why calling the OpenSSL configuration routines is
 175 advisable. For example new \s-1ENGINE\s0 functionality was added to OpenSSL 0.9.7.
 176 In OpenSSL 0.9.7 control functions can be supported by ENGINEs, this can be
 177 used (among other things) to load dynamic ENGINEs from shared libraries (DSOs).
 178 However very few applications currently support the control interface and so
 179 very few can load and use dynamic ENGINEs. Equally in future more sophisticated
 180 ENGINEs will require certain control operations to customize them. If an
 181 application calls \fIOPENSSL_config()\fR it doesn't need to know or care about
 182 \&\s-1ENGINE\s0 control operations because they can be performed by editing a
 183 configuration file.
 184 .PP
 185 Applications should free up configuration at application closedown by calling
 186 \&\fICONF_modules_free()\fR.
 187 .SH "RESTRICTIONS"
 188 .IX Header "RESTRICTIONS"
 189 The \fIOPENSSL_config()\fR function is designed to be a very simple \*(L"call it and
 190 forget it\*(R" function. As a result its behaviour is somewhat limited. It ignores
 191 all errors silently and it can only load from the standard configuration file
 192 location for example.
 193 .PP
 194 It is however \fBmuch\fR better than nothing. Applications which need finer
 195 control over their configuration functionality should use the configuration
 196 functions such as \fICONF_load_modules()\fR directly.
 197 .SH "RETURN VALUES"
 198 .IX Header "RETURN VALUES"
 199 Neither \fIOPENSSL_config()\fR nor \fIOPENSSL_no_config()\fR return a value.
 200 .SH "SEE ALSO"
 201 .IX Header "SEE ALSO"
 202 \&\fIconf\fR\|(5), \fICONF_load_modules_file\fR\|(3),
 203 \&\fICONF_modules_free\fR\|(3),\fICONF_modules_free\fR\|(3)
 204 .SH "HISTORY"
 205 .IX Header "HISTORY"
 206 \&\fIOPENSSL_config()\fR and \fIOPENSSL_no_config()\fR first appeared in OpenSSL 0.9.7