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