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

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.41)
   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 "SCT_VALIDATE 3"
 136 .TH SCT_VALIDATE 3 "2020-12-08" "1.1.1i" "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 SCT_validate, SCT_LIST_validate, SCT_get_validation_status \- checks Signed Certificate Timestamps (SCTs) are valid
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ct.h>
 147 \&
 148 \& typedef enum {
 149 \&     SCT_VALIDATION_STATUS_NOT_SET,
 150 \&     SCT_VALIDATION_STATUS_UNKNOWN_LOG,
 151 \&     SCT_VALIDATION_STATUS_VALID,
 152 \&     SCT_VALIDATION_STATUS_INVALID,
 153 \&     SCT_VALIDATION_STATUS_UNVERIFIED,
 154 \&     SCT_VALIDATION_STATUS_UNKNOWN_VERSION
 155 \& } sct_validation_status_t;
 156 \&
 157 \& int SCT_validate(SCT *sct, const CT_POLICY_EVAL_CTX *ctx);
 158 \& int SCT_LIST_validate(const STACK_OF(SCT) *scts, CT_POLICY_EVAL_CTX *ctx);
 159 \& sct_validation_status_t SCT_get_validation_status(const SCT *sct);
 160 .Ve
 161 .SH "DESCRIPTION"
 162 .IX Header "DESCRIPTION"
 163 \&\fBSCT_validate()\fR will check that an \s-1SCT\s0 is valid and verify its signature.
 164 \&\fBSCT_LIST_validate()\fR performs the same checks on an entire stack of SCTs.
 165 The result of the validation checks can be obtained by passing the \s-1SCT\s0 to
 166 \&\fBSCT_get_validation_status()\fR.
 167 .PP
 168 A \s-1CT_POLICY_EVAL_CTX\s0 must be provided that specifies:
 169 .IP "\(bu" 2
 170 The certificate the \s-1SCT\s0 was issued for.
 171 .Sp
 172 Failure to provide the certificate will result in the validation status being
 173 \&\s-1SCT_VALIDATION_STATUS_UNVERIFIED.\s0
 174 .IP "\(bu" 2
 175 The issuer of that certificate.
 176 .Sp
 177 This is only required if the \s-1SCT\s0 was issued for a pre-certificate
 178 (see \s-1RFC 6962\s0). If it is required but not provided, the validation status will
 179 be \s-1SCT_VALIDATION_STATUS_UNVERIFIED.\s0
 180 .IP "\(bu" 2
 181 A \s-1CTLOG_STORE\s0 that contains the \s-1CT\s0 log that issued this \s-1SCT.\s0
 182 .Sp
 183 If the \s-1SCT\s0 was issued by a log that is not in this \s-1CTLOG_STORE,\s0 the validation
 184 status will be \s-1SCT_VALIDATION_STATUS_UNKNOWN_LOG.\s0
 185 .PP
 186 If the \s-1SCT\s0 is of an unsupported version (only v1 is currently supported), the
 187 validation status will be \s-1SCT_VALIDATION_STATUS_UNKNOWN_VERSION.\s0
 188 .PP
 189 If the \s-1SCT\s0's signature is incorrect, its timestamp is in the future (relative to
 190 the time in \s-1CT_POLICY_EVAL_CTX\s0), or if it is otherwise invalid, the validation
 191 status will be \s-1SCT_VALIDATION_STATUS_INVALID.\s0
 192 .PP
 193 If all checks pass, the validation status will be \s-1SCT_VALIDATION_STATUS_VALID.\s0
 194 .SH "NOTES"
 195 .IX Header "NOTES"
 196 A return value of 0 from \fBSCT_LIST_validate()\fR should not be interpreted as a
 197 failure. At a minimum, only one valid \s-1SCT\s0 may provide sufficient confidence
 198 that a certificate has been publicly logged.
 199 .SH "RETURN VALUES"
 200 .IX Header "RETURN VALUES"
 201 \&\fBSCT_validate()\fR returns a negative integer if an internal error occurs, 0 if the
 202 \&\s-1SCT\s0 fails validation, or 1 if the \s-1SCT\s0 passes validation.
 203 .PP
 204 \&\fBSCT_LIST_validate()\fR returns a negative integer if an internal error occurs, 0
 205 if any of SCTs fails validation, or 1 if they all pass validation.
 206 .PP
 207 \&\fBSCT_get_validation_status()\fR returns the validation status of the \s-1SCT.\s0
 208 If \fBSCT_validate()\fR or \fBSCT_LIST_validate()\fR have not been passed that \s-1SCT,\s0 the
 209 returned value will be \s-1SCT_VALIDATION_STATUS_NOT_SET.\s0
 210 .SH "SEE ALSO"
 211 .IX Header "SEE ALSO"
 212 \&\fBct\fR\|(7)
 213 .SH "HISTORY"
 214 .IX Header "HISTORY"
 215 These functions were added in OpenSSL 1.1.0.
 216 .SH "COPYRIGHT"
 217 .IX Header "COPYRIGHT"
 218 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
 219 .PP
 220 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 221 this file except in compliance with the License.  You can obtain a copy
 222 in the file \s-1LICENSE\s0 in the source distribution or at
 223 <https://www.openssl.org/source/license.html>.