secure/lib/libcrypto/man/OPENSSL_init_ssl.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   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_INIT_SSL 3"
 136 .TH OPENSSL_INIT_SSL 3 "2019-09-10" "1.1.1d" "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_init_ssl \- OpenSSL (libssl and libcrypto) initialisation
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& int OPENSSL_init_ssl(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 During normal operation OpenSSL (libssl and libcrypto) will allocate various
 153 resources at start up that must, subsequently, be freed on close down of the
 154 library. Additionally some resources are allocated on a per thread basis (if the
 155 application is multi-threaded), and these resources must be freed prior to the
 156 thread closing.
 157 .PP
 158 As of version 1.1.0 OpenSSL will automatically allocate all resources that it
 159 needs so no explicit initialisation is required. Similarly it will also
 160 automatically deinitialise as required.
 161 .PP
 162 However, there may be situations when explicit initialisation is desirable or
 163 needed, for example when some non-default initialisation is required. The
 164 function \fBOPENSSL_init_ssl()\fR can be used for this purpose. Calling
 165 this function will explicitly initialise \s-1BOTH\s0 libcrypto and libssl. To
 166 explicitly initialise \s-1ONLY\s0 libcrypto see the
 167 \&\fBOPENSSL_init_crypto\fR\|(3) function.
 168 .PP
 169 Numerous internal OpenSSL functions call \fBOPENSSL_init_ssl()\fR.
 170 Therefore, in order to perform non-default initialisation,
 171 \&\fBOPENSSL_init_ssl()\fR \s-1MUST\s0 be called by application code prior to
 172 any other OpenSSL function calls.
 173 .PP
 174 The \fBopts\fR parameter specifies which aspects of libssl and libcrypto should be
 175 initialised. Valid options for libcrypto are described on the
 176 \&\fBOPENSSL_init_crypto\fR\|(3) page. In addition to any libcrypto
 177 specific option the following libssl options can also be used:
 178 .IP "\s-1OPENSSL_INIT_NO_LOAD_SSL_STRINGS\s0" 4
 179 .IX Item "OPENSSL_INIT_NO_LOAD_SSL_STRINGS"
 180 Suppress automatic loading of the libssl error strings. This option is
 181 not a default option. Once selected subsequent calls to
 182 \&\fBOPENSSL_init_ssl()\fR with the option
 183 \&\fB\s-1OPENSSL_INIT_LOAD_SSL_STRINGS\s0\fR will be ignored.
 184 .IP "\s-1OPENSSL_INIT_LOAD_SSL_STRINGS\s0" 4
 185 .IX Item "OPENSSL_INIT_LOAD_SSL_STRINGS"
 186 Automatic loading of the libssl error strings. This option is a
 187 default option. Once selected subsequent calls to
 188 \&\fBOPENSSL_init_ssl()\fR with the option
 189 \&\fB\s-1OPENSSL_INIT_LOAD_SSL_STRINGS\s0\fR will be ignored.
 190 .PP
 191 \&\fBOPENSSL_init_ssl()\fR takes a \fBsettings\fR parameter which can be used to
 192 set parameter values.  See \fBOPENSSL_init_crypto\fR\|(3) for details.
 193 .SH "RETURN VALUES"
 194 .IX Header "RETURN VALUES"
 195 The function \fBOPENSSL_init_ssl()\fR returns 1 on success or 0 on error.
 196 .SH "SEE ALSO"
 197 .IX Header "SEE ALSO"
 198 \&\fBOPENSSL_init_crypto\fR\|(3)
 199 .SH "HISTORY"
 200 .IX Header "HISTORY"
 201 The \fBOPENSSL_init_ssl()\fR function was added in OpenSSL 1.1.0.
 202 .SH "COPYRIGHT"
 203 .IX Header "COPYRIGHT"
 204 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
 205 .PP
 206 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 207 this file except in compliance with the License.  You can obtain a copy
 208 in the file \s-1LICENSE\s0 in the source distribution or at
 209 <https://www.openssl.org/source/license.html>.