include/openssl/ts.h

   1 /*
   2  * Copyright 2006-2017 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef HEADER_TS_H
  11 # define HEADER_TS_H
  12
  13 # include <openssl/opensslconf.h>
  14
  15 # ifndef OPENSSL_NO_TS
  16 # include <openssl/symhacks.h>
  17 # include <openssl/buffer.h>
  18 # include <openssl/evp.h>
  19 # include <openssl/bio.h>
  20 # include <openssl/asn1.h>
  21 # include <openssl/rsa.h>
  22 # include <openssl/dsa.h>
  23 # include <openssl/dh.h>
  24 # include <openssl/tserr.h>
  25 # ifdef  __cplusplus
  26 extern "C" {
  27 # endif
  28
  29 # include <openssl/x509.h>
  30 # include <openssl/x509v3.h>
  31
  32 typedef struct TS_msg_imprint_st TS_MSG_IMPRINT;
  33 typedef struct TS_req_st TS_REQ;
  34 typedef struct TS_accuracy_st TS_ACCURACY;
  35 typedef struct TS_tst_info_st TS_TST_INFO;
  36
  37 /* Possible values for status. */
  38 # define TS_STATUS_GRANTED                       0
  39 # define TS_STATUS_GRANTED_WITH_MODS             1
  40 # define TS_STATUS_REJECTION                     2
  41 # define TS_STATUS_WAITING                       3
  42 # define TS_STATUS_REVOCATION_WARNING            4
  43 # define TS_STATUS_REVOCATION_NOTIFICATION       5
  44
  45 /* Possible values for failure_info. */
  46 # define TS_INFO_BAD_ALG                 0
  47 # define TS_INFO_BAD_REQUEST             2
  48 # define TS_INFO_BAD_DATA_FORMAT         5
  49 # define TS_INFO_TIME_NOT_AVAILABLE      14
  50 # define TS_INFO_UNACCEPTED_POLICY       15
  51 # define TS_INFO_UNACCEPTED_EXTENSION    16
  52 # define TS_INFO_ADD_INFO_NOT_AVAILABLE  17
  53 # define TS_INFO_SYSTEM_FAILURE          25
  54
  55
  56 typedef struct TS_status_info_st TS_STATUS_INFO;
  57 typedef struct ESS_issuer_serial ESS_ISSUER_SERIAL;
  58 typedef struct ESS_cert_id ESS_CERT_ID;
  59 typedef struct ESS_signing_cert ESS_SIGNING_CERT;
  60
  61 DEFINE_STACK_OF(ESS_CERT_ID)
  62
  63 typedef struct ESS_cert_id_v2_st ESS_CERT_ID_V2;
  64 typedef struct ESS_signing_cert_v2_st ESS_SIGNING_CERT_V2;
  65
  66 DEFINE_STACK_OF(ESS_CERT_ID_V2)
  67
  68 typedef struct TS_resp_st TS_RESP;
  69
  70 TS_REQ *TS_REQ_new(void);
  71 void TS_REQ_free(TS_REQ *a);
  72 int i2d_TS_REQ(const TS_REQ *a, unsigned char **pp);
  73 TS_REQ *d2i_TS_REQ(TS_REQ **a, const unsigned char **pp, long length);
  74
  75 TS_REQ *TS_REQ_dup(TS_REQ *a);
  76
  77 #ifndef OPENSSL_NO_STDIO
  78 TS_REQ *d2i_TS_REQ_fp(FILE *fp, TS_REQ **a);
  79 int i2d_TS_REQ_fp(FILE *fp, TS_REQ *a);
  80 #endif
  81 TS_REQ *d2i_TS_REQ_bio(BIO *fp, TS_REQ **a);
  82 int i2d_TS_REQ_bio(BIO *fp, TS_REQ *a);
  83
  84 TS_MSG_IMPRINT *TS_MSG_IMPRINT_new(void);
  85 void TS_MSG_IMPRINT_free(TS_MSG_IMPRINT *a);
  86 int i2d_TS_MSG_IMPRINT(const TS_MSG_IMPRINT *a, unsigned char **pp);
  87 TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT(TS_MSG_IMPRINT **a,
  88                                    const unsigned char **pp, long length);
  89
  90 TS_MSG_IMPRINT *TS_MSG_IMPRINT_dup(TS_MSG_IMPRINT *a);
  91
  92 #ifndef OPENSSL_NO_STDIO
  93 TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT **a);
  94 int i2d_TS_MSG_IMPRINT_fp(FILE *fp, TS_MSG_IMPRINT *a);
  95 #endif
  96 TS_MSG_IMPRINT *d2i_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT **a);
  97 int i2d_TS_MSG_IMPRINT_bio(BIO *bio, TS_MSG_IMPRINT *a);
  98
  99 TS_RESP *TS_RESP_new(void);
 100 void TS_RESP_free(TS_RESP *a);
 101 int i2d_TS_RESP(const TS_RESP *a, unsigned char **pp);
 102 TS_RESP *d2i_TS_RESP(TS_RESP **a, const unsigned char **pp, long length);
 103 TS_TST_INFO *PKCS7_to_TS_TST_INFO(PKCS7 *token);
 104 TS_RESP *TS_RESP_dup(TS_RESP *a);
 105
 106 #ifndef OPENSSL_NO_STDIO
 107 TS_RESP *d2i_TS_RESP_fp(FILE *fp, TS_RESP **a);
 108 int i2d_TS_RESP_fp(FILE *fp, TS_RESP *a);
 109 #endif
 110 TS_RESP *d2i_TS_RESP_bio(BIO *bio, TS_RESP **a);
 111 int i2d_TS_RESP_bio(BIO *bio, TS_RESP *a);
 112
 113 TS_STATUS_INFO *TS_STATUS_INFO_new(void);
 114 void TS_STATUS_INFO_free(TS_STATUS_INFO *a);
 115 int i2d_TS_STATUS_INFO(const TS_STATUS_INFO *a, unsigned char **pp);
 116 TS_STATUS_INFO *d2i_TS_STATUS_INFO(TS_STATUS_INFO **a,
 117                                    const unsigned char **pp, long length);
 118 TS_STATUS_INFO *TS_STATUS_INFO_dup(TS_STATUS_INFO *a);
 119
 120 TS_TST_INFO *TS_TST_INFO_new(void);
 121 void TS_TST_INFO_free(TS_TST_INFO *a);
 122 int i2d_TS_TST_INFO(const TS_TST_INFO *a, unsigned char **pp);
 123 TS_TST_INFO *d2i_TS_TST_INFO(TS_TST_INFO **a, const unsigned char **pp,
 124                              long length);
 125 TS_TST_INFO *TS_TST_INFO_dup(TS_TST_INFO *a);
 126
 127 #ifndef OPENSSL_NO_STDIO
 128 TS_TST_INFO *d2i_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO **a);
 129 int i2d_TS_TST_INFO_fp(FILE *fp, TS_TST_INFO *a);
 130 #endif
 131 TS_TST_INFO *d2i_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO **a);
 132 int i2d_TS_TST_INFO_bio(BIO *bio, TS_TST_INFO *a);
 133
 134 TS_ACCURACY *TS_ACCURACY_new(void);
 135 void TS_ACCURACY_free(TS_ACCURACY *a);
 136 int i2d_TS_ACCURACY(const TS_ACCURACY *a, unsigned char **pp);
 137 TS_ACCURACY *d2i_TS_ACCURACY(TS_ACCURACY **a, const unsigned char **pp,
 138                              long length);
 139 TS_ACCURACY *TS_ACCURACY_dup(TS_ACCURACY *a);
 140
 141 ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_new(void);
 142 void ESS_ISSUER_SERIAL_free(ESS_ISSUER_SERIAL *a);
 143 int i2d_ESS_ISSUER_SERIAL(const ESS_ISSUER_SERIAL *a, unsigned char **pp);
 144 ESS_ISSUER_SERIAL *d2i_ESS_ISSUER_SERIAL(ESS_ISSUER_SERIAL **a,
 145                                          const unsigned char **pp,
 146                                          long length);
 147 ESS_ISSUER_SERIAL *ESS_ISSUER_SERIAL_dup(ESS_ISSUER_SERIAL *a);
 148
 149 ESS_CERT_ID *ESS_CERT_ID_new(void);
 150 void ESS_CERT_ID_free(ESS_CERT_ID *a);
 151 int i2d_ESS_CERT_ID(const ESS_CERT_ID *a, unsigned char **pp);
 152 ESS_CERT_ID *d2i_ESS_CERT_ID(ESS_CERT_ID **a, const unsigned char **pp,
 153                              long length);
 154 ESS_CERT_ID *ESS_CERT_ID_dup(ESS_CERT_ID *a);
 155
 156 ESS_SIGNING_CERT *ESS_SIGNING_CERT_new(void);
 157 void ESS_SIGNING_CERT_free(ESS_SIGNING_CERT *a);
 158 int i2d_ESS_SIGNING_CERT(const ESS_SIGNING_CERT *a, unsigned char **pp);
 159 ESS_SIGNING_CERT *d2i_ESS_SIGNING_CERT(ESS_SIGNING_CERT **a,
 160                                        const unsigned char **pp, long length);
 161 ESS_SIGNING_CERT *ESS_SIGNING_CERT_dup(ESS_SIGNING_CERT *a);
 162
 163 ESS_CERT_ID_V2 *ESS_CERT_ID_V2_new(void);
 164 void ESS_CERT_ID_V2_free(ESS_CERT_ID_V2 *a);
 165 int i2d_ESS_CERT_ID_V2(const ESS_CERT_ID_V2 *a, unsigned char **pp);
 166 ESS_CERT_ID_V2 *d2i_ESS_CERT_ID_V2(ESS_CERT_ID_V2 **a,
 167                                    const unsigned char **pp, long length);
 168 ESS_CERT_ID_V2 *ESS_CERT_ID_V2_dup(ESS_CERT_ID_V2 *a);
 169
 170 ESS_SIGNING_CERT_V2 *ESS_SIGNING_CERT_V2_new(void);
 171 void ESS_SIGNING_CERT_V2_free(ESS_SIGNING_CERT_V2 *a);
 172 int i2d_ESS_SIGNING_CERT_V2(const ESS_SIGNING_CERT_V2 *a, unsigned char **pp);
 173 ESS_SIGNING_CERT_V2 *d2i_ESS_SIGNING_CERT_V2(ESS_SIGNING_CERT_V2 **a,
 174                                              const unsigned char **pp,
 175                                              long length);
 176 ESS_SIGNING_CERT_V2 *ESS_SIGNING_CERT_V2_dup(ESS_SIGNING_CERT_V2 *a);
 177
 178 int TS_REQ_set_version(TS_REQ *a, long version);
 179 long TS_REQ_get_version(const TS_REQ *a);
 180
 181 int TS_STATUS_INFO_set_status(TS_STATUS_INFO *a, int i);
 182 const ASN1_INTEGER *TS_STATUS_INFO_get0_status(const TS_STATUS_INFO *a);
 183
 184 const STACK_OF(ASN1_UTF8STRING) *
 185 TS_STATUS_INFO_get0_text(const TS_STATUS_INFO *a);
 186
 187 const ASN1_BIT_STRING *
 188 TS_STATUS_INFO_get0_failure_info(const TS_STATUS_INFO *a);
 189
 190 int TS_REQ_set_msg_imprint(TS_REQ *a, TS_MSG_IMPRINT *msg_imprint);
 191 TS_MSG_IMPRINT *TS_REQ_get_msg_imprint(TS_REQ *a);
 192
 193 int TS_MSG_IMPRINT_set_algo(TS_MSG_IMPRINT *a, X509_ALGOR *alg);
 194 X509_ALGOR *TS_MSG_IMPRINT_get_algo(TS_MSG_IMPRINT *a);
 195
 196 int TS_MSG_IMPRINT_set_msg(TS_MSG_IMPRINT *a, unsigned char *d, int len);
 197 ASN1_OCTET_STRING *TS_MSG_IMPRINT_get_msg(TS_MSG_IMPRINT *a);
 198
 199 int TS_REQ_set_policy_id(TS_REQ *a, const ASN1_OBJECT *policy);
 200 ASN1_OBJECT *TS_REQ_get_policy_id(TS_REQ *a);
 201
 202 int TS_REQ_set_nonce(TS_REQ *a, const ASN1_INTEGER *nonce);
 203 const ASN1_INTEGER *TS_REQ_get_nonce(const TS_REQ *a);
 204
 205 int TS_REQ_set_cert_req(TS_REQ *a, int cert_req);
 206 int TS_REQ_get_cert_req(const TS_REQ *a);
 207
 208 STACK_OF(X509_EXTENSION) *TS_REQ_get_exts(TS_REQ *a);
 209 void TS_REQ_ext_free(TS_REQ *a);
 210 int TS_REQ_get_ext_count(TS_REQ *a);
 211 int TS_REQ_get_ext_by_NID(TS_REQ *a, int nid, int lastpos);
 212 int TS_REQ_get_ext_by_OBJ(TS_REQ *a, const ASN1_OBJECT *obj, int lastpos);
 213 int TS_REQ_get_ext_by_critical(TS_REQ *a, int crit, int lastpos);
 214 X509_EXTENSION *TS_REQ_get_ext(TS_REQ *a, int loc);
 215 X509_EXTENSION *TS_REQ_delete_ext(TS_REQ *a, int loc);
 216 int TS_REQ_add_ext(TS_REQ *a, X509_EXTENSION *ex, int loc);
 217 void *TS_REQ_get_ext_d2i(TS_REQ *a, int nid, int *crit, int *idx);
 218
 219 /* Function declarations for TS_REQ defined in ts/ts_req_print.c */
 220
 221 int TS_REQ_print_bio(BIO *bio, TS_REQ *a);
 222
 223 /* Function declarations for TS_RESP defined in ts/ts_resp_utils.c */
 224
 225 int TS_RESP_set_status_info(TS_RESP *a, TS_STATUS_INFO *info);
 226 TS_STATUS_INFO *TS_RESP_get_status_info(TS_RESP *a);
 227
 228 /* Caller loses ownership of PKCS7 and TS_TST_INFO objects. */
 229 void TS_RESP_set_tst_info(TS_RESP *a, PKCS7 *p7, TS_TST_INFO *tst_info);
 230 PKCS7 *TS_RESP_get_token(TS_RESP *a);
 231 TS_TST_INFO *TS_RESP_get_tst_info(TS_RESP *a);
 232
 233 int TS_TST_INFO_set_version(TS_TST_INFO *a, long version);
 234 long TS_TST_INFO_get_version(const TS_TST_INFO *a);
 235
 236 int TS_TST_INFO_set_policy_id(TS_TST_INFO *a, ASN1_OBJECT *policy_id);
 237 ASN1_OBJECT *TS_TST_INFO_get_policy_id(TS_TST_INFO *a);
 238
 239 int TS_TST_INFO_set_msg_imprint(TS_TST_INFO *a, TS_MSG_IMPRINT *msg_imprint);
 240 TS_MSG_IMPRINT *TS_TST_INFO_get_msg_imprint(TS_TST_INFO *a);
 241
 242 int TS_TST_INFO_set_serial(TS_TST_INFO *a, const ASN1_INTEGER *serial);
 243 const ASN1_INTEGER *TS_TST_INFO_get_serial(const TS_TST_INFO *a);
 244
 245 int TS_TST_INFO_set_time(TS_TST_INFO *a, const ASN1_GENERALIZEDTIME *gtime);
 246 const ASN1_GENERALIZEDTIME *TS_TST_INFO_get_time(const TS_TST_INFO *a);
 247
 248 int TS_TST_INFO_set_accuracy(TS_TST_INFO *a, TS_ACCURACY *accuracy);
 249 TS_ACCURACY *TS_TST_INFO_get_accuracy(TS_TST_INFO *a);
 250
 251 int TS_ACCURACY_set_seconds(TS_ACCURACY *a, const ASN1_INTEGER *seconds);
 252 const ASN1_INTEGER *TS_ACCURACY_get_seconds(const TS_ACCURACY *a);
 253
 254 int TS_ACCURACY_set_millis(TS_ACCURACY *a, const ASN1_INTEGER *millis);
 255 const ASN1_INTEGER *TS_ACCURACY_get_millis(const TS_ACCURACY *a);
 256
 257 int TS_ACCURACY_set_micros(TS_ACCURACY *a, const ASN1_INTEGER *micros);
 258 const ASN1_INTEGER *TS_ACCURACY_get_micros(const TS_ACCURACY *a);
 259
 260 int TS_TST_INFO_set_ordering(TS_TST_INFO *a, int ordering);
 261 int TS_TST_INFO_get_ordering(const TS_TST_INFO *a);
 262
 263 int TS_TST_INFO_set_nonce(TS_TST_INFO *a, const ASN1_INTEGER *nonce);
 264 const ASN1_INTEGER *TS_TST_INFO_get_nonce(const TS_TST_INFO *a);
 265
 266 int TS_TST_INFO_set_tsa(TS_TST_INFO *a, GENERAL_NAME *tsa);
 267 GENERAL_NAME *TS_TST_INFO_get_tsa(TS_TST_INFO *a);
 268
 269 STACK_OF(X509_EXTENSION) *TS_TST_INFO_get_exts(TS_TST_INFO *a);
 270 void TS_TST_INFO_ext_free(TS_TST_INFO *a);
 271 int TS_TST_INFO_get_ext_count(TS_TST_INFO *a);
 272 int TS_TST_INFO_get_ext_by_NID(TS_TST_INFO *a, int nid, int lastpos);
 273 int TS_TST_INFO_get_ext_by_OBJ(TS_TST_INFO *a, const ASN1_OBJECT *obj,
 274                                int lastpos);
 275 int TS_TST_INFO_get_ext_by_critical(TS_TST_INFO *a, int crit, int lastpos);
 276 X509_EXTENSION *TS_TST_INFO_get_ext(TS_TST_INFO *a, int loc);
 277 X509_EXTENSION *TS_TST_INFO_delete_ext(TS_TST_INFO *a, int loc);
 278 int TS_TST_INFO_add_ext(TS_TST_INFO *a, X509_EXTENSION *ex, int loc);
 279 void *TS_TST_INFO_get_ext_d2i(TS_TST_INFO *a, int nid, int *crit, int *idx);
 280
 281 /*
 282  * Declarations related to response generation, defined in ts/ts_resp_sign.c.
 283  */
 284
 285 /* Optional flags for response generation. */
 286
 287 /* Don't include the TSA name in response. */
 288 # define TS_TSA_NAME             0x01
 289
 290 /* Set ordering to true in response. */
 291 # define TS_ORDERING             0x02
 292
 293 /*
 294  * Include the signer certificate and the other specified certificates in
 295  * the ESS signing certificate attribute beside the PKCS7 signed data.
 296  * Only the signer certificates is included by default.
 297  */
 298 # define TS_ESS_CERT_ID_CHAIN    0x04
 299
 300 /* Forward declaration. */
 301 struct TS_resp_ctx;
 302
 303 /* This must return a unique number less than 160 bits long. */
 304 typedef ASN1_INTEGER *(*TS_serial_cb) (struct TS_resp_ctx *, void *);
 305
 306 /*
 307  * This must return the seconds and microseconds since Jan 1, 1970 in the sec
 308  * and usec variables allocated by the caller. Return non-zero for success
 309  * and zero for failure.
 310  */
 311 typedef int (*TS_time_cb) (struct TS_resp_ctx *, void *, long *sec,
 312                            long *usec);
 313
 314 /*
 315  * This must process the given extension. It can modify the TS_TST_INFO
 316  * object of the context. Return values: !0 (processed), 0 (error, it must
 317  * set the status info/failure info of the response).
 318  */
 319 typedef int (*TS_extension_cb) (struct TS_resp_ctx *, X509_EXTENSION *,
 320                                 void *);
 321
 322 typedef struct TS_resp_ctx TS_RESP_CTX;
 323
 324 DEFINE_STACK_OF_CONST(EVP_MD)
 325
 326 /* Creates a response context that can be used for generating responses. */
 327 TS_RESP_CTX *TS_RESP_CTX_new(void);
 328 void TS_RESP_CTX_free(TS_RESP_CTX *ctx);
 329
 330 /* This parameter must be set. */
 331 int TS_RESP_CTX_set_signer_cert(TS_RESP_CTX *ctx, X509 *signer);
 332
 333 /* This parameter must be set. */
 334 int TS_RESP_CTX_set_signer_key(TS_RESP_CTX *ctx, EVP_PKEY *key);
 335
 336 int TS_RESP_CTX_set_signer_digest(TS_RESP_CTX *ctx,
 337                                   const EVP_MD *signer_digest);
 338 int TS_RESP_CTX_set_ess_cert_id_digest(TS_RESP_CTX *ctx, const EVP_MD *md);
 339
 340 /* This parameter must be set. */
 341 int TS_RESP_CTX_set_def_policy(TS_RESP_CTX *ctx, const ASN1_OBJECT *def_policy);
 342
 343 /* No additional certs are included in the response by default. */
 344 int TS_RESP_CTX_set_certs(TS_RESP_CTX *ctx, STACK_OF(X509) *certs);
 345
 346 /*
 347  * Adds a new acceptable policy, only the default policy is accepted by
 348  * default.
 349  */
 350 int TS_RESP_CTX_add_policy(TS_RESP_CTX *ctx, const ASN1_OBJECT *policy);
 351
 352 /*
 353  * Adds a new acceptable message digest. Note that no message digests are
 354  * accepted by default. The md argument is shared with the caller.
 355  */
 356 int TS_RESP_CTX_add_md(TS_RESP_CTX *ctx, const EVP_MD *md);
 357
 358 /* Accuracy is not included by default. */
 359 int TS_RESP_CTX_set_accuracy(TS_RESP_CTX *ctx,
 360                              int secs, int millis, int micros);
 361
 362 /*
 363  * Clock precision digits, i.e. the number of decimal digits: '0' means sec,
 364  * '3' msec, '6' usec, and so on. Default is 0.
 365  */
 366 int TS_RESP_CTX_set_clock_precision_digits(TS_RESP_CTX *ctx,
 367                                            unsigned clock_precision_digits);
 368 /* At most we accept usec precision. */
 369 # define TS_MAX_CLOCK_PRECISION_DIGITS   6
 370
 371 /* Maximum status message length */
 372 # define TS_MAX_STATUS_LENGTH   (1024 * 1024)
 373
 374 /* No flags are set by default. */
 375 void TS_RESP_CTX_add_flags(TS_RESP_CTX *ctx, int flags);
 376
 377 /* Default callback always returns a constant. */
 378 void TS_RESP_CTX_set_serial_cb(TS_RESP_CTX *ctx, TS_serial_cb cb, void *data);
 379
 380 /* Default callback uses the gettimeofday() and gmtime() system calls. */
 381 void TS_RESP_CTX_set_time_cb(TS_RESP_CTX *ctx, TS_time_cb cb, void *data);
 382
 383 /*
 384  * Default callback rejects all extensions. The extension callback is called
 385  * when the TS_TST_INFO object is already set up and not signed yet.
 386  */
 387 /* FIXME: extension handling is not tested yet. */
 388 void TS_RESP_CTX_set_extension_cb(TS_RESP_CTX *ctx,
 389                                   TS_extension_cb cb, void *data);
 390
 391 /* The following methods can be used in the callbacks. */
 392 int TS_RESP_CTX_set_status_info(TS_RESP_CTX *ctx,
 393                                 int status, const char *text);
 394
 395 /* Sets the status info only if it is still TS_STATUS_GRANTED. */
 396 int TS_RESP_CTX_set_status_info_cond(TS_RESP_CTX *ctx,
 397                                      int status, const char *text);
 398
 399 int TS_RESP_CTX_add_failure_info(TS_RESP_CTX *ctx, int failure);
 400
 401 /* The get methods below can be used in the extension callback. */
 402 TS_REQ *TS_RESP_CTX_get_request(TS_RESP_CTX *ctx);
 403
 404 TS_TST_INFO *TS_RESP_CTX_get_tst_info(TS_RESP_CTX *ctx);
 405
 406 /*
 407  * Creates the signed TS_TST_INFO and puts it in TS_RESP.
 408  * In case of errors it sets the status info properly.
 409  * Returns NULL only in case of memory allocation/fatal error.
 410  */
 411 TS_RESP *TS_RESP_create_response(TS_RESP_CTX *ctx, BIO *req_bio);
 412
 413 /*
 414  * Declarations related to response verification,
 415  * they are defined in ts/ts_resp_verify.c.
 416  */
 417
 418 int TS_RESP_verify_signature(PKCS7 *token, STACK_OF(X509) *certs,
 419                              X509_STORE *store, X509 **signer_out);
 420
 421 /* Context structure for the generic verify method. */
 422
 423 /* Verify the signer's certificate and the signature of the response. */
 424 # define TS_VFY_SIGNATURE        (1u << 0)
 425 /* Verify the version number of the response. */
 426 # define TS_VFY_VERSION          (1u << 1)
 427 /* Verify if the policy supplied by the user matches the policy of the TSA. */
 428 # define TS_VFY_POLICY           (1u << 2)
 429 /*
 430  * Verify the message imprint provided by the user. This flag should not be
 431  * specified with TS_VFY_DATA.
 432  */
 433 # define TS_VFY_IMPRINT          (1u << 3)
 434 /*
 435  * Verify the message imprint computed by the verify method from the user
 436  * provided data and the MD algorithm of the response. This flag should not
 437  * be specified with TS_VFY_IMPRINT.
 438  */
 439 # define TS_VFY_DATA             (1u << 4)
 440 /* Verify the nonce value. */
 441 # define TS_VFY_NONCE            (1u << 5)
 442 /* Verify if the TSA name field matches the signer certificate. */
 443 # define TS_VFY_SIGNER           (1u << 6)
 444 /* Verify if the TSA name field equals to the user provided name. */
 445 # define TS_VFY_TSA_NAME         (1u << 7)
 446
 447 /* You can use the following convenience constants. */
 448 # define TS_VFY_ALL_IMPRINT      (TS_VFY_SIGNATURE       \
 449                                  | TS_VFY_VERSION       \
 450                                  | TS_VFY_POLICY        \
 451                                  | TS_VFY_IMPRINT       \
 452                                  | TS_VFY_NONCE         \
 453                                  | TS_VFY_SIGNER        \
 454                                  | TS_VFY_TSA_NAME)
 455 # define TS_VFY_ALL_DATA         (TS_VFY_SIGNATURE       \
 456                                  | TS_VFY_VERSION       \
 457                                  | TS_VFY_POLICY        \
 458                                  | TS_VFY_DATA          \
 459                                  | TS_VFY_NONCE         \
 460                                  | TS_VFY_SIGNER        \
 461                                  | TS_VFY_TSA_NAME)
 462
 463 typedef struct TS_verify_ctx TS_VERIFY_CTX;
 464
 465 int TS_RESP_verify_response(TS_VERIFY_CTX *ctx, TS_RESP *response);
 466 int TS_RESP_verify_token(TS_VERIFY_CTX *ctx, PKCS7 *token);
 467
 468 /*
 469  * Declarations related to response verification context,
 470  */
 471 TS_VERIFY_CTX *TS_VERIFY_CTX_new(void);
 472 void TS_VERIFY_CTX_init(TS_VERIFY_CTX *ctx);
 473 void TS_VERIFY_CTX_free(TS_VERIFY_CTX *ctx);
 474 void TS_VERIFY_CTX_cleanup(TS_VERIFY_CTX *ctx);
 475 int TS_VERIFY_CTX_set_flags(TS_VERIFY_CTX *ctx, int f);
 476 int TS_VERIFY_CTX_add_flags(TS_VERIFY_CTX *ctx, int f);
 477 BIO *TS_VERIFY_CTX_set_data(TS_VERIFY_CTX *ctx, BIO *b);
 478 unsigned char *TS_VERIFY_CTX_set_imprint(TS_VERIFY_CTX *ctx,
 479                                          unsigned char *hexstr, long len);
 480 X509_STORE *TS_VERIFY_CTX_set_store(TS_VERIFY_CTX *ctx, X509_STORE *s);
 481 STACK_OF(X509) *TS_VERIFY_CTS_set_certs(TS_VERIFY_CTX *ctx, STACK_OF(X509) *certs);
 482
 483 /*-
 484  * If ctx is NULL, it allocates and returns a new object, otherwise
 485  * it returns ctx. It initialises all the members as follows:
 486  * flags = TS_VFY_ALL_IMPRINT & ~(TS_VFY_TSA_NAME | TS_VFY_SIGNATURE)
 487  * certs = NULL
 488  * store = NULL
 489  * policy = policy from the request or NULL if absent (in this case
 490  *      TS_VFY_POLICY is cleared from flags as well)
 491  * md_alg = MD algorithm from request
 492  * imprint, imprint_len = imprint from request
 493  * data = NULL
 494  * nonce, nonce_len = nonce from the request or NULL if absent (in this case
 495  *      TS_VFY_NONCE is cleared from flags as well)
 496  * tsa_name = NULL
 497  * Important: after calling this method TS_VFY_SIGNATURE should be added!
 498  */
 499 TS_VERIFY_CTX *TS_REQ_to_TS_VERIFY_CTX(TS_REQ *req, TS_VERIFY_CTX *ctx);
 500
 501 /* Function declarations for TS_RESP defined in ts/ts_resp_print.c */
 502
 503 int TS_RESP_print_bio(BIO *bio, TS_RESP *a);
 504 int TS_STATUS_INFO_print_bio(BIO *bio, TS_STATUS_INFO *a);
 505 int TS_TST_INFO_print_bio(BIO *bio, TS_TST_INFO *a);
 506
 507 /* Common utility functions defined in ts/ts_lib.c */
 508
 509 int TS_ASN1_INTEGER_print_bio(BIO *bio, const ASN1_INTEGER *num);
 510 int TS_OBJ_print_bio(BIO *bio, const ASN1_OBJECT *obj);
 511 int TS_ext_print_bio(BIO *bio, const STACK_OF(X509_EXTENSION) *extensions);
 512 int TS_X509_ALGOR_print_bio(BIO *bio, const X509_ALGOR *alg);
 513 int TS_MSG_IMPRINT_print_bio(BIO *bio, TS_MSG_IMPRINT *msg);
 514
 515 /*
 516  * Function declarations for handling configuration options, defined in
 517  * ts/ts_conf.c
 518  */
 519
 520 X509 *TS_CONF_load_cert(const char *file);
 521 STACK_OF(X509) *TS_CONF_load_certs(const char *file);
 522 EVP_PKEY *TS_CONF_load_key(const char *file, const char *pass);
 523 const char *TS_CONF_get_tsa_section(CONF *conf, const char *section);
 524 int TS_CONF_set_serial(CONF *conf, const char *section, TS_serial_cb cb,
 525                        TS_RESP_CTX *ctx);
 526 #ifndef OPENSSL_NO_ENGINE
 527 int TS_CONF_set_crypto_device(CONF *conf, const char *section,
 528                               const char *device);
 529 int TS_CONF_set_default_engine(const char *name);
 530 #endif
 531 int TS_CONF_set_signer_cert(CONF *conf, const char *section,
 532                             const char *cert, TS_RESP_CTX *ctx);
 533 int TS_CONF_set_certs(CONF *conf, const char *section, const char *certs,
 534                       TS_RESP_CTX *ctx);
 535 int TS_CONF_set_signer_key(CONF *conf, const char *section,
 536                            const char *key, const char *pass,
 537                            TS_RESP_CTX *ctx);
 538 int TS_CONF_set_signer_digest(CONF *conf, const char *section,
 539                                const char *md, TS_RESP_CTX *ctx);
 540 int TS_CONF_set_def_policy(CONF *conf, const char *section,
 541                            const char *policy, TS_RESP_CTX *ctx);
 542 int TS_CONF_set_policies(CONF *conf, const char *section, TS_RESP_CTX *ctx);
 543 int TS_CONF_set_digests(CONF *conf, const char *section, TS_RESP_CTX *ctx);
 544 int TS_CONF_set_accuracy(CONF *conf, const char *section, TS_RESP_CTX *ctx);
 545 int TS_CONF_set_clock_precision_digits(CONF *conf, const char *section,
 546                                        TS_RESP_CTX *ctx);
 547 int TS_CONF_set_ordering(CONF *conf, const char *section, TS_RESP_CTX *ctx);
 548 int TS_CONF_set_tsa_name(CONF *conf, const char *section, TS_RESP_CTX *ctx);
 549 int TS_CONF_set_ess_cert_id_chain(CONF *conf, const char *section,
 550                                   TS_RESP_CTX *ctx);
 551 int TS_CONF_set_ess_cert_id_digest(CONF *conf, const char *section,
 552                                       TS_RESP_CTX *ctx);
 553 int ERR_load_TS_strings(void);
 554
 555 #  ifdef  __cplusplus
 556 }
 557 #  endif
 558 # endif
 559 #endif