2 * Written by Zoltan Glozik (zglozik@opentsa.org) for the OpenSSL project
5 /* ====================================================================
6 * Copyright (c) 2006 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
62 # include <openssl/opensslconf.h>
64 # ifndef OPENSSL_NO_TS
65 # include <openssl/symhacks.h>
66 # include <openssl/buffer.h>
67 # include <openssl/evp.h>
68 # include <openssl/bio.h>
69 # include <openssl/stack.h>
70 # include <openssl/asn1.h>
71 # include <openssl/safestack.h>
72 # include <openssl/rsa.h>
73 # include <openssl/dsa.h>
74 # include <openssl/dh.h>
80 /* Under Win32 this is defined in wincrypt.h */
84 # include <openssl/x509.h>
85 # include <openssl/x509v3.h>
87 typedef struct TS_msg_imprint_st TS_MSG_IMPRINT;
88 typedef struct TS_req_st TS_REQ;
89 typedef struct TS_accuracy_st TS_ACCURACY;
90 typedef struct TS_tst_info_st TS_TST_INFO;
92 /* Possible values for status. */
93 # define TS_STATUS_GRANTED 0
94 # define TS_STATUS_GRANTED_WITH_MODS 1
95 # define TS_STATUS_REJECTION 2
96 # define TS_STATUS_WAITING 3
97 # define TS_STATUS_REVOCATION_WARNING 4
98 # define TS_STATUS_REVOCATION_NOTIFICATION 5
100 /* Possible values for failure_info. */
101 # define TS_INFO_BAD_ALG 0
102 # define TS_INFO_BAD_REQUEST 2
103 # define TS_INFO_BAD_DATA_FORMAT 5
104 # define TS_INFO_TIME_NOT_AVAILABLE 14
105 # define TS_INFO_UNACCEPTED_POLICY 15
106 # define TS_INFO_UNACCEPTED_EXTENSION 16
107 # define TS_INFO_ADD_INFO_NOT_AVAILABLE 17
108 # define TS_INFO_SYSTEM_FAILURE 25
111 typedef struct TS_status_info_st TS_STATUS_INFO;
112 typedef struct ESS_issuer_serial ESS_ISSUER_SERIAL;
113 typedef struct ESS_cert_id ESS_CERT_ID;
114 typedef struct ESS_signing_cert ESS_SIGNING_CERT;
116 DEFINE_STACK_OF(ESS_CERT_ID)
118 typedef struct TS_resp_st TS_RESP;
120 TS_REQ *TS_REQ_new(void);
121 void TS_REQ_free(TS_REQ *a);
122 int i2d_TS_REQ(const TS_REQ *a, unsigned char **pp);
123 TS_REQ *d2i_TS_REQ(TS_REQ **a, const unsigned char **pp, long length);
125 TS_REQ *TS_REQ_dup(TS_REQ *a);
127 #ifndef OPENSSL_NO_STDIO
128 TS_REQ *d2i_TS_REQ_fp(FILE *fp, TS_REQ **a);
129 int i2d_TS_REQ_fp(FILE *fp, TS_REQ *a);
131 TS_REQ *d2i_TS_REQ_bio(BIO *fp, TS_REQ **a);
132 int i2d_TS_REQ_bio(BIO *fp, TS_REQ *a);
134 TS_MSG_IMPRINT *TS_MSG_IMPRINT_new(void);
135 void TS_MSG_IMPRINT_free(TS_MSG_IMPRINT *a);
136 int i2d_TS_MSG_IMPRINT(const TS_MSG_IMPRINT *a, unsigned char **pp);
137 TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT(TS_MSG_IMPRINT **a,
138 const unsigned char **pp, long length);
140 TS_MSG_IMPRINT *TS_MSG_IMPRINT_dup(TS_MSG_IMPRINT *a);
142 #ifndef OPENSSL_NO_STDIO
143 TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT **a);
144 int i2d_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT *a);
146 TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT **a);
147 int i2d_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT *a);
149 TS_RESP *TS_RESP_new(void);
150 void TS_RESP_free(TS_RESP *a);
151 int i2d_TS_RESP(const TS_RESP *a, unsigned char **pp);
152 TS_RESP *d2i_TS_RESP(TS_RESP **a, const unsigned char **pp, long length);
153 TS_TST_INFO *PKCS7_to_TS_TST_INFO(PKCS7 *token);
154 TS_RESP *TS_RESP_dup(TS_RESP *a);
156 #ifndef OPENSSL_NO_STDIO
157 TS_RESP *d2i_TS_RESP_fp(FILE *fp, TS_RESP **a);
158 int i2d_TS_RESP_fp(FILE *fp, TS_RESP *a);
160 TS_RESP *d2i_TS_RESP_bio(BIO *bio, TS_RESP **a);
161 int i2d_TS_RESP_bio(BIO *bio, TS_RESP *a);
163 TS_STATUS_INFO *TS_STATUS_INFO_new(void);
164 void TS_STATUS_INFO_free(TS_STATUS_INFO *a);
165 int i2d_TS_STATUS_INFO(const TS_STATUS_INFO *a, unsigned char **pp);
166 TS_STATUS_INFO *d2i_TS_STATUS_INFO(TS_STATUS_INFO **a,
167 const unsigned char **pp, long length);
168 TS_STATUS_INFO *TS_STATUS_INFO_dup(TS_STATUS_INFO *a);
170 TS_TST_INFO *TS_TST_INFO_new(void);
171 void TS_TST_INFO_free(TS_TST_INFO *a);
172 int i2d_TS_TST_INFO(const TS_TST_INFO *a, unsigned char **pp);
173 TS_TST_INFO *d2i_TS_TST_INFO(TS_TST_INFO **a, const unsigned char **pp,
175 TS_TST_INFO *TS_TST_INFO_dup(TS_TST_INFO *a);
177 #ifndef OPENSSL_NO_STDIO
178 TS_TST_INFO *d2i_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO **a);
179 int i2d_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO *a);
181 TS_TST_INFO *d2i_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO **a);
182 int i2d_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO *a);
184 TS_ACCURACY *TS_ACCURACY_new(void);
185 void TS_ACCURACY_free(TS_ACCURACY *a);
186 int i2d_TS_ACCURACY(const TS_ACCURACY *a, unsigned char **pp);
187 TS_ACCURACY *d2i_TS_ACCURACY(TS_ACCURACY **a, const unsigned char **pp,
189 TS_ACCURACY *TS_ACCURACY_dup(TS_ACCURACY *a);
191 ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_new(void);
192 void ESS_ISSUER_SERIAL_free(ESS_ISSUER_SERIAL *a);
193 int i2d_ESS_ISSUER_SERIAL(const ESS_ISSUER_SERIAL *a, unsigned char **pp);
194 ESS_ISSUER_SERIAL *d2i_ESS_ISSUER_SERIAL(ESS_ISSUER_SERIAL **a,
195 const unsigned char **pp,
197 ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_dup(ESS_ISSUER_SERIAL *a);
199 ESS_CERT_ID *ESS_CERT_ID_new(void);
200 void ESS_CERT_ID_free(ESS_CERT_ID *a);
201 int i2d_ESS_CERT_ID(const ESS_CERT_ID *a, unsigned char **pp);
202 ESS_CERT_ID *d2i_ESS_CERT_ID(ESS_CERT_ID **a, const unsigned char **pp,
204 ESS_CERT_ID *ESS_CERT_ID_dup(ESS_CERT_ID *a);
206 ESS_SIGNING_CERT *ESS_SIGNING_CERT_new(void);
207 void ESS_SIGNING_CERT_free(ESS_SIGNING_CERT *a);
208 int i2d_ESS_SIGNING_CERT(const ESS_SIGNING_CERT *a, unsigned char **pp);
209 ESS_SIGNING_CERT *d2i_ESS_SIGNING_CERT(ESS_SIGNING_CERT **a,
210 const unsigned char **pp, long length);
211 ESS_SIGNING_CERT *ESS_SIGNING_CERT_dup(ESS_SIGNING_CERT *a);
213 void ERR_load_TS_strings(void);
215 int TS_REQ_set_version(TS_REQ *a, long version);
216 long TS_REQ_get_version(const TS_REQ *a);
218 int TS_STATUS_INFO_set_status(TS_STATUS_INFO *a, int i);
219 ASN1_INTEGER *TS_STATUS_INFO_get0_status(TS_STATUS_INFO *a);
221 STACK_OF(ASN1_UTF8STRING) *TS_STATUS_INFO_get0_text(TS_STATUS_INFO *a);
223 ASN1_BIT_STRING *TS_STATUS_INFO_get0_failure_info(TS_STATUS_INFO *a);
225 int TS_REQ_set_msg_imprint(TS_REQ *a, TS_MSG_IMPRINT *msg_imprint);
226 TS_MSG_IMPRINT *TS_REQ_get_msg_imprint(TS_REQ *a);
228 int TS_MSG_IMPRINT_set_algo(TS_MSG_IMPRINT *a, X509_ALGOR *alg);
229 X509_ALGOR *TS_MSG_IMPRINT_get_algo(TS_MSG_IMPRINT *a);
231 int TS_MSG_IMPRINT_set_msg(TS_MSG_IMPRINT *a, unsigned char *d, int len);
232 ASN1_OCTET_STRING *TS_MSG_IMPRINT_get_msg(TS_MSG_IMPRINT *a);
234 int TS_REQ_set_policy_id(TS_REQ *a, ASN1_OBJECT *policy);
235 ASN1_OBJECT *TS_REQ_get_policy_id(TS_REQ *a);
237 int TS_REQ_set_nonce(TS_REQ *a, const ASN1_INTEGER *nonce);
238 const ASN1_INTEGER *TS_REQ_get_nonce(const TS_REQ *a);
240 int TS_REQ_set_cert_req(TS_REQ *a, int cert_req);
241 int TS_REQ_get_cert_req(const TS_REQ *a);
243 STACK_OF(X509_EXTENSION) *TS_REQ_get_exts(TS_REQ *a);
244 void TS_REQ_ext_free(TS_REQ *a);
245 int TS_REQ_get_ext_count(TS_REQ *a);
246 int TS_REQ_get_ext_by_NID(TS_REQ *a, int nid, int lastpos);
247 int TS_REQ_get_ext_by_OBJ(TS_REQ *a, ASN1_OBJECT *obj, int lastpos);
248 int TS_REQ_get_ext_by_critical(TS_REQ *a, int crit, int lastpos);
249 X509_EXTENSION *TS_REQ_get_ext(TS_REQ *a, int loc);
250 X509_EXTENSION *TS_REQ_delete_ext(TS_REQ *a, int loc);
251 int TS_REQ_add_ext(TS_REQ *a, X509_EXTENSION *ex, int loc);
252 void *TS_REQ_get_ext_d2i(TS_REQ *a, int nid, int *crit, int *idx);
254 /* Function declarations for TS_REQ defined in ts/ts_req_print.c */
256 int TS_REQ_print_bio(BIO *bio, TS_REQ *a);
258 /* Function declarations for TS_RESP defined in ts/ts_resp_utils.c */
260 int TS_RESP_set_status_info(TS_RESP *a, TS_STATUS_INFO *info);
261 TS_STATUS_INFO *TS_RESP_get_status_info(TS_RESP *a);
263 /* Caller loses ownership of PKCS7 and TS_TST_INFO objects. */
264 void TS_RESP_set_tst_info(TS_RESP *a, PKCS7 *p7, TS_TST_INFO *tst_info);
265 PKCS7 *TS_RESP_get_token(TS_RESP *a);
266 TS_TST_INFO *TS_RESP_get_tst_info(TS_RESP *a);
268 int TS_TST_INFO_set_version(TS_TST_INFO *a, long version);
269 long TS_TST_INFO_get_version(const TS_TST_INFO *a);
271 int TS_TST_INFO_set_policy_id(TS_TST_INFO *a, ASN1_OBJECT *policy_id);
272 ASN1_OBJECT *TS_TST_INFO_get_policy_id(TS_TST_INFO *a);
274 int TS_TST_INFO_set_msg_imprint(TS_TST_INFO *a, TS_MSG_IMPRINT *msg_imprint);
275 TS_MSG_IMPRINT *TS_TST_INFO_get_msg_imprint(TS_TST_INFO *a);
277 int TS_TST_INFO_set_serial(TS_TST_INFO *a, const ASN1_INTEGER *serial);
278 const ASN1_INTEGER *TS_TST_INFO_get_serial(const TS_TST_INFO *a);
280 int TS_TST_INFO_set_time(TS_TST_INFO *a, const ASN1_GENERALIZEDTIME *gtime);
281 const ASN1_GENERALIZEDTIME *TS_TST_INFO_get_time(const TS_TST_INFO *a);
283 int TS_TST_INFO_set_accuracy(TS_TST_INFO *a, TS_ACCURACY *accuracy);
284 TS_ACCURACY *TS_TST_INFO_get_accuracy(TS_TST_INFO *a);
286 int TS_ACCURACY_set_seconds(TS_ACCURACY *a, const ASN1_INTEGER *seconds);
287 const ASN1_INTEGER *TS_ACCURACY_get_seconds(const TS_ACCURACY *a);
289 int TS_ACCURACY_set_millis(TS_ACCURACY *a, const ASN1_INTEGER *millis);
290 const ASN1_INTEGER *TS_ACCURACY_get_millis(const TS_ACCURACY *a);
292 int TS_ACCURACY_set_micros(TS_ACCURACY *a, const ASN1_INTEGER *micros);
293 const ASN1_INTEGER *TS_ACCURACY_get_micros(const TS_ACCURACY *a);
295 int TS_TST_INFO_set_ordering(TS_TST_INFO *a, int ordering);
296 int TS_TST_INFO_get_ordering(const TS_TST_INFO *a);
298 int TS_TST_INFO_set_nonce(TS_TST_INFO *a, const ASN1_INTEGER *nonce);
299 const ASN1_INTEGER *TS_TST_INFO_get_nonce(const TS_TST_INFO *a);
301 int TS_TST_INFO_set_tsa(TS_TST_INFO *a, GENERAL_NAME *tsa);
302 GENERAL_NAME *TS_TST_INFO_get_tsa(TS_TST_INFO *a);
304 STACK_OF(X509_EXTENSION) *TS_TST_INFO_get_exts(TS_TST_INFO *a);
305 void TS_TST_INFO_ext_free(TS_TST_INFO *a);
306 int TS_TST_INFO_get_ext_count(TS_TST_INFO *a);
307 int TS_TST_INFO_get_ext_by_NID(TS_TST_INFO *a, int nid, int lastpos);
308 int TS_TST_INFO_get_ext_by_OBJ(TS_TST_INFO *a, ASN1_OBJECT *obj, int lastpos);
309 int TS_TST_INFO_get_ext_by_critical(TS_TST_INFO *a, int crit, int lastpos);
310 X509_EXTENSION *TS_TST_INFO_get_ext(TS_TST_INFO *a, int loc);
311 X509_EXTENSION *TS_TST_INFO_delete_ext(TS_TST_INFO *a, int loc);
312 int TS_TST_INFO_add_ext(TS_TST_INFO *a, X509_EXTENSION *ex, int loc);
313 void *TS_TST_INFO_get_ext_d2i(TS_TST_INFO *a, int nid, int *crit, int *idx);
316 * Declarations related to response generation, defined in ts/ts_resp_sign.c.
319 /* Optional flags for response generation. */
321 /* Don't include the TSA name in response. */
322 # define TS_TSA_NAME 0x01
324 /* Set ordering to true in response. */
325 # define TS_ORDERING 0x02
328 * Include the signer certificate and the other specified certificates in
329 * the ESS signing certificate attribute beside the PKCS7 signed data.
330 * Only the signer certificates is included by default.
332 # define TS_ESS_CERT_ID_CHAIN 0x04
334 /* Forward declaration. */
337 /* This must return a unique number less than 160 bits long. */
338 typedef ASN1_INTEGER *(*TS_serial_cb) (struct TS_resp_ctx *, void *);
341 * This must return the seconds and microseconds since Jan 1, 1970 in the sec
342 * and usec variables allocated by the caller. Return non-zero for success
343 * and zero for failure.
345 typedef int (*TS_time_cb) (struct TS_resp_ctx *, void *, long *sec,
349 * This must process the given extension. It can modify the TS_TST_INFO
350 * object of the context. Return values: !0 (processed), 0 (error, it must
351 * set the status info/failure info of the response).
353 typedef int (*TS_extension_cb) (struct TS_resp_ctx *, X509_EXTENSION *,
356 typedef struct TS_resp_ctx TS_RESP_CTX;
358 DEFINE_STACK_OF(EVP_MD)
360 /* Creates a response context that can be used for generating responses. */
361 TS_RESP_CTX *TS_RESP_CTX_new(void);
362 void TS_RESP_CTX_free(TS_RESP_CTX *ctx);
364 /* This parameter must be set. */
365 int TS_RESP_CTX_set_signer_cert(TS_RESP_CTX *ctx, X509 *signer);
367 /* This parameter must be set. */
368 int TS_RESP_CTX_set_signer_key(TS_RESP_CTX *ctx, EVP_PKEY *key);
370 int TS_RESP_CTX_set_signer_digest(TS_RESP_CTX *ctx,
371 const EVP_MD *signer_digest);
373 /* This parameter must be set. */
374 int TS_RESP_CTX_set_def_policy(TS_RESP_CTX *ctx, ASN1_OBJECT *def_policy);
376 /* No additional certs are included in the response by default. */
377 int TS_RESP_CTX_set_certs(TS_RESP_CTX *ctx, STACK_OF(X509) *certs);
380 * Adds a new acceptable policy, only the default policy is accepted by
383 int TS_RESP_CTX_add_policy(TS_RESP_CTX *ctx, ASN1_OBJECT *policy);
386 * Adds a new acceptable message digest. Note that no message digests are
387 * accepted by default. The md argument is shared with the caller.
389 int TS_RESP_CTX_add_md(TS_RESP_CTX *ctx, const EVP_MD *md);
391 /* Accuracy is not included by default. */
392 int TS_RESP_CTX_set_accuracy(TS_RESP_CTX *ctx,
393 int secs, int millis, int micros);
396 * Clock precision digits, i.e. the number of decimal digits: '0' means sec,
397 * '3' msec, '6' usec, and so on. Default is 0.
399 int TS_RESP_CTX_set_clock_precision_digits(TS_RESP_CTX *ctx,
400 unsigned clock_precision_digits);
401 /* At most we accept usec precision. */
402 # define TS_MAX_CLOCK_PRECISION_DIGITS 6
404 /* No flags are set by default. */
405 void TS_RESP_CTX_add_flags(TS_RESP_CTX *ctx, int flags);
407 /* Default callback always returns a constant. */
408 void TS_RESP_CTX_set_serial_cb(TS_RESP_CTX *ctx, TS_serial_cb cb, void *data);
410 /* Default callback uses the gettimeofday() and gmtime() system calls. */
411 void TS_RESP_CTX_set_time_cb(TS_RESP_CTX *ctx, TS_time_cb cb, void *data);
414 * Default callback rejects all extensions. The extension callback is called
415 * when the TS_TST_INFO object is already set up and not signed yet.
417 /* FIXME: extension handling is not tested yet. */
418 void TS_RESP_CTX_set_extension_cb(TS_RESP_CTX *ctx,
419 TS_extension_cb cb, void *data);
421 /* The following methods can be used in the callbacks. */
422 int TS_RESP_CTX_set_status_info(TS_RESP_CTX *ctx,
423 int status, const char *text);
425 /* Sets the status info only if it is still TS_STATUS_GRANTED. */
426 int TS_RESP_CTX_set_status_info_cond(TS_RESP_CTX *ctx,
427 int status, const char *text);
429 int TS_RESP_CTX_add_failure_info(TS_RESP_CTX *ctx, int failure);
431 /* The get methods below can be used in the extension callback. */
432 TS_REQ *TS_RESP_CTX_get_request(TS_RESP_CTX *ctx);
434 TS_TST_INFO *TS_RESP_CTX_get_tst_info(TS_RESP_CTX *ctx);
437 * Creates the signed TS_TST_INFO and puts it in TS_RESP.
438 * In case of errors it sets the status info properly.
439 * Returns NULL only in case of memory allocation/fatal error.
441 TS_RESP *TS_RESP_create_response(TS_RESP_CTX *ctx, BIO *req_bio);
444 * Declarations related to response verification,
445 * they are defined in ts/ts_resp_verify.c.
448 int TS_RESP_verify_signature(PKCS7 *token, STACK_OF(X509) *certs,
449 X509_STORE *store, X509 **signer_out);
451 /* Context structure for the generic verify method. */
453 /* Verify the signer's certificate and the signature of the response. */
454 # define TS_VFY_SIGNATURE (1u << 0)
455 /* Verify the version number of the response. */
456 # define TS_VFY_VERSION (1u << 1)
457 /* Verify if the policy supplied by the user matches the policy of the TSA. */
458 # define TS_VFY_POLICY (1u << 2)
460 * Verify the message imprint provided by the user. This flag should not be
461 * specified with TS_VFY_DATA.
463 # define TS_VFY_IMPRINT (1u << 3)
465 * Verify the message imprint computed by the verify method from the user
466 * provided data and the MD algorithm of the response. This flag should not
467 * be specified with TS_VFY_IMPRINT.
469 # define TS_VFY_DATA (1u << 4)
470 /* Verify the nonce value. */
471 # define TS_VFY_NONCE (1u << 5)
472 /* Verify if the TSA name field matches the signer certificate. */
473 # define TS_VFY_SIGNER (1u << 6)
474 /* Verify if the TSA name field equals to the user provided name. */
475 # define TS_VFY_TSA_NAME (1u << 7)
477 /* You can use the following convenience constants. */
478 # define TS_VFY_ALL_IMPRINT (TS_VFY_SIGNATURE \
485 # define TS_VFY_ALL_DATA (TS_VFY_SIGNATURE \
493 typedef struct TS_verify_ctx TS_VERIFY_CTX;
495 int TS_RESP_verify_response(TS_VERIFY_CTX *ctx, TS_RESP *response);
496 int TS_RESP_verify_token(TS_VERIFY_CTX *ctx, PKCS7 *token);
499 * Declarations related to response verification context,
501 TS_VERIFY_CTX *TS_VERIFY_CTX_new(void);
502 void TS_VERIFY_CTX_init(TS_VERIFY_CTX *ctx);
503 void TS_VERIFY_CTX_free(TS_VERIFY_CTX *ctx);
504 void TS_VERIFY_CTX_cleanup(TS_VERIFY_CTX *ctx);
505 int TS_VERIFY_CTX_set_flags(TS_VERIFY_CTX *ctx, int f);
506 int TS_VERIFY_CTX_add_flags(TS_VERIFY_CTX *ctx, int f);
507 BIO *TS_VERIFY_CTX_set_data(TS_VERIFY_CTX *ctx, BIO *b);
508 unsigned char *TS_VERIFY_CTX_set_imprint(TS_VERIFY_CTX *ctx,
509 unsigned char *hexstr, long len);
510 X509_STORE *TS_VERIFY_CTX_set_store(TS_VERIFY_CTX *ctx, X509_STORE *s);
511 STACK_OF(X509) *TS_VERIFY_CTS_set_certs(TS_VERIFY_CTX *ctx, STACK_OF(X509) *certs);
514 * If ctx is NULL, it allocates and returns a new object, otherwise
515 * it returns ctx. It initialises all the members as follows:
516 * flags = TS_VFY_ALL_IMPRINT & ~(TS_VFY_TSA_NAME | TS_VFY_SIGNATURE)
519 * policy = policy from the request or NULL if absent (in this case
520 * TS_VFY_POLICY is cleared from flags as well)
521 * md_alg = MD algorithm from request
522 * imprint, imprint_len = imprint from request
524 * nonce, nonce_len = nonce from the request or NULL if absent (in this case
525 * TS_VFY_NONCE is cleared from flags as well)
527 * Important: after calling this method TS_VFY_SIGNATURE should be added!
529 TS_VERIFY_CTX *TS_REQ_to_TS_VERIFY_CTX(TS_REQ *req, TS_VERIFY_CTX *ctx);
531 /* Function declarations for TS_RESP defined in ts/ts_resp_print.c */
533 int TS_RESP_print_bio(BIO *bio, TS_RESP *a);
534 int TS_STATUS_INFO_print_bio(BIO *bio, TS_STATUS_INFO *a);
535 int TS_TST_INFO_print_bio(BIO *bio, TS_TST_INFO *a);
537 /* Common utility functions defined in ts/ts_lib.c */
539 int TS_ASN1_INTEGER_print_bio(BIO *bio, const ASN1_INTEGER *num);
540 int TS_OBJ_print_bio(BIO *bio, const ASN1_OBJECT *obj);
541 int TS_ext_print_bio(BIO *bio, const STACK_OF(X509_EXTENSION) *extensions);
542 int TS_X509_ALGOR_print_bio(BIO *bio, const X509_ALGOR *alg);
543 int TS_MSG_IMPRINT_print_bio(BIO *bio, TS_MSG_IMPRINT *msg);
546 * Function declarations for handling configuration options, defined in
550 X509 *TS_CONF_load_cert(const char *file);
551 STACK_OF(X509) *TS_CONF_load_certs(const char *file);
552 EVP_PKEY *TS_CONF_load_key(const char *file, const char *pass);
553 const char *TS_CONF_get_tsa_section(CONF *conf, const char *section);
554 int TS_CONF_set_serial(CONF *conf, const char *section, TS_serial_cb cb,
556 #ifndef OPENSSL_NO_ENGINE
557 int TS_CONF_set_crypto_device(CONF *conf, const char *section,
559 int TS_CONF_set_default_engine(const char *name);
561 int TS_CONF_set_signer_cert(CONF *conf, const char *section,
562 const char *cert, TS_RESP_CTX *ctx);
563 int TS_CONF_set_certs(CONF *conf, const char *section, const char *certs,
565 int TS_CONF_set_signer_key(CONF *conf, const char *section,
566 const char *key, const char *pass,
568 int TS_CONF_set_signer_digest(CONF *conf, const char *section,
569 const char *md, TS_RESP_CTX *ctx);
570 int TS_CONF_set_def_policy(CONF *conf, const char *section,
571 const char *policy, TS_RESP_CTX *ctx);
572 int TS_CONF_set_policies(CONF *conf, const char *section, TS_RESP_CTX *ctx);
573 int TS_CONF_set_digests(CONF *conf, const char *section, TS_RESP_CTX *ctx);
574 int TS_CONF_set_accuracy(CONF *conf, const char *section, TS_RESP_CTX *ctx);
575 int TS_CONF_set_clock_precision_digits(CONF *conf, const char *section,
577 int TS_CONF_set_ordering(CONF *conf, const char *section, TS_RESP_CTX *ctx);
578 int TS_CONF_set_tsa_name(CONF *conf, const char *section, TS_RESP_CTX *ctx);
579 int TS_CONF_set_ess_cert_id_chain(CONF *conf, const char *section,
582 /* -------------------------------------------------- */
583 /* BEGIN ERROR CODES */
585 * The following lines are auto generated by the script mkerr.pl. Any changes
586 * made after this point may be overwritten when the script is next run.
588 void ERR_load_TS_strings(void);
590 /* Error codes for the TS functions. */
592 /* Function codes. */
593 # define TS_F_D2I_TS_RESP 147
594 # define TS_F_DEF_SERIAL_CB 110
595 # define TS_F_DEF_TIME_CB 111
596 # define TS_F_ESS_ADD_SIGNING_CERT 112
597 # define TS_F_ESS_CERT_ID_NEW_INIT 113
598 # define TS_F_ESS_SIGNING_CERT_NEW_INIT 114
599 # define TS_F_INT_TS_RESP_VERIFY_TOKEN 149
600 # define TS_F_PKCS7_TO_TS_TST_INFO 148
601 # define TS_F_TS_ACCURACY_SET_MICROS 115
602 # define TS_F_TS_ACCURACY_SET_MILLIS 116
603 # define TS_F_TS_ACCURACY_SET_SECONDS 117
604 # define TS_F_TS_CHECK_IMPRINTS 100
605 # define TS_F_TS_CHECK_NONCES 101
606 # define TS_F_TS_CHECK_POLICY 102
607 # define TS_F_TS_CHECK_SIGNING_CERTS 103
608 # define TS_F_TS_CHECK_STATUS_INFO 104
609 # define TS_F_TS_COMPUTE_IMPRINT 145
610 # define TS_F_TS_CONF_INVALID 151
611 # define TS_F_TS_CONF_LOAD_CERT 153
612 # define TS_F_TS_CONF_LOAD_CERTS 154
613 # define TS_F_TS_CONF_LOAD_KEY 155
614 # define TS_F_TS_CONF_LOOKUP_FAIL 152
615 # define TS_F_TS_CONF_SET_DEFAULT_ENGINE 146
616 # define TS_F_TS_GET_STATUS_TEXT 105
617 # define TS_F_TS_MSG_IMPRINT_SET_ALGO 118
618 # define TS_F_TS_REQ_SET_MSG_IMPRINT 119
619 # define TS_F_TS_REQ_SET_NONCE 120
620 # define TS_F_TS_REQ_SET_POLICY_ID 121
621 # define TS_F_TS_RESP_CREATE_RESPONSE 122
622 # define TS_F_TS_RESP_CREATE_TST_INFO 123
623 # define TS_F_TS_RESP_CTX_ADD_FAILURE_INFO 124
624 # define TS_F_TS_RESP_CTX_ADD_MD 125
625 # define TS_F_TS_RESP_CTX_ADD_POLICY 126
626 # define TS_F_TS_RESP_CTX_NEW 127
627 # define TS_F_TS_RESP_CTX_SET_ACCURACY 128
628 # define TS_F_TS_RESP_CTX_SET_CERTS 129
629 # define TS_F_TS_RESP_CTX_SET_DEF_POLICY 130
630 # define TS_F_TS_RESP_CTX_SET_SIGNER_CERT 131
631 # define TS_F_TS_RESP_CTX_SET_STATUS_INFO 132
632 # define TS_F_TS_RESP_GET_POLICY 133
633 # define TS_F_TS_RESP_SET_GENTIME_WITH_PRECISION 134
634 # define TS_F_TS_RESP_SET_STATUS_INFO 135
635 # define TS_F_TS_RESP_SET_TST_INFO 150
636 # define TS_F_TS_RESP_SIGN 136
637 # define TS_F_TS_RESP_VERIFY_SIGNATURE 106
638 # define TS_F_TS_RESP_VERIFY_TOKEN 107
639 # define TS_F_TS_TST_INFO_SET_ACCURACY 137
640 # define TS_F_TS_TST_INFO_SET_MSG_IMPRINT 138
641 # define TS_F_TS_TST_INFO_SET_NONCE 139
642 # define TS_F_TS_TST_INFO_SET_POLICY_ID 140
643 # define TS_F_TS_TST_INFO_SET_SERIAL 141
644 # define TS_F_TS_TST_INFO_SET_TIME 142
645 # define TS_F_TS_TST_INFO_SET_TSA 143
646 # define TS_F_TS_VERIFY 108
647 # define TS_F_TS_VERIFY_CERT 109
648 # define TS_F_TS_VERIFY_CTX_NEW 144
651 # define TS_R_BAD_PKCS7_TYPE 132
652 # define TS_R_BAD_TYPE 133
653 # define TS_R_CANNOT_LOAD_CERT 137
654 # define TS_R_CANNOT_LOAD_KEY 138
655 # define TS_R_CERTIFICATE_VERIFY_ERROR 100
656 # define TS_R_COULD_NOT_SET_ENGINE 127
657 # define TS_R_COULD_NOT_SET_TIME 115
658 # define TS_R_D2I_TS_RESP_INT_FAILED 128
659 # define TS_R_DETACHED_CONTENT 134
660 # define TS_R_ESS_ADD_SIGNING_CERT_ERROR 116
661 # define TS_R_ESS_SIGNING_CERTIFICATE_ERROR 101
662 # define TS_R_INVALID_NULL_POINTER 102
663 # define TS_R_INVALID_SIGNER_CERTIFICATE_PURPOSE 117
664 # define TS_R_MESSAGE_IMPRINT_MISMATCH 103
665 # define TS_R_NONCE_MISMATCH 104
666 # define TS_R_NONCE_NOT_RETURNED 105
667 # define TS_R_NO_CONTENT 106
668 # define TS_R_NO_TIME_STAMP_TOKEN 107
669 # define TS_R_PKCS7_ADD_SIGNATURE_ERROR 118
670 # define TS_R_PKCS7_ADD_SIGNED_ATTR_ERROR 119
671 # define TS_R_PKCS7_TO_TS_TST_INFO_FAILED 129
672 # define TS_R_POLICY_MISMATCH 108
673 # define TS_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 120
674 # define TS_R_RESPONSE_SETUP_ERROR 121
675 # define TS_R_SIGNATURE_FAILURE 109
676 # define TS_R_THERE_MUST_BE_ONE_SIGNER 110
677 # define TS_R_TIME_SYSCALL_ERROR 122
678 # define TS_R_TOKEN_NOT_PRESENT 130
679 # define TS_R_TOKEN_PRESENT 131
680 # define TS_R_TSA_NAME_MISMATCH 111
681 # define TS_R_TSA_UNTRUSTED 112
682 # define TS_R_TST_INFO_SETUP_ERROR 123
683 # define TS_R_TS_DATASIGN 124
684 # define TS_R_UNACCEPTABLE_POLICY 125
685 # define TS_R_UNSUPPORTED_MD_ALGORITHM 126
686 # define TS_R_UNSUPPORTED_VERSION 113
687 # define TS_R_VAR_BAD_VALUE 135
688 # define TS_R_VAR_LOOKUP_FAILURE 136
689 # define TS_R_WRONG_CONTENT_TYPE 114