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