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