2 * Public API for Certificate Transparency (CT).
3 * Written by Rob Percival (robpercival@google.com) for the OpenSSL project.
5 /* ====================================================================
6 * Copyright (c) 2016 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
55 # error "CT is disabled"
61 # include <openssl/ossl_typ.h>
62 # include <openssl/safestack.h>
63 # include <openssl/x509.h>
69 /* Minimum RSA key size, from RFC6962 */
70 # define SCT_MIN_RSA_BITS 2048
72 /* All hashes are SHA256 in v1 of Certificate Transparency */
73 # define CT_V1_HASHLEN SHA256_DIGEST_LENGTH
76 CT_LOG_ENTRY_TYPE_NOT_SET = -1,
77 CT_LOG_ENTRY_TYPE_X509 = 0,
78 CT_LOG_ENTRY_TYPE_PRECERT = 1
79 } ct_log_entry_type_t;
82 SCT_VERSION_NOT_SET = -1,
88 SCT_SOURCE_TLS_EXTENSION,
89 SCT_SOURCE_X509V3_EXTENSION,
90 SCT_SOURCE_OCSP_STAPLED_RESPONSE
94 DEFINE_STACK_OF(CTLOG)
101 * Creates a new, blank SCT.
102 * The caller is responsible for calling SCT_free when finished with the SCT.
107 * Creates a new SCT from some base64-encoded strings.
108 * The caller is responsible for calling SCT_free when finished with the SCT.
110 SCT *SCT_new_from_base64(unsigned char version,
111 const char *logid_base64,
112 ct_log_entry_type_t entry_type,
114 const char *extensions_base64,
115 const char *signature_base64);
118 * Frees the SCT and the underlying data structures.
120 void SCT_free(SCT *sct);
123 * Free a stack of SCTs, and the underlying SCTs themselves.
124 * Intended to be compatible with X509V3_EXT_FREE.
126 void SCT_LIST_free(STACK_OF(SCT) *a);
129 * Returns the version of the SCT.
131 sct_version_t SCT_get_version(const SCT *sct);
134 * Set the version of an SCT.
135 * Returns 1 on success, 0 if the version is unrecognized.
137 int SCT_set_version(SCT *sct, sct_version_t version);
140 * Returns the log entry type of the SCT.
142 ct_log_entry_type_t SCT_get_log_entry_type(const SCT *sct);
145 * Set the log entry type of an SCT.
146 * Returns 1 on success.
148 int SCT_set_log_entry_type(SCT *sct, ct_log_entry_type_t entry_type);
151 * Gets the ID of the log that an SCT came from.
152 * Ownership of the log ID remains with the SCT.
153 * Returns the length of the log ID.
155 size_t SCT_get0_log_id(const SCT *sct, unsigned char **log_id);
158 * Set the log ID of an SCT to point directly to the *log_id specified.
159 * The SCT takes ownership of the specified pointer.
160 * Returns 1 on success.
162 int SCT_set0_log_id(SCT *sct, unsigned char *log_id, size_t log_id_len);
165 * Set the log ID of an SCT.
166 * This makes a copy of the log_id.
167 * Returns 1 on success.
169 int SCT_set1_log_id(SCT *sct, const unsigned char *log_id, size_t log_id_len);
172 * Gets the name of the log that an SCT came from.
173 * Ownership of the log name remains with the SCT.
174 * Returns the log name, or NULL if it is not known.
176 const char *SCT_get0_log_name(const SCT *sct);
179 * Returns the timestamp for the SCT (epoch time in milliseconds).
181 uint64_t SCT_get_timestamp(const SCT *sct);
184 * Set the timestamp of an SCT (epoch time in milliseconds).
186 void SCT_set_timestamp(SCT *sct, uint64_t timestamp);
189 * Return the NID for the signature used by the SCT.
190 * For CT v1, this will be either NID_sha256WithRSAEncryption or
191 * NID_ecdsa_with_SHA256 (or NID_undef if incorrect/unset).
193 int SCT_get_signature_nid(const SCT *sct);
196 * Set the signature type of an SCT
197 * For CT v1, this should be either NID_sha256WithRSAEncryption or
198 * NID_ecdsa_with_SHA256.
199 * Returns 1 on success.
201 int SCT_set_signature_nid(SCT *sct, int nid);
204 * Set *ext to point to the extension data for the SCT. ext must not be NULL.
205 * The SCT retains ownership of this pointer.
206 * Returns length of the data pointed to.
208 size_t SCT_get0_extensions(const SCT *sct, unsigned char **ext);
211 * Set the extensions of an SCT to point directly to the *ext specified.
212 * The SCT takes ownership of the specified pointer.
214 void SCT_set0_extensions(SCT *sct, unsigned char *ext, size_t ext_len);
217 * Set the extensions of an SCT.
218 * This takes a copy of the ext.
219 * Returns 1 on success.
221 int SCT_set1_extensions(SCT *sct, const unsigned char *ext, size_t ext_len);
224 * Set *sig to point to the signature for the SCT. sig must not be NULL.
225 * The SCT retains ownership of this pointer.
226 * Returns length of the data pointed to.
228 size_t SCT_get0_signature(const SCT *sct, unsigned char **sig);
231 * Set the signature of an SCT to point directly to the *sig specified.
232 * The SCT takes ownership of the specified pointer.
234 void SCT_set0_signature(SCT *sct, unsigned char *sig, size_t sig_len);
237 * Set the signature of an SCT to be a copy of the *sig specified.
238 * Returns 1 on success.
240 int SCT_set1_signature(SCT *sct, const unsigned char *sig, size_t sig_len);
243 * The origin of this SCT, e.g. TLS extension, OCSP response, etc.
245 sct_source_t SCT_get_source(const SCT *sct);
248 * Set the origin of this SCT, e.g. TLS extension, OCSP response, etc.
249 * Returns 1 on success, 0 otherwise.
251 int SCT_set_source(SCT *sct, sct_source_t source);
254 * Sets the source of all of the SCTs to the same value.
255 * Returns 1 on success.
257 int SCT_LIST_set_source(const STACK_OF(SCT) *scts, sct_source_t source);
260 * Gets information about the log the SCT came from, if set.
262 CTLOG *SCT_get0_log(const SCT *sct);
265 * Looks up information about the log the SCT came from using a CT log store.
266 * Returns 1 if information about the log is found, 0 otherwise.
267 * The information can be accessed via SCT_get0_log.
269 int SCT_set0_log(SCT *sct, const CTLOG_STORE* ct_logs);
272 * Looks up information about the logs the SCTs came from using a CT log store.
273 * Returns the number of SCTs that now have a log set.
274 * If any SCTs already have a log set, they will be skipped.
276 int SCT_LIST_set0_logs(STACK_OF(SCT) *sct_list, const CTLOG_STORE *ct_logs);
279 * Pretty-prints an |sct| to |out|.
280 * It will be indented by the number of spaces specified by |indent|.
282 void SCT_print(const SCT *sct, BIO *out, int indent);
285 * Pretty-prints an |sct_list| to |out|.
286 * It will be indented by the number of spaces specified by |indent|.
287 * SCTs will be delimited by |separator|.
289 void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent,
290 const char *separator);
293 * Verifies an SCT with the given context.
294 * Returns 1 if the SCT verifies successfully, 0 if it cannot be verified and a
295 * negative integer if an error occurs.
297 int SCT_verify(const SCT_CTX *sctx, const SCT *sct);
300 * Verifies an SCT against the provided data.
301 * Returns 1 if the SCT verifies successfully, 0 if it cannot be verified and a
302 * negative integer if an error occurs.
304 int SCT_verify_v1(SCT *sct, X509 *cert, X509 *preissuer,
305 X509_PUBKEY *log_pubkey, X509 *issuer_cert);
307 /*********************************
308 * SCT parsing and serialisation *
309 *********************************/
312 * Serialize (to TLS format) a stack of SCTs and return the length.
313 * "a" must not be NULL.
314 * If "pp" is NULL, just return the length of what would have been serialized.
315 * If "pp" is not NULL and "*pp" is null, function will allocate a new pointer
316 * for data that caller is responsible for freeing (only if function returns
318 * If "pp" is NULL and "*pp" is not NULL, caller is responsible for ensuring
319 * that "*pp" is large enough to accept all of the serializied data.
320 * Returns < 0 on error, >= 0 indicating bytes written (or would have been)
323 int i2o_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp);
326 * Convert TLS format SCT list to a stack of SCTs.
327 * If "a" or "*a" is NULL, a new stack will be created that the caller is
328 * responsible for freeing (by calling SCT_LIST_free).
329 * "**pp" and "*pp" must not be NULL.
330 * Upon success, "*pp" will point to after the last bytes read, and a stack
332 * Upon failure, a NULL pointer will be returned, and the position of "*pp" is
335 STACK_OF(SCT) *o2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp,
339 * Serialize (to DER format) a stack of SCTs and return the length.
340 * "a" must not be NULL.
341 * If "pp" is NULL, just returns the length of what would have been serialized.
342 * If "pp" is not NULL and "*pp" is null, function will allocate a new pointer
343 * for data that caller is responsible for freeing (only if function returns
345 * If "pp" is NULL and "*pp" is not NULL, caller is responsible for ensuring
346 * that "*pp" is large enough to accept all of the serializied data.
347 * Returns < 0 on error, >= 0 indicating bytes written (or would have been)
350 int i2d_SCT_LIST(STACK_OF(SCT) *a, unsigned char **pp);
353 * Parses an SCT list in DER format and returns it.
354 * If "a" or "*a" is NULL, a new stack will be created that the caller is
355 * responsible for freeing (by calling SCT_LIST_free).
356 * "**pp" and "*pp" must not be NULL.
357 * Upon success, "*pp" will point to after the last bytes read, and a stack
359 * Upon failure, a NULL pointer will be returned, and the position of "*pp" is
362 STACK_OF(SCT) *d2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp,
366 * Serialize (to TLS format) an |sct| and write it to |out|.
367 * If |out| is null, no SCT will be output but the length will still be returned.
368 * If |out| points to a null pointer, a string will be allocated to hold the
369 * TLS-format SCT. It is the responsibility of the caller to free it.
370 * If |out| points to an allocated string, the TLS-format SCT will be written
372 * The length of the SCT in TLS format will be returned.
374 int i2o_SCT(const SCT *sct, unsigned char **out);
377 * Parses an SCT in TLS format and returns it.
378 * If |psct| is not null, it will end up pointing to the parsed SCT. If it
379 * already points to a non-null pointer, the pointer will be free'd.
380 * |in| should be a pointer to a string contianing the TLS-format SCT.
381 * |in| will be advanced to the end of the SCT if parsing succeeds.
382 * |len| should be the length of the SCT in |in|.
383 * Returns NULL if an error occurs.
384 * If the SCT is an unsupported version, only the SCT's 'sct' and 'sct_len'
385 * fields will be populated (with |in| and |len| respectively).
387 SCT *o2i_SCT(SCT **psct, const unsigned char **in, size_t len);
390 * Serialize (to TLS format) an |sct| signature and write it to |out|.
391 * If |out| is null, no signature will be output but the length will be returned.
392 * If |out| points to a null pointer, a string will be allocated to hold the
393 * TLS-format signature. It is the responsibility of the caller to free it.
394 * If |out| points to an allocated string, the signature will be written to it.
395 * The length of the signature in TLS format will be returned.
397 int i2o_SCT_signature(const SCT *sct, unsigned char **out);
400 * Parses an SCT signature in TLS format and populates the |sct| with it.
401 * |in| should be a pointer to a string contianing the TLS-format signature.
402 * |in| will be advanced to the end of the signature if parsing succeeds.
403 * |len| should be the length of the signature in |in|.
404 * Returns the number of bytes parsed, or a negative integer if an error occurs.
406 int o2i_SCT_signature(SCT *sct, const unsigned char **in, size_t len);
408 /********************
410 ********************/
413 * Creates a new CT log instance with the given |public_key| and |name|.
414 * Should be deleted by the caller using CTLOG_free when no longer needed.
416 CTLOG *CTLOG_new(EVP_PKEY *public_key, const char *name);
419 * Creates a new, blank CT log instance.
420 * Should be deleted by the caller using CTLOG_free when no longer needed.
422 CTLOG *CTLOG_new_null(void);
425 * Creates a new CT log instance with the given base64 public_key and |name|.
426 * Should be deleted by the caller using CTLOG_free when no longer needed.
428 CTLOG *CTLOG_new_from_base64(const char *pkey_base64, const char *name);
431 * Deletes a CT log instance and its fields.
433 void CTLOG_free(CTLOG *log);
435 /* Gets the name of the CT log */
436 const char *CTLOG_get0_name(CTLOG *log);
437 /* Gets the ID of the CT log */
438 void CTLOG_get0_log_id(CTLOG *log, uint8_t **log_id, size_t *log_id_len);
439 /* Gets the public key of the CT log */
440 EVP_PKEY *CTLOG_get0_public_key(CTLOG *log);
442 /**************************
443 * CT log store functions *
444 **************************/
447 * Creates a new CT log store.
448 * Should be deleted by the caller using CTLOG_STORE_free when no longer needed.
450 CTLOG_STORE *CTLOG_STORE_new(void);
453 * Deletes a CT log store and all of the CT log instances held within.
455 void CTLOG_STORE_free(CTLOG_STORE *store);
458 * Finds a CT log in the store based on its log ID.
459 * Returns the CT log, or NULL if no match is found.
461 CTLOG *CTLOG_STORE_get0_log_by_id(const CTLOG_STORE *store,
462 const uint8_t *log_id,
466 * Loads a CT log list into a |store| from a |file|.
467 * Returns 1 if loading is successful, or a non-positive integer otherwise.
469 int CTLOG_STORE_load_file(CTLOG_STORE *store, const char *file);
472 * Loads the default CT log list into a |store|.
473 * See internal/cryptlib.h for the environment variable and file path that are
474 * consulted to find the default file.
475 * Returns 1 if loading is successful, or a non-positive integer otherwise.
477 int CTLOG_STORE_load_default_file(CTLOG_STORE *store);
479 /* BEGIN ERROR CODES */
481 * The following lines are auto generated by the script mkerr.pl. Any changes
482 * made after this point may be overwritten when the script is next run.
484 void ERR_load_CT_strings(void);
486 /* Error codes for the CT functions. */
488 /* Function codes. */
489 # define CT_F_CTLOG_NEW 117
490 # define CT_F_CTLOG_NEW_FROM_BASE64 118
491 # define CT_F_CTLOG_NEW_FROM_CONF 119
492 # define CT_F_CTLOG_NEW_NULL 120
493 # define CT_F_CTLOG_STORE_GET0_LOG_BY_ID 121
494 # define CT_F_CTLOG_STORE_LOAD_CTX_NEW 122
495 # define CT_F_CTLOG_STORE_LOAD_FILE 123
496 # define CT_F_CT_BASE64_DECODE 124
497 # define CT_F_CT_V1_LOG_ID_FROM_PKEY 125
498 # define CT_F_D2I_SCT_LIST 105
499 # define CT_F_I2D_SCT_LIST 106
500 # define CT_F_I2O_SCT 107
501 # define CT_F_I2O_SCT_LIST 108
502 # define CT_F_I2O_SCT_SIGNATURE 109
503 # define CT_F_O2I_SCT 110
504 # define CT_F_O2I_SCT_LIST 111
505 # define CT_F_O2I_SCT_SIGNATURE 112
506 # define CT_F_SCT_CTX_NEW 126
507 # define CT_F_SCT_NEW 100
508 # define CT_F_SCT_NEW_FROM_BASE64 127
509 # define CT_F_SCT_SET0_LOG_ID 101
510 # define CT_F_SCT_SET1_EXTENSIONS 114
511 # define CT_F_SCT_SET1_LOG_ID 115
512 # define CT_F_SCT_SET1_SIGNATURE 116
513 # define CT_F_SCT_SET_LOG_ENTRY_TYPE 102
514 # define CT_F_SCT_SET_SIGNATURE_NID 103
515 # define CT_F_SCT_SET_VERSION 104
516 # define CT_F_SCT_SIGNATURE_IS_VALID 113
517 # define CT_F_SCT_VERIFY 128
518 # define CT_F_SCT_VERIFY_V1 129
521 # define CT_R_BASE64_DECODE_ERROR 108
522 # define CT_R_INVALID_LOG_ID_LENGTH 100
523 # define CT_R_LOG_CONF_INVALID 109
524 # define CT_R_LOG_CONF_INVALID_KEY 110
525 # define CT_R_LOG_CONF_MISSING_DESCRIPTION 111
526 # define CT_R_LOG_CONF_MISSING_KEY 112
527 # define CT_R_LOG_KEY_INVALID 113
528 # define CT_R_SCT_INVALID 104
529 # define CT_R_SCT_INVALID_SIGNATURE 107
530 # define CT_R_SCT_LIST_INVALID 105
531 # define CT_R_SCT_LOG_ID_MISMATCH 114
532 # define CT_R_SCT_NOT_SET 106
533 # define CT_R_SCT_UNSUPPORTED_VERSION 115
534 # define CT_R_UNRECOGNIZED_SIGNATURE_NID 101
535 # define CT_R_UNSUPPORTED_ENTRY_TYPE 102
536 # define CT_R_UNSUPPORTED_VERSION 103