1 | /*
|
---|
2 | * Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.
|
---|
3 | *
|
---|
4 | * Licensed under the Apache License 2.0 (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 OPENSSL_TS_H
|
---|
11 | # define OPENSSL_TS_H
|
---|
12 | # pragma once
|
---|
13 |
|
---|
14 | # include <openssl/macros.h>
|
---|
15 | # ifndef OPENSSL_NO_DEPRECATED_3_0
|
---|
16 | # define HEADER_TS_H
|
---|
17 | # endif
|
---|
18 |
|
---|
19 | # include <openssl/opensslconf.h>
|
---|
20 |
|
---|
21 | # ifndef OPENSSL_NO_TS
|
---|
22 | # include <openssl/symhacks.h>
|
---|
23 | # include <openssl/buffer.h>
|
---|
24 | # include <openssl/evp.h>
|
---|
25 | # include <openssl/bio.h>
|
---|
26 | # include <openssl/asn1.h>
|
---|
27 | # include <openssl/safestack.h>
|
---|
28 | # include <openssl/rsa.h>
|
---|
29 | # include <openssl/dsa.h>
|
---|
30 | # include <openssl/dh.h>
|
---|
31 | # include <openssl/tserr.h>
|
---|
32 | # include <openssl/ess.h>
|
---|
33 | # ifdef __cplusplus
|
---|
34 | extern "C" {
|
---|
35 | # endif
|
---|
36 |
|
---|
37 | # include <openssl/x509.h>
|
---|
38 | # include <openssl/x509v3.h>
|
---|
39 |
|
---|
40 | typedef struct TS_msg_imprint_st TS_MSG_IMPRINT;
|
---|
41 | typedef struct TS_req_st TS_REQ;
|
---|
42 | typedef struct TS_accuracy_st TS_ACCURACY;
|
---|
43 | typedef struct TS_tst_info_st TS_TST_INFO;
|
---|
44 |
|
---|
45 | /* Possible values for status. */
|
---|
46 | # define TS_STATUS_GRANTED 0
|
---|
47 | # define TS_STATUS_GRANTED_WITH_MODS 1
|
---|
48 | # define TS_STATUS_REJECTION 2
|
---|
49 | # define TS_STATUS_WAITING 3
|
---|
50 | # define TS_STATUS_REVOCATION_WARNING 4
|
---|
51 | # define TS_STATUS_REVOCATION_NOTIFICATION 5
|
---|
52 |
|
---|
53 | /* Possible values for failure_info. */
|
---|
54 | # define TS_INFO_BAD_ALG 0
|
---|
55 | # define TS_INFO_BAD_REQUEST 2
|
---|
56 | # define TS_INFO_BAD_DATA_FORMAT 5
|
---|
57 | # define TS_INFO_TIME_NOT_AVAILABLE 14
|
---|
58 | # define TS_INFO_UNACCEPTED_POLICY 15
|
---|
59 | # define TS_INFO_UNACCEPTED_EXTENSION 16
|
---|
60 | # define TS_INFO_ADD_INFO_NOT_AVAILABLE 17
|
---|
61 | # define TS_INFO_SYSTEM_FAILURE 25
|
---|
62 |
|
---|
63 |
|
---|
64 | typedef struct TS_status_info_st TS_STATUS_INFO;
|
---|
65 |
|
---|
66 | typedef struct TS_resp_st TS_RESP;
|
---|
67 |
|
---|
68 | DECLARE_ASN1_ALLOC_FUNCTIONS(TS_REQ)
|
---|
69 | DECLARE_ASN1_ENCODE_FUNCTIONS_only(TS_REQ, TS_REQ)
|
---|
70 | DECLARE_ASN1_DUP_FUNCTION(TS_REQ)
|
---|
71 |
|
---|
72 | #ifndef OPENSSL_NO_STDIO
|
---|
73 | TS_REQ *d2i_TS_REQ_fp(FILE *fp, TS_REQ **a);
|
---|
74 | int i2d_TS_REQ_fp(FILE *fp, const TS_REQ *a);
|
---|
75 | #endif
|
---|
76 | TS_REQ *d2i_TS_REQ_bio(BIO *fp, TS_REQ **a);
|
---|
77 | int i2d_TS_REQ_bio(BIO *fp, const TS_REQ *a);
|
---|
78 |
|
---|
79 | DECLARE_ASN1_ALLOC_FUNCTIONS(TS_MSG_IMPRINT)
|
---|
80 | DECLARE_ASN1_ENCODE_FUNCTIONS_only(TS_MSG_IMPRINT, TS_MSG_IMPRINT)
|
---|
81 | DECLARE_ASN1_DUP_FUNCTION(TS_MSG_IMPRINT)
|
---|
82 |
|
---|
83 | #ifndef OPENSSL_NO_STDIO
|
---|
84 | TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT **a);
|
---|
85 | int i2d_TS_MSG_IMPRINT_fp(FILE *fp, const TS_MSG_IMPRINT *a);
|
---|
86 | #endif
|
---|
87 | TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT **a);
|
---|
88 | int i2d_TS_MSG_IMPRINT_bio(BIO *bio, const TS_MSG_IMPRINT *a);
|
---|
89 |
|
---|
90 | DECLARE_ASN1_ALLOC_FUNCTIONS(TS_RESP)
|
---|
91 | DECLARE_ASN1_ENCODE_FUNCTIONS_only(TS_RESP, TS_RESP)
|
---|
92 | DECLARE_ASN1_DUP_FUNCTION(TS_RESP)
|
---|
93 |
|
---|
94 | #ifndef OPENSSL_NO_STDIO
|
---|
95 | TS_RESP *d2i_TS_RESP_fp(FILE *fp, TS_RESP **a);
|
---|
96 | int i2d_TS_RESP_fp(FILE *fp, const TS_RESP *a);
|
---|
97 | #endif
|
---|
98 | TS_RESP *d2i_TS_RESP_bio(BIO *bio, TS_RESP **a);
|
---|
99 | int i2d_TS_RESP_bio(BIO *bio, const TS_RESP *a);
|
---|
100 |
|
---|
101 | DECLARE_ASN1_ALLOC_FUNCTIONS(TS_STATUS_INFO)
|
---|
102 | DECLARE_ASN1_ENCODE_FUNCTIONS_only(TS_STATUS_INFO, TS_STATUS_INFO)
|
---|
103 | DECLARE_ASN1_DUP_FUNCTION(TS_STATUS_INFO)
|
---|
104 |
|
---|
105 | DECLARE_ASN1_ALLOC_FUNCTIONS(TS_TST_INFO)
|
---|
106 | DECLARE_ASN1_ENCODE_FUNCTIONS_only(TS_TST_INFO, TS_TST_INFO)
|
---|
107 | DECLARE_ASN1_DUP_FUNCTION(TS_TST_INFO)
|
---|
108 | TS_TST_INFO *PKCS7_to_TS_TST_INFO(PKCS7 *token);
|
---|
109 |
|
---|
110 | #ifndef OPENSSL_NO_STDIO
|
---|
111 | TS_TST_INFO *d2i_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO **a);
|
---|
112 | int i2d_TS_TST_INFO_fp(FILE *fp, const TS_TST_INFO *a);
|
---|
113 | #endif
|
---|
114 | TS_TST_INFO *d2i_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO **a);
|
---|
115 | int i2d_TS_TST_INFO_bio(BIO *bio, const TS_TST_INFO *a);
|
---|
116 |
|
---|
117 | DECLARE_ASN1_ALLOC_FUNCTIONS(TS_ACCURACY)
|
---|
118 | DECLARE_ASN1_ENCODE_FUNCTIONS_only(TS_ACCURACY, TS_ACCURACY)
|
---|
119 | DECLARE_ASN1_DUP_FUNCTION(TS_ACCURACY)
|
---|
120 |
|
---|
121 | int TS_REQ_set_version(TS_REQ *a, long version);
|
---|
122 | long TS_REQ_get_version(const TS_REQ *a);
|
---|
123 |
|
---|
124 | int TS_STATUS_INFO_set_status(TS_STATUS_INFO *a, int i);
|
---|
125 | const ASN1_INTEGER *TS_STATUS_INFO_get0_status(const TS_STATUS_INFO *a);
|
---|
126 |
|
---|
127 | const STACK_OF(ASN1_UTF8STRING) *
|
---|
128 | TS_STATUS_INFO_get0_text(const TS_STATUS_INFO *a);
|
---|
129 |
|
---|
130 | const ASN1_BIT_STRING *
|
---|
131 | TS_STATUS_INFO_get0_failure_info(const TS_STATUS_INFO *a);
|
---|
132 |
|
---|
133 | int TS_REQ_set_msg_imprint(TS_REQ *a, TS_MSG_IMPRINT *msg_imprint);
|
---|
134 | TS_MSG_IMPRINT *TS_REQ_get_msg_imprint(TS_REQ *a);
|
---|
135 |
|
---|
136 | int TS_MSG_IMPRINT_set_algo(TS_MSG_IMPRINT *a, X509_ALGOR *alg);
|
---|
137 | X509_ALGOR *TS_MSG_IMPRINT_get_algo(TS_MSG_IMPRINT *a);
|
---|
138 |
|
---|
139 | int TS_MSG_IMPRINT_set_msg(TS_MSG_IMPRINT *a, unsigned char *d, int len);
|
---|
140 | ASN1_OCTET_STRING *TS_MSG_IMPRINT_get_msg(TS_MSG_IMPRINT *a);
|
---|
141 |
|
---|
142 | int TS_REQ_set_policy_id(TS_REQ *a, const ASN1_OBJECT *policy);
|
---|
143 | ASN1_OBJECT *TS_REQ_get_policy_id(TS_REQ *a);
|
---|
144 |
|
---|
145 | int TS_REQ_set_nonce(TS_REQ *a, const ASN1_INTEGER *nonce);
|
---|
146 | const ASN1_INTEGER *TS_REQ_get_nonce(const TS_REQ *a);
|
---|
147 |
|
---|
148 | int TS_REQ_set_cert_req(TS_REQ *a, int cert_req);
|
---|
149 | int TS_REQ_get_cert_req(const TS_REQ *a);
|
---|
150 |
|
---|
151 | STACK_OF(X509_EXTENSION) *TS_REQ_get_exts(TS_REQ *a);
|
---|
152 | void TS_REQ_ext_free(TS_REQ *a);
|
---|
153 | int TS_REQ_get_ext_count(TS_REQ *a);
|
---|
154 | int TS_REQ_get_ext_by_NID(TS_REQ *a, int nid, int lastpos);
|
---|
155 | int TS_REQ_get_ext_by_OBJ(TS_REQ *a, const ASN1_OBJECT *obj, int lastpos);
|
---|
156 | int TS_REQ_get_ext_by_critical(TS_REQ *a, int crit, int lastpos);
|
---|
157 | X509_EXTENSION *TS_REQ_get_ext(TS_REQ *a, int loc);
|
---|
158 | X509_EXTENSION *TS_REQ_delete_ext(TS_REQ *a, int loc);
|
---|
159 | int TS_REQ_add_ext(TS_REQ *a, X509_EXTENSION *ex, int loc);
|
---|
160 | void *TS_REQ_get_ext_d2i(TS_REQ *a, int nid, int *crit, int *idx);
|
---|
161 |
|
---|
162 | /* Function declarations for TS_REQ defined in ts/ts_req_print.c */
|
---|
163 |
|
---|
164 | int TS_REQ_print_bio(BIO *bio, TS_REQ *a);
|
---|
165 |
|
---|
166 | /* Function declarations for TS_RESP defined in ts/ts_resp_utils.c */
|
---|
167 |
|
---|
168 | int TS_RESP_set_status_info(TS_RESP *a, TS_STATUS_INFO *info);
|
---|
169 | TS_STATUS_INFO *TS_RESP_get_status_info(TS_RESP *a);
|
---|
170 |
|
---|
171 | /* Caller loses ownership of PKCS7 and TS_TST_INFO objects. */
|
---|
172 | void TS_RESP_set_tst_info(TS_RESP *a, PKCS7 *p7, TS_TST_INFO *tst_info);
|
---|
173 | PKCS7 *TS_RESP_get_token(TS_RESP *a);
|
---|
174 | TS_TST_INFO *TS_RESP_get_tst_info(TS_RESP *a);
|
---|
175 |
|
---|
176 | int TS_TST_INFO_set_version(TS_TST_INFO *a, long version);
|
---|
177 | long TS_TST_INFO_get_version(const TS_TST_INFO *a);
|
---|
178 |
|
---|
179 | int TS_TST_INFO_set_policy_id(TS_TST_INFO *a, ASN1_OBJECT *policy_id);
|
---|
180 | ASN1_OBJECT *TS_TST_INFO_get_policy_id(TS_TST_INFO *a);
|
---|
181 |
|
---|
182 | int TS_TST_INFO_set_msg_imprint(TS_TST_INFO *a, TS_MSG_IMPRINT *msg_imprint);
|
---|
183 | TS_MSG_IMPRINT *TS_TST_INFO_get_msg_imprint(TS_TST_INFO *a);
|
---|
184 |
|
---|
185 | int TS_TST_INFO_set_serial(TS_TST_INFO *a, const ASN1_INTEGER *serial);
|
---|
186 | const ASN1_INTEGER *TS_TST_INFO_get_serial(const TS_TST_INFO *a);
|
---|
187 |
|
---|
188 | int TS_TST_INFO_set_time(TS_TST_INFO *a, const ASN1_GENERALIZEDTIME *gtime);
|
---|
189 | const ASN1_GENERALIZEDTIME *TS_TST_INFO_get_time(const TS_TST_INFO *a);
|
---|
190 |
|
---|
191 | int TS_TST_INFO_set_accuracy(TS_TST_INFO *a, TS_ACCURACY *accuracy);
|
---|
192 | TS_ACCURACY *TS_TST_INFO_get_accuracy(TS_TST_INFO *a);
|
---|
193 |
|
---|
194 | int TS_ACCURACY_set_seconds(TS_ACCURACY *a, const ASN1_INTEGER *seconds);
|
---|
195 | const ASN1_INTEGER *TS_ACCURACY_get_seconds(const TS_ACCURACY *a);
|
---|
196 |
|
---|
197 | int TS_ACCURACY_set_millis(TS_ACCURACY *a, const ASN1_INTEGER *millis);
|
---|
198 | const ASN1_INTEGER *TS_ACCURACY_get_millis(const TS_ACCURACY *a);
|
---|
199 |
|
---|
200 | int TS_ACCURACY_set_micros(TS_ACCURACY *a, const ASN1_INTEGER *micros);
|
---|
201 | const ASN1_INTEGER *TS_ACCURACY_get_micros(const TS_ACCURACY *a);
|
---|
202 |
|
---|
203 | int TS_TST_INFO_set_ordering(TS_TST_INFO *a, int ordering);
|
---|
204 | int TS_TST_INFO_get_ordering(const TS_TST_INFO *a);
|
---|
205 |
|
---|
206 | int TS_TST_INFO_set_nonce(TS_TST_INFO *a, const ASN1_INTEGER *nonce);
|
---|
207 | const ASN1_INTEGER *TS_TST_INFO_get_nonce(const TS_TST_INFO *a);
|
---|
208 |
|
---|
209 | int TS_TST_INFO_set_tsa(TS_TST_INFO *a, GENERAL_NAME *tsa);
|
---|
210 | GENERAL_NAME *TS_TST_INFO_get_tsa(TS_TST_INFO *a);
|
---|
211 |
|
---|
212 | STACK_OF(X509_EXTENSION) *TS_TST_INFO_get_exts(TS_TST_INFO *a);
|
---|
213 | void TS_TST_INFO_ext_free(TS_TST_INFO *a);
|
---|
214 | int TS_TST_INFO_get_ext_count(TS_TST_INFO *a);
|
---|
215 | int TS_TST_INFO_get_ext_by_NID(TS_TST_INFO *a, int nid, int lastpos);
|
---|
216 | int TS_TST_INFO_get_ext_by_OBJ(TS_TST_INFO *a, const ASN1_OBJECT *obj,
|
---|
217 | int lastpos);
|
---|
218 | int TS_TST_INFO_get_ext_by_critical(TS_TST_INFO *a, int crit, int lastpos);
|
---|
219 | X509_EXTENSION *TS_TST_INFO_get_ext(TS_TST_INFO *a, int loc);
|
---|
220 | X509_EXTENSION *TS_TST_INFO_delete_ext(TS_TST_INFO *a, int loc);
|
---|
221 | int TS_TST_INFO_add_ext(TS_TST_INFO *a, X509_EXTENSION *ex, int loc);
|
---|
222 | void *TS_TST_INFO_get_ext_d2i(TS_TST_INFO *a, int nid, int *crit, int *idx);
|
---|
223 |
|
---|
224 | /*
|
---|
225 | * Declarations related to response generation, defined in ts/ts_resp_sign.c.
|
---|
226 | */
|
---|
227 |
|
---|
228 | /* Optional flags for response generation. */
|
---|
229 |
|
---|
230 | /* Don't include the TSA name in response. */
|
---|
231 | # define TS_TSA_NAME 0x01
|
---|
232 |
|
---|
233 | /* Set ordering to true in response. */
|
---|
234 | # define TS_ORDERING 0x02
|
---|
235 |
|
---|
236 | /*
|
---|
237 | * Include the signer certificate and the other specified certificates in
|
---|
238 | * the ESS signing certificate attribute beside the PKCS7 signed data.
|
---|
239 | * Only the signer certificates is included by default.
|
---|
240 | */
|
---|
241 | # define TS_ESS_CERT_ID_CHAIN 0x04
|
---|
242 |
|
---|
243 | /* Forward declaration. */
|
---|
244 | struct TS_resp_ctx;
|
---|
245 |
|
---|
246 | /* This must return a unique number less than 160 bits long. */
|
---|
247 | typedef ASN1_INTEGER *(*TS_serial_cb) (struct TS_resp_ctx *, void *);
|
---|
248 |
|
---|
249 | /*
|
---|
250 | * This must return the seconds and microseconds since Jan 1, 1970 in the sec
|
---|
251 | * and usec variables allocated by the caller. Return non-zero for success
|
---|
252 | * and zero for failure.
|
---|
253 | */
|
---|
254 | typedef int (*TS_time_cb) (struct TS_resp_ctx *, void *, long *sec,
|
---|
255 | long *usec);
|
---|
256 |
|
---|
257 | /*
|
---|
258 | * This must process the given extension. It can modify the TS_TST_INFO
|
---|
259 | * object of the context. Return values: !0 (processed), 0 (error, it must
|
---|
260 | * set the status info/failure info of the response).
|
---|
261 | */
|
---|
262 | typedef int (*TS_extension_cb) (struct TS_resp_ctx *, X509_EXTENSION *,
|
---|
263 | void *);
|
---|
264 |
|
---|
265 | typedef struct TS_resp_ctx TS_RESP_CTX;
|
---|
266 |
|
---|
267 | /* Creates a response context that can be used for generating responses. */
|
---|
268 | TS_RESP_CTX *TS_RESP_CTX_new(void);
|
---|
269 | TS_RESP_CTX *TS_RESP_CTX_new_ex(OSSL_LIB_CTX *libctx, const char *propq);
|
---|
270 | void TS_RESP_CTX_free(TS_RESP_CTX *ctx);
|
---|
271 |
|
---|
272 | /* This parameter must be set. */
|
---|
273 | int TS_RESP_CTX_set_signer_cert(TS_RESP_CTX *ctx, X509 *signer);
|
---|
274 |
|
---|
275 | /* This parameter must be set. */
|
---|
276 | int TS_RESP_CTX_set_signer_key(TS_RESP_CTX *ctx, EVP_PKEY *key);
|
---|
277 |
|
---|
278 | int TS_RESP_CTX_set_signer_digest(TS_RESP_CTX *ctx,
|
---|
279 | const EVP_MD *signer_digest);
|
---|
280 | int TS_RESP_CTX_set_ess_cert_id_digest(TS_RESP_CTX *ctx, const EVP_MD *md);
|
---|
281 |
|
---|
282 | /* This parameter must be set. */
|
---|
283 | int TS_RESP_CTX_set_def_policy(TS_RESP_CTX *ctx, const ASN1_OBJECT *def_policy);
|
---|
284 |
|
---|
285 | /* No additional certs are included in the response by default. */
|
---|
286 | int TS_RESP_CTX_set_certs(TS_RESP_CTX *ctx, STACK_OF(X509) *certs);
|
---|
287 |
|
---|
288 | /*
|
---|
289 | * Adds a new acceptable policy, only the default policy is accepted by
|
---|
290 | * default.
|
---|
291 | */
|
---|
292 | int TS_RESP_CTX_add_policy(TS_RESP_CTX *ctx, const ASN1_OBJECT *policy);
|
---|
293 |
|
---|
294 | /*
|
---|
295 | * Adds a new acceptable message digest. Note that no message digests are
|
---|
296 | * accepted by default. The md argument is shared with the caller.
|
---|
297 | */
|
---|
298 | int TS_RESP_CTX_add_md(TS_RESP_CTX *ctx, const EVP_MD *md);
|
---|
299 |
|
---|
300 | /* Accuracy is not included by default. */
|
---|
301 | int TS_RESP_CTX_set_accuracy(TS_RESP_CTX *ctx,
|
---|
302 | int secs, int millis, int micros);
|
---|
303 |
|
---|
304 | /*
|
---|
305 | * Clock precision digits, i.e. the number of decimal digits: '0' means sec,
|
---|
306 | * '3' msec, '6' usec, and so on. Default is 0.
|
---|
307 | */
|
---|
308 | int TS_RESP_CTX_set_clock_precision_digits(TS_RESP_CTX *ctx,
|
---|
309 | unsigned clock_precision_digits);
|
---|
310 | /* At most we accept usec precision. */
|
---|
311 | # define TS_MAX_CLOCK_PRECISION_DIGITS 6
|
---|
312 |
|
---|
313 | /* Maximum status message length */
|
---|
314 | # define TS_MAX_STATUS_LENGTH (1024 * 1024)
|
---|
315 |
|
---|
316 | /* No flags are set by default. */
|
---|
317 | void TS_RESP_CTX_add_flags(TS_RESP_CTX *ctx, int flags);
|
---|
318 |
|
---|
319 | /* Default callback always returns a constant. */
|
---|
320 | void TS_RESP_CTX_set_serial_cb(TS_RESP_CTX *ctx, TS_serial_cb cb, void *data);
|
---|
321 |
|
---|
322 | /* Default callback uses the gettimeofday() and gmtime() system calls. */
|
---|
323 | void TS_RESP_CTX_set_time_cb(TS_RESP_CTX *ctx, TS_time_cb cb, void *data);
|
---|
324 |
|
---|
325 | /*
|
---|
326 | * Default callback rejects all extensions. The extension callback is called
|
---|
327 | * when the TS_TST_INFO object is already set up and not signed yet.
|
---|
328 | */
|
---|
329 | /* FIXME: extension handling is not tested yet. */
|
---|
330 | void TS_RESP_CTX_set_extension_cb(TS_RESP_CTX *ctx,
|
---|
331 | TS_extension_cb cb, void *data);
|
---|
332 |
|
---|
333 | /* The following methods can be used in the callbacks. */
|
---|
334 | int TS_RESP_CTX_set_status_info(TS_RESP_CTX *ctx,
|
---|
335 | int status, const char *text);
|
---|
336 |
|
---|
337 | /* Sets the status info only if it is still TS_STATUS_GRANTED. */
|
---|
338 | int TS_RESP_CTX_set_status_info_cond(TS_RESP_CTX *ctx,
|
---|
339 | int status, const char *text);
|
---|
340 |
|
---|
341 | int TS_RESP_CTX_add_failure_info(TS_RESP_CTX *ctx, int failure);
|
---|
342 |
|
---|
343 | /* The get methods below can be used in the extension callback. */
|
---|
344 | TS_REQ *TS_RESP_CTX_get_request(TS_RESP_CTX *ctx);
|
---|
345 |
|
---|
346 | TS_TST_INFO *TS_RESP_CTX_get_tst_info(TS_RESP_CTX *ctx);
|
---|
347 |
|
---|
348 | /*
|
---|
349 | * Creates the signed TS_TST_INFO and puts it in TS_RESP.
|
---|
350 | * In case of errors it sets the status info properly.
|
---|
351 | * Returns NULL only in case of memory allocation/fatal error.
|
---|
352 | */
|
---|
353 | TS_RESP *TS_RESP_create_response(TS_RESP_CTX *ctx, BIO *req_bio);
|
---|
354 |
|
---|
355 | /*
|
---|
356 | * Declarations related to response verification,
|
---|
357 | * they are defined in ts/ts_resp_verify.c.
|
---|
358 | */
|
---|
359 |
|
---|
360 | int TS_RESP_verify_signature(PKCS7 *token, STACK_OF(X509) *certs,
|
---|
361 | X509_STORE *store, X509 **signer_out);
|
---|
362 |
|
---|
363 | /* Context structure for the generic verify method. */
|
---|
364 |
|
---|
365 | /* Verify the signer's certificate and the signature of the response. */
|
---|
366 | # define TS_VFY_SIGNATURE (1u << 0)
|
---|
367 | /* Verify the version number of the response. */
|
---|
368 | # define TS_VFY_VERSION (1u << 1)
|
---|
369 | /* Verify if the policy supplied by the user matches the policy of the TSA. */
|
---|
370 | # define TS_VFY_POLICY (1u << 2)
|
---|
371 | /*
|
---|
372 | * Verify the message imprint provided by the user. This flag should not be
|
---|
373 | * specified with TS_VFY_DATA.
|
---|
374 | */
|
---|
375 | # define TS_VFY_IMPRINT (1u << 3)
|
---|
376 | /*
|
---|
377 | * Verify the message imprint computed by the verify method from the user
|
---|
378 | * provided data and the MD algorithm of the response. This flag should not
|
---|
379 | * be specified with TS_VFY_IMPRINT.
|
---|
380 | */
|
---|
381 | # define TS_VFY_DATA (1u << 4)
|
---|
382 | /* Verify the nonce value. */
|
---|
383 | # define TS_VFY_NONCE (1u << 5)
|
---|
384 | /* Verify if the TSA name field matches the signer certificate. */
|
---|
385 | # define TS_VFY_SIGNER (1u << 6)
|
---|
386 | /* Verify if the TSA name field equals to the user provided name. */
|
---|
387 | # define TS_VFY_TSA_NAME (1u << 7)
|
---|
388 |
|
---|
389 | /* You can use the following convenience constants. */
|
---|
390 | # define TS_VFY_ALL_IMPRINT (TS_VFY_SIGNATURE \
|
---|
391 | | TS_VFY_VERSION \
|
---|
392 | | TS_VFY_POLICY \
|
---|
393 | | TS_VFY_IMPRINT \
|
---|
394 | | TS_VFY_NONCE \
|
---|
395 | | TS_VFY_SIGNER \
|
---|
396 | | TS_VFY_TSA_NAME)
|
---|
397 | # define TS_VFY_ALL_DATA (TS_VFY_SIGNATURE \
|
---|
398 | | TS_VFY_VERSION \
|
---|
399 | | TS_VFY_POLICY \
|
---|
400 | | TS_VFY_DATA \
|
---|
401 | | TS_VFY_NONCE \
|
---|
402 | | TS_VFY_SIGNER \
|
---|
403 | | TS_VFY_TSA_NAME)
|
---|
404 |
|
---|
405 | typedef struct TS_verify_ctx TS_VERIFY_CTX;
|
---|
406 |
|
---|
407 | int TS_RESP_verify_response(TS_VERIFY_CTX *ctx, TS_RESP *response);
|
---|
408 | int TS_RESP_verify_token(TS_VERIFY_CTX *ctx, PKCS7 *token);
|
---|
409 |
|
---|
410 | /*
|
---|
411 | * Declarations related to response verification context,
|
---|
412 | */
|
---|
413 | TS_VERIFY_CTX *TS_VERIFY_CTX_new(void);
|
---|
414 | void TS_VERIFY_CTX_init(TS_VERIFY_CTX *ctx);
|
---|
415 | void TS_VERIFY_CTX_free(TS_VERIFY_CTX *ctx);
|
---|
416 | void TS_VERIFY_CTX_cleanup(TS_VERIFY_CTX *ctx);
|
---|
417 | int TS_VERIFY_CTX_set_flags(TS_VERIFY_CTX *ctx, int f);
|
---|
418 | int TS_VERIFY_CTX_add_flags(TS_VERIFY_CTX *ctx, int f);
|
---|
419 | BIO *TS_VERIFY_CTX_set_data(TS_VERIFY_CTX *ctx, BIO *b);
|
---|
420 | unsigned char *TS_VERIFY_CTX_set_imprint(TS_VERIFY_CTX *ctx,
|
---|
421 | unsigned char *hexstr, long len);
|
---|
422 | X509_STORE *TS_VERIFY_CTX_set_store(TS_VERIFY_CTX *ctx, X509_STORE *s);
|
---|
423 | # ifndef OPENSSL_NO_DEPRECATED_3_0
|
---|
424 | # define TS_VERIFY_CTS_set_certs(ctx, cert) TS_VERIFY_CTX_set_certs(ctx,cert)
|
---|
425 | # endif
|
---|
426 | STACK_OF(X509) *TS_VERIFY_CTX_set_certs(TS_VERIFY_CTX *ctx, STACK_OF(X509) *certs);
|
---|
427 |
|
---|
428 | /*-
|
---|
429 | * If ctx is NULL, it allocates and returns a new object, otherwise
|
---|
430 | * it returns ctx. It initialises all the members as follows:
|
---|
431 | * flags = TS_VFY_ALL_IMPRINT & ~(TS_VFY_TSA_NAME | TS_VFY_SIGNATURE)
|
---|
432 | * certs = NULL
|
---|
433 | * store = NULL
|
---|
434 | * policy = policy from the request or NULL if absent (in this case
|
---|
435 | * TS_VFY_POLICY is cleared from flags as well)
|
---|
436 | * md_alg = MD algorithm from request
|
---|
437 | * imprint, imprint_len = imprint from request
|
---|
438 | * data = NULL
|
---|
439 | * nonce, nonce_len = nonce from the request or NULL if absent (in this case
|
---|
440 | * TS_VFY_NONCE is cleared from flags as well)
|
---|
441 | * tsa_name = NULL
|
---|
442 | * Important: after calling this method TS_VFY_SIGNATURE should be added!
|
---|
443 | */
|
---|
444 | TS_VERIFY_CTX *TS_REQ_to_TS_VERIFY_CTX(TS_REQ *req, TS_VERIFY_CTX *ctx);
|
---|
445 |
|
---|
446 | /* Function declarations for TS_RESP defined in ts/ts_resp_print.c */
|
---|
447 |
|
---|
448 | int TS_RESP_print_bio(BIO *bio, TS_RESP *a);
|
---|
449 | int TS_STATUS_INFO_print_bio(BIO *bio, TS_STATUS_INFO *a);
|
---|
450 | int TS_TST_INFO_print_bio(BIO *bio, TS_TST_INFO *a);
|
---|
451 |
|
---|
452 | /* Common utility functions defined in ts/ts_lib.c */
|
---|
453 |
|
---|
454 | int TS_ASN1_INTEGER_print_bio(BIO *bio, const ASN1_INTEGER *num);
|
---|
455 | int TS_OBJ_print_bio(BIO *bio, const ASN1_OBJECT *obj);
|
---|
456 | int TS_ext_print_bio(BIO *bio, const STACK_OF(X509_EXTENSION) *extensions);
|
---|
457 | int TS_X509_ALGOR_print_bio(BIO *bio, const X509_ALGOR *alg);
|
---|
458 | int TS_MSG_IMPRINT_print_bio(BIO *bio, TS_MSG_IMPRINT *msg);
|
---|
459 |
|
---|
460 | /*
|
---|
461 | * Function declarations for handling configuration options, defined in
|
---|
462 | * ts/ts_conf.c
|
---|
463 | */
|
---|
464 |
|
---|
465 | X509 *TS_CONF_load_cert(const char *file);
|
---|
466 | STACK_OF(X509) *TS_CONF_load_certs(const char *file);
|
---|
467 | EVP_PKEY *TS_CONF_load_key(const char *file, const char *pass);
|
---|
468 | const char *TS_CONF_get_tsa_section(CONF *conf, const char *section);
|
---|
469 | int TS_CONF_set_serial(CONF *conf, const char *section, TS_serial_cb cb,
|
---|
470 | TS_RESP_CTX *ctx);
|
---|
471 | #ifndef OPENSSL_NO_ENGINE
|
---|
472 | int TS_CONF_set_crypto_device(CONF *conf, const char *section,
|
---|
473 | const char *device);
|
---|
474 | int TS_CONF_set_default_engine(const char *name);
|
---|
475 | #endif
|
---|
476 | int TS_CONF_set_signer_cert(CONF *conf, const char *section,
|
---|
477 | const char *cert, TS_RESP_CTX *ctx);
|
---|
478 | int TS_CONF_set_certs(CONF *conf, const char *section, const char *certs,
|
---|
479 | TS_RESP_CTX *ctx);
|
---|
480 | int TS_CONF_set_signer_key(CONF *conf, const char *section,
|
---|
481 | const char *key, const char *pass,
|
---|
482 | TS_RESP_CTX *ctx);
|
---|
483 | int TS_CONF_set_signer_digest(CONF *conf, const char *section,
|
---|
484 | const char *md, TS_RESP_CTX *ctx);
|
---|
485 | int TS_CONF_set_def_policy(CONF *conf, const char *section,
|
---|
486 | const char *policy, TS_RESP_CTX *ctx);
|
---|
487 | int TS_CONF_set_policies(CONF *conf, const char *section, TS_RESP_CTX *ctx);
|
---|
488 | int TS_CONF_set_digests(CONF *conf, const char *section, TS_RESP_CTX *ctx);
|
---|
489 | int TS_CONF_set_accuracy(CONF *conf, const char *section, TS_RESP_CTX *ctx);
|
---|
490 | int TS_CONF_set_clock_precision_digits(const CONF *conf, const char *section,
|
---|
491 | TS_RESP_CTX *ctx);
|
---|
492 | int TS_CONF_set_ordering(CONF *conf, const char *section, TS_RESP_CTX *ctx);
|
---|
493 | int TS_CONF_set_tsa_name(CONF *conf, const char *section, TS_RESP_CTX *ctx);
|
---|
494 | int TS_CONF_set_ess_cert_id_chain(CONF *conf, const char *section,
|
---|
495 | TS_RESP_CTX *ctx);
|
---|
496 | int TS_CONF_set_ess_cert_id_digest(CONF *conf, const char *section,
|
---|
497 | TS_RESP_CTX *ctx);
|
---|
498 |
|
---|
499 | # ifdef __cplusplus
|
---|
500 | }
|
---|
501 | # endif
|
---|
502 | # endif
|
---|
503 | #endif
|
---|