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