Debian Codegraph @

Cryptlib/Include/openssl/ts.h

raw
1 /* crypto/ts/ts.h */
2 /*
3 * Written by Zoltan Glozik ([email protected]) for the OpenSSL project
4 * 2002, 2003, 2004.
5 */
6 /* ====================================================================
7 * Copyright (c) 2006 The OpenSSL Project. All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 *
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * [email protected].
30 *
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
34 *
35 * 6. Redistributions of any form whatsoever must retain the following
36 * acknowledgment:
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 *
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
53 *
54 * This product includes cryptographic software written by Eric Young
55 * ([email protected]). This product includes software written by Tim
56 * Hudson ([email protected]).
57 *
58 */
59
60 #ifndef HEADER_TS_H
61 # define HEADER_TS_H
62
63 # include <openssl/opensslconf.h>
64 # include <openssl/symhacks.h>
65 # ifndef OPENSSL_NO_BUFFER
66 # include <openssl/buffer.h>
67 # endif
68 # ifndef OPENSSL_NO_EVP
69 # include <openssl/evp.h>
70 # endif
71 # ifndef OPENSSL_NO_BIO
72 # include <openssl/bio.h>
73 # endif
74 # include <openssl/stack.h>
75 # include <openssl/asn1.h>
76 # include <openssl/safestack.h>
77
78 # ifndef OPENSSL_NO_RSA
79 # include <openssl/rsa.h>
80 # endif
81
82 # ifndef OPENSSL_NO_DSA
83 # include <openssl/dsa.h>
84 # endif
85
86 # ifndef OPENSSL_NO_DH
87 # include <openssl/dh.h>
88 # endif
89
90 #ifdef __cplusplus
91 extern "C" {
92 #endif
93
94 # ifdef WIN32
95 /* Under Win32 this is defined in wincrypt.h */
96 # undef X509_NAME
97 # endif
98
99 # include <openssl/x509.h>
100 # include <openssl/x509v3.h>
101
102 /*-
103 MessageImprint ::= SEQUENCE {
104 hashAlgorithm AlgorithmIdentifier,
105 hashedMessage OCTET STRING }
106 */
107
108 typedef struct TS_msg_imprint_st {
109 X509_ALGOR *hash_algo;
110 ASN1_OCTET_STRING *hashed_msg;
111 } TS_MSG_IMPRINT;
112
113 /*-
114 TimeStampReq ::= SEQUENCE {
115 version INTEGER { v1(1) },
116 messageImprint MessageImprint,
117 --a hash algorithm OID and the hash value of the data to be
118 --time-stamped
119 reqPolicy TSAPolicyId OPTIONAL,
120 nonce INTEGER OPTIONAL,
121 certReq BOOLEAN DEFAULT FALSE,
122 extensions [0] IMPLICIT Extensions OPTIONAL }
123 */
124
125 typedef struct TS_req_st {
126 ASN1_INTEGER *version;
127 TS_MSG_IMPRINT *msg_imprint;
128 ASN1_OBJECT *policy_id; /* OPTIONAL */
129 ASN1_INTEGER *nonce; /* OPTIONAL */
130 ASN1_BOOLEAN cert_req; /* DEFAULT FALSE */
131 STACK_OF(X509_EXTENSION) *extensions; /* [0] OPTIONAL */
132 } TS_REQ;
133
134 /*-
135 Accuracy ::= SEQUENCE {
136 seconds INTEGER OPTIONAL,
137 millis [0] INTEGER (1..999) OPTIONAL,
138 micros [1] INTEGER (1..999) OPTIONAL }
139 */
140
141 typedef struct TS_accuracy_st {
142 ASN1_INTEGER *seconds;
143 ASN1_INTEGER *millis;
144 ASN1_INTEGER *micros;
145 } TS_ACCURACY;
146
147 /*-
148 TSTInfo ::= SEQUENCE {
149 version INTEGER { v1(1) },
150 policy TSAPolicyId,
151 messageImprint MessageImprint,
152 -- MUST have the same value as the similar field in
153 -- TimeStampReq
154 serialNumber INTEGER,
155 -- Time-Stamping users MUST be ready to accommodate integers
156 -- up to 160 bits.
157 genTime GeneralizedTime,
158 accuracy Accuracy OPTIONAL,
159 ordering BOOLEAN DEFAULT FALSE,
160 nonce INTEGER OPTIONAL,
161 -- MUST be present if the similar field was present
162 -- in TimeStampReq. In that case it MUST have the same value.
163 tsa [0] GeneralName OPTIONAL,
164 extensions [1] IMPLICIT Extensions OPTIONAL }
165 */
166
167 typedef struct TS_tst_info_st {
168 ASN1_INTEGER *version;
169 ASN1_OBJECT *policy_id;
170 TS_MSG_IMPRINT *msg_imprint;
171 ASN1_INTEGER *serial;
172 ASN1_GENERALIZEDTIME *time;
173 TS_ACCURACY *accuracy;
174 ASN1_BOOLEAN ordering;
175 ASN1_INTEGER *nonce;
176 GENERAL_NAME *tsa;
177 STACK_OF(X509_EXTENSION) *extensions;
178 } TS_TST_INFO;
179
180 /*-
181 PKIStatusInfo ::= SEQUENCE {
182 status PKIStatus,
183 statusString PKIFreeText OPTIONAL,
184 failInfo PKIFailureInfo OPTIONAL }
185
186 From RFC 1510 - section 3.1.1:
187 PKIFreeText ::= SEQUENCE SIZE (1..MAX) OF UTF8String
188 -- text encoded as UTF-8 String (note: each UTF8String SHOULD
189 -- include an RFC 1766 language tag to indicate the language
190 -- of the contained text)
191 */
192
193 /* Possible values for status. See ts_resp_print.c && ts_resp_verify.c. */
194
195 # define TS_STATUS_GRANTED 0
196 # define TS_STATUS_GRANTED_WITH_MODS 1
197 # define TS_STATUS_REJECTION 2
198 # define TS_STATUS_WAITING 3
199 # define TS_STATUS_REVOCATION_WARNING 4
200 # define TS_STATUS_REVOCATION_NOTIFICATION 5
201
202 /*
203 * Possible values for failure_info. See ts_resp_print.c && ts_resp_verify.c
204 */
205
206 # define TS_INFO_BAD_ALG 0
207 # define TS_INFO_BAD_REQUEST 2
208 # define TS_INFO_BAD_DATA_FORMAT 5
209 # define TS_INFO_TIME_NOT_AVAILABLE 14
210 # define TS_INFO_UNACCEPTED_POLICY 15
211 # define TS_INFO_UNACCEPTED_EXTENSION 16
212 # define TS_INFO_ADD_INFO_NOT_AVAILABLE 17
213 # define TS_INFO_SYSTEM_FAILURE 25
214
215 typedef struct TS_status_info_st {
216 ASN1_INTEGER *status;
217 STACK_OF(ASN1_UTF8STRING) *text;
218 ASN1_BIT_STRING *failure_info;
219 } TS_STATUS_INFO;
220
221 DECLARE_STACK_OF(ASN1_UTF8STRING)
222 DECLARE_ASN1_SET_OF(ASN1_UTF8STRING)
223
224 /*-
225 TimeStampResp ::= SEQUENCE {
226 status PKIStatusInfo,
227 timeStampToken TimeStampToken OPTIONAL }
228 */
229
230 typedef struct TS_resp_st {
231 TS_STATUS_INFO *status_info;
232 PKCS7 *token;
233 TS_TST_INFO *tst_info;
234 } TS_RESP;
235
236 /* The structure below would belong to the ESS component. */
237
238 /*-
239 IssuerSerial ::= SEQUENCE {
240 issuer GeneralNames,
241 serialNumber CertificateSerialNumber
242 }
243 */
244
245 typedef struct ESS_issuer_serial {
246 STACK_OF(GENERAL_NAME) *issuer;
247 ASN1_INTEGER *serial;
248 } ESS_ISSUER_SERIAL;
249
250 /*-
251 ESSCertID ::= SEQUENCE {
252 certHash Hash,
253 issuerSerial IssuerSerial OPTIONAL
254 }
255 */
256
257 typedef struct ESS_cert_id {
258 ASN1_OCTET_STRING *hash; /* Always SHA-1 digest. */
259 ESS_ISSUER_SERIAL *issuer_serial;
260 } ESS_CERT_ID;
261
262 DECLARE_STACK_OF(ESS_CERT_ID)
263 DECLARE_ASN1_SET_OF(ESS_CERT_ID)
264
265 /*-
266 SigningCertificate ::= SEQUENCE {
267 certs SEQUENCE OF ESSCertID,
268 policies SEQUENCE OF PolicyInformation OPTIONAL
269 }
270 */
271
272 typedef struct ESS_signing_cert {
273 STACK_OF(ESS_CERT_ID) *cert_ids;
274 STACK_OF(POLICYINFO) *policy_info;
275 } ESS_SIGNING_CERT;
276
277 TS_REQ *TS_REQ_new(void);
278 void TS_REQ_free(TS_REQ *a);
279 int i2d_TS_REQ(const TS_REQ *a, unsigned char **pp);
280 TS_REQ *d2i_TS_REQ(TS_REQ **a, const unsigned char **pp, long length);
281
282 TS_REQ *TS_REQ_dup(TS_REQ *a);
283
284 #ifndef OPENSSL_NO_FP_API
285 TS_REQ *d2i_TS_REQ_fp(FILE *fp, TS_REQ **a);
286 int i2d_TS_REQ_fp(FILE *fp, TS_REQ *a);
287 #endif
288 TS_REQ *d2i_TS_REQ_bio(BIO *fp, TS_REQ **a);
289 int i2d_TS_REQ_bio(BIO *fp, TS_REQ *a);
290
291 TS_MSG_IMPRINT *TS_MSG_IMPRINT_new(void);
292 void TS_MSG_IMPRINT_free(TS_MSG_IMPRINT *a);
293 int i2d_TS_MSG_IMPRINT(const TS_MSG_IMPRINT *a, unsigned char **pp);
294 TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT(TS_MSG_IMPRINT **a,
295 const unsigned char **pp, long length);
296
297 TS_MSG_IMPRINT *TS_MSG_IMPRINT_dup(TS_MSG_IMPRINT *a);
298
299 #ifndef OPENSSL_NO_FP_API
300 TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT **a);
301 int i2d_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT *a);
302 #endif
303 TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT **a);
304 int i2d_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT *a);
305
306 TS_RESP *TS_RESP_new(void);
307 void TS_RESP_free(TS_RESP *a);
308 int i2d_TS_RESP(const TS_RESP *a, unsigned char **pp);
309 TS_RESP *d2i_TS_RESP(TS_RESP **a, const unsigned char **pp, long length);
310 TS_TST_INFO *PKCS7_to_TS_TST_INFO(PKCS7 *token);
311 TS_RESP *TS_RESP_dup(TS_RESP *a);
312
313 #ifndef OPENSSL_NO_FP_API
314 TS_RESP *d2i_TS_RESP_fp(FILE *fp, TS_RESP **a);
315 int i2d_TS_RESP_fp(FILE *fp, TS_RESP *a);
316 #endif
317 TS_RESP *d2i_TS_RESP_bio(BIO *bio, TS_RESP **a);
318 int i2d_TS_RESP_bio(BIO *bio, TS_RESP *a);
319
320 TS_STATUS_INFO *TS_STATUS_INFO_new(void);
321 void TS_STATUS_INFO_free(TS_STATUS_INFO *a);
322 int i2d_TS_STATUS_INFO(const TS_STATUS_INFO *a, unsigned char **pp);
323 TS_STATUS_INFO *d2i_TS_STATUS_INFO(TS_STATUS_INFO **a,
324 const unsigned char **pp, long length);
325 TS_STATUS_INFO *TS_STATUS_INFO_dup(TS_STATUS_INFO *a);
326
327 TS_TST_INFO *TS_TST_INFO_new(void);
328 void TS_TST_INFO_free(TS_TST_INFO *a);
329 int i2d_TS_TST_INFO(const TS_TST_INFO *a, unsigned char **pp);
330 TS_TST_INFO *d2i_TS_TST_INFO(TS_TST_INFO **a, const unsigned char **pp,
331 long length);
332 TS_TST_INFO *TS_TST_INFO_dup(TS_TST_INFO *a);
333
334 #ifndef OPENSSL_NO_FP_API
335 TS_TST_INFO *d2i_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO **a);
336 int i2d_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO *a);
337 #endif
338 TS_TST_INFO *d2i_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO **a);
339 int i2d_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO *a);
340
341 TS_ACCURACY *TS_ACCURACY_new(void);
342 void TS_ACCURACY_free(TS_ACCURACY *a);
343 int i2d_TS_ACCURACY(const TS_ACCURACY *a, unsigned char **pp);
344 TS_ACCURACY *d2i_TS_ACCURACY(TS_ACCURACY **a, const unsigned char **pp,
345 long length);
346 TS_ACCURACY *TS_ACCURACY_dup(TS_ACCURACY *a);
347
348 ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_new(void);
349 void ESS_ISSUER_SERIAL_free(ESS_ISSUER_SERIAL *a);
350 int i2d_ESS_ISSUER_SERIAL(const ESS_ISSUER_SERIAL *a, unsigned char **pp);
351 ESS_ISSUER_SERIAL *d2i_ESS_ISSUER_SERIAL(ESS_ISSUER_SERIAL **a,
352 const unsigned char **pp,
353 long length);
354 ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_dup(ESS_ISSUER_SERIAL *a);
355
356 ESS_CERT_ID *ESS_CERT_ID_new(void);
357 void ESS_CERT_ID_free(ESS_CERT_ID *a);
358 int i2d_ESS_CERT_ID(const ESS_CERT_ID *a, unsigned char **pp);
359 ESS_CERT_ID *d2i_ESS_CERT_ID(ESS_CERT_ID **a, const unsigned char **pp,
360 long length);
361 ESS_CERT_ID *ESS_CERT_ID_dup(ESS_CERT_ID *a);
362
363 ESS_SIGNING_CERT *ESS_SIGNING_CERT_new(void);
364 void ESS_SIGNING_CERT_free(ESS_SIGNING_CERT *a);
365 int i2d_ESS_SIGNING_CERT(const ESS_SIGNING_CERT *a, unsigned char **pp);
366 ESS_SIGNING_CERT *d2i_ESS_SIGNING_CERT(ESS_SIGNING_CERT **a,
367 const unsigned char **pp, long length);
368 ESS_SIGNING_CERT *ESS_SIGNING_CERT_dup(ESS_SIGNING_CERT *a);
369
370 void ERR_load_TS_strings(void);
371
372 int TS_REQ_set_version(TS_REQ *a, long version);
373 long TS_REQ_get_version(const TS_REQ *a);
374
375 int TS_REQ_set_msg_imprint(TS_REQ *a, TS_MSG_IMPRINT *msg_imprint);
376 TS_MSG_IMPRINT *TS_REQ_get_msg_imprint(TS_REQ *a);
377
378 int TS_MSG_IMPRINT_set_algo(TS_MSG_IMPRINT *a, X509_ALGOR *alg);
379 X509_ALGOR *TS_MSG_IMPRINT_get_algo(TS_MSG_IMPRINT *a);
380
381 int TS_MSG_IMPRINT_set_msg(TS_MSG_IMPRINT *a, unsigned char *d, int len);
382 ASN1_OCTET_STRING *TS_MSG_IMPRINT_get_msg(TS_MSG_IMPRINT *a);
383
384 int TS_REQ_set_policy_id(TS_REQ *a, ASN1_OBJECT *policy);
385 ASN1_OBJECT *TS_REQ_get_policy_id(TS_REQ *a);
386
387 int TS_REQ_set_nonce(TS_REQ *a, const ASN1_INTEGER *nonce);
388 const ASN1_INTEGER *TS_REQ_get_nonce(const TS_REQ *a);
389
390 int TS_REQ_set_cert_req(TS_REQ *a, int cert_req);
391 int TS_REQ_get_cert_req(const TS_REQ *a);
392
393 STACK_OF(X509_EXTENSION) *TS_REQ_get_exts(TS_REQ *a);
394 void TS_REQ_ext_free(TS_REQ *a);
395 int TS_REQ_get_ext_count(TS_REQ *a);
396 int TS_REQ_get_ext_by_NID(TS_REQ *a, int nid, int lastpos);
397 int TS_REQ_get_ext_by_OBJ(TS_REQ *a, ASN1_OBJECT *obj, int lastpos);
398 int TS_REQ_get_ext_by_critical(TS_REQ *a, int crit, int lastpos);
399 X509_EXTENSION *TS_REQ_get_ext(TS_REQ *a, int loc);
400 X509_EXTENSION *TS_REQ_delete_ext(TS_REQ *a, int loc);
401 int TS_REQ_add_ext(TS_REQ *a, X509_EXTENSION *ex, int loc);
402 void *TS_REQ_get_ext_d2i(TS_REQ *a, int nid, int *crit, int *idx);
403
404 /* Function declarations for TS_REQ defined in ts/ts_req_print.c */
405
406 int TS_REQ_print_bio(BIO *bio, TS_REQ *a);
407
408 /* Function declarations for TS_RESP defined in ts/ts_resp_utils.c */
409
410 int TS_RESP_set_status_info(TS_RESP *a, TS_STATUS_INFO *info);
411 TS_STATUS_INFO *TS_RESP_get_status_info(TS_RESP *a);
412
413 /* Caller loses ownership of PKCS7 and TS_TST_INFO objects. */
414 void TS_RESP_set_tst_info(TS_RESP *a, PKCS7 *p7, TS_TST_INFO *tst_info);
415 PKCS7 *TS_RESP_get_token(TS_RESP *a);
416 TS_TST_INFO *TS_RESP_get_tst_info(TS_RESP *a);
417
418 int TS_TST_INFO_set_version(TS_TST_INFO *a, long version);
419 long TS_TST_INFO_get_version(const TS_TST_INFO *a);
420
421 int TS_TST_INFO_set_policy_id(TS_TST_INFO *a, ASN1_OBJECT *policy_id);
422 ASN1_OBJECT *TS_TST_INFO_get_policy_id(TS_TST_INFO *a);
423
424 int TS_TST_INFO_set_msg_imprint(TS_TST_INFO *a, TS_MSG_IMPRINT *msg_imprint);
425 TS_MSG_IMPRINT *TS_TST_INFO_get_msg_imprint(TS_TST_INFO *a);
426
427 int TS_TST_INFO_set_serial(TS_TST_INFO *a, const ASN1_INTEGER *serial);
428 const ASN1_INTEGER *TS_TST_INFO_get_serial(const TS_TST_INFO *a);
429
430 int TS_TST_INFO_set_time(TS_TST_INFO *a, const ASN1_GENERALIZEDTIME *gtime);
431 const ASN1_GENERALIZEDTIME *TS_TST_INFO_get_time(const TS_TST_INFO *a);
432
433 int TS_TST_INFO_set_accuracy(TS_TST_INFO *a, TS_ACCURACY *accuracy);
434 TS_ACCURACY *TS_TST_INFO_get_accuracy(TS_TST_INFO *a);
435
436 int TS_ACCURACY_set_seconds(TS_ACCURACY *a, const ASN1_INTEGER *seconds);
437 const ASN1_INTEGER *TS_ACCURACY_get_seconds(const TS_ACCURACY *a);
438
439 int TS_ACCURACY_set_millis(TS_ACCURACY *a, const ASN1_INTEGER *millis);
440 const ASN1_INTEGER *TS_ACCURACY_get_millis(const TS_ACCURACY *a);
441
442 int TS_ACCURACY_set_micros(TS_ACCURACY *a, const ASN1_INTEGER *micros);
443 const ASN1_INTEGER *TS_ACCURACY_get_micros(const TS_ACCURACY *a);
444
445 int TS_TST_INFO_set_ordering(TS_TST_INFO *a, int ordering);
446 int TS_TST_INFO_get_ordering(const TS_TST_INFO *a);
447
448 int TS_TST_INFO_set_nonce(TS_TST_INFO *a, const ASN1_INTEGER *nonce);
449 const ASN1_INTEGER *TS_TST_INFO_get_nonce(const TS_TST_INFO *a);
450
451 int TS_TST_INFO_set_tsa(TS_TST_INFO *a, GENERAL_NAME *tsa);
452 GENERAL_NAME *TS_TST_INFO_get_tsa(TS_TST_INFO *a);
453
454 STACK_OF(X509_EXTENSION) *TS_TST_INFO_get_exts(TS_TST_INFO *a);
455 void TS_TST_INFO_ext_free(TS_TST_INFO *a);
456 int TS_TST_INFO_get_ext_count(TS_TST_INFO *a);
457 int TS_TST_INFO_get_ext_by_NID(TS_TST_INFO *a, int nid, int lastpos);
458 int TS_TST_INFO_get_ext_by_OBJ(TS_TST_INFO *a, ASN1_OBJECT *obj, int lastpos);
459 int TS_TST_INFO_get_ext_by_critical(TS_TST_INFO *a, int crit, int lastpos);
460 X509_EXTENSION *TS_TST_INFO_get_ext(TS_TST_INFO *a, int loc);
461 X509_EXTENSION *TS_TST_INFO_delete_ext(TS_TST_INFO *a, int loc);
462 int TS_TST_INFO_add_ext(TS_TST_INFO *a, X509_EXTENSION *ex, int loc);
463 void *TS_TST_INFO_get_ext_d2i(TS_TST_INFO *a, int nid, int *crit, int *idx);
464
465 /*
466 * Declarations related to response generation, defined in ts/ts_resp_sign.c.
467 */
468
469 /* Optional flags for response generation. */
470
471 /* Don't include the TSA name in response. */
472 # define TS_TSA_NAME 0x01
473
474 /* Set ordering to true in response. */
475 # define TS_ORDERING 0x02
476
477 /*
478 * Include the signer certificate and the other specified certificates in
479 * the ESS signing certificate attribute beside the PKCS7 signed data.
480 * Only the signer certificates is included by default.
481 */
482 # define TS_ESS_CERT_ID_CHAIN 0x04
483
484 /* Forward declaration. */
485 struct TS_resp_ctx;
486
487 /* This must return a unique number less than 160 bits long. */
488 typedef ASN1_INTEGER *(*TS_serial_cb) (struct TS_resp_ctx *, void *);
489
490 /*
491 * This must return the seconds and microseconds since Jan 1, 1970 in the sec
492 * and usec variables allocated by the caller. Return non-zero for success
493 * and zero for failure.
494 */
495 typedef int (*TS_time_cb) (struct TS_resp_ctx *, void *, long *sec,
496 long *usec);
497
498 /*
499 * This must process the given extension. It can modify the TS_TST_INFO
500 * object of the context. Return values: !0 (processed), 0 (error, it must
501 * set the status info/failure info of the response).
502 */
503 typedef int (*TS_extension_cb) (struct TS_resp_ctx *, X509_EXTENSION *,
504 void *);
505
506 typedef struct TS_resp_ctx {
507 X509 *signer_cert;
508 EVP_PKEY *signer_key;
509 STACK_OF(X509) *certs; /* Certs to include in signed data. */
510 STACK_OF(ASN1_OBJECT) *policies; /* Acceptable policies. */
511 ASN1_OBJECT *default_policy; /* It may appear in policies, too. */
512 STACK_OF(EVP_MD) *mds; /* Acceptable message digests. */
513 ASN1_INTEGER *seconds; /* accuracy, 0 means not specified. */
514 ASN1_INTEGER *millis; /* accuracy, 0 means not specified. */
515 ASN1_INTEGER *micros; /* accuracy, 0 means not specified. */
516 unsigned clock_precision_digits; /* fraction of seconds in time stamp
517 * token. */
518 unsigned flags; /* Optional info, see values above. */
519 /* Callback functions. */
520 TS_serial_cb serial_cb;
521 void *serial_cb_data; /* User data for serial_cb. */
522 TS_time_cb time_cb;
523 void *time_cb_data; /* User data for time_cb. */
524 TS_extension_cb extension_cb;
525 void *extension_cb_data; /* User data for extension_cb. */
526 /* These members are used only while creating the response. */
527 TS_REQ *request;
528 TS_RESP *response;
529 TS_TST_INFO *tst_info;
530 } TS_RESP_CTX;
531
532 DECLARE_STACK_OF(EVP_MD)
533 DECLARE_ASN1_SET_OF(EVP_MD)
534
535 /* Creates a response context that can be used for generating responses. */
536 TS_RESP_CTX *TS_RESP_CTX_new(void);
537 void TS_RESP_CTX_free(TS_RESP_CTX *ctx);
538
539 /* This parameter must be set. */
540 int TS_RESP_CTX_set_signer_cert(TS_RESP_CTX *ctx, X509 *signer);
541
542 /* This parameter must be set. */
543 int TS_RESP_CTX_set_signer_key(TS_RESP_CTX *ctx, EVP_PKEY *key);
544
545 /* This parameter must be set. */
546 int TS_RESP_CTX_set_def_policy(TS_RESP_CTX *ctx, ASN1_OBJECT *def_policy);
547
548 /* No additional certs are included in the response by default. */
549 int TS_RESP_CTX_set_certs(TS_RESP_CTX *ctx, STACK_OF(X509) *certs);
550
551 /*
552 * Adds a new acceptable policy, only the default policy is accepted by
553 * default.
554 */
555 int TS_RESP_CTX_add_policy(TS_RESP_CTX *ctx, ASN1_OBJECT *policy);
556
557 /*
558 * Adds a new acceptable message digest. Note that no message digests are
559 * accepted by default. The md argument is shared with the caller.
560 */
561 int TS_RESP_CTX_add_md(TS_RESP_CTX *ctx, const EVP_MD *md);
562
563 /* Accuracy is not included by default. */
564 int TS_RESP_CTX_set_accuracy(TS_RESP_CTX *ctx,
565 int secs, int millis, int micros);
566
567 /*
568 * Clock precision digits, i.e. the number of decimal digits: '0' means sec,
569 * '3' msec, '6' usec, and so on. Default is 0.
570 */
571 int TS_RESP_CTX_set_clock_precision_digits(TS_RESP_CTX *ctx,
572 unsigned clock_precision_digits);
573 /* At most we accept usec precision. */
574 # define TS_MAX_CLOCK_PRECISION_DIGITS 6
575
576 /* Maximum status message length */
577 # define TS_MAX_STATUS_LENGTH (1024 * 1024)
578
579 /* No flags are set by default. */
580 void TS_RESP_CTX_add_flags(TS_RESP_CTX *ctx, int flags);
581
582 /* Default callback always returns a constant. */
583 void TS_RESP_CTX_set_serial_cb(TS_RESP_CTX *ctx, TS_serial_cb cb, void *data);
584
585 /* Default callback uses the gettimeofday() and gmtime() system calls. */
586 void TS_RESP_CTX_set_time_cb(TS_RESP_CTX *ctx, TS_time_cb cb, void *data);
587
588 /*
589 * Default callback rejects all extensions. The extension callback is called
590 * when the TS_TST_INFO object is already set up and not signed yet.
591 */
592 /* FIXME: extension handling is not tested yet. */
593 void TS_RESP_CTX_set_extension_cb(TS_RESP_CTX *ctx,
594 TS_extension_cb cb, void *data);
595
596 /* The following methods can be used in the callbacks. */
597 int TS_RESP_CTX_set_status_info(TS_RESP_CTX *ctx,
598 int status, const char *text);
599
600 /* Sets the status info only if it is still TS_STATUS_GRANTED. */
601 int TS_RESP_CTX_set_status_info_cond(TS_RESP_CTX *ctx,
602 int status, const char *text);
603
604 int TS_RESP_CTX_add_failure_info(TS_RESP_CTX *ctx, int failure);
605
606 /* The get methods below can be used in the extension callback. */
607 TS_REQ *TS_RESP_CTX_get_request(TS_RESP_CTX *ctx);
608
609 TS_TST_INFO *TS_RESP_CTX_get_tst_info(TS_RESP_CTX *ctx);
610
611 /*
612 * Creates the signed TS_TST_INFO and puts it in TS_RESP.
613 * In case of errors it sets the status info properly.
614 * Returns NULL only in case of memory allocation/fatal error.
615 */
616 TS_RESP *TS_RESP_create_response(TS_RESP_CTX *ctx, BIO *req_bio);
617
618 /*
619 * Declarations related to response verification,
620 * they are defined in ts/ts_resp_verify.c.
621 */
622
623 int TS_RESP_verify_signature(PKCS7 *token, STACK_OF(X509) *certs,
624 X509_STORE *store, X509 **signer_out);
625
626 /* Context structure for the generic verify method. */
627
628 /* Verify the signer's certificate and the signature of the response. */
629 # define TS_VFY_SIGNATURE (1u << 0)
630 /* Verify the version number of the response. */
631 # define TS_VFY_VERSION (1u << 1)
632 /* Verify if the policy supplied by the user matches the policy of the TSA. */
633 # define TS_VFY_POLICY (1u << 2)
634 /*
635 * Verify the message imprint provided by the user. This flag should not be
636 * specified with TS_VFY_DATA.
637 */
638 # define TS_VFY_IMPRINT (1u << 3)
639 /*
640 * Verify the message imprint computed by the verify method from the user
641 * provided data and the MD algorithm of the response. This flag should not
642 * be specified with TS_VFY_IMPRINT.
643 */
644 # define TS_VFY_DATA (1u << 4)
645 /* Verify the nonce value. */
646 # define TS_VFY_NONCE (1u << 5)
647 /* Verify if the TSA name field matches the signer certificate. */
648 # define TS_VFY_SIGNER (1u << 6)
649 /* Verify if the TSA name field equals to the user provided name. */
650 # define TS_VFY_TSA_NAME (1u << 7)
651
652 /* You can use the following convenience constants. */
653 # define TS_VFY_ALL_IMPRINT (TS_VFY_SIGNATURE \
654 | TS_VFY_VERSION \
655 | TS_VFY_POLICY \
656 | TS_VFY_IMPRINT \
657 | TS_VFY_NONCE \
658 | TS_VFY_SIGNER \
659 | TS_VFY_TSA_NAME)
660 # define TS_VFY_ALL_DATA (TS_VFY_SIGNATURE \
661 | TS_VFY_VERSION \
662 | TS_VFY_POLICY \
663 | TS_VFY_DATA \
664 | TS_VFY_NONCE \
665 | TS_VFY_SIGNER \
666 | TS_VFY_TSA_NAME)
667
668 typedef struct TS_verify_ctx {
669 /* Set this to the union of TS_VFY_... flags you want to carry out. */
670 unsigned flags;
671 /* Must be set only with TS_VFY_SIGNATURE. certs is optional. */
672 X509_STORE *store;
673 STACK_OF(X509) *certs;
674 /* Must be set only with TS_VFY_POLICY. */
675 ASN1_OBJECT *policy;
676 /*
677 * Must be set only with TS_VFY_IMPRINT. If md_alg is NULL, the
678 * algorithm from the response is used.
679 */
680 X509_ALGOR *md_alg;
681 unsigned char *imprint;
682 unsigned imprint_len;
683 /* Must be set only with TS_VFY_DATA. */
684 BIO *data;
685 /* Must be set only with TS_VFY_TSA_NAME. */
686 ASN1_INTEGER *nonce;
687 /* Must be set only with TS_VFY_TSA_NAME. */
688 GENERAL_NAME *tsa_name;
689 } TS_VERIFY_CTX;
690
691 int TS_RESP_verify_response(TS_VERIFY_CTX *ctx, TS_RESP *response);
692 int TS_RESP_verify_token(TS_VERIFY_CTX *ctx, PKCS7 *token);
693
694 /*
695 * Declarations related to response verification context,
696 * they are defined in ts/ts_verify_ctx.c.
697 */
698
699 /* Set all fields to zero. */
700 TS_VERIFY_CTX *TS_VERIFY_CTX_new(void);
701 void TS_VERIFY_CTX_init(TS_VERIFY_CTX *ctx);
702 void TS_VERIFY_CTX_free(TS_VERIFY_CTX *ctx);
703 void TS_VERIFY_CTX_cleanup(TS_VERIFY_CTX *ctx);
704
705 /*-
706 * If ctx is NULL, it allocates and returns a new object, otherwise
707 * it returns ctx. It initialises all the members as follows:
708 * flags = TS_VFY_ALL_IMPRINT & ~(TS_VFY_TSA_NAME | TS_VFY_SIGNATURE)
709 * certs = NULL
710 * store = NULL
711 * policy = policy from the request or NULL if absent (in this case
712 * TS_VFY_POLICY is cleared from flags as well)
713 * md_alg = MD algorithm from request
714 * imprint, imprint_len = imprint from request
715 * data = NULL
716 * nonce, nonce_len = nonce from the request or NULL if absent (in this case
717 * TS_VFY_NONCE is cleared from flags as well)
718 * tsa_name = NULL
719 * Important: after calling this method TS_VFY_SIGNATURE should be added!
720 */
721 TS_VERIFY_CTX *TS_REQ_to_TS_VERIFY_CTX(TS_REQ *req, TS_VERIFY_CTX *ctx);
722
723 /* Function declarations for TS_RESP defined in ts/ts_resp_print.c */
724
725 int TS_RESP_print_bio(BIO *bio, TS_RESP *a);
726 int TS_STATUS_INFO_print_bio(BIO *bio, TS_STATUS_INFO *a);
727 int TS_TST_INFO_print_bio(BIO *bio, TS_TST_INFO *a);
728
729 /* Common utility functions defined in ts/ts_lib.c */
730
731 int TS_ASN1_INTEGER_print_bio(BIO *bio, const ASN1_INTEGER *num);
732 int TS_OBJ_print_bio(BIO *bio, const ASN1_OBJECT *obj);
733 int TS_ext_print_bio(BIO *bio, const STACK_OF(X509_EXTENSION) *extensions);
734 int TS_X509_ALGOR_print_bio(BIO *bio, const X509_ALGOR *alg);
735 int TS_MSG_IMPRINT_print_bio(BIO *bio, TS_MSG_IMPRINT *msg);
736
737 /*
738 * Function declarations for handling configuration options, defined in
739 * ts/ts_conf.c
740 */
741
742 #ifndef OPENSSL_NO_STDIO
743 X509 *TS_CONF_load_cert(const char *file);
744 STACK_OF(X509) *TS_CONF_load_certs(const char *file);
745 EVP_PKEY *TS_CONF_load_key(const char *file, const char *pass);
746 #endif
747 const char *TS_CONF_get_tsa_section(CONF *conf, const char *section);
748 int TS_CONF_set_serial(CONF *conf, const char *section, TS_serial_cb cb,
749 TS_RESP_CTX *ctx);
750 int TS_CONF_set_crypto_device(CONF *conf, const char *section,
751 const char *device);
752 int TS_CONF_set_default_engine(const char *name);
753 #ifndef OPENSSL_NO_STDIO
754 int TS_CONF_set_signer_cert(CONF *conf, const char *section,
755 const char *cert, TS_RESP_CTX *ctx);
756 int TS_CONF_set_certs(CONF *conf, const char *section, const char *certs,
757 TS_RESP_CTX *ctx);
758 int TS_CONF_set_signer_key(CONF *conf, const char *section,
759 const char *key, const char *pass,
760 TS_RESP_CTX *ctx);
761 #endif
762 int TS_CONF_set_def_policy(CONF *conf, const char *section,
763 const char *policy, TS_RESP_CTX *ctx);
764 int TS_CONF_set_policies(CONF *conf, const char *section, TS_RESP_CTX *ctx);
765 int TS_CONF_set_digests(CONF *conf, const char *section, TS_RESP_CTX *ctx);
766 int TS_CONF_set_accuracy(CONF *conf, const char *section, TS_RESP_CTX *ctx);
767 int TS_CONF_set_clock_precision_digits(CONF *conf, const char *section,
768 TS_RESP_CTX *ctx);
769 int TS_CONF_set_ordering(CONF *conf, const char *section, TS_RESP_CTX *ctx);
770 int TS_CONF_set_tsa_name(CONF *conf, const char *section, TS_RESP_CTX *ctx);
771 int TS_CONF_set_ess_cert_id_chain(CONF *conf, const char *section,
772 TS_RESP_CTX *ctx);
773
774 /* -------------------------------------------------- */
775 /* BEGIN ERROR CODES */
776 /*
777 * The following lines are auto generated by the script mkerr.pl. Any changes
778 * made after this point may be overwritten when the script is next run.
779 */
780 void ERR_load_TS_strings(void);
781
782 /* Error codes for the TS functions. */
783
784 /* Function codes. */
785 # define TS_F_D2I_TS_RESP 147
786 # define TS_F_DEF_SERIAL_CB 110
787 # define TS_F_DEF_TIME_CB 111
788 # define TS_F_ESS_ADD_SIGNING_CERT 112
789 # define TS_F_ESS_CERT_ID_NEW_INIT 113
790 # define TS_F_ESS_SIGNING_CERT_NEW_INIT 114
791 # define TS_F_INT_TS_RESP_VERIFY_TOKEN 149
792 # define TS_F_PKCS7_TO_TS_TST_INFO 148
793 # define TS_F_TS_ACCURACY_SET_MICROS 115
794 # define TS_F_TS_ACCURACY_SET_MILLIS 116
795 # define TS_F_TS_ACCURACY_SET_SECONDS 117
796 # define TS_F_TS_CHECK_IMPRINTS 100
797 # define TS_F_TS_CHECK_NONCES 101
798 # define TS_F_TS_CHECK_POLICY 102
799 # define TS_F_TS_CHECK_SIGNING_CERTS 103
800 # define TS_F_TS_CHECK_STATUS_INFO 104
801 # define TS_F_TS_COMPUTE_IMPRINT 145
802 # define TS_F_TS_CONF_INVALID 151
803 # define TS_F_TS_CONF_LOAD_CERT 153
804 # define TS_F_TS_CONF_LOAD_CERTS 154
805 # define TS_F_TS_CONF_LOAD_KEY 155
806 # define TS_F_TS_CONF_LOOKUP_FAIL 152
807 # define TS_F_TS_CONF_SET_DEFAULT_ENGINE 146
808 # define TS_F_TS_GET_STATUS_TEXT 105
809 # define TS_F_TS_MSG_IMPRINT_SET_ALGO 118
810 # define TS_F_TS_REQ_SET_MSG_IMPRINT 119
811 # define TS_F_TS_REQ_SET_NONCE 120
812 # define TS_F_TS_REQ_SET_POLICY_ID 121
813 # define TS_F_TS_RESP_CREATE_RESPONSE 122
814 # define TS_F_TS_RESP_CREATE_TST_INFO 123
815 # define TS_F_TS_RESP_CTX_ADD_FAILURE_INFO 124
816 # define TS_F_TS_RESP_CTX_ADD_MD 125
817 # define TS_F_TS_RESP_CTX_ADD_POLICY 126
818 # define TS_F_TS_RESP_CTX_NEW 127
819 # define TS_F_TS_RESP_CTX_SET_ACCURACY 128
820 # define TS_F_TS_RESP_CTX_SET_CERTS 129
821 # define TS_F_TS_RESP_CTX_SET_DEF_POLICY 130
822 # define TS_F_TS_RESP_CTX_SET_SIGNER_CERT 131
823 # define TS_F_TS_RESP_CTX_SET_STATUS_INFO 132
824 # define TS_F_TS_RESP_GET_POLICY 133
825 # define TS_F_TS_RESP_SET_GENTIME_WITH_PRECISION 134
826 # define TS_F_TS_RESP_SET_STATUS_INFO 135
827 # define TS_F_TS_RESP_SET_TST_INFO 150
828 # define TS_F_TS_RESP_SIGN 136
829 # define TS_F_TS_RESP_VERIFY_SIGNATURE 106
830 # define TS_F_TS_RESP_VERIFY_TOKEN 107
831 # define TS_F_TS_TST_INFO_SET_ACCURACY 137
832 # define TS_F_TS_TST_INFO_SET_MSG_IMPRINT 138
833 # define TS_F_TS_TST_INFO_SET_NONCE 139
834 # define TS_F_TS_TST_INFO_SET_POLICY_ID 140
835 # define TS_F_TS_TST_INFO_SET_SERIAL 141
836 # define TS_F_TS_TST_INFO_SET_TIME 142
837 # define TS_F_TS_TST_INFO_SET_TSA 143
838 # define TS_F_TS_VERIFY 108
839 # define TS_F_TS_VERIFY_CERT 109
840 # define TS_F_TS_VERIFY_CTX_NEW 144
841
842 /* Reason codes. */
843 # define TS_R_BAD_PKCS7_TYPE 132
844 # define TS_R_BAD_TYPE 133
845 # define TS_R_CANNOT_LOAD_CERT 137
846 # define TS_R_CANNOT_LOAD_KEY 138
847 # define TS_R_CERTIFICATE_VERIFY_ERROR 100
848 # define TS_R_COULD_NOT_SET_ENGINE 127
849 # define TS_R_COULD_NOT_SET_TIME 115
850 # define TS_R_D2I_TS_RESP_INT_FAILED 128
851 # define TS_R_DETACHED_CONTENT 134
852 # define TS_R_ESS_ADD_SIGNING_CERT_ERROR 116
853 # define TS_R_ESS_SIGNING_CERTIFICATE_ERROR 101
854 # define TS_R_INVALID_NULL_POINTER 102
855 # define TS_R_INVALID_SIGNER_CERTIFICATE_PURPOSE 117
856 # define TS_R_MESSAGE_IMPRINT_MISMATCH 103
857 # define TS_R_NONCE_MISMATCH 104
858 # define TS_R_NONCE_NOT_RETURNED 105
859 # define TS_R_NO_CONTENT 106
860 # define TS_R_NO_TIME_STAMP_TOKEN 107
861 # define TS_R_PKCS7_ADD_SIGNATURE_ERROR 118
862 # define TS_R_PKCS7_ADD_SIGNED_ATTR_ERROR 119
863 # define TS_R_PKCS7_TO_TS_TST_INFO_FAILED 129
864 # define TS_R_POLICY_MISMATCH 108
865 # define TS_R_PRIVATE_KEY_DOES_NOT_MATCH_CERTIFICATE 120
866 # define TS_R_RESPONSE_SETUP_ERROR 121
867 # define TS_R_SIGNATURE_FAILURE 109
868 # define TS_R_THERE_MUST_BE_ONE_SIGNER 110
869 # define TS_R_TIME_SYSCALL_ERROR 122
870 # define TS_R_TOKEN_NOT_PRESENT 130
871 # define TS_R_TOKEN_PRESENT 131
872 # define TS_R_TSA_NAME_MISMATCH 111
873 # define TS_R_TSA_UNTRUSTED 112
874 # define TS_R_TST_INFO_SETUP_ERROR 123
875 # define TS_R_TS_DATASIGN 124
876 # define TS_R_UNACCEPTABLE_POLICY 125
877 # define TS_R_UNSUPPORTED_MD_ALGORITHM 126
878 # define TS_R_UNSUPPORTED_VERSION 113
879 # define TS_R_VAR_BAD_VALUE 135
880 # define TS_R_VAR_LOOKUP_FAILURE 136
881 # define TS_R_WRONG_CONTENT_TYPE 114
882
883 #ifdef __cplusplus
884 }
885 #endif
886 #endif