]>
Commit | Line | Data |
---|---|---|
0cea8832 RP |
1 | /* |
2 | * Public API for Certificate Transparency (CT). | |
3 | * Written by Rob Percival (robpercival@google.com) for the OpenSSL project. | |
4 | */ | |
5 | /* ==================================================================== | |
6 | * Copyright (c) 2016 The OpenSSL Project. All rights reserved. | |
7 | * | |
8 | * Redistribution and use in source and binary forms, with or without | |
9 | * modification, are permitted provided that the following conditions | |
10 | * are met: | |
11 | * | |
12 | * 1. Redistributions of source code must retain the above copyright | |
13 | * notice, this list of conditions and the following disclaimer. | |
14 | * | |
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 | |
18 | * distribution. | |
19 | * | |
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/)" | |
24 | * | |
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. | |
29 | * | |
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. | |
33 | * | |
34 | * 6. Redistributions of any form whatsoever must retain the following | |
35 | * acknowledgment: | |
36 | * "This product includes software developed by the OpenSSL Project | |
37 | * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)" | |
38 | * | |
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 | * ==================================================================== | |
52 | */ | |
53 | ||
54 | #ifdef OPENSSL_NO_CT | |
55 | # error "CT is disabled" | |
56 | #endif | |
57 | ||
58 | #ifndef HEADER_CT_H | |
59 | # define HEADER_CT_H | |
60 | ||
a8d177ac | 61 | # include <openssl/ossl_typ.h> |
0cea8832 RP |
62 | # include <openssl/safestack.h> |
63 | # include <openssl/x509.h> | |
64 | ||
65 | # ifdef __cplusplus | |
66 | extern "C" { | |
67 | # endif | |
68 | ||
69 | /* Minimum RSA key size, from RFC6962 */ | |
70 | # define SCT_MIN_RSA_BITS 2048 | |
71 | ||
72 | /* All hashes are SHA256 in v1 of Certificate Transparency */ | |
73 | # define CT_V1_HASHLEN SHA256_DIGEST_LENGTH | |
74 | ||
75 | typedef enum { | |
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; | |
80 | ||
81 | typedef enum { | |
82 | SCT_VERSION_NOT_SET = -1, | |
83 | SCT_VERSION_V1 = 0 | |
84 | } sct_version_t; | |
85 | ||
8c6afbc5 RP |
86 | typedef enum { |
87 | SCT_SOURCE_UNKNOWN, | |
88 | SCT_SOURCE_TLS_EXTENSION, | |
89 | SCT_SOURCE_X509V3_EXTENSION, | |
90 | SCT_SOURCE_OCSP_STAPLED_RESPONSE | |
91 | } sct_source_t; | |
92 | ||
7d054e5a RP |
93 | typedef enum { |
94 | SCT_VALIDATION_STATUS_NOT_SET, | |
95 | SCT_VALIDATION_STATUS_UNKNOWN_LOG, | |
96 | SCT_VALIDATION_STATUS_VALID, | |
97 | SCT_VALIDATION_STATUS_INVALID, | |
98 | SCT_VALIDATION_STATUS_UNVERIFIED, | |
99 | SCT_VALIDATION_STATUS_UNKNOWN_VERSION | |
100 | } sct_validation_status_t; | |
101 | ||
0cea8832 | 102 | DEFINE_STACK_OF(SCT) |
8c6afbc5 | 103 | DEFINE_STACK_OF(CTLOG) |
0cea8832 | 104 | |
7d054e5a RP |
105 | /****************************************** |
106 | * CT policy evaluation context functions * | |
107 | ******************************************/ | |
108 | ||
109 | /* Creates a new, empty policy evaluation context */ | |
110 | CT_POLICY_EVAL_CTX *CT_POLICY_EVAL_CTX_new(void); | |
111 | ||
112 | /* Deletes a policy evaluation context */ | |
113 | void CT_POLICY_EVAL_CTX_free(CT_POLICY_EVAL_CTX *ctx); | |
114 | ||
115 | /* Gets the peer certificate that the SCTs are for */ | |
116 | X509* CT_POLICY_EVAL_CTX_get0_cert(CT_POLICY_EVAL_CTX *ctx); | |
117 | ||
118 | /* Sets the certificate associated with the received SCTs */ | |
119 | void CT_POLICY_EVAL_CTX_set0_cert(CT_POLICY_EVAL_CTX *ctx, X509 *cert); | |
120 | ||
121 | /* Gets the issuer of the aforementioned certificate */ | |
122 | X509* CT_POLICY_EVAL_CTX_get0_issuer(CT_POLICY_EVAL_CTX *ctx); | |
123 | ||
124 | /* Sets the issuer of the certificate associated with the received SCTs */ | |
125 | void CT_POLICY_EVAL_CTX_set0_issuer(CT_POLICY_EVAL_CTX *ctx, X509 *issuer); | |
126 | ||
127 | /* Gets the CT logs that are trusted sources of SCTs */ | |
128 | CTLOG_STORE *CT_POLICY_EVAL_CTX_get0_log_store(CT_POLICY_EVAL_CTX *ctx); | |
129 | ||
130 | /* Sets the log store that is in use */ | |
131 | void CT_POLICY_EVAL_CTX_set0_log_store(CT_POLICY_EVAL_CTX *ctx, | |
132 | CTLOG_STORE *log_store); | |
133 | ||
134 | /* | |
135 | * A callback for verifying that the received SCTs are sufficient. | |
136 | * Expected to return 1 if they are sufficient, otherwise 0. | |
137 | * May return a negative integer if an error occurs. | |
138 | * A connection should be aborted if the SCTs are deemed insufficient. | |
139 | */ | |
140 | typedef int(*ct_validation_cb)(const CT_POLICY_EVAL_CTX *ctx, | |
141 | const STACK_OF(SCT) *scts, void *arg); | |
142 | /* Returns 0 if there are invalid SCTs */ | |
143 | int CT_verify_no_bad_scts(const CT_POLICY_EVAL_CTX *ctx, | |
144 | const STACK_OF(SCT) *scts, void *arg); | |
145 | /* Returns 0 if there are invalid SCTS or fewer than one valid SCT */ | |
146 | int CT_verify_at_least_one_good_sct(const CT_POLICY_EVAL_CTX *ctx, | |
147 | const STACK_OF(SCT) *scts, void *arg); | |
148 | ||
0cea8832 RP |
149 | /***************** |
150 | * SCT functions * | |
151 | *****************/ | |
152 | ||
153 | /* | |
154 | * Creates a new, blank SCT. | |
155 | * The caller is responsible for calling SCT_free when finished with the SCT. | |
156 | */ | |
157 | SCT *SCT_new(void); | |
158 | ||
8c6afbc5 RP |
159 | /* |
160 | * Creates a new SCT from some base64-encoded strings. | |
161 | * The caller is responsible for calling SCT_free when finished with the SCT. | |
162 | */ | |
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 | ||
0cea8832 RP |
170 | /* |
171 | * Frees the SCT and the underlying data structures. | |
172 | */ | |
173 | void SCT_free(SCT *sct); | |
174 | ||
175 | /* | |
176 | * Free a stack of SCTs, and the underlying SCTs themselves. | |
177 | * Intended to be compatible with X509V3_EXT_FREE. | |
178 | */ | |
179 | void SCT_LIST_free(STACK_OF(SCT) *a); | |
180 | ||
181 | /* | |
182 | * Returns the version of the SCT. | |
183 | */ | |
184 | sct_version_t SCT_get_version(const SCT *sct); | |
185 | ||
186 | /* | |
187 | * Set the version of an SCT. | |
188 | * Returns 1 on success, 0 if the version is unrecognized. | |
189 | */ | |
5da65ef2 | 190 | __owur int SCT_set_version(SCT *sct, sct_version_t version); |
0cea8832 RP |
191 | |
192 | /* | |
193 | * Returns the log entry type of the SCT. | |
194 | */ | |
195 | ct_log_entry_type_t SCT_get_log_entry_type(const SCT *sct); | |
196 | ||
197 | /* | |
198 | * Set the log entry type of an SCT. | |
5da65ef2 | 199 | * Returns 1 on success, 0 otherwise. |
0cea8832 | 200 | */ |
5da65ef2 | 201 | __owur int SCT_set_log_entry_type(SCT *sct, ct_log_entry_type_t entry_type); |
0cea8832 RP |
202 | |
203 | /* | |
204 | * Gets the ID of the log that an SCT came from. | |
205 | * Ownership of the log ID remains with the SCT. | |
206 | * Returns the length of the log ID. | |
207 | */ | |
208 | size_t SCT_get0_log_id(const SCT *sct, unsigned char **log_id); | |
209 | ||
210 | /* | |
211 | * Set the log ID of an SCT to point directly to the *log_id specified. | |
212 | * The SCT takes ownership of the specified pointer. | |
5da65ef2 | 213 | * Returns 1 on success, 0 otherwise. |
0cea8832 | 214 | */ |
5da65ef2 | 215 | __owur int SCT_set0_log_id(SCT *sct, unsigned char *log_id, size_t log_id_len); |
0cea8832 RP |
216 | |
217 | /* | |
218 | * Set the log ID of an SCT. | |
219 | * This makes a copy of the log_id. | |
5da65ef2 | 220 | * Returns 1 on success, 0 otherwise. |
0cea8832 | 221 | */ |
5da65ef2 RP |
222 | __owur int SCT_set1_log_id(SCT *sct, const unsigned char *log_id, |
223 | size_t log_id_len); | |
0cea8832 RP |
224 | |
225 | /* | |
226 | * Returns the timestamp for the SCT (epoch time in milliseconds). | |
227 | */ | |
228 | uint64_t SCT_get_timestamp(const SCT *sct); | |
229 | ||
230 | /* | |
231 | * Set the timestamp of an SCT (epoch time in milliseconds). | |
232 | */ | |
233 | void SCT_set_timestamp(SCT *sct, uint64_t timestamp); | |
234 | ||
235 | /* | |
236 | * Return the NID for the signature used by the SCT. | |
237 | * For CT v1, this will be either NID_sha256WithRSAEncryption or | |
238 | * NID_ecdsa_with_SHA256 (or NID_undef if incorrect/unset). | |
239 | */ | |
240 | int SCT_get_signature_nid(const SCT *sct); | |
241 | ||
242 | /* | |
243 | * Set the signature type of an SCT | |
244 | * For CT v1, this should be either NID_sha256WithRSAEncryption or | |
245 | * NID_ecdsa_with_SHA256. | |
5da65ef2 | 246 | * Returns 1 on success, 0 otherwise. |
0cea8832 | 247 | */ |
5da65ef2 | 248 | __owur int SCT_set_signature_nid(SCT *sct, int nid); |
0cea8832 RP |
249 | |
250 | /* | |
251 | * Set *ext to point to the extension data for the SCT. ext must not be NULL. | |
252 | * The SCT retains ownership of this pointer. | |
253 | * Returns length of the data pointed to. | |
254 | */ | |
255 | size_t SCT_get0_extensions(const SCT *sct, unsigned char **ext); | |
256 | ||
257 | /* | |
258 | * Set the extensions of an SCT to point directly to the *ext specified. | |
259 | * The SCT takes ownership of the specified pointer. | |
260 | */ | |
261 | void SCT_set0_extensions(SCT *sct, unsigned char *ext, size_t ext_len); | |
262 | ||
263 | /* | |
264 | * Set the extensions of an SCT. | |
265 | * This takes a copy of the ext. | |
5da65ef2 | 266 | * Returns 1 on success, 0 otherwise. |
0cea8832 | 267 | */ |
5da65ef2 RP |
268 | __owur int SCT_set1_extensions(SCT *sct, const unsigned char *ext, |
269 | size_t ext_len); | |
0cea8832 RP |
270 | |
271 | /* | |
272 | * Set *sig to point to the signature for the SCT. sig must not be NULL. | |
273 | * The SCT retains ownership of this pointer. | |
274 | * Returns length of the data pointed to. | |
275 | */ | |
276 | size_t SCT_get0_signature(const SCT *sct, unsigned char **sig); | |
277 | ||
278 | /* | |
279 | * Set the signature of an SCT to point directly to the *sig specified. | |
280 | * The SCT takes ownership of the specified pointer. | |
281 | */ | |
282 | void SCT_set0_signature(SCT *sct, unsigned char *sig, size_t sig_len); | |
283 | ||
284 | /* | |
285 | * Set the signature of an SCT to be a copy of the *sig specified. | |
5da65ef2 | 286 | * Returns 1 on success, 0 otherwise. |
0cea8832 | 287 | */ |
5da65ef2 RP |
288 | __owur int SCT_set1_signature(SCT *sct, const unsigned char *sig, |
289 | size_t sig_len); | |
0cea8832 | 290 | |
8c6afbc5 RP |
291 | /* |
292 | * The origin of this SCT, e.g. TLS extension, OCSP response, etc. | |
293 | */ | |
294 | sct_source_t SCT_get_source(const SCT *sct); | |
295 | ||
296 | /* | |
297 | * Set the origin of this SCT, e.g. TLS extension, OCSP response, etc. | |
298 | * Returns 1 on success, 0 otherwise. | |
299 | */ | |
5da65ef2 | 300 | __owur int SCT_set_source(SCT *sct, sct_source_t source); |
8c6afbc5 | 301 | |
0cea8832 RP |
302 | /* |
303 | * Pretty-prints an |sct| to |out|. | |
304 | * It will be indented by the number of spaces specified by |indent|. | |
8359b57f RP |
305 | * If |log| is not NULL: |
306 | * - it should be the CT log that the SCT came from. | |
307 | * - its name will be printed. | |
0cea8832 | 308 | */ |
8359b57f | 309 | void SCT_print(const SCT *sct, BIO *out, int indent, const CTLOG *log); |
0cea8832 RP |
310 | |
311 | /* | |
312 | * Pretty-prints an |sct_list| to |out|. | |
313 | * It will be indented by the number of spaces specified by |indent|. | |
314 | * SCTs will be delimited by |separator|. | |
8359b57f RP |
315 | * If |logs| is not NULL, it will be used to lookup the CT log that each SCT |
316 | * came from, so that the log names can be printed. | |
0cea8832 RP |
317 | */ |
318 | void SCT_LIST_print(const STACK_OF(SCT) *sct_list, BIO *out, int indent, | |
8359b57f | 319 | const char *separator, const CTLOG_STORE *logs); |
0cea8832 | 320 | |
8c6afbc5 RP |
321 | /* |
322 | * Verifies an SCT with the given context. | |
70073f3e | 323 | * Returns 1 if the SCT verifies successfully, 0 otherwise. |
8c6afbc5 | 324 | */ |
5da65ef2 | 325 | __owur int SCT_verify(const SCT_CTX *sctx, const SCT *sct); |
8c6afbc5 RP |
326 | |
327 | /* | |
328 | * Verifies an SCT against the provided data. | |
70073f3e | 329 | * Returns 1 if the SCT verifies successfully, 0 otherwise. |
8c6afbc5 | 330 | */ |
5da65ef2 | 331 | __owur int SCT_verify_v1(SCT *sct, X509 *cert, X509 *preissuer, |
8c6afbc5 RP |
332 | X509_PUBKEY *log_pubkey, X509 *issuer_cert); |
333 | ||
7d054e5a RP |
334 | /* |
335 | * Gets the last result of validating this SCT. | |
336 | * If it has not been validated yet, returns SCT_VALIDATION_STATUS_NOT_SET. | |
337 | */ | |
338 | sct_validation_status_t SCT_get_validation_status(const SCT *sct); | |
339 | ||
340 | /* | |
341 | * Validates the given SCT with the provided context. | |
342 | * Sets the "validation_status" field of the SCT. | |
343 | * Returns 1 if the SCT is valid and the signature verifies. | |
344 | * Returns 0 if the SCT is invalid or could not be verified. | |
345 | * Returns -1 if an error occurs. | |
346 | */ | |
5da65ef2 | 347 | __owur int SCT_validate(SCT *sct, const CT_POLICY_EVAL_CTX *ctx); |
7d054e5a RP |
348 | |
349 | /* | |
350 | * Validates the given list of SCTs with the provided context. | |
351 | * Populates the "good_scts" and "bad_scts" of the evaluation context. | |
352 | * Returns 1 if there are no invalid SCTs and all signatures verify. | |
353 | * Returns 0 if at least one SCT is invalid or could not be verified. | |
354 | * Returns a negative integer if an error occurs. | |
355 | */ | |
5da65ef2 RP |
356 | __owur int SCT_LIST_validate(const STACK_OF(SCT) *scts, |
357 | CT_POLICY_EVAL_CTX *ctx); | |
7d054e5a RP |
358 | |
359 | ||
0cea8832 RP |
360 | /********************************* |
361 | * SCT parsing and serialisation * | |
362 | *********************************/ | |
363 | ||
364 | /* | |
365 | * Serialize (to TLS format) a stack of SCTs and return the length. | |
366 | * "a" must not be NULL. | |
367 | * If "pp" is NULL, just return the length of what would have been serialized. | |
368 | * If "pp" is not NULL and "*pp" is null, function will allocate a new pointer | |
369 | * for data that caller is responsible for freeing (only if function returns | |
370 | * successfully). | |
371 | * If "pp" is NULL and "*pp" is not NULL, caller is responsible for ensuring | |
372 | * that "*pp" is large enough to accept all of the serializied data. | |
373 | * Returns < 0 on error, >= 0 indicating bytes written (or would have been) | |
374 | * on success. | |
375 | */ | |
5da65ef2 | 376 | __owur int i2o_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp); |
0cea8832 RP |
377 | |
378 | /* | |
379 | * Convert TLS format SCT list to a stack of SCTs. | |
380 | * If "a" or "*a" is NULL, a new stack will be created that the caller is | |
381 | * responsible for freeing (by calling SCT_LIST_free). | |
382 | * "**pp" and "*pp" must not be NULL. | |
383 | * Upon success, "*pp" will point to after the last bytes read, and a stack | |
384 | * will be returned. | |
385 | * Upon failure, a NULL pointer will be returned, and the position of "*pp" is | |
386 | * not defined. | |
387 | */ | |
388 | STACK_OF(SCT) *o2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp, | |
389 | size_t len); | |
390 | ||
391 | /* | |
392 | * Serialize (to DER format) a stack of SCTs and return the length. | |
393 | * "a" must not be NULL. | |
394 | * If "pp" is NULL, just returns the length of what would have been serialized. | |
395 | * If "pp" is not NULL and "*pp" is null, function will allocate a new pointer | |
396 | * for data that caller is responsible for freeing (only if function returns | |
397 | * successfully). | |
398 | * If "pp" is NULL and "*pp" is not NULL, caller is responsible for ensuring | |
399 | * that "*pp" is large enough to accept all of the serializied data. | |
400 | * Returns < 0 on error, >= 0 indicating bytes written (or would have been) | |
401 | * on success. | |
402 | */ | |
eac84e81 | 403 | __owur int i2d_SCT_LIST(const STACK_OF(SCT) *a, unsigned char **pp); |
0cea8832 RP |
404 | |
405 | /* | |
406 | * Parses an SCT list in DER format and returns it. | |
407 | * If "a" or "*a" is NULL, a new stack will be created that the caller is | |
408 | * responsible for freeing (by calling SCT_LIST_free). | |
409 | * "**pp" and "*pp" must not be NULL. | |
410 | * Upon success, "*pp" will point to after the last bytes read, and a stack | |
411 | * will be returned. | |
412 | * Upon failure, a NULL pointer will be returned, and the position of "*pp" is | |
413 | * not defined. | |
414 | */ | |
415 | STACK_OF(SCT) *d2i_SCT_LIST(STACK_OF(SCT) **a, const unsigned char **pp, | |
416 | long len); | |
417 | ||
418 | /* | |
419 | * Serialize (to TLS format) an |sct| and write it to |out|. | |
420 | * If |out| is null, no SCT will be output but the length will still be returned. | |
421 | * If |out| points to a null pointer, a string will be allocated to hold the | |
422 | * TLS-format SCT. It is the responsibility of the caller to free it. | |
423 | * If |out| points to an allocated string, the TLS-format SCT will be written | |
424 | * to it. | |
425 | * The length of the SCT in TLS format will be returned. | |
426 | */ | |
5da65ef2 | 427 | __owur int i2o_SCT(const SCT *sct, unsigned char **out); |
0cea8832 RP |
428 | |
429 | /* | |
430 | * Parses an SCT in TLS format and returns it. | |
431 | * If |psct| is not null, it will end up pointing to the parsed SCT. If it | |
432 | * already points to a non-null pointer, the pointer will be free'd. | |
433 | * |in| should be a pointer to a string contianing the TLS-format SCT. | |
434 | * |in| will be advanced to the end of the SCT if parsing succeeds. | |
435 | * |len| should be the length of the SCT in |in|. | |
436 | * Returns NULL if an error occurs. | |
437 | * If the SCT is an unsupported version, only the SCT's 'sct' and 'sct_len' | |
438 | * fields will be populated (with |in| and |len| respectively). | |
439 | */ | |
440 | SCT *o2i_SCT(SCT **psct, const unsigned char **in, size_t len); | |
441 | ||
442 | /* | |
443 | * Serialize (to TLS format) an |sct| signature and write it to |out|. | |
444 | * If |out| is null, no signature will be output but the length will be returned. | |
445 | * If |out| points to a null pointer, a string will be allocated to hold the | |
446 | * TLS-format signature. It is the responsibility of the caller to free it. | |
447 | * If |out| points to an allocated string, the signature will be written to it. | |
448 | * The length of the signature in TLS format will be returned. | |
449 | */ | |
5da65ef2 | 450 | __owur int i2o_SCT_signature(const SCT *sct, unsigned char **out); |
0cea8832 RP |
451 | |
452 | /* | |
453 | * Parses an SCT signature in TLS format and populates the |sct| with it. | |
454 | * |in| should be a pointer to a string contianing the TLS-format signature. | |
455 | * |in| will be advanced to the end of the signature if parsing succeeds. | |
456 | * |len| should be the length of the signature in |in|. | |
457 | * Returns the number of bytes parsed, or a negative integer if an error occurs. | |
458 | */ | |
5da65ef2 | 459 | __owur int o2i_SCT_signature(SCT *sct, const unsigned char **in, size_t len); |
0cea8832 | 460 | |
8c6afbc5 RP |
461 | /******************** |
462 | * CT log functions * | |
463 | ********************/ | |
464 | ||
465 | /* | |
466 | * Creates a new CT log instance with the given |public_key| and |name|. | |
467 | * Should be deleted by the caller using CTLOG_free when no longer needed. | |
468 | */ | |
469 | CTLOG *CTLOG_new(EVP_PKEY *public_key, const char *name); | |
470 | ||
471 | /* | |
472 | * Creates a new, blank CT log instance. | |
473 | * Should be deleted by the caller using CTLOG_free when no longer needed. | |
474 | */ | |
475 | CTLOG *CTLOG_new_null(void); | |
476 | ||
477 | /* | |
478 | * Creates a new CT log instance with the given base64 public_key and |name|. | |
479 | * Should be deleted by the caller using CTLOG_free when no longer needed. | |
480 | */ | |
481 | CTLOG *CTLOG_new_from_base64(const char *pkey_base64, const char *name); | |
482 | ||
483 | /* | |
484 | * Deletes a CT log instance and its fields. | |
485 | */ | |
486 | void CTLOG_free(CTLOG *log); | |
487 | ||
488 | /* Gets the name of the CT log */ | |
8c92c4ea | 489 | const char *CTLOG_get0_name(const CTLOG *log); |
8c6afbc5 | 490 | /* Gets the ID of the CT log */ |
8c92c4ea RP |
491 | void CTLOG_get0_log_id(const CTLOG *log, const uint8_t **log_id, |
492 | size_t *log_id_len); | |
8c6afbc5 | 493 | /* Gets the public key of the CT log */ |
8c92c4ea | 494 | EVP_PKEY *CTLOG_get0_public_key(const CTLOG *log); |
8c6afbc5 RP |
495 | |
496 | /************************** | |
497 | * CT log store functions * | |
498 | **************************/ | |
499 | ||
500 | /* | |
501 | * Creates a new CT log store. | |
502 | * Should be deleted by the caller using CTLOG_STORE_free when no longer needed. | |
503 | */ | |
504 | CTLOG_STORE *CTLOG_STORE_new(void); | |
505 | ||
506 | /* | |
507 | * Deletes a CT log store and all of the CT log instances held within. | |
508 | */ | |
509 | void CTLOG_STORE_free(CTLOG_STORE *store); | |
510 | ||
511 | /* | |
512 | * Finds a CT log in the store based on its log ID. | |
513 | * Returns the CT log, or NULL if no match is found. | |
514 | */ | |
12d2d281 RP |
515 | const CTLOG *CTLOG_STORE_get0_log_by_id(const CTLOG_STORE *store, |
516 | const uint8_t *log_id, | |
517 | size_t log_id_len); | |
8c6afbc5 RP |
518 | |
519 | /* | |
520 | * Loads a CT log list into a |store| from a |file|. | |
a930afb6 | 521 | * Returns 1 if loading is successful, or 0 otherwise. |
8c6afbc5 | 522 | */ |
5da65ef2 | 523 | __owur int CTLOG_STORE_load_file(CTLOG_STORE *store, const char *file); |
8c6afbc5 RP |
524 | |
525 | /* | |
526 | * Loads the default CT log list into a |store|. | |
527 | * See internal/cryptlib.h for the environment variable and file path that are | |
528 | * consulted to find the default file. | |
a930afb6 | 529 | * Returns 1 if loading is successful, or 0 otherwise. |
8c6afbc5 | 530 | */ |
5da65ef2 | 531 | __owur int CTLOG_STORE_load_default_file(CTLOG_STORE *store); |
8c6afbc5 | 532 | |
0cea8832 RP |
533 | /* BEGIN ERROR CODES */ |
534 | /* | |
535 | * The following lines are auto generated by the script mkerr.pl. Any changes | |
536 | * made after this point may be overwritten when the script is next run. | |
537 | */ | |
538 | void ERR_load_CT_strings(void); | |
539 | ||
540 | /* Error codes for the CT functions. */ | |
541 | ||
542 | /* Function codes. */ | |
8c6afbc5 RP |
543 | # define CT_F_CTLOG_NEW 117 |
544 | # define CT_F_CTLOG_NEW_FROM_BASE64 118 | |
545 | # define CT_F_CTLOG_NEW_FROM_CONF 119 | |
546 | # define CT_F_CTLOG_NEW_NULL 120 | |
547 | # define CT_F_CTLOG_STORE_GET0_LOG_BY_ID 121 | |
548 | # define CT_F_CTLOG_STORE_LOAD_CTX_NEW 122 | |
549 | # define CT_F_CTLOG_STORE_LOAD_FILE 123 | |
550 | # define CT_F_CT_BASE64_DECODE 124 | |
7d054e5a RP |
551 | # define CT_F_CT_POLICY_EVAL_CTX_GET0_CERT 130 |
552 | # define CT_F_CT_POLICY_EVAL_CTX_GET0_ISSUER 131 | |
553 | # define CT_F_CT_POLICY_EVAL_CTX_GET0_LOG_STORE 132 | |
554 | # define CT_F_CT_POLICY_EVAL_CTX_NEW 133 | |
555 | # define CT_F_CT_POLICY_EVAL_CTX_SET0_CERT 134 | |
556 | # define CT_F_CT_POLICY_EVAL_CTX_SET0_ISSUER 135 | |
557 | # define CT_F_CT_POLICY_EVAL_CTX_SET0_LOG_STORE 136 | |
8c6afbc5 | 558 | # define CT_F_CT_V1_LOG_ID_FROM_PKEY 125 |
7d054e5a RP |
559 | # define CT_F_CT_VERIFY_AT_LEAST_ONE_GOOD_SCT 137 |
560 | # define CT_F_CT_VERIFY_NO_BAD_SCTS 138 | |
0cea8832 RP |
561 | # define CT_F_D2I_SCT_LIST 105 |
562 | # define CT_F_I2D_SCT_LIST 106 | |
563 | # define CT_F_I2O_SCT 107 | |
564 | # define CT_F_I2O_SCT_LIST 108 | |
565 | # define CT_F_I2O_SCT_SIGNATURE 109 | |
566 | # define CT_F_O2I_SCT 110 | |
567 | # define CT_F_O2I_SCT_LIST 111 | |
568 | # define CT_F_O2I_SCT_SIGNATURE 112 | |
8c6afbc5 | 569 | # define CT_F_SCT_CTX_NEW 126 |
7d054e5a | 570 | # define CT_F_SCT_LIST_VALIDATE 139 |
0cea8832 | 571 | # define CT_F_SCT_NEW 100 |
8c6afbc5 | 572 | # define CT_F_SCT_NEW_FROM_BASE64 127 |
0cea8832 RP |
573 | # define CT_F_SCT_SET0_LOG_ID 101 |
574 | # define CT_F_SCT_SET1_EXTENSIONS 114 | |
575 | # define CT_F_SCT_SET1_LOG_ID 115 | |
576 | # define CT_F_SCT_SET1_SIGNATURE 116 | |
577 | # define CT_F_SCT_SET_LOG_ENTRY_TYPE 102 | |
578 | # define CT_F_SCT_SET_SIGNATURE_NID 103 | |
579 | # define CT_F_SCT_SET_VERSION 104 | |
580 | # define CT_F_SCT_SIGNATURE_IS_VALID 113 | |
7d054e5a | 581 | # define CT_F_SCT_VALIDATE 140 |
8c6afbc5 RP |
582 | # define CT_F_SCT_VERIFY 128 |
583 | # define CT_F_SCT_VERIFY_V1 129 | |
0cea8832 RP |
584 | |
585 | /* Reason codes. */ | |
8c6afbc5 | 586 | # define CT_R_BASE64_DECODE_ERROR 108 |
0cea8832 | 587 | # define CT_R_INVALID_LOG_ID_LENGTH 100 |
8c6afbc5 RP |
588 | # define CT_R_LOG_CONF_INVALID 109 |
589 | # define CT_R_LOG_CONF_INVALID_KEY 110 | |
590 | # define CT_R_LOG_CONF_MISSING_DESCRIPTION 111 | |
591 | # define CT_R_LOG_CONF_MISSING_KEY 112 | |
592 | # define CT_R_LOG_KEY_INVALID 113 | |
7d054e5a | 593 | # define CT_R_NOT_ENOUGH_SCTS 116 |
0cea8832 RP |
594 | # define CT_R_SCT_INVALID 104 |
595 | # define CT_R_SCT_INVALID_SIGNATURE 107 | |
596 | # define CT_R_SCT_LIST_INVALID 105 | |
8c6afbc5 | 597 | # define CT_R_SCT_LOG_ID_MISMATCH 114 |
0cea8832 | 598 | # define CT_R_SCT_NOT_SET 106 |
8c6afbc5 | 599 | # define CT_R_SCT_UNSUPPORTED_VERSION 115 |
7d054e5a | 600 | # define CT_R_SCT_VALIDATION_STATUS_NOT_SET 117 |
0cea8832 RP |
601 | # define CT_R_UNRECOGNIZED_SIGNATURE_NID 101 |
602 | # define CT_R_UNSUPPORTED_ENTRY_TYPE 102 | |
603 | # define CT_R_UNSUPPORTED_VERSION 103 | |
604 | ||
605 | #ifdef __cplusplus | |
606 | } | |
607 | #endif | |
608 | #endif |