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