]>
Commit | Line | Data |
---|---|---|
0f113f3e | 1 | /* |
6738bf14 | 2 | * Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved. |
c7235be6 | 3 | * |
48f4ad77 | 4 | * Licensed under the Apache License 2.0 (the "License"). You may not use |
21dcbebc RS |
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 | |
c7235be6 UM |
8 | */ |
9 | ||
ae4186b0 DMSP |
10 | #ifndef OPENSSL_TS_H |
11 | # define OPENSSL_TS_H | |
d86167ec DMSP |
12 | # pragma once |
13 | ||
14 | # include <openssl/macros.h> | |
936c2b9e | 15 | # ifndef OPENSSL_NO_DEPRECATED_3_0 |
d86167ec DMSP |
16 | # define HEADER_TS_H |
17 | # endif | |
0f113f3e MC |
18 | |
19 | # include <openssl/opensslconf.h> | |
3c27208f | 20 | |
f3852635 | 21 | # ifndef OPENSSL_NO_TS |
0f113f3e | 22 | # include <openssl/symhacks.h> |
a00ae6c4 RS |
23 | # include <openssl/buffer.h> |
24 | # include <openssl/evp.h> | |
25 | # include <openssl/bio.h> | |
0f113f3e | 26 | # include <openssl/asn1.h> |
af3e5e1b | 27 | # include <openssl/safestack.h> |
3c27208f RS |
28 | # include <openssl/rsa.h> |
29 | # include <openssl/dsa.h> | |
30 | # include <openssl/dh.h> | |
52df25cf | 31 | # include <openssl/tserr.h> |
e85d19c6 | 32 | # include <openssl/ess.h> |
3c27208f | 33 | # ifdef __cplusplus |
c7235be6 | 34 | extern "C" { |
3c27208f | 35 | # endif |
c7235be6 | 36 | |
0f113f3e MC |
37 | # include <openssl/x509.h> |
38 | # include <openssl/x509v3.h> | |
c7235be6 | 39 | |
ca4a494c RS |
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; | |
c7235be6 | 44 | |
ca4a494c | 45 | /* Possible values for status. */ |
0f113f3e MC |
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 | ||
ca4a494c | 53 | /* Possible values for failure_info. */ |
0f113f3e MC |
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 | ||
c7235be6 | 63 | |
ca4a494c | 64 | typedef struct TS_status_info_st TS_STATUS_INFO; |
f0ef20bf | 65 | |
ca4a494c | 66 | typedef struct TS_resp_st TS_RESP; |
c7235be6 | 67 | |
9fdcc21f DO |
68 | DECLARE_ASN1_ALLOC_FUNCTIONS(TS_REQ) |
69 | DECLARE_ASN1_ENCODE_FUNCTIONS_only(TS_REQ, TS_REQ) | |
70 | DECLARE_ASN1_DUP_FUNCTION(TS_REQ) | |
c7235be6 | 71 | |
984d6c60 | 72 | #ifndef OPENSSL_NO_STDIO |
0f113f3e | 73 | TS_REQ *d2i_TS_REQ_fp(FILE *fp, TS_REQ **a); |
9fdcc21f | 74 | int i2d_TS_REQ_fp(FILE *fp, const TS_REQ *a); |
984d6c60 | 75 | #endif |
0f113f3e | 76 | TS_REQ *d2i_TS_REQ_bio(BIO *fp, TS_REQ **a); |
9fdcc21f | 77 | int i2d_TS_REQ_bio(BIO *fp, const TS_REQ *a); |
c7235be6 | 78 | |
9fdcc21f DO |
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) | |
c7235be6 | 82 | |
984d6c60 | 83 | #ifndef OPENSSL_NO_STDIO |
0f113f3e | 84 | TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT **a); |
9fdcc21f | 85 | int i2d_TS_MSG_IMPRINT_fp(FILE *fp, const TS_MSG_IMPRINT *a); |
984d6c60 DW |
86 | #endif |
87 | TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT **a); | |
9fdcc21f | 88 | int i2d_TS_MSG_IMPRINT_bio(BIO *bio, const TS_MSG_IMPRINT *a); |
c7235be6 | 89 | |
9fdcc21f DO |
90 | DECLARE_ASN1_ALLOC_FUNCTIONS(TS_RESP) |
91 | DECLARE_ASN1_ENCODE_FUNCTIONS_only(TS_RESP, TS_RESP) | |
92 | DECLARE_ASN1_DUP_FUNCTION(TS_RESP) | |
0f113f3e | 93 | |
984d6c60 | 94 | #ifndef OPENSSL_NO_STDIO |
0f113f3e | 95 | TS_RESP *d2i_TS_RESP_fp(FILE *fp, TS_RESP **a); |
9fdcc21f | 96 | int i2d_TS_RESP_fp(FILE *fp, const TS_RESP *a); |
984d6c60 DW |
97 | #endif |
98 | TS_RESP *d2i_TS_RESP_bio(BIO *bio, TS_RESP **a); | |
9fdcc21f DO |
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); | |
0f113f3e | 109 | |
984d6c60 | 110 | #ifndef OPENSSL_NO_STDIO |
0f113f3e | 111 | TS_TST_INFO *d2i_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO **a); |
9fdcc21f | 112 | int i2d_TS_TST_INFO_fp(FILE *fp, const TS_TST_INFO *a); |
984d6c60 DW |
113 | #endif |
114 | TS_TST_INFO *d2i_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO **a); | |
9fdcc21f DO |
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) | |
c7235be6 | 120 | |
c7235be6 | 121 | int TS_REQ_set_version(TS_REQ *a, long version); |
6c73d011 | 122 | long TS_REQ_get_version(const TS_REQ *a); |
c7235be6 | 123 | |
ca4a494c | 124 | int TS_STATUS_INFO_set_status(TS_STATUS_INFO *a, int i); |
bb2f62ba | 125 | const ASN1_INTEGER *TS_STATUS_INFO_get0_status(const TS_STATUS_INFO *a); |
9e5cd4ba | 126 | |
bb2f62ba MC |
127 | const STACK_OF(ASN1_UTF8STRING) * |
128 | TS_STATUS_INFO_get0_text(const TS_STATUS_INFO *a); | |
9e5cd4ba | 129 | |
bb2f62ba MC |
130 | const ASN1_BIT_STRING * |
131 | TS_STATUS_INFO_get0_failure_info(const TS_STATUS_INFO *a); | |
ca4a494c | 132 | |
c7235be6 UM |
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 | ||
c47ba4e9 | 142 | int TS_REQ_set_policy_id(TS_REQ *a, const ASN1_OBJECT *policy); |
c7235be6 UM |
143 | ASN1_OBJECT *TS_REQ_get_policy_id(TS_REQ *a); |
144 | ||
6c73d011 NL |
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); | |
c7235be6 UM |
147 | |
148 | int TS_REQ_set_cert_req(TS_REQ *a, int cert_req); | |
6c73d011 | 149 | int TS_REQ_get_cert_req(const TS_REQ *a); |
c7235be6 UM |
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); | |
c47ba4e9 | 155 | int TS_REQ_get_ext_by_OBJ(TS_REQ *a, const ASN1_OBJECT *obj, int lastpos); |
c7235be6 UM |
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); | |
6c73d011 | 177 | long TS_TST_INFO_get_version(const TS_TST_INFO *a); |
c7235be6 UM |
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 | ||
6c73d011 NL |
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); | |
c7235be6 | 187 | |
6c73d011 NL |
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); | |
c7235be6 UM |
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 | ||
6c73d011 NL |
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); | |
c7235be6 | 196 | |
6c73d011 NL |
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); | |
c7235be6 | 199 | |
6c73d011 NL |
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); | |
c7235be6 UM |
202 | |
203 | int TS_TST_INFO_set_ordering(TS_TST_INFO *a, int ordering); | |
6c73d011 | 204 | int TS_TST_INFO_get_ordering(const TS_TST_INFO *a); |
c7235be6 | 205 | |
6c73d011 NL |
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); | |
c7235be6 UM |
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); | |
c47ba4e9 F |
216 | int TS_TST_INFO_get_ext_by_OBJ(TS_TST_INFO *a, const ASN1_OBJECT *obj, |
217 | int lastpos); | |
c7235be6 UM |
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 | ||
0f113f3e MC |
224 | /* |
225 | * Declarations related to response generation, defined in ts/ts_resp_sign.c. | |
226 | */ | |
c7235be6 UM |
227 | |
228 | /* Optional flags for response generation. */ | |
229 | ||
230 | /* Don't include the TSA name in response. */ | |
0f113f3e | 231 | # define TS_TSA_NAME 0x01 |
c7235be6 UM |
232 | |
233 | /* Set ordering to true in response. */ | |
0f113f3e | 234 | # define TS_ORDERING 0x02 |
c7235be6 UM |
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 | */ | |
0f113f3e | 241 | # define TS_ESS_CERT_ID_CHAIN 0x04 |
c7235be6 UM |
242 | |
243 | /* Forward declaration. */ | |
244 | struct TS_resp_ctx; | |
245 | ||
246 | /* This must return a unique number less than 160 bits long. */ | |
0f113f3e | 247 | typedef ASN1_INTEGER *(*TS_serial_cb) (struct TS_resp_ctx *, void *); |
c7235be6 | 248 | |
0f113f3e MC |
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); | |
c7235be6 | 256 | |
0f113f3e MC |
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). | |
c7235be6 | 261 | */ |
0f113f3e MC |
262 | typedef int (*TS_extension_cb) (struct TS_resp_ctx *, X509_EXTENSION *, |
263 | void *); | |
264 | ||
ca4a494c | 265 | typedef struct TS_resp_ctx TS_RESP_CTX; |
c7235be6 | 266 | |
ac94c8fd | 267 | DEFINE_STACK_OF_CONST(EVP_MD) |
c7235be6 UM |
268 | |
269 | /* Creates a response context that can be used for generating responses. */ | |
270 | TS_RESP_CTX *TS_RESP_CTX_new(void); | |
271 | void TS_RESP_CTX_free(TS_RESP_CTX *ctx); | |
272 | ||
273 | /* This parameter must be set. */ | |
274 | int TS_RESP_CTX_set_signer_cert(TS_RESP_CTX *ctx, X509 *signer); | |
275 | ||
276 | /* This parameter must be set. */ | |
277 | int TS_RESP_CTX_set_signer_key(TS_RESP_CTX *ctx, EVP_PKEY *key); | |
278 | ||
e20b4727 DSH |
279 | int TS_RESP_CTX_set_signer_digest(TS_RESP_CTX *ctx, |
280 | const EVP_MD *signer_digest); | |
f0ef20bf | 281 | int TS_RESP_CTX_set_ess_cert_id_digest(TS_RESP_CTX *ctx, const EVP_MD *md); |
e20b4727 | 282 | |
c7235be6 | 283 | /* This parameter must be set. */ |
c47ba4e9 | 284 | int TS_RESP_CTX_set_def_policy(TS_RESP_CTX *ctx, const ASN1_OBJECT *def_policy); |
c7235be6 UM |
285 | |
286 | /* No additional certs are included in the response by default. */ | |
287 | int TS_RESP_CTX_set_certs(TS_RESP_CTX *ctx, STACK_OF(X509) *certs); | |
288 | ||
0f113f3e MC |
289 | /* |
290 | * Adds a new acceptable policy, only the default policy is accepted by | |
291 | * default. | |
292 | */ | |
c47ba4e9 | 293 | int TS_RESP_CTX_add_policy(TS_RESP_CTX *ctx, const ASN1_OBJECT *policy); |
c7235be6 | 294 | |
0f113f3e MC |
295 | /* |
296 | * Adds a new acceptable message digest. Note that no message digests are | |
297 | * accepted by default. The md argument is shared with the caller. | |
298 | */ | |
c7235be6 UM |
299 | int TS_RESP_CTX_add_md(TS_RESP_CTX *ctx, const EVP_MD *md); |
300 | ||
301 | /* Accuracy is not included by default. */ | |
302 | int TS_RESP_CTX_set_accuracy(TS_RESP_CTX *ctx, | |
0f113f3e | 303 | int secs, int millis, int micros); |
c7235be6 | 304 | |
0f113f3e MC |
305 | /* |
306 | * Clock precision digits, i.e. the number of decimal digits: '0' means sec, | |
307 | * '3' msec, '6' usec, and so on. Default is 0. | |
308 | */ | |
c7235be6 | 309 | int TS_RESP_CTX_set_clock_precision_digits(TS_RESP_CTX *ctx, |
0f113f3e MC |
310 | unsigned clock_precision_digits); |
311 | /* At most we accept usec precision. */ | |
312 | # define TS_MAX_CLOCK_PRECISION_DIGITS 6 | |
c7235be6 | 313 | |
20fc103f DSH |
314 | /* Maximum status message length */ |
315 | # define TS_MAX_STATUS_LENGTH (1024 * 1024) | |
316 | ||
c7235be6 UM |
317 | /* No flags are set by default. */ |
318 | void TS_RESP_CTX_add_flags(TS_RESP_CTX *ctx, int flags); | |
319 | ||
320 | /* Default callback always returns a constant. */ | |
321 | void TS_RESP_CTX_set_serial_cb(TS_RESP_CTX *ctx, TS_serial_cb cb, void *data); | |
322 | ||
323 | /* Default callback uses the gettimeofday() and gmtime() system calls. */ | |
324 | void TS_RESP_CTX_set_time_cb(TS_RESP_CTX *ctx, TS_time_cb cb, void *data); | |
325 | ||
0f113f3e MC |
326 | /* |
327 | * Default callback rejects all extensions. The extension callback is called | |
328 | * when the TS_TST_INFO object is already set up and not signed yet. | |
329 | */ | |
c7235be6 | 330 | /* FIXME: extension handling is not tested yet. */ |
0f113f3e MC |
331 | void TS_RESP_CTX_set_extension_cb(TS_RESP_CTX *ctx, |
332 | TS_extension_cb cb, void *data); | |
c7235be6 UM |
333 | |
334 | /* The following methods can be used in the callbacks. */ | |
0f113f3e MC |
335 | int TS_RESP_CTX_set_status_info(TS_RESP_CTX *ctx, |
336 | int status, const char *text); | |
c7235be6 UM |
337 | |
338 | /* Sets the status info only if it is still TS_STATUS_GRANTED. */ | |
0f113f3e MC |
339 | int TS_RESP_CTX_set_status_info_cond(TS_RESP_CTX *ctx, |
340 | int status, const char *text); | |
c7235be6 UM |
341 | |
342 | int TS_RESP_CTX_add_failure_info(TS_RESP_CTX *ctx, int failure); | |
343 | ||
344 | /* The get methods below can be used in the extension callback. */ | |
345 | TS_REQ *TS_RESP_CTX_get_request(TS_RESP_CTX *ctx); | |
346 | ||
347 | TS_TST_INFO *TS_RESP_CTX_get_tst_info(TS_RESP_CTX *ctx); | |
348 | ||
0f113f3e | 349 | /* |
c7235be6 UM |
350 | * Creates the signed TS_TST_INFO and puts it in TS_RESP. |
351 | * In case of errors it sets the status info properly. | |
352 | * Returns NULL only in case of memory allocation/fatal error. | |
353 | */ | |
354 | TS_RESP *TS_RESP_create_response(TS_RESP_CTX *ctx, BIO *req_bio); | |
355 | ||
356 | /* | |
357 | * Declarations related to response verification, | |
358 | * they are defined in ts/ts_resp_verify.c. | |
359 | */ | |
360 | ||
361 | int TS_RESP_verify_signature(PKCS7 *token, STACK_OF(X509) *certs, | |
0f113f3e | 362 | X509_STORE *store, X509 **signer_out); |
c7235be6 UM |
363 | |
364 | /* Context structure for the generic verify method. */ | |
365 | ||
366 | /* Verify the signer's certificate and the signature of the response. */ | |
0f113f3e | 367 | # define TS_VFY_SIGNATURE (1u << 0) |
c7235be6 | 368 | /* Verify the version number of the response. */ |
0f113f3e | 369 | # define TS_VFY_VERSION (1u << 1) |
c7235be6 | 370 | /* Verify if the policy supplied by the user matches the policy of the TSA. */ |
0f113f3e MC |
371 | # define TS_VFY_POLICY (1u << 2) |
372 | /* | |
373 | * Verify the message imprint provided by the user. This flag should not be | |
374 | * specified with TS_VFY_DATA. | |
375 | */ | |
376 | # define TS_VFY_IMPRINT (1u << 3) | |
377 | /* | |
378 | * Verify the message imprint computed by the verify method from the user | |
379 | * provided data and the MD algorithm of the response. This flag should not | |
380 | * be specified with TS_VFY_IMPRINT. | |
381 | */ | |
382 | # define TS_VFY_DATA (1u << 4) | |
c7235be6 | 383 | /* Verify the nonce value. */ |
0f113f3e | 384 | # define TS_VFY_NONCE (1u << 5) |
c7235be6 | 385 | /* Verify if the TSA name field matches the signer certificate. */ |
0f113f3e | 386 | # define TS_VFY_SIGNER (1u << 6) |
c7235be6 | 387 | /* Verify if the TSA name field equals to the user provided name. */ |
0f113f3e | 388 | # define TS_VFY_TSA_NAME (1u << 7) |
c7235be6 UM |
389 | |
390 | /* You can use the following convenience constants. */ | |
0f113f3e MC |
391 | # define TS_VFY_ALL_IMPRINT (TS_VFY_SIGNATURE \ |
392 | | TS_VFY_VERSION \ | |
393 | | TS_VFY_POLICY \ | |
394 | | TS_VFY_IMPRINT \ | |
395 | | TS_VFY_NONCE \ | |
396 | | TS_VFY_SIGNER \ | |
397 | | TS_VFY_TSA_NAME) | |
398 | # define TS_VFY_ALL_DATA (TS_VFY_SIGNATURE \ | |
399 | | TS_VFY_VERSION \ | |
400 | | TS_VFY_POLICY \ | |
401 | | TS_VFY_DATA \ | |
402 | | TS_VFY_NONCE \ | |
403 | | TS_VFY_SIGNER \ | |
404 | | TS_VFY_TSA_NAME) | |
405 | ||
ca4a494c | 406 | typedef struct TS_verify_ctx TS_VERIFY_CTX; |
c7235be6 UM |
407 | |
408 | int TS_RESP_verify_response(TS_VERIFY_CTX *ctx, TS_RESP *response); | |
409 | int TS_RESP_verify_token(TS_VERIFY_CTX *ctx, PKCS7 *token); | |
410 | ||
411 | /* | |
412 | * Declarations related to response verification context, | |
c7235be6 | 413 | */ |
c7235be6 UM |
414 | TS_VERIFY_CTX *TS_VERIFY_CTX_new(void); |
415 | void TS_VERIFY_CTX_init(TS_VERIFY_CTX *ctx); | |
416 | void TS_VERIFY_CTX_free(TS_VERIFY_CTX *ctx); | |
417 | void TS_VERIFY_CTX_cleanup(TS_VERIFY_CTX *ctx); | |
ca4a494c RS |
418 | int TS_VERIFY_CTX_set_flags(TS_VERIFY_CTX *ctx, int f); |
419 | int TS_VERIFY_CTX_add_flags(TS_VERIFY_CTX *ctx, int f); | |
420 | BIO *TS_VERIFY_CTX_set_data(TS_VERIFY_CTX *ctx, BIO *b); | |
421 | unsigned char *TS_VERIFY_CTX_set_imprint(TS_VERIFY_CTX *ctx, | |
422 | unsigned char *hexstr, long len); | |
423 | X509_STORE *TS_VERIFY_CTX_set_store(TS_VERIFY_CTX *ctx, X509_STORE *s); | |
936c2b9e | 424 | # ifndef OPENSSL_NO_DEPRECATED_3_0 |
1af26e53 AS |
425 | # define TS_VERIFY_CTS_set_certs(ctx, cert) TS_VERIFY_CTX_set_certs(ctx,cert) |
426 | # endif | |
427 | STACK_OF(X509) *TS_VERIFY_CTX_set_certs(TS_VERIFY_CTX *ctx, STACK_OF(X509) *certs); | |
c7235be6 | 428 | |
1d97c843 | 429 | /*- |
c7235be6 UM |
430 | * If ctx is NULL, it allocates and returns a new object, otherwise |
431 | * it returns ctx. It initialises all the members as follows: | |
432 | * flags = TS_VFY_ALL_IMPRINT & ~(TS_VFY_TSA_NAME | TS_VFY_SIGNATURE) | |
433 | * certs = NULL | |
434 | * store = NULL | |
435 | * policy = policy from the request or NULL if absent (in this case | |
0f113f3e | 436 | * TS_VFY_POLICY is cleared from flags as well) |
c7235be6 UM |
437 | * md_alg = MD algorithm from request |
438 | * imprint, imprint_len = imprint from request | |
439 | * data = NULL | |
440 | * nonce, nonce_len = nonce from the request or NULL if absent (in this case | |
0f113f3e | 441 | * TS_VFY_NONCE is cleared from flags as well) |
c7235be6 UM |
442 | * tsa_name = NULL |
443 | * Important: after calling this method TS_VFY_SIGNATURE should be added! | |
444 | */ | |
445 | TS_VERIFY_CTX *TS_REQ_to_TS_VERIFY_CTX(TS_REQ *req, TS_VERIFY_CTX *ctx); | |
446 | ||
447 | /* Function declarations for TS_RESP defined in ts/ts_resp_print.c */ | |
448 | ||
449 | int TS_RESP_print_bio(BIO *bio, TS_RESP *a); | |
450 | int TS_STATUS_INFO_print_bio(BIO *bio, TS_STATUS_INFO *a); | |
451 | int TS_TST_INFO_print_bio(BIO *bio, TS_TST_INFO *a); | |
452 | ||
453 | /* Common utility functions defined in ts/ts_lib.c */ | |
454 | ||
6c73d011 NL |
455 | int TS_ASN1_INTEGER_print_bio(BIO *bio, const ASN1_INTEGER *num); |
456 | int TS_OBJ_print_bio(BIO *bio, const ASN1_OBJECT *obj); | |
457 | int TS_ext_print_bio(BIO *bio, const STACK_OF(X509_EXTENSION) *extensions); | |
458 | int TS_X509_ALGOR_print_bio(BIO *bio, const X509_ALGOR *alg); | |
c7235be6 UM |
459 | int TS_MSG_IMPRINT_print_bio(BIO *bio, TS_MSG_IMPRINT *msg); |
460 | ||
0f113f3e MC |
461 | /* |
462 | * Function declarations for handling configuration options, defined in | |
463 | * ts/ts_conf.c | |
464 | */ | |
c7235be6 UM |
465 | |
466 | X509 *TS_CONF_load_cert(const char *file); | |
467 | STACK_OF(X509) *TS_CONF_load_certs(const char *file); | |
468 | EVP_PKEY *TS_CONF_load_key(const char *file, const char *pass); | |
469 | const char *TS_CONF_get_tsa_section(CONF *conf, const char *section); | |
470 | int TS_CONF_set_serial(CONF *conf, const char *section, TS_serial_cb cb, | |
0f113f3e | 471 | TS_RESP_CTX *ctx); |
8e237299 | 472 | #ifndef OPENSSL_NO_ENGINE |
c7235be6 | 473 | int TS_CONF_set_crypto_device(CONF *conf, const char *section, |
0f113f3e | 474 | const char *device); |
c7235be6 | 475 | int TS_CONF_set_default_engine(const char *name); |
8e237299 | 476 | #endif |
c7235be6 | 477 | int TS_CONF_set_signer_cert(CONF *conf, const char *section, |
0f113f3e | 478 | const char *cert, TS_RESP_CTX *ctx); |
c7235be6 | 479 | int TS_CONF_set_certs(CONF *conf, const char *section, const char *certs, |
0f113f3e | 480 | TS_RESP_CTX *ctx); |
c7235be6 | 481 | int TS_CONF_set_signer_key(CONF *conf, const char *section, |
0f113f3e MC |
482 | const char *key, const char *pass, |
483 | TS_RESP_CTX *ctx); | |
e20b4727 DSH |
484 | int TS_CONF_set_signer_digest(CONF *conf, const char *section, |
485 | const char *md, TS_RESP_CTX *ctx); | |
c7235be6 | 486 | int TS_CONF_set_def_policy(CONF *conf, const char *section, |
0f113f3e | 487 | const char *policy, TS_RESP_CTX *ctx); |
c7235be6 UM |
488 | int TS_CONF_set_policies(CONF *conf, const char *section, TS_RESP_CTX *ctx); |
489 | int TS_CONF_set_digests(CONF *conf, const char *section, TS_RESP_CTX *ctx); | |
490 | int TS_CONF_set_accuracy(CONF *conf, const char *section, TS_RESP_CTX *ctx); | |
491 | int TS_CONF_set_clock_precision_digits(CONF *conf, const char *section, | |
0f113f3e | 492 | TS_RESP_CTX *ctx); |
c7235be6 UM |
493 | int TS_CONF_set_ordering(CONF *conf, const char *section, TS_RESP_CTX *ctx); |
494 | int TS_CONF_set_tsa_name(CONF *conf, const char *section, TS_RESP_CTX *ctx); | |
495 | int TS_CONF_set_ess_cert_id_chain(CONF *conf, const char *section, | |
0f113f3e | 496 | TS_RESP_CTX *ctx); |
f0ef20bf MK |
497 | int TS_CONF_set_ess_cert_id_digest(CONF *conf, const char *section, |
498 | TS_RESP_CTX *ctx); | |
c7235be6 | 499 | |
0cd0a820 | 500 | # ifdef __cplusplus |
c7235be6 | 501 | } |
0cd0a820 | 502 | # endif |
3c27208f | 503 | # endif |
f3852635 | 504 | #endif |