ts.h 27 KB

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