secure/lib/libcrypto/man/man3/SSL_CTX_set_ct_validation_callback.3

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