xref: /freebsd/crypto/heimdal/lib/hx509/hx509.h (revision 4e1bc9a039df516be13abb902ab76677fef81b1d)
1 /*
2  * Copyright (c) 2004 - 2007 Kungliga Tekniska Högskolan
3  * (Royal Institute of Technology, Stockholm, Sweden).
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * 3. Neither the name of the Institute nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33 
34 /* $Id$ */
35 
36 #ifndef HEIMDAL_HX509_H
37 #define HEIMDAL_HX509_H 1
38 
39 #include <rfc2459_asn1.h>
40 #include <stdarg.h>
41 #include <stdio.h>
42 
43 typedef struct hx509_cert_attribute_data *hx509_cert_attribute;
44 typedef struct hx509_cert_data *hx509_cert;
45 typedef struct hx509_certs_data *hx509_certs;
46 typedef struct hx509_context_data *hx509_context;
47 typedef struct hx509_crypto_data *hx509_crypto;
48 typedef struct hx509_lock_data *hx509_lock;
49 typedef struct hx509_name_data *hx509_name;
50 typedef struct hx509_private_key *hx509_private_key;
51 typedef struct hx509_private_key_ops hx509_private_key_ops;
52 typedef struct hx509_validate_ctx_data *hx509_validate_ctx;
53 typedef struct hx509_verify_ctx_data *hx509_verify_ctx;
54 typedef struct hx509_revoke_ctx_data *hx509_revoke_ctx;
55 typedef struct hx509_query_data hx509_query;
56 typedef void * hx509_cursor;
57 typedef struct hx509_request_data *hx509_request;
58 typedef struct hx509_error_data *hx509_error;
59 typedef struct hx509_peer_info *hx509_peer_info;
60 typedef struct hx509_ca_tbs *hx509_ca_tbs;
61 typedef struct hx509_env_data *hx509_env;
62 typedef struct hx509_crl *hx509_crl;
63 
64 typedef void (*hx509_vprint_func)(void *, const char *, va_list);
65 
66 enum {
67     HX509_VHN_F_ALLOW_NO_MATCH = 1
68 };
69 
70 enum {
71     HX509_VALIDATE_F_VALIDATE = 1,
72     HX509_VALIDATE_F_VERBOSE = 2
73 };
74 
75 enum {
76     HX509_CRYPTO_PADDING_PKCS7 = 0,
77     HX509_CRYPTO_PADDING_NONE = 1
78 };
79 
80 enum {
81     HX509_KEY_FORMAT_GUESS = 0,
82     HX509_KEY_FORMAT_DER = 1,
83     HX509_KEY_FORMAT_WIN_BACKUPKEY = 2
84 };
85 typedef uint32_t hx509_key_format_t;
86 
87 struct hx509_cert_attribute_data {
88     heim_oid oid;
89     heim_octet_string data;
90 };
91 
92 typedef enum {
93     HX509_PROMPT_TYPE_PASSWORD		= 0x1,	/* password, hidden */
94     HX509_PROMPT_TYPE_QUESTION		= 0x2,	/* question, not hidden */
95     HX509_PROMPT_TYPE_INFO		= 0x4	/* infomation, reply doesn't matter */
96 } hx509_prompt_type;
97 
98 typedef struct hx509_prompt {
99     const char *prompt;
100     hx509_prompt_type type;
101     heim_octet_string reply;
102 } hx509_prompt;
103 
104 typedef int (*hx509_prompter_fct)(void *, const hx509_prompt *);
105 
106 typedef struct hx509_octet_string_list {
107     size_t len;
108     heim_octet_string *val;
109 } hx509_octet_string_list;
110 
111 typedef struct hx509_pem_header {
112     struct hx509_pem_header *next;
113     char *header;
114     char *value;
115 } hx509_pem_header;
116 
117 typedef int
118 (*hx509_pem_read_func)(hx509_context, const char *, const hx509_pem_header *,
119 		       const void *, size_t, void *ctx);
120 
121 /*
122  * Options passed to hx509_query_match_option.
123  */
124 typedef enum {
125     HX509_QUERY_OPTION_PRIVATE_KEY = 1,
126     HX509_QUERY_OPTION_KU_ENCIPHERMENT = 2,
127     HX509_QUERY_OPTION_KU_DIGITALSIGNATURE = 3,
128     HX509_QUERY_OPTION_KU_KEYCERTSIGN = 4,
129     HX509_QUERY_OPTION_END = 0xffff
130 } hx509_query_option;
131 
132 /* flags to hx509_certs_init */
133 #define HX509_CERTS_CREATE				0x01
134 #define HX509_CERTS_UNPROTECT_ALL			0x02
135 
136 /* flags to hx509_set_error_string */
137 #define HX509_ERROR_APPEND				0x01
138 
139 /* flags to hx509_cms_unenvelope */
140 #define HX509_CMS_UE_DONT_REQUIRE_KU_ENCIPHERMENT	0x01
141 #define HX509_CMS_UE_ALLOW_WEAK				0x02
142 
143 /* flags to hx509_cms_envelope_1 */
144 #define HX509_CMS_EV_NO_KU_CHECK			0x01
145 #define HX509_CMS_EV_ALLOW_WEAK				0x02
146 #define HX509_CMS_EV_ID_NAME				0x04
147 
148 /* flags to hx509_cms_verify_signed */
149 #define HX509_CMS_VS_ALLOW_DATA_OID_MISMATCH		0x01
150 #define HX509_CMS_VS_NO_KU_CHECK			0x02
151 #define HX509_CMS_VS_ALLOW_ZERO_SIGNER			0x04
152 #define HX509_CMS_VS_NO_VALIDATE			0x08
153 
154 /* selectors passed to hx509_crypto_select and hx509_crypto_available */
155 #define HX509_SELECT_ALL 0
156 #define HX509_SELECT_DIGEST 1
157 #define HX509_SELECT_PUBLIC_SIG 2
158 #define HX509_SELECT_PUBLIC_ENC 3
159 #define HX509_SELECT_SECRET_ENC 4
160 
161 /* flags to hx509_ca_tbs_set_template */
162 #define HX509_CA_TEMPLATE_SUBJECT 1
163 #define HX509_CA_TEMPLATE_SERIAL 2
164 #define HX509_CA_TEMPLATE_NOTBEFORE 4
165 #define HX509_CA_TEMPLATE_NOTAFTER 8
166 #define HX509_CA_TEMPLATE_SPKI 16
167 #define HX509_CA_TEMPLATE_KU 32
168 #define HX509_CA_TEMPLATE_EKU 64
169 
170 /* flags hx509_cms_create_signed* */
171 #define HX509_CMS_SIGNATURE_DETACHED			0x01
172 #define HX509_CMS_SIGNATURE_ID_NAME			0x02
173 #define HX509_CMS_SIGNATURE_NO_SIGNER			0x04
174 #define HX509_CMS_SIGNATURE_LEAF_ONLY			0x08
175 #define HX509_CMS_SIGNATURE_NO_CERTS			0x10
176 
177 /* hx509_verify_hostname nametype */
178 typedef enum  {
179     HX509_HN_HOSTNAME = 0,
180     HX509_HN_DNSSRV
181 } hx509_hostname_type;
182 
183 #include <hx509-protos.h>
184 #include <hx509_err.h>
185 
186 #endif /* HEIMDAL_HX509_H */
187