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