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