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