crypto/ts/ts.h

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