Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/openssl/ts.h @ 69:33d812a61356

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