]>
Commit | Line | Data |
---|---|---|
d3819813 | 1 | /* |
7bf7a6d0 | 2 | * Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved. |
d3819813 | 3 | * |
7bf7a6d0 MTL |
4 | * Licensed under the OpenSSL license (the "License"). You may not use |
5 | * this file except in compliance with the License. You can obtain a copy | |
6 | * in the file LICENSE in the source distribution or at | |
7 | * https://www.openssl.org/source/license.html | |
d3819813 MTL |
8 | */ |
9 | ||
10 | #ifndef HEADER_TS_H | |
11 | # define HEADER_TS_H | |
12 | ||
13 | # include <openssl/opensslconf.h> | |
7bf7a6d0 MTL |
14 | |
15 | # ifndef OPENSSL_NO_TS | |
d3819813 | 16 | # include <openssl/symhacks.h> |
7bf7a6d0 MTL |
17 | # include <openssl/buffer.h> |
18 | # include <openssl/evp.h> | |
19 | # include <openssl/bio.h> | |
d3819813 MTL |
20 | # include <openssl/stack.h> |
21 | # include <openssl/asn1.h> | |
22 | # include <openssl/safestack.h> | |
7bf7a6d0 MTL |
23 | # include <openssl/rsa.h> |
24 | # include <openssl/dsa.h> | |
25 | # include <openssl/dh.h> | |
26 | # ifdef __cplusplus | |
d3819813 | 27 | extern "C" { |
d3819813 MTL |
28 | # endif |
29 | ||
30 | # include <openssl/x509.h> | |
31 | # include <openssl/x509v3.h> | |
32 | ||
7bf7a6d0 MTL |
33 | typedef struct TS_msg_imprint_st TS_MSG_IMPRINT; |
34 | typedef struct TS_req_st TS_REQ; | |
35 | typedef struct TS_accuracy_st TS_ACCURACY; | |
36 | typedef struct TS_tst_info_st TS_TST_INFO; | |
d3819813 | 37 | |
7bf7a6d0 | 38 | /* Possible values for status. */ |
d3819813 MTL |
39 | # define TS_STATUS_GRANTED 0 |
40 | # define TS_STATUS_GRANTED_WITH_MODS 1 | |
41 | # define TS_STATUS_REJECTION 2 | |
42 | # define TS_STATUS_WAITING 3 | |
43 | # define TS_STATUS_REVOCATION_WARNING 4 | |
44 | # define TS_STATUS_REVOCATION_NOTIFICATION 5 | |
45 | ||
7bf7a6d0 | 46 | /* Possible values for failure_info. */ |
d3819813 MTL |
47 | # define TS_INFO_BAD_ALG 0 |
48 | # define TS_INFO_BAD_REQUEST 2 | |
49 | # define TS_INFO_BAD_DATA_FORMAT 5 | |
50 | # define TS_INFO_TIME_NOT_AVAILABLE 14 | |
51 | # define TS_INFO_UNACCEPTED_POLICY 15 | |
52 | # define TS_INFO_UNACCEPTED_EXTENSION 16 | |
53 | # define TS_INFO_ADD_INFO_NOT_AVAILABLE 17 | |
54 | # define TS_INFO_SYSTEM_FAILURE 25 | |
55 | ||
d3819813 | 56 | |
7bf7a6d0 MTL |
57 | typedef struct TS_status_info_st TS_STATUS_INFO; |
58 | typedef struct ESS_issuer_serial ESS_ISSUER_SERIAL; | |
59 | typedef struct ESS_cert_id ESS_CERT_ID; | |
60 | typedef struct ESS_signing_cert ESS_SIGNING_CERT; | |
d3819813 | 61 | |
7bf7a6d0 | 62 | DEFINE_STACK_OF(ESS_CERT_ID) |
d3819813 | 63 | |
7bf7a6d0 | 64 | typedef struct TS_resp_st TS_RESP; |
d3819813 MTL |
65 | |
66 | TS_REQ *TS_REQ_new(void); | |
67 | void TS_REQ_free(TS_REQ *a); | |
68 | int i2d_TS_REQ(const TS_REQ *a, unsigned char **pp); | |
69 | TS_REQ *d2i_TS_REQ(TS_REQ **a, const unsigned char **pp, long length); | |
70 | ||
71 | TS_REQ *TS_REQ_dup(TS_REQ *a); | |
72 | ||
7bf7a6d0 | 73 | #ifndef OPENSSL_NO_STDIO |
d3819813 MTL |
74 | TS_REQ *d2i_TS_REQ_fp(FILE *fp, TS_REQ **a); |
75 | int i2d_TS_REQ_fp(FILE *fp, TS_REQ *a); | |
62f0afa2 | 76 | #endif |
d3819813 MTL |
77 | TS_REQ *d2i_TS_REQ_bio(BIO *fp, TS_REQ **a); |
78 | int i2d_TS_REQ_bio(BIO *fp, TS_REQ *a); | |
79 | ||
80 | TS_MSG_IMPRINT *TS_MSG_IMPRINT_new(void); | |
81 | void TS_MSG_IMPRINT_free(TS_MSG_IMPRINT *a); | |
82 | int i2d_TS_MSG_IMPRINT(const TS_MSG_IMPRINT *a, unsigned char **pp); | |
83 | TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT(TS_MSG_IMPRINT **a, | |
84 | const unsigned char **pp, long length); | |
85 | ||
86 | TS_MSG_IMPRINT *TS_MSG_IMPRINT_dup(TS_MSG_IMPRINT *a); | |
87 | ||
7bf7a6d0 | 88 | #ifndef OPENSSL_NO_STDIO |
d3819813 MTL |
89 | TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT **a); |
90 | int i2d_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT *a); | |
62f0afa2 MTL |
91 | #endif |
92 | TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT **a); | |
93 | int i2d_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT *a); | |
d3819813 MTL |
94 | |
95 | TS_RESP *TS_RESP_new(void); | |
96 | void TS_RESP_free(TS_RESP *a); | |
97 | int i2d_TS_RESP(const TS_RESP *a, unsigned char **pp); | |
98 | TS_RESP *d2i_TS_RESP(TS_RESP **a, const unsigned char **pp, long length); | |
99 | TS_TST_INFO *PKCS7_to_TS_TST_INFO(PKCS7 *token); | |
100 | TS_RESP *TS_RESP_dup(TS_RESP *a); | |
101 | ||
7bf7a6d0 | 102 | #ifndef OPENSSL_NO_STDIO |
d3819813 MTL |
103 | TS_RESP *d2i_TS_RESP_fp(FILE *fp, TS_RESP **a); |
104 | int i2d_TS_RESP_fp(FILE *fp, TS_RESP *a); | |
62f0afa2 MTL |
105 | #endif |
106 | TS_RESP *d2i_TS_RESP_bio(BIO *bio, TS_RESP **a); | |
107 | int i2d_TS_RESP_bio(BIO *bio, TS_RESP *a); | |
d3819813 MTL |
108 | |
109 | TS_STATUS_INFO *TS_STATUS_INFO_new(void); | |
110 | void TS_STATUS_INFO_free(TS_STATUS_INFO *a); | |
111 | int i2d_TS_STATUS_INFO(const TS_STATUS_INFO *a, unsigned char **pp); | |
112 | TS_STATUS_INFO *d2i_TS_STATUS_INFO(TS_STATUS_INFO **a, | |
113 | const unsigned char **pp, long length); | |
114 | TS_STATUS_INFO *TS_STATUS_INFO_dup(TS_STATUS_INFO *a); | |
115 | ||
116 | TS_TST_INFO *TS_TST_INFO_new(void); | |
117 | void TS_TST_INFO_free(TS_TST_INFO *a); | |
118 | int i2d_TS_TST_INFO(const TS_TST_INFO *a, unsigned char **pp); | |
119 | TS_TST_INFO *d2i_TS_TST_INFO(TS_TST_INFO **a, const unsigned char **pp, | |
120 | long length); | |
121 | TS_TST_INFO *TS_TST_INFO_dup(TS_TST_INFO *a); | |
122 | ||
7bf7a6d0 | 123 | #ifndef OPENSSL_NO_STDIO |
d3819813 MTL |
124 | TS_TST_INFO *d2i_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO **a); |
125 | int i2d_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO *a); | |
62f0afa2 MTL |
126 | #endif |
127 | TS_TST_INFO *d2i_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO **a); | |
128 | int i2d_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO *a); | |
d3819813 MTL |
129 | |
130 | TS_ACCURACY *TS_ACCURACY_new(void); | |
131 | void TS_ACCURACY_free(TS_ACCURACY *a); | |
132 | int i2d_TS_ACCURACY(const TS_ACCURACY *a, unsigned char **pp); | |
133 | TS_ACCURACY *d2i_TS_ACCURACY(TS_ACCURACY **a, const unsigned char **pp, | |
134 | long length); | |
135 | TS_ACCURACY *TS_ACCURACY_dup(TS_ACCURACY *a); | |
136 | ||
137 | ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_new(void); | |
138 | void ESS_ISSUER_SERIAL_free(ESS_ISSUER_SERIAL *a); | |
139 | int i2d_ESS_ISSUER_SERIAL(const ESS_ISSUER_SERIAL *a, unsigned char **pp); | |
140 | ESS_ISSUER_SERIAL *d2i_ESS_ISSUER_SERIAL(ESS_ISSUER_SERIAL **a, | |
141 | const unsigned char **pp, | |
142 | long length); | |
143 | ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_dup(ESS_ISSUER_SERIAL *a); | |
144 | ||
145 | ESS_CERT_ID *ESS_CERT_ID_new(void); | |
146 | void ESS_CERT_ID_free(ESS_CERT_ID *a); | |
147 | int i2d_ESS_CERT_ID(const ESS_CERT_ID *a, unsigned char **pp); | |
148 | ESS_CERT_ID *d2i_ESS_CERT_ID(ESS_CERT_ID **a, const unsigned char **pp, | |
149 | long length); | |
150 | ESS_CERT_ID *ESS_CERT_ID_dup(ESS_CERT_ID *a); | |
151 | ||
152 | ESS_SIGNING_CERT *ESS_SIGNING_CERT_new(void); | |
153 | void ESS_SIGNING_CERT_free(ESS_SIGNING_CERT *a); | |
154 | int i2d_ESS_SIGNING_CERT(const ESS_SIGNING_CERT *a, unsigned char **pp); | |
155 | ESS_SIGNING_CERT *d2i_ESS_SIGNING_CERT(ESS_SIGNING_CERT **a, | |
156 | const unsigned char **pp, long length); | |
157 | ESS_SIGNING_CERT *ESS_SIGNING_CERT_dup(ESS_SIGNING_CERT *a); | |
158 | ||
d3819813 MTL |
159 | int TS_REQ_set_version(TS_REQ *a, long version); |
160 | long TS_REQ_get_version(const TS_REQ *a); | |
161 | ||
7bf7a6d0 MTL |
162 | int TS_STATUS_INFO_set_status(TS_STATUS_INFO *a, int i); |
163 | const ASN1_INTEGER *TS_STATUS_INFO_get0_status(const TS_STATUS_INFO *a); | |
164 | ||
165 | const STACK_OF(ASN1_UTF8STRING) * | |
166 | TS_STATUS_INFO_get0_text(const TS_STATUS_INFO *a); | |
167 | ||
168 | const ASN1_BIT_STRING * | |
169 | TS_STATUS_INFO_get0_failure_info(const TS_STATUS_INFO *a); | |
170 | ||
d3819813 MTL |
171 | int TS_REQ_set_msg_imprint(TS_REQ *a, TS_MSG_IMPRINT *msg_imprint); |
172 | TS_MSG_IMPRINT *TS_REQ_get_msg_imprint(TS_REQ *a); | |
173 | ||
174 | int TS_MSG_IMPRINT_set_algo(TS_MSG_IMPRINT *a, X509_ALGOR *alg); | |
175 | X509_ALGOR *TS_MSG_IMPRINT_get_algo(TS_MSG_IMPRINT *a); | |
176 | ||
177 | int TS_MSG_IMPRINT_set_msg(TS_MSG_IMPRINT *a, unsigned char *d, int len); | |
178 | ASN1_OCTET_STRING *TS_MSG_IMPRINT_get_msg(TS_MSG_IMPRINT *a); | |
179 | ||
7bf7a6d0 | 180 | int TS_REQ_set_policy_id(TS_REQ *a, const ASN1_OBJECT *policy); |
d3819813 MTL |
181 | ASN1_OBJECT *TS_REQ_get_policy_id(TS_REQ *a); |
182 | ||
183 | int TS_REQ_set_nonce(TS_REQ *a, const ASN1_INTEGER *nonce); | |
184 | const ASN1_INTEGER *TS_REQ_get_nonce(const TS_REQ *a); | |
185 | ||
186 | int TS_REQ_set_cert_req(TS_REQ *a, int cert_req); | |
187 | int TS_REQ_get_cert_req(const TS_REQ *a); | |
188 | ||
189 | STACK_OF(X509_EXTENSION) *TS_REQ_get_exts(TS_REQ *a); | |
190 | void TS_REQ_ext_free(TS_REQ *a); | |
191 | int TS_REQ_get_ext_count(TS_REQ *a); | |
192 | int TS_REQ_get_ext_by_NID(TS_REQ *a, int nid, int lastpos); | |
7bf7a6d0 | 193 | int TS_REQ_get_ext_by_OBJ(TS_REQ *a, const ASN1_OBJECT *obj, int lastpos); |
d3819813 MTL |
194 | int TS_REQ_get_ext_by_critical(TS_REQ *a, int crit, int lastpos); |
195 | X509_EXTENSION *TS_REQ_get_ext(TS_REQ *a, int loc); | |
196 | X509_EXTENSION *TS_REQ_delete_ext(TS_REQ *a, int loc); | |
197 | int TS_REQ_add_ext(TS_REQ *a, X509_EXTENSION *ex, int loc); | |
198 | void *TS_REQ_get_ext_d2i(TS_REQ *a, int nid, int *crit, int *idx); | |
199 | ||
200 | /* Function declarations for TS_REQ defined in ts/ts_req_print.c */ | |
201 | ||
202 | int TS_REQ_print_bio(BIO *bio, TS_REQ *a); | |
203 | ||
204 | /* Function declarations for TS_RESP defined in ts/ts_resp_utils.c */ | |
205 | ||
206 | int TS_RESP_set_status_info(TS_RESP *a, TS_STATUS_INFO *info); | |
207 | TS_STATUS_INFO *TS_RESP_get_status_info(TS_RESP *a); | |
208 | ||
209 | /* Caller loses ownership of PKCS7 and TS_TST_INFO objects. */ | |
210 | void TS_RESP_set_tst_info(TS_RESP *a, PKCS7 *p7, TS_TST_INFO *tst_info); | |
211 | PKCS7 *TS_RESP_get_token(TS_RESP *a); | |
212 | TS_TST_INFO *TS_RESP_get_tst_info(TS_RESP *a); | |
213 | ||
214 | int TS_TST_INFO_set_version(TS_TST_INFO *a, long version); | |
215 | long TS_TST_INFO_get_version(const TS_TST_INFO *a); | |
216 | ||
217 | int TS_TST_INFO_set_policy_id(TS_TST_INFO *a, ASN1_OBJECT *policy_id); | |
218 | ASN1_OBJECT *TS_TST_INFO_get_policy_id(TS_TST_INFO *a); | |
219 | ||
220 | int TS_TST_INFO_set_msg_imprint(TS_TST_INFO *a, TS_MSG_IMPRINT *msg_imprint); | |
221 | TS_MSG_IMPRINT *TS_TST_INFO_get_msg_imprint(TS_TST_INFO *a); | |
222 | ||
223 | int TS_TST_INFO_set_serial(TS_TST_INFO *a, const ASN1_INTEGER *serial); | |
224 | const ASN1_INTEGER *TS_TST_INFO_get_serial(const TS_TST_INFO *a); | |
225 | ||
226 | int TS_TST_INFO_set_time(TS_TST_INFO *a, const ASN1_GENERALIZEDTIME *gtime); | |
227 | const ASN1_GENERALIZEDTIME *TS_TST_INFO_get_time(const TS_TST_INFO *a); | |
228 | ||
229 | int TS_TST_INFO_set_accuracy(TS_TST_INFO *a, TS_ACCURACY *accuracy); | |
230 | TS_ACCURACY *TS_TST_INFO_get_accuracy(TS_TST_INFO *a); | |
231 | ||
232 | int TS_ACCURACY_set_seconds(TS_ACCURACY *a, const ASN1_INTEGER *seconds); | |
233 | const ASN1_INTEGER *TS_ACCURACY_get_seconds(const TS_ACCURACY *a); | |
234 | ||
235 | int TS_ACCURACY_set_millis(TS_ACCURACY *a, const ASN1_INTEGER *millis); | |
236 | const ASN1_INTEGER *TS_ACCURACY_get_millis(const TS_ACCURACY *a); | |
237 | ||
238 | int TS_ACCURACY_set_micros(TS_ACCURACY *a, const ASN1_INTEGER *micros); | |
239 | const ASN1_INTEGER *TS_ACCURACY_get_micros(const TS_ACCURACY *a); | |
240 | ||
241 | int TS_TST_INFO_set_ordering(TS_TST_INFO *a, int ordering); | |
242 | int TS_TST_INFO_get_ordering(const TS_TST_INFO *a); | |
243 | ||
244 | int TS_TST_INFO_set_nonce(TS_TST_INFO *a, const ASN1_INTEGER *nonce); | |
245 | const ASN1_INTEGER *TS_TST_INFO_get_nonce(const TS_TST_INFO *a); | |
246 | ||
247 | int TS_TST_INFO_set_tsa(TS_TST_INFO *a, GENERAL_NAME *tsa); | |
248 | GENERAL_NAME *TS_TST_INFO_get_tsa(TS_TST_INFO *a); | |
249 | ||
250 | STACK_OF(X509_EXTENSION) *TS_TST_INFO_get_exts(TS_TST_INFO *a); | |
251 | void TS_TST_INFO_ext_free(TS_TST_INFO *a); | |
252 | int TS_TST_INFO_get_ext_count(TS_TST_INFO *a); | |
253 | int TS_TST_INFO_get_ext_by_NID(TS_TST_INFO *a, int nid, int lastpos); | |
7bf7a6d0 MTL |
254 | int TS_TST_INFO_get_ext_by_OBJ(TS_TST_INFO *a, const ASN1_OBJECT *obj, |
255 | int lastpos); | |
d3819813 MTL |
256 | int TS_TST_INFO_get_ext_by_critical(TS_TST_INFO *a, int crit, int lastpos); |
257 | X509_EXTENSION *TS_TST_INFO_get_ext(TS_TST_INFO *a, int loc); | |
258 | X509_EXTENSION *TS_TST_INFO_delete_ext(TS_TST_INFO *a, int loc); | |
259 | int TS_TST_INFO_add_ext(TS_TST_INFO *a, X509_EXTENSION *ex, int loc); | |
260 | void *TS_TST_INFO_get_ext_d2i(TS_TST_INFO *a, int nid, int *crit, int *idx); | |
261 | ||
262 | /* | |
263 | * Declarations related to response generation, defined in ts/ts_resp_sign.c. | |
264 | */ | |
265 | ||
266 | /* Optional flags for response generation. */ | |
267 | ||
268 | /* Don't include the TSA name in response. */ | |
269 | # define TS_TSA_NAME 0x01 | |
270 | ||
271 | /* Set ordering to true in response. */ | |
272 | # define TS_ORDERING 0x02 | |
273 | ||
274 | /* | |
275 | * Include the signer certificate and the other specified certificates in | |
276 | * the ESS signing certificate attribute beside the PKCS7 signed data. | |
277 | * Only the signer certificates is included by default. | |
278 | */ | |
279 | # define TS_ESS_CERT_ID_CHAIN 0x04 | |
280 | ||
281 | /* Forward declaration. */ | |
282 | struct TS_resp_ctx; | |
283 | ||
284 | /* This must return a unique number less than 160 bits long. */ | |
285 | typedef ASN1_INTEGER *(*TS_serial_cb) (struct TS_resp_ctx *, void *); | |
286 | ||
287 | /* | |
288 | * This must return the seconds and microseconds since Jan 1, 1970 in the sec | |
289 | * and usec variables allocated by the caller. Return non-zero for success | |
290 | * and zero for failure. | |
291 | */ | |
292 | typedef int (*TS_time_cb) (struct TS_resp_ctx *, void *, long *sec, | |
293 | long *usec); | |
294 | ||
295 | /* | |
296 | * This must process the given extension. It can modify the TS_TST_INFO | |
297 | * object of the context. Return values: !0 (processed), 0 (error, it must | |
298 | * set the status info/failure info of the response). | |
299 | */ | |
300 | typedef int (*TS_extension_cb) (struct TS_resp_ctx *, X509_EXTENSION *, | |
301 | void *); | |
302 | ||
7bf7a6d0 MTL |
303 | typedef struct TS_resp_ctx TS_RESP_CTX; |
304 | ||
305 | DEFINE_STACK_OF_CONST(EVP_MD) | |
d3819813 MTL |
306 | |
307 | /* Creates a response context that can be used for generating responses. */ | |
308 | TS_RESP_CTX *TS_RESP_CTX_new(void); | |
309 | void TS_RESP_CTX_free(TS_RESP_CTX *ctx); | |
310 | ||
311 | /* This parameter must be set. */ | |
312 | int TS_RESP_CTX_set_signer_cert(TS_RESP_CTX *ctx, X509 *signer); | |
313 | ||
314 | /* This parameter must be set. */ | |
315 | int TS_RESP_CTX_set_signer_key(TS_RESP_CTX *ctx, EVP_PKEY *key); | |
316 | ||
7bf7a6d0 MTL |
317 | int TS_RESP_CTX_set_signer_digest(TS_RESP_CTX *ctx, |
318 | const EVP_MD *signer_digest); | |
319 | ||
d3819813 | 320 | /* This parameter must be set. */ |
7bf7a6d0 | 321 | int TS_RESP_CTX_set_def_policy(TS_RESP_CTX *ctx, const ASN1_OBJECT *def_policy); |
d3819813 MTL |
322 | |
323 | /* No additional certs are included in the response by default. */ | |
324 | int TS_RESP_CTX_set_certs(TS_RESP_CTX *ctx, STACK_OF(X509) *certs); | |
325 | ||
326 | /* | |
327 | * Adds a new acceptable policy, only the default policy is accepted by | |
328 | * default. | |
329 | */ | |
7bf7a6d0 | 330 | int TS_RESP_CTX_add_policy(TS_RESP_CTX *ctx, const ASN1_OBJECT *policy); |
d3819813 MTL |
331 | |
332 | /* | |
333 | * Adds a new acceptable message digest. Note that no message digests are | |
334 | * accepted by default. The md argument is shared with the caller. | |
335 | */ | |
336 | int TS_RESP_CTX_add_md(TS_RESP_CTX *ctx, const EVP_MD *md); | |
337 | ||
338 | /* Accuracy is not included by default. */ | |
339 | int TS_RESP_CTX_set_accuracy(TS_RESP_CTX *ctx, | |
340 | int secs, int millis, int micros); | |
341 | ||
342 | /* | |
343 | * Clock precision digits, i.e. the number of decimal digits: '0' means sec, | |
344 | * '3' msec, '6' usec, and so on. Default is 0. | |
345 | */ | |
346 | int TS_RESP_CTX_set_clock_precision_digits(TS_RESP_CTX *ctx, | |
347 | unsigned clock_precision_digits); | |
348 | /* At most we accept usec precision. */ | |
349 | # define TS_MAX_CLOCK_PRECISION_DIGITS 6 | |
350 | ||
f4173af1 MTL |
351 | /* Maximum status message length */ |
352 | # define TS_MAX_STATUS_LENGTH (1024 * 1024) | |
353 | ||
d3819813 MTL |
354 | /* No flags are set by default. */ |
355 | void TS_RESP_CTX_add_flags(TS_RESP_CTX *ctx, int flags); | |
356 | ||
357 | /* Default callback always returns a constant. */ | |
358 | void TS_RESP_CTX_set_serial_cb(TS_RESP_CTX *ctx, TS_serial_cb cb, void *data); | |
359 | ||
360 | /* Default callback uses the gettimeofday() and gmtime() system calls. */ | |
361 | void TS_RESP_CTX_set_time_cb(TS_RESP_CTX *ctx, TS_time_cb cb, void *data); | |
362 | ||
363 | /* | |
364 | * Default callback rejects all extensions. The extension callback is called | |
365 | * when the TS_TST_INFO object is already set up and not signed yet. | |
366 | */ | |
367 | /* FIXME: extension handling is not tested yet. */ | |
368 | void TS_RESP_CTX_set_extension_cb(TS_RESP_CTX *ctx, | |
369 | TS_extension_cb cb, void *data); | |
370 | ||
371 | /* The following methods can be used in the callbacks. */ | |
372 | int TS_RESP_CTX_set_status_info(TS_RESP_CTX *ctx, | |
373 | int status, const char *text); | |
374 | ||
375 | /* Sets the status info only if it is still TS_STATUS_GRANTED. */ | |
376 | int TS_RESP_CTX_set_status_info_cond(TS_RESP_CTX *ctx, | |
377 | int status, const char *text); | |
378 | ||
379 | int TS_RESP_CTX_add_failure_info(TS_RESP_CTX *ctx, int failure); | |
380 | ||
381 | /* The get methods below can be used in the extension callback. */ | |
382 | TS_REQ *TS_RESP_CTX_get_request(TS_RESP_CTX *ctx); | |
383 | ||
384 | TS_TST_INFO *TS_RESP_CTX_get_tst_info(TS_RESP_CTX *ctx); | |
385 | ||
386 | /* | |
387 | * Creates the signed TS_TST_INFO and puts it in TS_RESP. | |
388 | * In case of errors it sets the status info properly. | |
389 | * Returns NULL only in case of memory allocation/fatal error. | |
390 | */ | |
391 | TS_RESP *TS_RESP_create_response(TS_RESP_CTX *ctx, BIO *req_bio); | |
392 | ||
393 | /* | |
394 | * Declarations related to response verification, | |
395 | * they are defined in ts/ts_resp_verify.c. | |
396 | */ | |
397 | ||
398 | int TS_RESP_verify_signature(PKCS7 *token, STACK_OF(X509) *certs, | |
399 | X509_STORE *store, X509 **signer_out); | |
400 | ||
401 | /* Context structure for the generic verify method. */ | |
402 | ||
403 | /* Verify the signer's certificate and the signature of the response. */ | |
404 | # define TS_VFY_SIGNATURE (1u << 0) | |
405 | /* Verify the version number of the response. */ | |
406 | # define TS_VFY_VERSION (1u << 1) | |
407 | /* Verify if the policy supplied by the user matches the policy of the TSA. */ | |
408 | # define TS_VFY_POLICY (1u << 2) | |
409 | /* | |
410 | * Verify the message imprint provided by the user. This flag should not be | |
411 | * specified with TS_VFY_DATA. | |
412 | */ | |
413 | # define TS_VFY_IMPRINT (1u << 3) | |
414 | /* | |
415 | * Verify the message imprint computed by the verify method from the user | |
416 | * provided data and the MD algorithm of the response. This flag should not | |
417 | * be specified with TS_VFY_IMPRINT. | |
418 | */ | |
419 | # define TS_VFY_DATA (1u << 4) | |
420 | /* Verify the nonce value. */ | |
421 | # define TS_VFY_NONCE (1u << 5) | |
422 | /* Verify if the TSA name field matches the signer certificate. */ | |
423 | # define TS_VFY_SIGNER (1u << 6) | |
424 | /* Verify if the TSA name field equals to the user provided name. */ | |
425 | # define TS_VFY_TSA_NAME (1u << 7) | |
426 | ||
427 | /* You can use the following convenience constants. */ | |
428 | # define TS_VFY_ALL_IMPRINT (TS_VFY_SIGNATURE \ | |
429 | | TS_VFY_VERSION \ | |
430 | | TS_VFY_POLICY \ | |
431 | | TS_VFY_IMPRINT \ | |
432 | | TS_VFY_NONCE \ | |
433 | | TS_VFY_SIGNER \ | |
434 | | TS_VFY_TSA_NAME) | |
435 | # define TS_VFY_ALL_DATA (TS_VFY_SIGNATURE \ | |
436 | | TS_VFY_VERSION \ | |
437 | | TS_VFY_POLICY \ | |
438 | | TS_VFY_DATA \ | |
439 | | TS_VFY_NONCE \ | |
440 | | TS_VFY_SIGNER \ | |
441 | | TS_VFY_TSA_NAME) | |
442 | ||
7bf7a6d0 | 443 | typedef struct TS_verify_ctx TS_VERIFY_CTX; |
d3819813 MTL |
444 | |
445 | int TS_RESP_verify_response(TS_VERIFY_CTX *ctx, TS_RESP *response); | |
446 | int TS_RESP_verify_token(TS_VERIFY_CTX *ctx, PKCS7 *token); | |
447 | ||
448 | /* | |
449 | * Declarations related to response verification context, | |
d3819813 | 450 | */ |
d3819813 MTL |
451 | TS_VERIFY_CTX *TS_VERIFY_CTX_new(void); |
452 | void TS_VERIFY_CTX_init(TS_VERIFY_CTX *ctx); | |
453 | void TS_VERIFY_CTX_free(TS_VERIFY_CTX *ctx); | |
454 | void TS_VERIFY_CTX_cleanup(TS_VERIFY_CTX *ctx); | |
7bf7a6d0 MTL |
455 | int TS_VERIFY_CTX_set_flags(TS_VERIFY_CTX *ctx, int f); |
456 | int TS_VERIFY_CTX_add_flags(TS_VERIFY_CTX *ctx, int f); | |
457 | BIO *TS_VERIFY_CTX_set_data(TS_VERIFY_CTX *ctx, BIO *b); | |
458 | unsigned char *TS_VERIFY_CTX_set_imprint(TS_VERIFY_CTX *ctx, | |
459 | unsigned char *hexstr, long len); | |
460 | X509_STORE *TS_VERIFY_CTX_set_store(TS_VERIFY_CTX *ctx, X509_STORE *s); | |
461 | STACK_OF(X509) *TS_VERIFY_CTS_set_certs(TS_VERIFY_CTX *ctx, STACK_OF(X509) *certs); | |
d3819813 MTL |
462 | |
463 | /*- | |
464 | * If ctx is NULL, it allocates and returns a new object, otherwise | |
465 | * it returns ctx. It initialises all the members as follows: | |
466 | * flags = TS_VFY_ALL_IMPRINT & ~(TS_VFY_TSA_NAME | TS_VFY_SIGNATURE) | |
467 | * certs = NULL | |
468 | * store = NULL | |
469 | * policy = policy from the request or NULL if absent (in this case | |
470 | * TS_VFY_POLICY is cleared from flags as well) | |
471 | * md_alg = MD algorithm from request | |
472 | * imprint, imprint_len = imprint from request | |
473 | * data = NULL | |
474 | * nonce, nonce_len = nonce from the request or NULL if absent (in this case | |
475 | * TS_VFY_NONCE is cleared from flags as well) | |
476 | * tsa_name = NULL | |
477 | * Important: after calling this method TS_VFY_SIGNATURE should be added! | |
478 | */ | |
479 | TS_VERIFY_CTX *TS_REQ_to_TS_VERIFY_CTX(TS_REQ *req, TS_VERIFY_CTX *ctx); | |
480 | ||
481 | /* Function declarations for TS_RESP defined in ts/ts_resp_print.c */ | |
482 | ||
483 | int TS_RESP_print_bio(BIO *bio, TS_RESP *a); | |
484 | int TS_STATUS_INFO_print_bio(BIO *bio, TS_STATUS_INFO *a); | |
485 | int TS_TST_INFO_print_bio(BIO *bio, TS_TST_INFO *a); | |
486 | ||
487 | /* Common utility functions defined in ts/ts_lib.c */ | |
488 | ||
489 | int TS_ASN1_INTEGER_print_bio(BIO *bio, const ASN1_INTEGER *num); | |
490 | int TS_OBJ_print_bio(BIO *bio, const ASN1_OBJECT *obj); | |
491 | int TS_ext_print_bio(BIO *bio, const STACK_OF(X509_EXTENSION) *extensions); | |
492 | int TS_X509_ALGOR_print_bio(BIO *bio, const X509_ALGOR *alg); | |
493 | int TS_MSG_IMPRINT_print_bio(BIO *bio, TS_MSG_IMPRINT *msg); | |
494 | ||
495 | /* | |
496 | * Function declarations for handling configuration options, defined in | |
497 | * ts/ts_conf.c | |
498 | */ | |
499 | ||
500 | X509 *TS_CONF_load_cert(const char *file); | |
501 | STACK_OF(X509) *TS_CONF_load_certs(const char *file); | |
502 | EVP_PKEY *TS_CONF_load_key(const char *file, const char *pass); | |
503 | const char *TS_CONF_get_tsa_section(CONF *conf, const char *section); | |
504 | int TS_CONF_set_serial(CONF *conf, const char *section, TS_serial_cb cb, | |
505 | TS_RESP_CTX *ctx); | |
7bf7a6d0 | 506 | #ifndef OPENSSL_NO_ENGINE |
d3819813 MTL |
507 | int TS_CONF_set_crypto_device(CONF *conf, const char *section, |
508 | const char *device); | |
509 | int TS_CONF_set_default_engine(const char *name); | |
7bf7a6d0 | 510 | #endif |
d3819813 MTL |
511 | int TS_CONF_set_signer_cert(CONF *conf, const char *section, |
512 | const char *cert, TS_RESP_CTX *ctx); | |
513 | int TS_CONF_set_certs(CONF *conf, const char *section, const char *certs, | |
514 | TS_RESP_CTX *ctx); | |
515 | int TS_CONF_set_signer_key(CONF *conf, const char *section, | |
516 | const char *key, const char *pass, | |
517 | TS_RESP_CTX *ctx); | |
7bf7a6d0 MTL |
518 | int TS_CONF_set_signer_digest(CONF *conf, const char *section, |
519 | const char *md, TS_RESP_CTX *ctx); | |
d3819813 MTL |
520 | int TS_CONF_set_def_policy(CONF *conf, const char *section, |
521 | const char *policy, TS_RESP_CTX *ctx); | |
522 | int TS_CONF_set_policies(CONF *conf, const char *section, TS_RESP_CTX *ctx); | |
523 | int TS_CONF_set_digests(CONF *conf, const char *section, TS_RESP_CTX *ctx); | |
524 | int TS_CONF_set_accuracy(CONF *conf, const char *section, TS_RESP_CTX *ctx); | |
525 | int TS_CONF_set_clock_precision_digits(CONF *conf, const char *section, | |
526 | TS_RESP_CTX *ctx); | |
527 | int TS_CONF_set_ordering(CONF *conf, const char *section, TS_RESP_CTX *ctx); | |
528 | int TS_CONF_set_tsa_name(CONF *conf, const char *section, TS_RESP_CTX *ctx); | |
529 | int TS_CONF_set_ess_cert_id_chain(CONF *conf, const char *section, | |
530 | TS_RESP_CTX *ctx); | |
531 | ||
532 | /* -------------------------------------------------- */ | |
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 | */ | |
7bf7a6d0 MTL |
538 | |
539 | int ERR_load_TS_strings(void); | |
d3819813 MTL |
540 | |
541 | /* Error codes for the TS functions. */ | |
542 | ||
543 | /* Function codes. */ | |
d3819813 MTL |
544 | # define TS_F_DEF_SERIAL_CB 110 |
545 | # define TS_F_DEF_TIME_CB 111 | |
546 | # define TS_F_ESS_ADD_SIGNING_CERT 112 | |
547 | # define TS_F_ESS_CERT_ID_NEW_INIT 113 | |
548 | # define TS_F_ESS_SIGNING_CERT_NEW_INIT 114 | |
549 | # define TS_F_INT_TS_RESP_VERIFY_TOKEN 149 | |
550 | # define TS_F_PKCS7_TO_TS_TST_INFO 148 | |
551 | # define TS_F_TS_ACCURACY_SET_MICROS 115 | |
552 | # define TS_F_TS_ACCURACY_SET_MILLIS 116 | |
553 | # define TS_F_TS_ACCURACY_SET_SECONDS 117 | |
554 | # define TS_F_TS_CHECK_IMPRINTS 100 | |
555 | # define TS_F_TS_CHECK_NONCES 101 | |
556 | # define TS_F_TS_CHECK_POLICY 102 | |
557 | # define TS_F_TS_CHECK_SIGNING_CERTS 103 | |
558 | # define TS_F_TS_CHECK_STATUS_INFO 104 | |
559 | # define TS_F_TS_COMPUTE_IMPRINT 145 | |
62f0afa2 MTL |
560 | # define TS_F_TS_CONF_INVALID 151 |
561 | # define TS_F_TS_CONF_LOAD_CERT 153 | |
562 | # define TS_F_TS_CONF_LOAD_CERTS 154 | |
563 | # define TS_F_TS_CONF_LOAD_KEY 155 | |
564 | # define TS_F_TS_CONF_LOOKUP_FAIL 152 | |
d3819813 MTL |
565 | # define TS_F_TS_CONF_SET_DEFAULT_ENGINE 146 |
566 | # define TS_F_TS_GET_STATUS_TEXT 105 | |
567 | # define TS_F_TS_MSG_IMPRINT_SET_ALGO 118 | |
568 | # define TS_F_TS_REQ_SET_MSG_IMPRINT 119 | |
569 | # define TS_F_TS_REQ_SET_NONCE 120 | |
570 | # define TS_F_TS_REQ_SET_POLICY_ID 121 | |
571 | # define TS_F_TS_RESP_CREATE_RESPONSE 122 | |
572 | # define TS_F_TS_RESP_CREATE_TST_INFO 123 | |
573 | # define TS_F_TS_RESP_CTX_ADD_FAILURE_INFO 124 | |
574 | # define TS_F_TS_RESP_CTX_ADD_MD 125 | |
575 | # define TS_F_TS_RESP_CTX_ADD_POLICY 126 | |
576 | # define TS_F_TS_RESP_CTX_NEW 127 | |
577 | # define TS_F_TS_RESP_CTX_SET_ACCURACY 128 | |
578 | # define TS_F_TS_RESP_CTX_SET_CERTS 129 | |
579 | # define TS_F_TS_RESP_CTX_SET_DEF_POLICY 130 | |
580 | # define TS_F_TS_RESP_CTX_SET_SIGNER_CERT 131 | |
581 | # define TS_F_TS_RESP_CTX_SET_STATUS_INFO 132 | |
582 | # define TS_F_TS_RESP_GET_POLICY 133 | |
583 | # define TS_F_TS_RESP_SET_GENTIME_WITH_PRECISION 134 | |
584 | # define TS_F_TS_RESP_SET_STATUS_INFO 135 | |
585 | # define TS_F_TS_RESP_SET_TST_INFO 150 | |
586 | # define TS_F_TS_RESP_SIGN 136 | |
587 | # define TS_F_TS_RESP_VERIFY_SIGNATURE 106 | |
d3819813 MTL |
588 | # define TS_F_TS_TST_INFO_SET_ACCURACY 137 |
589 | # define TS_F_TS_TST_INFO_SET_MSG_IMPRINT 138 | |
590 | # define TS_F_TS_TST_INFO_SET_NONCE 139 | |
591 | # define TS_F_TS_TST_INFO_SET_POLICY_ID 140 | |
592 | # define TS_F_TS_TST_INFO_SET_SERIAL 141 | |
593 | # define TS_F_TS_TST_INFO_SET_TIME 142 | |
594 | # define TS_F_TS_TST_INFO_SET_TSA 143 | |
595 | # define TS_F_TS_VERIFY 108 | |
596 | # define TS_F_TS_VERIFY_CERT 109 | |
597 | # define TS_F_TS_VERIFY_CTX_NEW 144 | |
598 | ||
599 | /* Reason codes. */ | |
600 | # define TS_R_BAD_PKCS7_TYPE 132 | |
601 | # define TS_R_BAD_TYPE 133 | |
62f0afa2 MTL |
602 | # define TS_R_CANNOT_LOAD_CERT 137 |
603 | # define TS_R_CANNOT_LOAD_KEY 138 | |
d3819813 MTL |
604 | # define TS_R_CERTIFICATE_VERIFY_ERROR 100 |
605 | # define TS_R_COULD_NOT_SET_ENGINE 127 | |
606 | # define TS_R_COULD_NOT_SET_TIME 115 | |
d3819813 MTL |
607 | # define TS_R_DETACHED_CONTENT 134 |
608 | # define TS_R_ESS_ADD_SIGNING_CERT_ERROR 116 | |
609 | # define TS_R_ESS_SIGNING_CERTIFICATE_ERROR 101 | |
610 | # define TS_R_INVALID_NULL_POINTER 102 | |
611 | # define TS_R_INVALID_SIGNER_CERTIFICATE_PURPOSE 117 | |
612 | # define TS_R_MESSAGE_IMPRINT_MISMATCH 103 | |
613 | # define TS_R_NONCE_MISMATCH 104 | |
614 | # define TS_R_NONCE_NOT_RETURNED 105 | |
615 | # define TS_R_NO_CONTENT 106 | |
616 | # define TS_R_NO_TIME_STAMP_TOKEN 107 | |
617 | # define TS_R_PKCS7_ADD_SIGNATURE_ERROR 118 | |
618 | # define TS_R_PKCS7_ADD_SIGNED_ATTR_ERROR 119 | |
619 | # define TS_R_PKCS7_TO_TS_TST_INFO_FAILED 129 | |
620 | # define TS_R_POLICY_MISMATCH 108 | |
621 | # define TS_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 120 | |
622 | # define TS_R_RESPONSE_SETUP_ERROR 121 | |
623 | # define TS_R_SIGNATURE_FAILURE 109 | |
624 | # define TS_R_THERE_MUST_BE_ONE_SIGNER 110 | |
625 | # define TS_R_TIME_SYSCALL_ERROR 122 | |
626 | # define TS_R_TOKEN_NOT_PRESENT 130 | |
627 | # define TS_R_TOKEN_PRESENT 131 | |
628 | # define TS_R_TSA_NAME_MISMATCH 111 | |
629 | # define TS_R_TSA_UNTRUSTED 112 | |
630 | # define TS_R_TST_INFO_SETUP_ERROR 123 | |
631 | # define TS_R_TS_DATASIGN 124 | |
632 | # define TS_R_UNACCEPTABLE_POLICY 125 | |
633 | # define TS_R_UNSUPPORTED_MD_ALGORITHM 126 | |
634 | # define TS_R_UNSUPPORTED_VERSION 113 | |
62f0afa2 MTL |
635 | # define TS_R_VAR_BAD_VALUE 135 |
636 | # define TS_R_VAR_LOOKUP_FAILURE 136 | |
d3819813 MTL |
637 | # define TS_R_WRONG_CONTENT_TYPE 114 |
638 | ||
7bf7a6d0 | 639 | # ifdef __cplusplus |
d3819813 | 640 | } |
7bf7a6d0 MTL |
641 | # endif |
642 | # endif | |
d3819813 | 643 | #endif |