secure/lib/libcrypto/man/SSL_CTX_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 "SSL_CTX_CONFIG 3"
 132 .TH SSL_CTX_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 SSL_CTX_config, SSL_config \- configure SSL_CTX or SSL structure
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& int SSL_CTX_config(SSL_CTX *ctx, const char *name);
 145 \& int SSL_config(SSL *s, const char *name);
 146 .Ve
 147 .SH "DESCRIPTION"
 148 .IX Header "DESCRIPTION"
 149 The functions \fISSL_CTX_config()\fR and \fISSL_config()\fR configure an \fB\s-1SSL_CTX\s0\fR or
 150 \&\fB\s-1SSL\s0\fR structure using the configuration \fBname\fR.
 151 .SH "NOTES"
 152 .IX Header "NOTES"
 153 By calling \fISSL_CTX_config()\fR or \fISSL_config()\fR an application can perform many
 154 complex tasks based on the contents of the configuration file: greatly
 155 simplifying application configuration code. A degree of future proofing
 156 can also be achieved: an application can support configuration features
 157 in newer versions of OpenSSL automatically.
 158 .PP
 159 A configuration file must have been previously loaded, for example using
 160 \&\fICONF_modules_load_file()\fR. See \fIconfig\fR\|(5) for details of the configuration
 161 file syntax.
 162 .SH "RETURN VALUES"
 163 .IX Header "RETURN VALUES"
 164 \&\fISSL_CTX_config()\fR and \fISSL_config()\fR return 1 for success or 0 if an error
 165 occurred.
 166 .SH "EXAMPLE"
 167 .IX Header "EXAMPLE"
 168 If the file \*(L"config.cnf\*(R" contains the following:
 169 .PP
 170 .Vb 1
 171 \& testapp = test_sect
 172 \&
 173 \& [test_sect]
 174 \& # list of configuration modules
 175 \&
 176 \& ssl_conf = ssl_sect
 177 \&
 178 \& [ssl_sect]
 179 \& server = server_section
 180 \&
 181 \& [server_section]
 182 \& RSA.Certificate = server\-rsa.pem
 183 \& ECDSA.Certificate = server\-ecdsa.pem
 184 \& Ciphers = ALL:!RC4
 185 .Ve
 186 .PP
 187 An application could call:
 188 .PP
 189 .Vb 4
 190 \& if (CONF_modules_load_file("config.cnf", "testapp", 0) <= 0) {
 191 \&     fprintf(stderr, "Error processing config file\en");
 192 \&     goto err;
 193 \& }
 194 \&
 195 \& ctx = SSL_CTX_new(TLS_server_method());
 196 \&
 197 \& if (SSL_CTX_config(ctx, "server") == 0) {
 198 \&     fprintf(stderr, "Error configuring server.\en");
 199 \&     goto err;
 200 \& }
 201 .Ve
 202 .PP
 203 In this example two certificates and the cipher list are configured without
 204 the need for any additional application code.
 205 .SH "SEE ALSO"
 206 .IX Header "SEE ALSO"
 207 \&\fIconfig\fR\|(5),
 208 \&\fISSL_CONF_cmd\fR\|(3),
 209 \&\fICONF_modules_load_file\fR\|(3)
 210 .SH "HISTORY"
 211 .IX Header "HISTORY"
 212 \&\fISSL_CTX_config()\fR and \fISSL_config()\fR were first added to OpenSSL 1.1.0
 213 .SH "COPYRIGHT"
 214 .IX Header "COPYRIGHT"
 215 Copyright 2015\-2016 The OpenSSL Project Authors. All Rights Reserved.
 216 .PP
 217 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 218 this file except in compliance with the License.  You can obtain a copy
 219 in the file \s-1LICENSE\s0 in the source distribution or at
 220 <https://www.openssl.org/source/license.html>.