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