secure/lib/libcrypto/man/SCT_new.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 "SCT_NEW 3"
 132 .TH SCT_NEW 3 "2018-11-20" "1.1.1a" "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 SCT_new, SCT_new_from_base64, SCT_free, SCT_LIST_free, SCT_get_version, SCT_set_version, SCT_get_log_entry_type, SCT_set_log_entry_type, SCT_get0_log_id, SCT_set0_log_id, SCT_set1_log_id, SCT_get_timestamp, SCT_set_timestamp, SCT_get_signature_nid, SCT_set_signature_nid, SCT_get0_signature, SCT_set0_signature, SCT_set1_signature, SCT_get0_extensions, SCT_set0_extensions, SCT_set1_extensions, SCT_get_source, SCT_set_source \&\- A Certificate Transparency Signed Certificate Timestamp
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ct.h>
 143 \&
 144 \& typedef enum {
 145 \&     CT_LOG_ENTRY_TYPE_NOT_SET = \-1,
 146 \&     CT_LOG_ENTRY_TYPE_X509 = 0,
 147 \&     CT_LOG_ENTRY_TYPE_PRECERT = 1
 148 \& } ct_log_entry_type_t;
 149 \&
 150 \& typedef enum {
 151 \&     SCT_VERSION_NOT_SET = \-1,
 152 \&     SCT_VERSION_V1 = 0
 153 \& } sct_version_t;
 154 \&
 155 \& typedef enum {
 156 \&     SCT_SOURCE_UNKNOWN,
 157 \&     SCT_SOURCE_TLS_EXTENSION,
 158 \&     SCT_SOURCE_X509V3_EXTENSION,
 159 \&     SCT_SOURCE_OCSP_STAPLED_RESPONSE
 160 \& } sct_source_t;
 161 \&
 162 \& SCT *SCT_new(void);
 163 \& SCT *SCT_new_from_base64(unsigned char version,
 164 \&                          const char *logid_base64,
 165 \&                          ct_log_entry_type_t entry_type,
 166 \&                          uint64_t timestamp,
 167 \&                          const char *extensions_base64,
 168 \&                          const char *signature_base64);
 169 \&
 170 \& void SCT_free(SCT *sct);
 171 \& void SCT_LIST_free(STACK_OF(SCT) *a);
 172 \&
 173 \& sct_version_t SCT_get_version(const SCT *sct);
 174 \& int SCT_set_version(SCT *sct, sct_version_t version);
 175 \&
 176 \& ct_log_entry_type_t SCT_get_log_entry_type(const SCT *sct);
 177 \& int SCT_set_log_entry_type(SCT *sct, ct_log_entry_type_t entry_type);
 178 \&
 179 \& size_t SCT_get0_log_id(const SCT *sct, unsigned char **log_id);
 180 \& int SCT_set0_log_id(SCT *sct, unsigned char *log_id, size_t log_id_len);
 181 \& int SCT_set1_log_id(SCT *sct, const unsigned char *log_id, size_t log_id_len);
 182 \&
 183 \& uint64_t SCT_get_timestamp(const SCT *sct);
 184 \& void SCT_set_timestamp(SCT *sct, uint64_t timestamp);
 185 \&
 186 \& int SCT_get_signature_nid(const SCT *sct);
 187 \& int SCT_set_signature_nid(SCT *sct, int nid);
 188 \&
 189 \& size_t SCT_get0_signature(const SCT *sct, unsigned char **sig);
 190 \& void SCT_set0_signature(SCT *sct, unsigned char *sig, size_t sig_len);
 191 \& int SCT_set1_signature(SCT *sct, const unsigned char *sig, size_t sig_len);
 192 \&
 193 \& size_t SCT_get0_extensions(const SCT *sct, unsigned char **ext);
 194 \& void SCT_set0_extensions(SCT *sct, unsigned char *ext, size_t ext_len);
 195 \& int SCT_set1_extensions(SCT *sct, const unsigned char *ext, size_t ext_len);
 196 \&
 197 \& sct_source_t SCT_get_source(const SCT *sct);
 198 \& int SCT_set_source(SCT *sct, sct_source_t source);
 199 .Ve
 200 .SH "DESCRIPTION"
 201 .IX Header "DESCRIPTION"
 202 Signed Certificate Timestamps (SCTs) are defined by \s-1RFC 6962,\s0 Section 3.2.
 203 They constitute a promise by a Certificate Transparency (\s-1CT\s0) log to publicly
 204 record a certificate. By cryptographically verifying that a log did indeed issue
 205 an \s-1SCT,\s0 some confidence can be gained that the certificate is publicly known.
 206 .PP
 207 An internal representation of an \s-1SCT\s0 can be created in one of two ways.
 208 The first option is to create a blank \s-1SCT,\s0 using \fISCT_new()\fR, and then populate
 209 it using:
 210 .IP "\(bu" 2
 211 \&\fISCT_set_version()\fR to set the \s-1SCT\s0 version.
 212 .Sp
 213 Only \s-1SCT_VERSION_V1\s0 is currently supported.
 214 .IP "\(bu" 2
 215 \&\fISCT_set_log_entry_type()\fR to set the type of certificate the \s-1SCT\s0 was issued for:
 216 .Sp
 217 \&\fB\s-1CT_LOG_ENTRY_TYPE_X509\s0\fR for a normal certificate.
 218 \&\fB\s-1CT_LOG_ENTRY_TYPE_PRECERT\s0\fR for a pre-certificate.
 219 .IP "\(bu" 2
 220 \&\fISCT_set0_log_id()\fR or \fISCT_set1_log_id()\fR to set the LogID of the \s-1CT\s0 log that the \s-1SCT\s0 came from.
 221 .Sp
 222 The former takes ownership, whereas the latter makes a copy.
 223 See \s-1RFC 6962,\s0 Section 3.2 for the definition of LogID.
 224 .IP "\(bu" 2
 225 \&\fISCT_set_timestamp()\fR to set the time the \s-1SCT\s0 was issued (epoch time in milliseconds).
 226 .IP "\(bu" 2
 227 \&\fISCT_set_signature_nid()\fR to set the \s-1NID\s0 of the signature.
 228 .IP "\(bu" 2
 229 \&\fISCT_set0_signature()\fR or \fISCT_set1_signature()\fR to set the raw signature value.
 230 .Sp
 231 The former takes ownership, whereas the latter makes a copy.
 232 .IP "\(bu" 2
 233 \&\fISCT_set0_extensions()\fR or \fBSCT_set1_extensions\fR to provide \s-1SCT\s0 extensions.
 234 .Sp
 235 The former takes ownership, whereas the latter makes a copy.
 236 .PP
 237 Alternatively, the \s-1SCT\s0 can be pre-populated from the following data using
 238 \&\fISCT_new_from_base64()\fR:
 239 .IP "\(bu" 2
 240 The \s-1SCT\s0 version (only \s-1SCT_VERSION_V1\s0 is currently supported).
 241 .IP "\(bu" 2
 242 The LogID (see \s-1RFC 6962,\s0 Section 3.2), base64 encoded.
 243 .IP "\(bu" 2
 244 The type of certificate the \s-1SCT\s0 was issued for:
 245 \&\fB\s-1CT_LOG_ENTRY_TYPE_X509\s0\fR for a normal certificate.
 246 \&\fB\s-1CT_LOG_ENTRY_TYPE_PRECERT\s0\fR for a pre-certificate.
 247 .IP "\(bu" 2
 248 The time that the \s-1SCT\s0 was issued (epoch time in milliseconds).
 249 .IP "\(bu" 2
 250 The \s-1SCT\s0 extensions, base64 encoded.
 251 .IP "\(bu" 2
 252 The \s-1SCT\s0 signature, base64 encoded.
 253 .PP
 254 \&\fISCT_set_source()\fR can be used to record where the \s-1SCT\s0 was found
 255 (\s-1TLS\s0 extension, X.509 certificate extension or \s-1OCSP\s0 response). This is not
 256 required for verifying the \s-1SCT.\s0
 257 .SH "NOTES"
 258 .IX Header "NOTES"
 259 Some of the setters return int, instead of void. These will all return 1 on
 260 success, 0 on failure. They will not make changes on failure.
 261 .PP
 262 All of the setters will reset the validation status of the \s-1SCT\s0 to
 263 \&\s-1SCT_VALIDATION_STATUS_NOT_SET\s0 (see \fISCT_validate\fR\|(3)).
 264 .PP
 265 \&\fISCT_set_source()\fR will call \fISCT_set_log_entry_type()\fR if the type of
 266 certificate the \s-1SCT\s0 was issued for can be inferred from where the \s-1SCT\s0 was found.
 267 For example, an \s-1SCT\s0 found in an X.509 extension must have been issued for a pre\-
 268 certificate.
 269 .PP
 270 \&\fISCT_set_source()\fR will not refuse unknown values.
 271 .SH "RETURN VALUES"
 272 .IX Header "RETURN VALUES"
 273 \&\fISCT_set_version()\fR returns 1 if the specified version is supported, 0 otherwise.
 274 .PP
 275 \&\fISCT_set_log_entry_type()\fR returns 1 if the specified log entry type is supported, 0 otherwise.
 276 .PP
 277 \&\fISCT_set0_log_id()\fR and \fBSCT_set1_log_id\fR return 1 if the specified LogID is a
 278 valid \s-1SHA\-256\s0 hash, 0 otherwise. Additionally, \fBSCT_set1_log_id\fR returns 0 if
 279 malloc fails.
 280 .PP
 281 \&\fBSCT_set_signature_nid\fR returns 1 if the specified \s-1NID\s0 is supported, 0 otherwise.
 282 .PP
 283 \&\fBSCT_set1_extensions\fR and \fBSCT_set1_signature\fR return 1 if the supplied buffer
 284 is copied successfully, 0 otherwise (i.e. if malloc fails).
 285 .PP
 286 \&\fBSCT_set_source\fR returns 1 on success, 0 otherwise.
 287 .SH "SEE ALSO"
 288 .IX Header "SEE ALSO"
 289 \&\fIct\fR\|(7),
 290 \&\fISCT_validate\fR\|(3),
 291 \&\fIOBJ_nid2obj\fR\|(3)
 292 .SH "HISTORY"
 293 .IX Header "HISTORY"
 294 These functions were added in OpenSSL 1.1.0.
 295 .SH "COPYRIGHT"
 296 .IX Header "COPYRIGHT"
 297 Copyright 2016\-2017 The OpenSSL Project Authors. All Rights Reserved.
 298 .PP
 299 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 300 this file except in compliance with the License.  You can obtain a copy
 301 in the file \s-1LICENSE\s0 in the source distribution or at
 302 <https://www.openssl.org/source/license.html>.