include/openssl/ct.h.in

   1 /*
   2  * {- join("\n * ", @autowarntext) -}
   3  *
   4  * Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
   5  *
   6  * Licensed under the Apache License 2.0 (the "License").  You may not use
   7  * this file except in compliance with the License.  You can obtain a copy
   8  * in the file LICENSE in the source distribution or at
   9  * https://www.openssl.org/source/license.html
  10  */
  11
  12 {-
  13 use OpenSSL::stackhash qw(generate_stack_macros);
  14 -}
  15
  16 #ifndef OPENSSL_CT_H
  17 # define OPENSSL_CT_H
  18 # pragma once
  19
  20 # include <openssl/macros.h>
  21 # ifndef OPENSSL_NO_DEPRECATED_3_0
  22 #  define HEADER_CT_H
  23 # endif
  24
  25 # include <openssl/opensslconf.h>
  26
  27 # ifndef OPENSSL_NO_CT
  28 # include <openssl/types.h>
  29 # include <openssl/safestack.h>
  30 # include <openssl/x509.h>
  31 # include <openssl/cterr.h>
  32 # ifdef  __cplusplus
  33 extern "C" {
  34 # endif
  35
  36
  37 /* Minimum RSA key size, from RFC6962 */
  38 # define SCT_MIN_RSA_BITS 2048
  39
  40 /* All hashes are SHA256 in v1 of Certificate Transparency */
  41 # define CT_V1_HASHLEN SHA256_DIGEST_LENGTH
  42
  43 {-
  44     generate_stack_macros("SCT")
  45     .generate_stack_macros("CTLOG");
  46 -}
  47
  48
  49 typedef enum {
  50     CT_LOG_ENTRY_TYPE_NOT_SET = -1,
  51     CT_LOG_ENTRY_TYPE_X509 = 0,
  52     CT_LOG_ENTRY_TYPE_PRECERT = 1
  53 } ct_log_entry_type_t;
  54
  55 typedef enum {
  56     SCT_VERSION_NOT_SET = -1,
  57     SCT_VERSION_V1 = 0
  58 } sct_version_t;
  59
  60 typedef enum {
  61     SCT_SOURCE_UNKNOWN,
  62     SCT_SOURCE_TLS_EXTENSION,
  63     SCT_SOURCE_X509V3_EXTENSION,
  64     SCT_SOURCE_OCSP_STAPLED_RESPONSE
  65 } sct_source_t;
  66
  67 typedef enum {
  68     SCT_VALIDATION_STATUS_NOT_SET,
  69     SCT_VALIDATION_STATUS_UNKNOWN_LOG,
  70     SCT_VALIDATION_STATUS_VALID,
  71     SCT_VALIDATION_STATUS_INVALID,
  72     SCT_VALIDATION_STATUS_UNVERIFIED,
  73     SCT_VALIDATION_STATUS_UNKNOWN_VERSION
  74 } sct_validation_status_t;
  75
  76 /******************************************
  77  * CT policy evaluation context functions *
  78  ******************************************/
  79
  80 /*
  81  * Creates a new, empty policy evaluation context associated with the given
  82  * library context and property query string.
  83  * The caller is responsible for calling CT_POLICY_EVAL_CTX_free when finished
  84  * with the CT_POLICY_EVAL_CTX.
  85  */
  86 CT_POLICY_EVAL_CTX *CT_POLICY_EVAL_CTX_new_ex(OSSL_LIB_CTX *libctx,
  87                                               const char *propq);
  88
  89 /*
  90  * The same as CT_POLICY_EVAL_CTX_new_ex() but the default library
  91  * context and property query string is used.
  92  */
  93 CT_POLICY_EVAL_CTX *CT_POLICY_EVAL_CTX_new(void);
  94
  95 /* Deletes a policy evaluation context and anything it owns. */
  96 void CT_POLICY_EVAL_CTX_free(CT_POLICY_EVAL_CTX *ctx);
  97
  98 /* Gets the peer certificate that the SCTs are for */
  99 X509* CT_POLICY_EVAL_CTX_get0_cert(const CT_POLICY_EVAL_CTX *ctx);
 100
 101 /*
 102  * Sets the certificate associated with the received SCTs.
 103  * Increments the reference count of cert.
 104  * Returns 1 on success, 0 otherwise.
 105  */
 106 int CT_POLICY_EVAL_CTX_set1_cert(CT_POLICY_EVAL_CTX *ctx, X509 *cert);
 107
 108 /* Gets the issuer of the aforementioned certificate */
 109 X509* CT_POLICY_EVAL_CTX_get0_issuer(const CT_POLICY_EVAL_CTX *ctx);
 110
 111 /*
 112  * Sets the issuer of the certificate associated with the received SCTs.
 113  * Increments the reference count of issuer.
 114  * Returns 1 on success, 0 otherwise.
 115  */
 116 int CT_POLICY_EVAL_CTX_set1_issuer(CT_POLICY_EVAL_CTX *ctx, X509 *issuer);
 117
 118 /* Gets the CT logs that are trusted sources of SCTs */
 119 const CTLOG_STORE *CT_POLICY_EVAL_CTX_get0_log_store(const CT_POLICY_EVAL_CTX *ctx);
 120
 121 /* Sets the log store that is in use. It must outlive the CT_POLICY_EVAL_CTX. */
 122 void CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(CT_POLICY_EVAL_CTX *ctx,
 123                                                CTLOG_STORE *log_store);
 124
 125 /*
 126  * Gets the time, in milliseconds since the Unix epoch, that will be used as the
 127  * current time when checking whether an SCT was issued in the future.
 128  * Such SCTs will fail validation, as required by RFC6962.
 129  */
 130 uint64_t CT_POLICY_EVAL_CTX_get_time(const CT_POLICY_EVAL_CTX *ctx);
 131
 132 /*
 133  * Sets the time to evaluate SCTs against, in milliseconds since the Unix epoch.
 134  * If an SCT's timestamp is after this time, it will be interpreted as having
 135  * been issued in the future. RFC6962 states that "TLS clients MUST reject SCTs
 136  * whose timestamp is in the future", so an SCT will not validate in this case.
 137  */
 138 void CT_POLICY_EVAL_CTX_set_time(CT_POLICY_EVAL_CTX *ctx, uint64_t time_in_ms);
 139
 140 /*****************
 141  * SCT functions *
 142  *****************/
 143
 144 /*
 145  * Creates a new, blank SCT.
 146  * The caller is responsible for calling SCT_free when finished with the SCT.
 147  */
 148 SCT *SCT_new(void);
 149
 150 /*
 151  * Creates a new SCT from some base64-encoded strings.
 152  * The caller is responsible for calling SCT_free when finished with the SCT.
 153  */
 154 SCT *SCT_new_from_base64(unsigned char version,
 155                          const char *logid_base64,
 156                          ct_log_entry_type_t entry_type,
 157                          uint64_t timestamp,
 158                          const char *extensions_base64,
 159                          const char *signature_base64);
 160
 161 /*
 162  * Frees the SCT and the underlying data structures.
 163  */
 164 void SCT_free(SCT *sct);
 165
 166 /*
 167  * Free a stack of SCTs, and the underlying SCTs themselves.
 168  * Intended to be compatible with X509V3_EXT_FREE.
 169  */
 170 void SCT_LIST_free(STACK_OF(SCT) *a);
 171
 172 /*
 173  * Returns the version of the SCT.
 174  */
 175 sct_version_t SCT_get_version(const SCT *sct);
 176
 177 /*
 178  * Set the version of an SCT.
 179  * Returns 1 on success, 0 if the version is unrecognized.
 180  */
 181 __owur int SCT_set_version(SCT *sct, sct_version_t version);
 182
 183 /*
 184  * Returns the log entry type of the SCT.
 185  */
 186 ct_log_entry_type_t SCT_get_log_entry_type(const SCT *sct);
 187
 188 /*
 189  * Set the log entry type of an SCT.
 190  * Returns 1 on success, 0 otherwise.
 191  */
 192 __owur int SCT_set_log_entry_type(SCT *sct, ct_log_entry_type_t entry_type);
 193
 194 /*
 195  * Gets the ID of the log that an SCT came from.
 196  * Ownership of the log ID remains with the SCT.
 197  * Returns the length of the log ID.
 198  */
 199 size_t SCT_get0_log_id(const SCT *sct, unsigned char **log_id);
 200
 201 /*
 202  * Set the log ID of an SCT to point directly to the *log_id specified.
 203  * The SCT takes ownership of the specified pointer.
 204  * Returns 1 on success, 0 otherwise.
 205  */
 206 __owur int SCT_set0_log_id(SCT *sct, unsigned char *log_id, size_t log_id_len);
 207
 208 /*
 209  * Set the log ID of an SCT.
 210  * This makes a copy of the log_id.
 211  * Returns 1 on success, 0 otherwise.
 212  */
 213 __owur int SCT_set1_log_id(SCT *sct, const unsigned char *log_id,
 214                            size_t log_id_len);
 215
 216 /*
 217  * Returns the timestamp for the SCT (epoch time in milliseconds).
 218  */
 219 uint64_t SCT_get_timestamp(const SCT *sct);
 220
 221 /*
 222  * Set the timestamp of an SCT (epoch time in milliseconds).
 223  */
 224 void SCT_set_timestamp(SCT *sct, uint64_t timestamp);
 225
 226 /*
 227  * Return the NID for the signature used by the SCT.
 228  * For CT v1, this will be either NID_sha256WithRSAEncryption or
 229  * NID_ecdsa_with_SHA256 (or NID_undef if incorrect/unset).
 230  */
 231 int SCT_get_signature_nid(const SCT *sct);
 232
 233 /*
 234  * Set the signature type of an SCT
 235  * For CT v1, this should be either NID_sha256WithRSAEncryption or
 236  * NID_ecdsa_with_SHA256.
 237  * Returns 1 on success, 0 otherwise.
 238  */
 239 __owur int SCT_set_signature_nid(SCT *sct, int nid);
 240
 241 /*
 242  * Set *ext to point to the extension data for the SCT. ext must not be NULL.
 243  * The SCT retains ownership of this pointer.
 244  * Returns length of the data pointed to.
 245  */
 246 size_t SCT_get0_extensions(const SCT *sct, unsigned char **ext);
 247
 248 /*
 249  * Set the extensions of an SCT to point directly to the *ext specified.
 250  * The SCT takes ownership of the specified pointer.
 251  */
 252 void SCT_set0_extensions(SCT *sct, unsigned char *ext, size_t ext_len);
 253
 254 /*
 255  * Set the extensions of an SCT.
 256  * This takes a copy of the ext.
 257  * Returns 1 on success, 0 otherwise.
 258  */
 259 __owur int SCT_set1_extensions(SCT *sct, const unsigned char *ext,
 260                                size_t ext_len);
 261
 262 /*
 263  * Set *sig to point to the signature for the SCT. sig must not be NULL.
 264  * The SCT retains ownership of this pointer.
 265  * Returns length of the data pointed to.
 266  */
 267 size_t SCT_get0_signature(const SCT *sct, unsigned char **sig);
 268
 269 /*
 270  * Set the signature of an SCT to point directly to the *sig specified.
 271  * The SCT takes ownership of the specified pointer.
 272  */
 273 void SCT_set0_signature(SCT *sct, unsigned char *sig, size_t sig_len);
 274
 275 /*
 276  * Set the signature of an SCT to be a copy of the *sig specified.
 277  * Returns 1 on success, 0 otherwise.
 278  */
 279 __owur int SCT_set1_signature(SCT *sct, const unsigned char *sig,
 280                               size_t sig_len);
 281
 282 /*
 283  * The origin of this SCT, e.g. TLS extension, OCSP response, etc.
 284  */
 285 sct_source_t SCT_get_source(const SCT *sct);
 286
 287 /*
 288  * Set the origin of this SCT, e.g. TLS extension, OCSP response, etc.
 289  * Returns 1 on success, 0 otherwise.
 290  */
 291 __owur int SCT_set_source(SCT *sct, sct_source_t source);
 292
 293 /*
 294  * Returns a text string describing the validation status of |sct|.
 295  */
 296 const char *SCT_validation_status_string(const SCT *sct);
 297
 298 /*
 299  * Pretty-prints an |sct| to |out|.
 300  * It will be indented by the number of spaces specified by |indent|.
 301  * If |logs| is not NULL, it will be used to lookup the CT log that the SCT came
 302  * from, so that the log name can be printed.
 303  */
 304 void SCT_print(const SCT *sct, BIO *out, int indent, const CTLOG_STORE *logs);
 305
 306 /*
 307  * Pretty-prints an |sct_list| to |out|.
 308  * It will be indented by the number of spaces specified by |indent|.
 309  * SCTs will be delimited by |separator|.
 310  * If |logs| is not NULL, it will be used to lookup the CT log that each SCT
 311  * came from, so that the log names can be printed.
 312  */
 313 void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent,
 314                     const char *separator, const CTLOG_STORE *logs);
 315
 316 /*
 317  * Gets the last result of validating this SCT.
 318  * If it has not been validated yet, returns SCT_VALIDATION_STATUS_NOT_SET.
 319  */
 320 sct_validation_status_t SCT_get_validation_status(const SCT *sct);
 321
 322 /*
 323  * Validates the given SCT with the provided context.
 324  * Sets the "validation_status" field of the SCT.
 325  * Returns 1 if the SCT is valid and the signature verifies.
 326  * Returns 0 if the SCT is invalid or could not be verified.
 327  * Returns -1 if an error occurs.
 328  */
 329 __owur int SCT_validate(SCT *sct, const CT_POLICY_EVAL_CTX *ctx);
 330
 331 /*
 332  * Validates the given list of SCTs with the provided context.
 333  * Sets the "validation_status" field of each SCT.
 334  * Returns 1 if there are no invalid SCTs and all signatures verify.
 335  * Returns 0 if at least one SCT is invalid or could not be verified.
 336  * Returns a negative integer if an error occurs.
 337  */
 338 __owur int SCT_LIST_validate(const STACK_OF(SCT) *scts,
 339                              CT_POLICY_EVAL_CTX *ctx);
 340
 341
 342 /*********************************
 343  * SCT parsing and serialization *
 344  *********************************/
 345
 346 /*
 347  * Serialize (to TLS format) a stack of SCTs and return the length.
 348  * "a" must not be NULL.
 349  * If "pp" is NULL, just return the length of what would have been serialized.
 350  * If "pp" is not NULL and "*pp" is null, function will allocate a new pointer
 351  * for data that caller is responsible for freeing (only if function returns
 352  * successfully).
 353  * If "pp" is NULL and "*pp" is not NULL, caller is responsible for ensuring
 354  * that "*pp" is large enough to accept all of the serialized data.
 355  * Returns < 0 on error, >= 0 indicating bytes written (or would have been)
 356  * on success.
 357  */
 358 __owur int i2o_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp);
 359
 360 /*
 361  * Convert TLS format SCT list to a stack of SCTs.
 362  * If "a" or "*a" is NULL, a new stack will be created that the caller is
 363  * responsible for freeing (by calling SCT_LIST_free).
 364  * "**pp" and "*pp" must not be NULL.
 365  * Upon success, "*pp" will point to after the last bytes read, and a stack
 366  * will be returned.
 367  * Upon failure, a NULL pointer will be returned, and the position of "*pp" is
 368  * not defined.
 369  */
 370 STACK_OF(SCT) *o2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp,
 371                             size_t len);
 372
 373 /*
 374  * Serialize (to DER format) a stack of SCTs and return the length.
 375  * "a" must not be NULL.
 376  * If "pp" is NULL, just returns the length of what would have been serialized.
 377  * If "pp" is not NULL and "*pp" is null, function will allocate a new pointer
 378  * for data that caller is responsible for freeing (only if function returns
 379  * successfully).
 380  * If "pp" is NULL and "*pp" is not NULL, caller is responsible for ensuring
 381  * that "*pp" is large enough to accept all of the serialized data.
 382  * Returns < 0 on error, >= 0 indicating bytes written (or would have been)
 383  * on success.
 384  */
 385 __owur int i2d_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp);
 386
 387 /*
 388  * Parses an SCT list in DER format and returns it.
 389  * If "a" or "*a" is NULL, a new stack will be created that the caller is
 390  * responsible for freeing (by calling SCT_LIST_free).
 391  * "**pp" and "*pp" must not be NULL.
 392  * Upon success, "*pp" will point to after the last bytes read, and a stack
 393  * will be returned.
 394  * Upon failure, a NULL pointer will be returned, and the position of "*pp" is
 395  * not defined.
 396  */
 397 STACK_OF(SCT) *d2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp,
 398                             long len);
 399
 400 /*
 401  * Serialize (to TLS format) an |sct| and write it to |out|.
 402  * If |out| is null, no SCT will be output but the length will still be returned.
 403  * If |out| points to a null pointer, a string will be allocated to hold the
 404  * TLS-format SCT. It is the responsibility of the caller to free it.
 405  * If |out| points to an allocated string, the TLS-format SCT will be written
 406  * to it.
 407  * The length of the SCT in TLS format will be returned.
 408  */
 409 __owur int i2o_SCT(const SCT *sct, unsigned char **out);
 410
 411 /*
 412  * Parses an SCT in TLS format and returns it.
 413  * If |psct| is not null, it will end up pointing to the parsed SCT. If it
 414  * already points to a non-null pointer, the pointer will be free'd.
 415  * |in| should be a pointer to a string containing the TLS-format SCT.
 416  * |in| will be advanced to the end of the SCT if parsing succeeds.
 417  * |len| should be the length of the SCT in |in|.
 418  * Returns NULL if an error occurs.
 419  * If the SCT is an unsupported version, only the SCT's 'sct' and 'sct_len'
 420  * fields will be populated (with |in| and |len| respectively).
 421  */
 422 SCT *o2i_SCT(SCT **psct, const unsigned char **in, size_t len);
 423
 424 /********************
 425  * CT log functions *
 426  ********************/
 427
 428 /*
 429  * Creates a new CT log instance with the given |public_key| and |name| and
 430  * associates it with the give library context |libctx| and property query
 431  * string |propq|.
 432  * Takes ownership of |public_key| but copies |name|.
 433  * Returns NULL if malloc fails or if |public_key| cannot be converted to DER.
 434  * Should be deleted by the caller using CTLOG_free when no longer needed.
 435  */
 436 CTLOG *CTLOG_new_ex(EVP_PKEY *public_key, const char *name, OSSL_LIB_CTX *libctx,
 437                     const char *propq);
 438
 439 /*
 440  * The same as CTLOG_new_ex except that the default library context and
 441  * property query string are used.
 442  */
 443 CTLOG *CTLOG_new(EVP_PKEY *public_key, const char *name);
 444
 445 /*
 446  * Creates a new CTLOG instance with the base64-encoded SubjectPublicKeyInfo DER
 447  * in |pkey_base64| and associated with the given library context |libctx| and
 448  * property query string |propq|. The |name| is a string to help users identify
 449  * this log.
 450  * Returns 1 on success, 0 on failure.
 451  * Should be deleted by the caller using CTLOG_free when no longer needed.
 452  */
 453 int CTLOG_new_from_base64_ex(CTLOG **ct_log, const char *pkey_base64,
 454                              const char *name, OSSL_LIB_CTX *libctx,
 455                              const char *propq);
 456
 457 /*
 458  * The same as CTLOG_new_from_base64_ex() except that the default
 459  * library context and property query string are used.
 460  * Returns 1 on success, 0 on failure.
 461  */
 462 int CTLOG_new_from_base64(CTLOG ** ct_log,
 463                           const char *pkey_base64, const char *name);
 464
 465 /*
 466  * Deletes a CT log instance and its fields.
 467  */
 468 void CTLOG_free(CTLOG *log);
 469
 470 /* Gets the name of the CT log */
 471 const char *CTLOG_get0_name(const CTLOG *log);
 472 /* Gets the ID of the CT log */
 473 void CTLOG_get0_log_id(const CTLOG *log, const uint8_t **log_id,
 474                        size_t *log_id_len);
 475 /* Gets the public key of the CT log */
 476 EVP_PKEY *CTLOG_get0_public_key(const CTLOG *log);
 477
 478 /**************************
 479  * CT log store functions *
 480  **************************/
 481
 482 /*
 483  * Creates a new CT log store and associates it with the given libctx and
 484  * property query string.
 485  * Should be deleted by the caller using CTLOG_STORE_free when no longer needed.
 486  */
 487 CTLOG_STORE *CTLOG_STORE_new_ex(OSSL_LIB_CTX *libctx, const char *propq);
 488
 489 /*
 490  * Same as CTLOG_STORE_new_ex except that the default libctx and
 491  * property query string are used.
 492  * Should be deleted by the caller using CTLOG_STORE_free when no longer needed.
 493  */
 494 CTLOG_STORE *CTLOG_STORE_new(void);
 495
 496 /*
 497  * Deletes a CT log store and all of the CT log instances held within.
 498  */
 499 void CTLOG_STORE_free(CTLOG_STORE *store);
 500
 501 /*
 502  * Finds a CT log in the store based on its log ID.
 503  * Returns the CT log, or NULL if no match is found.
 504  */
 505 const CTLOG *CTLOG_STORE_get0_log_by_id(const CTLOG_STORE *store,
 506                                         const uint8_t *log_id,
 507                                         size_t log_id_len);
 508
 509 /*
 510  * Loads a CT log list into a |store| from a |file|.
 511  * Returns 1 if loading is successful, or 0 otherwise.
 512  */
 513 __owur int CTLOG_STORE_load_file(CTLOG_STORE *store, const char *file);
 514
 515 /*
 516  * Loads the default CT log list into a |store|.
 517  * Returns 1 if loading is successful, or 0 otherwise.
 518  */
 519 __owur int CTLOG_STORE_load_default_file(CTLOG_STORE *store);
 520
 521 #  ifdef  __cplusplus
 522 }
 523 #  endif
 524 # endif
 525 #endif