include/openssl/ts.h

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