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