include/openssl/ts.h

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