secure/lib/libcrypto/man/SSL_CTX_set_ct_validation_callback.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_SET_CT_VALIDATION_CALLBACK 3"
 132 .TH SSL_CTX_SET_CT_VALIDATION_CALLBACK 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_ct_validation_cb, SSL_enable_ct, SSL_CTX_enable_ct, SSL_disable_ct, SSL_CTX_disable_ct, SSL_set_ct_validation_callback, SSL_CTX_set_ct_validation_callback, SSL_ct_is_enabled, SSL_CTX_ct_is_enabled \- control Certificate Transparency policy
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& typedef int (*ssl_ct_validation_cb)(const CT_POLICY_EVAL_CTX *ctx,
 145 \&                                    const STACK_OF(SCT) *scts, void *arg);
 146 \&
 147 \& int SSL_enable_ct(SSL *s, int validation_mode);
 148 \& int SSL_CTX_enable_ct(SSL_CTX *ctx, int validation_mode);
 149 \& int SSL_set_ct_validation_callback(SSL *s, ssl_ct_validation_cb callback,
 150 \&                                    void *arg);
 151 \& int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx,
 152 \&                                        ssl_ct_validation_cb callback,
 153 \&                                        void *arg);
 154 \& void SSL_disable_ct(SSL *s);
 155 \& void SSL_CTX_disable_ct(SSL_CTX *ctx);
 156 \& int SSL_ct_is_enabled(const SSL *s);
 157 \& int SSL_CTX_ct_is_enabled(const SSL_CTX *ctx);
 158 .Ve
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 \&\fISSL_enable_ct()\fR and \fISSL_CTX_enable_ct()\fR enable the processing of signed
 162 certificate timestamps (SCTs) either for a given \s-1SSL\s0 connection or for all
 163 connections that share the given \s-1SSL\s0 context, respectively.
 164 This is accomplished by setting a built-in \s-1CT\s0 validation callback.
 165 The behaviour of the callback is determined by the \fBvalidation_mode\fR argument,
 166 which can be either of \fB\s-1SSL_CT_VALIDATION_PERMISSIVE\s0\fR or
 167 \&\fB\s-1SSL_CT_VALIDATION_STRICT\s0\fR as described below.
 168 .PP
 169 If \fBvalidation_mode\fR is equal to \fB\s-1SSL_CT_VALIDATION_STRICT\s0\fR, then in a full
 170 \&\s-1TLS\s0 handshake with the verification mode set to \fB\s-1SSL_VERIFY_PEER\s0\fR, if the peer
 171 presents no valid SCTs the handshake will be aborted.
 172 If the verification mode is \fB\s-1SSL_VERIFY_NONE\s0\fR, the handshake will continue
 173 despite lack of valid SCTs.
 174 However, in that case if the verification status before the built-in callback
 175 was \fBX509_V_OK\fR it will be set to \fBX509_V_ERR_NO_VALID_SCTS\fR after the
 176 callback.
 177 Applications can call \fISSL_get_verify_result\fR\|(3) to check the status at
 178 handshake completion, even after session resumption since the verification
 179 status is part of the saved session state.
 180 See \fISSL_set_verify\fR\|(3), <\fISSL_get_verify_result\fR\|(3)>, \fISSL_session_reused\fR\|(3).
 181 .PP
 182 If \fBvalidation_mode\fR is equal to \fB\s-1SSL_CT_VALIDATION_PERMISSIVE\s0\fR, then the
 183 handshake continues, and the verification status is not modified, regardless of
 184 the validation status of any SCTs.
 185 The application can still inspect the validation status of the SCTs at
 186 handshake completion.
 187 Note that with session resumption there will not be any SCTs presented during
 188 the handshake.
 189 Therefore, in applications that delay \s-1SCT\s0 policy enforcement until after
 190 handshake completion, such delayed \s-1SCT\s0 checks should only be performed when the
 191 session is not resumed.
 192 .PP
 193 \&\fISSL_set_ct_validation_callback()\fR and \fISSL_CTX_set_ct_validation_callback()\fR
 194 register a custom callback that may implement a different policy than either of
 195 the above.
 196 This callback can examine the peer's SCTs and determine whether they are
 197 sufficient to allow the connection to continue.
 198 The \s-1TLS\s0 handshake is aborted if the verification mode is not \fB\s-1SSL_VERIFY_NONE\s0\fR
 199 and the callback returns a non-positive result.
 200 .PP
 201 An arbitrary callback context argument, \fBarg\fR, can be passed in when setting
 202 the callback.
 203 This will be passed to the callback whenever it is invoked.
 204 Ownership of this context remains with the caller.
 205 .PP
 206 If no callback is set, SCTs will not be requested and Certificate Transparency
 207 validation will not occur.
 208 .PP
 209 No callback will be invoked when the peer presents no certificate, e.g. by
 210 employing an anonymous (aNULL) cipher suite.
 211 In that case the handshake continues as it would had no callback been
 212 requested.
 213 Callbacks are also not invoked when the peer certificate chain is invalid or
 214 validated via \s-1\fIDANE\-TA\s0\fR\|(2) or \s-1\fIDANE\-EE\s0\fR\|(3) \s-1TLSA\s0 records which use a private X.509
 215 \&\s-1PKI,\s0 or no X.509 \s-1PKI\s0 at all, respectively.
 216 Clients that require SCTs are expected to not have enabled any aNULL ciphers
 217 nor to have specified server verification via \s-1\fIDANE\-TA\s0\fR\|(2) or \s-1\fIDANE\-EE\s0\fR\|(3) \s-1TLSA\s0
 218 records.
 219 .PP
 220 \&\fISSL_disable_ct()\fR and \fISSL_CTX_disable_ct()\fR turn off \s-1CT\s0 processing, whether
 221 enabled via the built-in or the custom callbacks, by setting a \s-1NULL\s0 callback.
 222 These may be implemented as macros.
 223 .PP
 224 \&\fISSL_ct_is_enabled()\fR and \fISSL_CTX_ct_is_enabled()\fR return 1 if \s-1CT\s0 processing is
 225 enabled via either \fISSL_enable_ct()\fR or a non-null custom callback, and 0
 226 otherwise.
 227 .SH "NOTES"
 228 .IX Header "NOTES"
 229 When \s-1SCT\s0 processing is enabled, \s-1OCSP\s0 stapling will be enabled. This is because
 230 one possible source of SCTs is the \s-1OCSP\s0 response from a server.
 231 .PP
 232 The time returned by \fISSL_SESSION_get_time()\fR will be used to evaluate whether any
 233 presented SCTs have timestamps that are in the future (and therefore invalid).
 234 .SH "RESTRICTIONS"
 235 .IX Header "RESTRICTIONS"
 236 Certificate Transparency validation cannot be enabled and so a callback cannot
 237 be set if a custom client extension handler has been registered to handle \s-1SCT\s0
 238 extensions (\fBTLSEXT_TYPE_signed_certificate_timestamp\fR).
 239 .SH "RETURN VALUES"
 240 .IX Header "RETURN VALUES"
 241 \&\fISSL_enable_ct()\fR, \fISSL_CTX_enable_ct()\fR, \fISSL_CTX_set_ct_validation_callback()\fR and
 242 \&\fISSL_set_ct_validation_callback()\fR return 1 if the \fBcallback\fR is successfully
 243 set.
 244 They return 0 if an error occurs, e.g. a custom client extension handler has
 245 been setup to handle SCTs.
 246 .PP
 247 \&\fISSL_disable_ct()\fR and \fISSL_CTX_disable_ct()\fR do not return a result.
 248 .PP
 249 \&\fISSL_CTX_ct_is_enabled()\fR and \fISSL_ct_is_enabled()\fR return a 1 if a non-null \s-1CT\s0
 250 validation callback is set, or 0 if no callback (or equivalently a \s-1NULL\s0
 251 callback) is set.
 252 .SH "SEE ALSO"
 253 .IX Header "SEE ALSO"
 254 \&\fIssl\fR\|(7),
 255 <\fISSL_get_verify_result\fR\|(3)>,
 256 \&\fISSL_session_reused\fR\|(3),
 257 \&\fISSL_set_verify\fR\|(3),
 258 \&\fISSL_CTX_set_verify\fR\|(3),
 259 \&\fISSL_SESSION_get_time\fR\|(3)
 260 .SH "COPYRIGHT"
 261 .IX Header "COPYRIGHT"
 262 Copyright 2016\-2017 The OpenSSL Project Authors. All Rights Reserved.
 263 .PP
 264 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 265 this file except in compliance with the License.  You can obtain a copy
 266 in the file \s-1LICENSE\s0 in the source distribution or at
 267 <https://www.openssl.org/source/license.html>.