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