more keyusage
[heimdal.git] / lib / krb5 / krb5.h
blobf0f08a8d45e83092c3b532328c477eec6999b073
1 /*
2 * Copyright (c) 1997 - 2007 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
4 * All rights reserved.
6 * Portions Copyright (c) 2009 Apple Inc. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the Institute nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
36 /* $Id$ */
38 #ifndef __KRB5_H__
39 #define __KRB5_H__
41 #include <time.h>
42 #include <krb5-types.h>
44 #include <asn1_err.h>
45 #include <krb5_err.h>
46 #include <heim_err.h>
47 #include <k524_err.h>
49 #include <krb5_asn1.h>
51 /* name confusion with MIT */
52 #ifndef KRB5KDC_ERR_KEY_EXP
53 #define KRB5KDC_ERR_KEY_EXP KRB5KDC_ERR_KEY_EXPIRED
54 #endif
56 #ifdef _WIN32
57 #define KRB5_CALLCONV __stdcall
58 #else
59 #define KRB5_CALLCONV
60 #endif
62 /* simple constants */
64 #ifndef TRUE
65 #define TRUE 1
66 #define FALSE 0
67 #endif
69 typedef int krb5_boolean;
71 typedef int32_t krb5_error_code;
73 typedef int32_t krb5_kvno;
75 typedef uint32_t krb5_flags;
77 typedef void *krb5_pointer;
78 typedef const void *krb5_const_pointer;
80 struct krb5_crypto_data;
81 typedef struct krb5_crypto_data *krb5_crypto;
83 struct krb5_get_creds_opt_data;
84 typedef struct krb5_get_creds_opt_data *krb5_get_creds_opt;
86 struct krb5_digest_data;
87 typedef struct krb5_digest_data *krb5_digest;
88 struct krb5_ntlm_data;
89 typedef struct krb5_ntlm_data *krb5_ntlm;
91 struct krb5_pac_data;
92 typedef struct krb5_pac_data *krb5_pac;
94 typedef struct krb5_rd_req_in_ctx_data *krb5_rd_req_in_ctx;
95 typedef struct krb5_rd_req_out_ctx_data *krb5_rd_req_out_ctx;
97 typedef CKSUMTYPE krb5_cksumtype;
99 typedef Checksum krb5_checksum;
101 typedef ENCTYPE krb5_enctype;
103 typedef struct krb5_get_init_creds_ctx *krb5_init_creds_context;
105 typedef heim_octet_string krb5_data;
107 /* PKINIT related forward declarations */
108 struct ContentInfo;
109 struct krb5_pk_identity;
110 struct krb5_pk_cert;
112 /* krb5_enc_data is a mit compat structure */
113 typedef struct krb5_enc_data {
114 krb5_enctype enctype;
115 krb5_kvno kvno;
116 krb5_data ciphertext;
117 } krb5_enc_data;
119 /* alternative names */
120 enum {
121 ENCTYPE_NULL = KRB5_ENCTYPE_NULL,
122 ENCTYPE_DES_CBC_CRC = KRB5_ENCTYPE_DES_CBC_CRC,
123 ENCTYPE_DES_CBC_MD4 = KRB5_ENCTYPE_DES_CBC_MD4,
124 ENCTYPE_DES_CBC_MD5 = KRB5_ENCTYPE_DES_CBC_MD5,
125 ENCTYPE_DES3_CBC_MD5 = KRB5_ENCTYPE_DES3_CBC_MD5,
126 ENCTYPE_OLD_DES3_CBC_SHA1 = KRB5_ENCTYPE_OLD_DES3_CBC_SHA1,
127 ENCTYPE_SIGN_DSA_GENERATE = KRB5_ENCTYPE_SIGN_DSA_GENERATE,
128 ENCTYPE_ENCRYPT_RSA_PRIV = KRB5_ENCTYPE_ENCRYPT_RSA_PRIV,
129 ENCTYPE_ENCRYPT_RSA_PUB = KRB5_ENCTYPE_ENCRYPT_RSA_PUB,
130 ENCTYPE_DES3_CBC_SHA1 = KRB5_ENCTYPE_DES3_CBC_SHA1,
131 ENCTYPE_AES128_CTS_HMAC_SHA1_96 = KRB5_ENCTYPE_AES128_CTS_HMAC_SHA1_96,
132 ENCTYPE_AES256_CTS_HMAC_SHA1_96 = KRB5_ENCTYPE_AES256_CTS_HMAC_SHA1_96,
133 ENCTYPE_ARCFOUR_HMAC = KRB5_ENCTYPE_ARCFOUR_HMAC_MD5,
134 ENCTYPE_ARCFOUR_HMAC_MD5 = KRB5_ENCTYPE_ARCFOUR_HMAC_MD5,
135 ENCTYPE_ARCFOUR_HMAC_MD5_56 = KRB5_ENCTYPE_ARCFOUR_HMAC_MD5_56,
136 ENCTYPE_ENCTYPE_PK_CROSS = KRB5_ENCTYPE_ENCTYPE_PK_CROSS,
137 ENCTYPE_DES_CBC_NONE = KRB5_ENCTYPE_DES_CBC_NONE,
138 ENCTYPE_DES3_CBC_NONE = KRB5_ENCTYPE_DES3_CBC_NONE,
139 ENCTYPE_DES_CFB64_NONE = KRB5_ENCTYPE_DES_CFB64_NONE,
140 ENCTYPE_DES_PCBC_NONE = KRB5_ENCTYPE_DES_PCBC_NONE,
141 ETYPE_NULL = KRB5_ENCTYPE_NULL,
142 ETYPE_DES_CBC_CRC = KRB5_ENCTYPE_DES_CBC_CRC,
143 ETYPE_DES_CBC_MD4 = KRB5_ENCTYPE_DES_CBC_MD4,
144 ETYPE_DES_CBC_MD5 = KRB5_ENCTYPE_DES_CBC_MD5,
145 ETYPE_DES3_CBC_MD5 = KRB5_ENCTYPE_DES3_CBC_MD5,
146 ETYPE_OLD_DES3_CBC_SHA1 = KRB5_ENCTYPE_OLD_DES3_CBC_SHA1,
147 ETYPE_SIGN_DSA_GENERATE = KRB5_ENCTYPE_SIGN_DSA_GENERATE,
148 ETYPE_ENCRYPT_RSA_PRIV = KRB5_ENCTYPE_ENCRYPT_RSA_PRIV,
149 ETYPE_ENCRYPT_RSA_PUB = KRB5_ENCTYPE_ENCRYPT_RSA_PUB,
150 ETYPE_DES3_CBC_SHA1 = KRB5_ENCTYPE_DES3_CBC_SHA1,
151 ETYPE_AES128_CTS_HMAC_SHA1_96 = KRB5_ENCTYPE_AES128_CTS_HMAC_SHA1_96,
152 ETYPE_AES256_CTS_HMAC_SHA1_96 = KRB5_ENCTYPE_AES256_CTS_HMAC_SHA1_96,
153 ETYPE_ARCFOUR_HMAC_MD5 = KRB5_ENCTYPE_ARCFOUR_HMAC_MD5,
154 ETYPE_ARCFOUR_HMAC_MD5_56 = KRB5_ENCTYPE_ARCFOUR_HMAC_MD5_56,
155 ETYPE_ENCTYPE_PK_CROSS = KRB5_ENCTYPE_ENCTYPE_PK_CROSS,
156 ETYPE_ARCFOUR_MD4 = KRB5_ENCTYPE_ARCFOUR_MD4,
157 ETYPE_ARCFOUR_HMAC_OLD = KRB5_ENCTYPE_ARCFOUR_HMAC_OLD,
158 ETYPE_ARCFOUR_HMAC_OLD_EXP = KRB5_ENCTYPE_ARCFOUR_HMAC_OLD_EXP,
159 ETYPE_DES_CBC_NONE = KRB5_ENCTYPE_DES_CBC_NONE,
160 ETYPE_DES3_CBC_NONE = KRB5_ENCTYPE_DES3_CBC_NONE,
161 ETYPE_DES_CFB64_NONE = KRB5_ENCTYPE_DES_CFB64_NONE,
162 ETYPE_DES_PCBC_NONE = KRB5_ENCTYPE_DES_PCBC_NONE,
163 ETYPE_DIGEST_MD5_NONE = KRB5_ENCTYPE_DIGEST_MD5_NONE,
164 ETYPE_CRAM_MD5_NONE = KRB5_ENCTYPE_CRAM_MD5_NONE
168 /* PDU types */
169 typedef enum krb5_pdu {
170 KRB5_PDU_ERROR = 0,
171 KRB5_PDU_TICKET = 1,
172 KRB5_PDU_AS_REQUEST = 2,
173 KRB5_PDU_AS_REPLY = 3,
174 KRB5_PDU_TGS_REQUEST = 4,
175 KRB5_PDU_TGS_REPLY = 5,
176 KRB5_PDU_AP_REQUEST = 6,
177 KRB5_PDU_AP_REPLY = 7,
178 KRB5_PDU_KRB_SAFE = 8,
179 KRB5_PDU_KRB_PRIV = 9,
180 KRB5_PDU_KRB_CRED = 10,
181 KRB5_PDU_NONE = 11 /* See krb5_get_permitted_enctypes() */
182 } krb5_pdu;
184 typedef PADATA_TYPE krb5_preauthtype;
186 typedef enum krb5_key_usage {
187 KRB5_KU_PA_ENC_TIMESTAMP = 1,
188 /* AS-REQ PA-ENC-TIMESTAMP padata timestamp, encrypted with the
189 client key (section 5.4.1) */
190 KRB5_KU_TICKET = 2,
191 /* AS-REP Ticket and TGS-REP Ticket (includes tgs session key or
192 application session key), encrypted with the service key
193 (section 5.4.2) */
194 KRB5_KU_AS_REP_ENC_PART = 3,
195 /* AS-REP encrypted part (includes tgs session key or application
196 session key), encrypted with the client key (section 5.4.2) */
197 KRB5_KU_TGS_REQ_AUTH_DAT_SESSION = 4,
198 /* TGS-REQ KDC-REQ-BODY AuthorizationData, encrypted with the tgs
199 session key (section 5.4.1) */
200 KRB5_KU_TGS_REQ_AUTH_DAT_SUBKEY = 5,
201 /* TGS-REQ KDC-REQ-BODY AuthorizationData, encrypted with the tgs
202 authenticator subkey (section 5.4.1) */
203 KRB5_KU_TGS_REQ_AUTH_CKSUM = 6,
204 /* TGS-REQ PA-TGS-REQ padata AP-REQ Authenticator cksum, keyed
205 with the tgs session key (sections 5.3.2, 5.4.1) */
206 KRB5_KU_TGS_REQ_AUTH = 7,
207 /* TGS-REQ PA-TGS-REQ padata AP-REQ Authenticator (includes tgs
208 authenticator subkey), encrypted with the tgs session key
209 (section 5.3.2) */
210 KRB5_KU_TGS_REP_ENC_PART_SESSION = 8,
211 /* TGS-REP encrypted part (includes application session key),
212 encrypted with the tgs session key (section 5.4.2) */
213 KRB5_KU_TGS_REP_ENC_PART_SUB_KEY = 9,
214 /* TGS-REP encrypted part (includes application session key),
215 encrypted with the tgs authenticator subkey (section 5.4.2) */
216 KRB5_KU_AP_REQ_AUTH_CKSUM = 10,
217 /* AP-REQ Authenticator cksum, keyed with the application session
218 key (section 5.3.2) */
219 KRB5_KU_AP_REQ_AUTH = 11,
220 /* AP-REQ Authenticator (includes application authenticator
221 subkey), encrypted with the application session key (section
222 5.3.2) */
223 KRB5_KU_AP_REQ_ENC_PART = 12,
224 /* AP-REP encrypted part (includes application session subkey),
225 encrypted with the application session key (section 5.5.2) */
226 KRB5_KU_KRB_PRIV = 13,
227 /* KRB-PRIV encrypted part, encrypted with a key chosen by the
228 application (section 5.7.1) */
229 KRB5_KU_KRB_CRED = 14,
230 /* KRB-CRED encrypted part, encrypted with a key chosen by the
231 application (section 5.8.1) */
232 KRB5_KU_KRB_SAFE_CKSUM = 15,
233 /* KRB-SAFE cksum, keyed with a key chosen by the application
234 (section 5.6.1) */
235 KRB5_KU_OTHER_ENCRYPTED = 16,
236 /* Data which is defined in some specification outside of
237 Kerberos to be encrypted using an RFC1510 encryption type. */
238 KRB5_KU_OTHER_CKSUM = 17,
239 /* Data which is defined in some specification outside of
240 Kerberos to be checksummed using an RFC1510 checksum type. */
241 KRB5_KU_KRB_ERROR = 18,
242 /* Krb-error checksum */
243 KRB5_KU_AD_KDC_ISSUED = 19,
244 /* AD-KDCIssued checksum */
245 KRB5_KU_MANDATORY_TICKET_EXTENSION = 20,
246 /* Checksum for Mandatory Ticket Extensions */
247 KRB5_KU_AUTH_DATA_TICKET_EXTENSION = 21,
248 /* Checksum in Authorization Data in Ticket Extensions */
249 KRB5_KU_USAGE_SEAL = 22,
250 /* seal in GSSAPI krb5 mechanism */
251 KRB5_KU_USAGE_SIGN = 23,
252 /* sign in GSSAPI krb5 mechanism */
253 KRB5_KU_USAGE_SEQ = 24,
254 /* SEQ in GSSAPI krb5 mechanism */
255 KRB5_KU_USAGE_ACCEPTOR_SEAL = 22,
256 /* acceptor sign in GSSAPI CFX krb5 mechanism */
257 KRB5_KU_USAGE_ACCEPTOR_SIGN = 23,
258 /* acceptor seal in GSSAPI CFX krb5 mechanism */
259 KRB5_KU_USAGE_INITIATOR_SEAL = 24,
260 /* initiator sign in GSSAPI CFX krb5 mechanism */
261 KRB5_KU_USAGE_INITIATOR_SIGN = 25,
262 /* initiator seal in GSSAPI CFX krb5 mechanism */
263 KRB5_KU_PA_SERVER_REFERRAL_DATA = 22,
264 /* encrypted server referral data */
265 KRB5_KU_SAM_CHECKSUM = 25,
266 /* Checksum for the SAM-CHECKSUM field */
267 KRB5_KU_SAM_ENC_TRACK_ID = 26,
268 /* Encryption of the SAM-TRACK-ID field */
269 KRB5_KU_PA_SERVER_REFERRAL = 26,
270 /* Keyusage for the server referral in a TGS req */
271 KRB5_KU_SAM_ENC_NONCE_SAD = 27,
272 /* Encryption of the SAM-NONCE-OR-SAD field */
273 KRB5_KU_PA_PKINIT_KX = 44,
274 /* Encryption type of the kdc session contribution in pk-init */
275 KRB5_KU_AS_REQ = 56,
276 /* Checksum of over the AS-REQ send by the KDC in PA-REQ-ENC-PA-REP */
277 KRB5_KU_FAST_REQ_CHKSUM = 50,
278 /* FAST armor checksum */
279 KRB5_KU_FAST_ENC = 51,
280 /* FAST armor encryption */
281 KRB5_KU_FAST_REP = 52,
282 /* FAST armor reply */
283 KRB5_KU_FAST_FINISHED = 53,
284 /* FAST finished checksum */
285 KRB5_KU_ENC_CHALLENGE_CLIENT = 54,
286 /* fast challange from client */
287 KRB5_KU_ENC_CHALLENGE_KDC = 55,
288 /* fast challange from kdc */
289 KRB5_KU_DIGEST_ENCRYPT = -18,
290 /* Encryption key usage used in the digest encryption field */
291 KRB5_KU_DIGEST_OPAQUE = -19,
292 /* Checksum key usage used in the digest opaque field */
293 KRB5_KU_KRB5SIGNEDPATH = -21,
294 /* Checksum key usage on KRB5SignedPath */
295 KRB5_KU_CANONICALIZED_NAMES = -23
296 /* Checksum key usage on PA-CANONICALIZED */
297 } krb5_key_usage;
299 typedef krb5_key_usage krb5_keyusage;
301 typedef enum krb5_salttype {
302 KRB5_PW_SALT = KRB5_PADATA_PW_SALT,
303 KRB5_AFS3_SALT = KRB5_PADATA_AFS3_SALT
304 }krb5_salttype;
306 typedef struct krb5_salt {
307 krb5_salttype salttype;
308 krb5_data saltvalue;
309 } krb5_salt;
311 typedef ETYPE_INFO krb5_preauthinfo;
313 typedef struct {
314 krb5_preauthtype type;
315 krb5_preauthinfo info; /* list of preauthinfo for this type */
316 } krb5_preauthdata_entry;
318 typedef struct krb5_preauthdata {
319 unsigned len;
320 krb5_preauthdata_entry *val;
321 }krb5_preauthdata;
323 typedef enum krb5_address_type {
324 KRB5_ADDRESS_INET = 2,
325 KRB5_ADDRESS_NETBIOS = 20,
326 KRB5_ADDRESS_INET6 = 24,
327 KRB5_ADDRESS_ADDRPORT = 256,
328 KRB5_ADDRESS_IPPORT = 257
329 } krb5_address_type;
331 enum {
332 AP_OPTS_USE_SESSION_KEY = 1,
333 AP_OPTS_MUTUAL_REQUIRED = 2,
334 AP_OPTS_USE_SUBKEY = 4 /* library internal */
337 typedef HostAddress krb5_address;
339 typedef HostAddresses krb5_addresses;
341 typedef krb5_enctype krb5_keytype;
343 enum krb5_keytype_old {
344 KEYTYPE_NULL = ETYPE_NULL,
345 KEYTYPE_DES = ETYPE_DES_CBC_CRC,
346 KEYTYPE_DES3 = ETYPE_OLD_DES3_CBC_SHA1,
347 KEYTYPE_AES128 = ETYPE_AES128_CTS_HMAC_SHA1_96,
348 KEYTYPE_AES256 = ETYPE_AES256_CTS_HMAC_SHA1_96,
349 KEYTYPE_ARCFOUR = ETYPE_ARCFOUR_HMAC_MD5,
350 KEYTYPE_ARCFOUR_56 = ETYPE_ARCFOUR_HMAC_MD5_56
353 typedef EncryptionKey krb5_keyblock;
355 typedef AP_REQ krb5_ap_req;
357 struct krb5_cc_ops;
359 #ifdef _WIN32
360 #define KRB5_USE_PATH_TOKENS 1
361 #endif
363 #ifdef KRB5_USE_PATH_TOKENS
364 #define KRB5_DEFAULT_CCFILE_ROOT "%{TEMP}/krb5cc_"
365 #else
366 #define KRB5_DEFAULT_CCFILE_ROOT "/tmp/krb5cc_"
367 #endif
369 #define KRB5_DEFAULT_CCROOT "FILE:" KRB5_DEFAULT_CCFILE_ROOT
371 #define KRB5_ACCEPT_NULL_ADDRESSES(C) \
372 krb5_config_get_bool_default((C), NULL, TRUE, \
373 "libdefaults", "accept_null_addresses", \
374 NULL)
376 typedef void *krb5_cc_cursor;
377 typedef struct krb5_cccol_cursor_data *krb5_cccol_cursor;
379 typedef struct krb5_ccache_data {
380 const struct krb5_cc_ops *ops;
381 krb5_data data;
382 }krb5_ccache_data;
384 typedef struct krb5_ccache_data *krb5_ccache;
386 typedef struct krb5_context_data *krb5_context;
388 typedef Realm krb5_realm;
389 typedef const char *krb5_const_realm; /* stupid language */
391 #define krb5_realm_length(r) strlen(r)
392 #define krb5_realm_data(r) (r)
394 typedef Principal krb5_principal_data;
395 typedef struct Principal *krb5_principal;
396 typedef const struct Principal *krb5_const_principal;
397 typedef struct Principals *krb5_principals;
399 typedef time_t krb5_deltat;
400 typedef time_t krb5_timestamp;
402 typedef struct krb5_times {
403 krb5_timestamp authtime;
404 krb5_timestamp starttime;
405 krb5_timestamp endtime;
406 krb5_timestamp renew_till;
407 } krb5_times;
409 typedef union {
410 TicketFlags b;
411 krb5_flags i;
412 } krb5_ticket_flags;
414 /* options for krb5_get_in_tkt() */
415 #define KDC_OPT_FORWARDABLE (1 << 1)
416 #define KDC_OPT_FORWARDED (1 << 2)
417 #define KDC_OPT_PROXIABLE (1 << 3)
418 #define KDC_OPT_PROXY (1 << 4)
419 #define KDC_OPT_ALLOW_POSTDATE (1 << 5)
420 #define KDC_OPT_POSTDATED (1 << 6)
421 #define KDC_OPT_RENEWABLE (1 << 8)
422 #define KDC_OPT_REQUEST_ANONYMOUS (1 << 14)
423 #define KDC_OPT_DISABLE_TRANSITED_CHECK (1 << 26)
424 #define KDC_OPT_RENEWABLE_OK (1 << 27)
425 #define KDC_OPT_ENC_TKT_IN_SKEY (1 << 28)
426 #define KDC_OPT_RENEW (1 << 30)
427 #define KDC_OPT_VALIDATE (1 << 31)
429 typedef union {
430 KDCOptions b;
431 krb5_flags i;
432 } krb5_kdc_flags;
434 /* flags for krb5_verify_ap_req */
436 #define KRB5_VERIFY_AP_REQ_IGNORE_INVALID (1 << 0)
438 #define KRB5_GC_CACHED (1U << 0)
439 #define KRB5_GC_USER_USER (1U << 1)
440 #define KRB5_GC_EXPIRED_OK (1U << 2)
441 #define KRB5_GC_NO_STORE (1U << 3)
442 #define KRB5_GC_FORWARDABLE (1U << 4)
443 #define KRB5_GC_NO_TRANSIT_CHECK (1U << 5)
444 #define KRB5_GC_CONSTRAINED_DELEGATION (1U << 6)
445 #define KRB5_GC_CANONICALIZE (1U << 7)
447 /* constants for compare_creds (and cc_retrieve_cred) */
448 #define KRB5_TC_DONT_MATCH_REALM (1U << 31)
449 #define KRB5_TC_MATCH_KEYTYPE (1U << 30)
450 #define KRB5_TC_MATCH_KTYPE KRB5_TC_MATCH_KEYTYPE /* MIT name */
451 #define KRB5_TC_MATCH_SRV_NAMEONLY (1 << 29)
452 #define KRB5_TC_MATCH_FLAGS_EXACT (1 << 28)
453 #define KRB5_TC_MATCH_FLAGS (1 << 27)
454 #define KRB5_TC_MATCH_TIMES_EXACT (1 << 26)
455 #define KRB5_TC_MATCH_TIMES (1 << 25)
456 #define KRB5_TC_MATCH_AUTHDATA (1 << 24)
457 #define KRB5_TC_MATCH_2ND_TKT (1 << 23)
458 #define KRB5_TC_MATCH_IS_SKEY (1 << 22)
460 /* constants for get_flags and set_flags */
461 #define KRB5_TC_OPENCLOSE 0x00000001
462 #define KRB5_TC_NOTICKET 0x00000002
464 typedef AuthorizationData krb5_authdata;
466 typedef KRB_ERROR krb5_error;
468 typedef struct krb5_creds {
469 krb5_principal client;
470 krb5_principal server;
471 krb5_keyblock session;
472 krb5_times times;
473 krb5_data ticket;
474 krb5_data second_ticket;
475 krb5_authdata authdata;
476 krb5_addresses addresses;
477 krb5_ticket_flags flags;
478 } krb5_creds;
480 typedef struct krb5_cc_cache_cursor_data *krb5_cc_cache_cursor;
482 #define KRB5_CC_OPS_VERSION 3
484 typedef struct krb5_cc_ops {
485 int version;
486 const char *prefix;
487 const char* (KRB5_CALLCONV * get_name)(krb5_context, krb5_ccache);
488 krb5_error_code (KRB5_CALLCONV * resolve)(krb5_context, krb5_ccache *, const char *);
489 krb5_error_code (KRB5_CALLCONV * gen_new)(krb5_context, krb5_ccache *);
490 krb5_error_code (KRB5_CALLCONV * init)(krb5_context, krb5_ccache, krb5_principal);
491 krb5_error_code (KRB5_CALLCONV * destroy)(krb5_context, krb5_ccache);
492 krb5_error_code (KRB5_CALLCONV * close)(krb5_context, krb5_ccache);
493 krb5_error_code (KRB5_CALLCONV * store)(krb5_context, krb5_ccache, krb5_creds*);
494 krb5_error_code (KRB5_CALLCONV * retrieve)(krb5_context, krb5_ccache,
495 krb5_flags, const krb5_creds*, krb5_creds *);
496 krb5_error_code (KRB5_CALLCONV * get_princ)(krb5_context, krb5_ccache, krb5_principal*);
497 krb5_error_code (KRB5_CALLCONV * get_first)(krb5_context, krb5_ccache, krb5_cc_cursor *);
498 krb5_error_code (KRB5_CALLCONV * get_next)(krb5_context, krb5_ccache,
499 krb5_cc_cursor*, krb5_creds*);
500 krb5_error_code (KRB5_CALLCONV * end_get)(krb5_context, krb5_ccache, krb5_cc_cursor*);
501 krb5_error_code (KRB5_CALLCONV * remove_cred)(krb5_context, krb5_ccache,
502 krb5_flags, krb5_creds*);
503 krb5_error_code (KRB5_CALLCONV * set_flags)(krb5_context, krb5_ccache, krb5_flags);
504 int (KRB5_CALLCONV * get_version)(krb5_context, krb5_ccache);
505 krb5_error_code (KRB5_CALLCONV * get_cache_first)(krb5_context, krb5_cc_cursor *);
506 krb5_error_code (KRB5_CALLCONV * get_cache_next)(krb5_context, krb5_cc_cursor,
507 krb5_ccache *);
508 krb5_error_code (KRB5_CALLCONV * end_cache_get)(krb5_context, krb5_cc_cursor);
509 krb5_error_code (KRB5_CALLCONV * move)(krb5_context, krb5_ccache, krb5_ccache);
510 krb5_error_code (KRB5_CALLCONV * get_default_name)(krb5_context, char **);
511 krb5_error_code (KRB5_CALLCONV * set_default)(krb5_context, krb5_ccache);
512 krb5_error_code (KRB5_CALLCONV * lastchange)(krb5_context, krb5_ccache, krb5_timestamp *);
513 krb5_error_code (KRB5_CALLCONV * set_kdc_offset)(krb5_context, krb5_ccache, krb5_deltat);
514 krb5_error_code (KRB5_CALLCONV * get_kdc_offset)(krb5_context, krb5_ccache, krb5_deltat *);
515 } krb5_cc_ops;
517 struct krb5_log_facility;
519 struct krb5_config_binding {
520 enum { krb5_config_string, krb5_config_list } type;
521 char *name;
522 struct krb5_config_binding *next;
523 union {
524 char *string;
525 struct krb5_config_binding *list;
526 void *generic;
527 } u;
530 typedef struct krb5_config_binding krb5_config_binding;
532 typedef krb5_config_binding krb5_config_section;
534 typedef struct krb5_ticket {
535 EncTicketPart ticket;
536 krb5_principal client;
537 krb5_principal server;
538 } krb5_ticket;
540 typedef Authenticator krb5_authenticator_data;
542 typedef krb5_authenticator_data *krb5_authenticator;
544 struct krb5_rcache_data;
545 typedef struct krb5_rcache_data *krb5_rcache;
546 typedef Authenticator krb5_donot_replay;
548 #define KRB5_STORAGE_HOST_BYTEORDER 0x01 /* old */
549 #define KRB5_STORAGE_PRINCIPAL_WRONG_NUM_COMPONENTS 0x02
550 #define KRB5_STORAGE_PRINCIPAL_NO_NAME_TYPE 0x04
551 #define KRB5_STORAGE_KEYBLOCK_KEYTYPE_TWICE 0x08
552 #define KRB5_STORAGE_BYTEORDER_MASK 0x60
553 #define KRB5_STORAGE_BYTEORDER_BE 0x00 /* default */
554 #define KRB5_STORAGE_BYTEORDER_LE 0x20
555 #define KRB5_STORAGE_BYTEORDER_HOST 0x40
556 #define KRB5_STORAGE_CREDS_FLAGS_WRONG_BITORDER 0x80
558 struct krb5_storage_data;
559 typedef struct krb5_storage_data krb5_storage;
561 typedef struct krb5_keytab_entry {
562 krb5_principal principal;
563 krb5_kvno vno;
564 krb5_keyblock keyblock;
565 uint32_t timestamp;
566 uint32_t flags;
567 krb5_principals aliases;
568 } krb5_keytab_entry;
570 typedef struct krb5_kt_cursor {
571 int fd;
572 krb5_storage *sp;
573 void *data;
574 } krb5_kt_cursor;
576 struct krb5_keytab_data;
578 typedef struct krb5_keytab_data *krb5_keytab;
580 #define KRB5_KT_PREFIX_MAX_LEN 30
582 struct krb5_keytab_data {
583 const char *prefix;
584 krb5_error_code (KRB5_CALLCONV * resolve)(krb5_context, const char*, krb5_keytab);
585 krb5_error_code (KRB5_CALLCONV * get_name)(krb5_context, krb5_keytab, char*, size_t);
586 krb5_error_code (KRB5_CALLCONV * close)(krb5_context, krb5_keytab);
587 krb5_error_code (KRB5_CALLCONV * destroy)(krb5_context, krb5_keytab);
588 krb5_error_code (KRB5_CALLCONV * get)(krb5_context, krb5_keytab, krb5_const_principal,
589 krb5_kvno, krb5_enctype, krb5_keytab_entry*);
590 krb5_error_code (KRB5_CALLCONV * start_seq_get)(krb5_context, krb5_keytab, krb5_kt_cursor*);
591 krb5_error_code (KRB5_CALLCONV * next_entry)(krb5_context, krb5_keytab,
592 krb5_keytab_entry*, krb5_kt_cursor*);
593 krb5_error_code (KRB5_CALLCONV * end_seq_get)(krb5_context, krb5_keytab, krb5_kt_cursor*);
594 krb5_error_code (KRB5_CALLCONV * add)(krb5_context, krb5_keytab, krb5_keytab_entry*);
595 krb5_error_code (KRB5_CALLCONV * remove)(krb5_context, krb5_keytab, krb5_keytab_entry*);
596 void *data;
597 int32_t version;
600 typedef struct krb5_keytab_data krb5_kt_ops;
602 struct krb5_keytab_key_proc_args {
603 krb5_keytab keytab;
604 krb5_principal principal;
607 typedef struct krb5_keytab_key_proc_args krb5_keytab_key_proc_args;
609 typedef struct krb5_replay_data {
610 krb5_timestamp timestamp;
611 int32_t usec;
612 uint32_t seq;
613 } krb5_replay_data;
615 /* flags for krb5_auth_con_setflags */
616 enum {
617 KRB5_AUTH_CONTEXT_DO_TIME = 1,
618 KRB5_AUTH_CONTEXT_RET_TIME = 2,
619 KRB5_AUTH_CONTEXT_DO_SEQUENCE = 4,
620 KRB5_AUTH_CONTEXT_RET_SEQUENCE = 8,
621 KRB5_AUTH_CONTEXT_PERMIT_ALL = 16,
622 KRB5_AUTH_CONTEXT_USE_SUBKEY = 32,
623 KRB5_AUTH_CONTEXT_CLEAR_FORWARDED_CRED = 64
626 /* flags for krb5_auth_con_genaddrs */
627 enum {
628 KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR = 1,
629 KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR = 3,
630 KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR = 4,
631 KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR = 12
634 typedef struct krb5_auth_context_data {
635 unsigned int flags;
637 krb5_address *local_address;
638 krb5_address *remote_address;
639 int16_t local_port;
640 int16_t remote_port;
641 krb5_keyblock *keyblock;
642 krb5_keyblock *local_subkey;
643 krb5_keyblock *remote_subkey;
645 uint32_t local_seqnumber;
646 uint32_t remote_seqnumber;
648 krb5_authenticator authenticator;
650 krb5_pointer i_vector;
652 krb5_rcache rcache;
654 krb5_keytype keytype; /* ¿requested key type ? */
655 krb5_cksumtype cksumtype; /* ¡requested checksum type! */
657 }krb5_auth_context_data, *krb5_auth_context;
659 typedef struct {
660 KDC_REP kdc_rep;
661 EncKDCRepPart enc_part;
662 KRB_ERROR error;
663 } krb5_kdc_rep;
665 extern const char *heimdal_version, *heimdal_long_version;
667 typedef void (KRB5_CALLCONV * krb5_log_log_func_t)(const char*, const char*, void*);
668 typedef void (KRB5_CALLCONV * krb5_log_close_func_t)(void*);
670 typedef struct krb5_log_facility {
671 char *program;
672 int len;
673 struct facility *val;
674 } krb5_log_facility;
676 typedef EncAPRepPart krb5_ap_rep_enc_part;
678 #define KRB5_RECVAUTH_IGNORE_VERSION 1
680 #define KRB5_SENDAUTH_VERSION "KRB5_SENDAUTH_V1.0"
682 #define KRB5_TGS_NAME_SIZE (6)
683 #define KRB5_TGS_NAME ("krbtgt")
684 #define KRB5_WELLKNOWN_NAME ("WELLKNOWN")
685 #define KRB5_ANON_NAME ("ANONYMOUS")
686 #define KRB5_DIGEST_NAME ("digest")
688 typedef enum {
689 KRB5_PROMPT_TYPE_PASSWORD = 0x1,
690 KRB5_PROMPT_TYPE_NEW_PASSWORD = 0x2,
691 KRB5_PROMPT_TYPE_NEW_PASSWORD_AGAIN = 0x3,
692 KRB5_PROMPT_TYPE_PREAUTH = 0x4,
693 KRB5_PROMPT_TYPE_INFO = 0x5
694 } krb5_prompt_type;
696 typedef struct _krb5_prompt {
697 const char *prompt;
698 int hidden;
699 krb5_data *reply;
700 krb5_prompt_type type;
701 } krb5_prompt;
703 typedef int (KRB5_CALLCONV * krb5_prompter_fct)(krb5_context /*context*/,
704 void * /*data*/,
705 const char * /*name*/,
706 const char * /*banner*/,
707 int /*num_prompts*/,
708 krb5_prompt /*prompts*/[]);
709 typedef krb5_error_code (KRB5_CALLCONV * krb5_key_proc)(krb5_context /*context*/,
710 krb5_enctype /*type*/,
711 krb5_salt /*salt*/,
712 krb5_const_pointer /*keyseed*/,
713 krb5_keyblock ** /*key*/);
714 typedef krb5_error_code (KRB5_CALLCONV * krb5_decrypt_proc)(krb5_context /*context*/,
715 krb5_keyblock * /*key*/,
716 krb5_key_usage /*usage*/,
717 krb5_const_pointer /*decrypt_arg*/,
718 krb5_kdc_rep * /*dec_rep*/);
719 typedef krb5_error_code (KRB5_CALLCONV * krb5_s2k_proc)(krb5_context /*context*/,
720 krb5_enctype /*type*/,
721 krb5_const_pointer /*keyseed*/,
722 krb5_salt /*salt*/,
723 krb5_data * /*s2kparms*/,
724 krb5_keyblock ** /*key*/);
726 struct _krb5_get_init_creds_opt_private;
728 struct _krb5_get_init_creds_opt {
729 krb5_flags flags;
730 krb5_deltat tkt_life;
731 krb5_deltat renew_life;
732 int forwardable;
733 int proxiable;
734 int anonymous;
735 krb5_enctype *etype_list;
736 int etype_list_length;
737 krb5_addresses *address_list;
738 /* XXX the next three should not be used, as they may be
739 removed later */
740 krb5_preauthtype *preauth_list;
741 int preauth_list_length;
742 krb5_data *salt;
743 struct _krb5_get_init_creds_opt_private *opt_private;
746 typedef struct _krb5_get_init_creds_opt krb5_get_init_creds_opt;
748 #define KRB5_GET_INIT_CREDS_OPT_TKT_LIFE 0x0001
749 #define KRB5_GET_INIT_CREDS_OPT_RENEW_LIFE 0x0002
750 #define KRB5_GET_INIT_CREDS_OPT_FORWARDABLE 0x0004
751 #define KRB5_GET_INIT_CREDS_OPT_PROXIABLE 0x0008
752 #define KRB5_GET_INIT_CREDS_OPT_ETYPE_LIST 0x0010
753 #define KRB5_GET_INIT_CREDS_OPT_ADDRESS_LIST 0x0020
754 #define KRB5_GET_INIT_CREDS_OPT_PREAUTH_LIST 0x0040
755 #define KRB5_GET_INIT_CREDS_OPT_SALT 0x0080 /* no supported */
756 #define KRB5_GET_INIT_CREDS_OPT_ANONYMOUS 0x0100
757 #define KRB5_GET_INIT_CREDS_OPT_DISABLE_TRANSITED_CHECK 0x0200
759 /* krb5_init_creds_step flags argument */
760 #define KRB5_INIT_CREDS_STEP_FLAG_CONTINUE 0x0001
762 typedef struct _krb5_verify_init_creds_opt {
763 krb5_flags flags;
764 int ap_req_nofail;
765 } krb5_verify_init_creds_opt;
767 #define KRB5_VERIFY_INIT_CREDS_OPT_AP_REQ_NOFAIL 0x0001
769 typedef struct krb5_verify_opt {
770 unsigned int flags;
771 krb5_ccache ccache;
772 krb5_keytab keytab;
773 krb5_boolean secure;
774 const char *service;
775 } krb5_verify_opt;
777 #define KRB5_VERIFY_LREALMS 1
778 #define KRB5_VERIFY_NO_ADDRESSES 2
780 #define KRB5_KPASSWD_VERS_CHANGEPW 1
781 #define KRB5_KPASSWD_VERS_SETPW 0xff80
783 #define KRB5_KPASSWD_SUCCESS 0
784 #define KRB5_KPASSWD_MALFORMED 1
785 #define KRB5_KPASSWD_HARDERROR 2
786 #define KRB5_KPASSWD_AUTHERROR 3
787 #define KRB5_KPASSWD_SOFTERROR 4
788 #define KRB5_KPASSWD_ACCESSDENIED 5
789 #define KRB5_KPASSWD_BAD_VERSION 6
790 #define KRB5_KPASSWD_INITIAL_FLAG_NEEDED 7
792 #define KPASSWD_PORT 464
794 /* types for the new krbhst interface */
795 struct krb5_krbhst_data;
796 typedef struct krb5_krbhst_data *krb5_krbhst_handle;
798 #define KRB5_KRBHST_KDC 1
799 #define KRB5_KRBHST_ADMIN 2
800 #define KRB5_KRBHST_CHANGEPW 3
801 #define KRB5_KRBHST_KRB524 4
802 #define KRB5_KRBHST_KCA 5
804 typedef struct krb5_krbhst_info {
805 enum { KRB5_KRBHST_UDP,
806 KRB5_KRBHST_TCP,
807 KRB5_KRBHST_HTTP } proto;
808 unsigned short port;
809 unsigned short def_port;
810 struct addrinfo *ai;
811 struct krb5_krbhst_info *next;
812 char hostname[1]; /* has to come last */
813 } krb5_krbhst_info;
815 /* flags for krb5_krbhst_init_flags (and krb5_send_to_kdc_flags) */
816 enum {
817 KRB5_KRBHST_FLAGS_MASTER = 1,
818 KRB5_KRBHST_FLAGS_LARGE_MSG = 2
821 typedef krb5_error_code
822 (KRB5_CALLCONV * krb5_send_to_kdc_func)(krb5_context, void *, krb5_krbhst_info *, time_t,
823 const krb5_data *, krb5_data *);
825 /** flags for krb5_parse_name_flags */
826 enum {
827 KRB5_PRINCIPAL_PARSE_NO_REALM = 1, /**< Require that there are no realm */
828 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM = 2, /**< Require a realm present */
829 KRB5_PRINCIPAL_PARSE_ENTERPRISE = 4 /**< Parse as a NT-ENTERPRISE name */
832 /** flags for krb5_unparse_name_flags */
833 enum {
834 KRB5_PRINCIPAL_UNPARSE_SHORT = 1, /**< No realm if it is the default realm */
835 KRB5_PRINCIPAL_UNPARSE_NO_REALM = 2, /**< No realm */
836 KRB5_PRINCIPAL_UNPARSE_DISPLAY = 4 /**< No quoting */
839 typedef struct krb5_sendto_ctx_data *krb5_sendto_ctx;
841 #define KRB5_SENDTO_DONE 0
842 #define KRB5_SENDTO_RESTART 1
843 #define KRB5_SENDTO_CONTINUE 2
845 typedef krb5_error_code
846 (KRB5_CALLCONV * krb5_sendto_ctx_func)(krb5_context, krb5_sendto_ctx, void *,
847 const krb5_data *, int *);
849 struct krb5_plugin;
850 enum krb5_plugin_type {
851 PLUGIN_TYPE_DATA = 1,
852 PLUGIN_TYPE_FUNC
855 struct credentials; /* this is to keep the compiler happy */
856 struct getargs;
857 struct sockaddr;
860 * Semi private, not stable yet
863 typedef struct krb5_crypto_iov {
864 unsigned int flags;
865 /* ignored */
866 #define KRB5_CRYPTO_TYPE_EMPTY 0
867 /* OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_HEADER) */
868 #define KRB5_CRYPTO_TYPE_HEADER 1
869 /* IN and OUT */
870 #define KRB5_CRYPTO_TYPE_DATA 2
871 /* IN */
872 #define KRB5_CRYPTO_TYPE_SIGN_ONLY 3
873 /* (only for encryption) OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_TRAILER) */
874 #define KRB5_CRYPTO_TYPE_PADDING 4
875 /* OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_TRAILER) */
876 #define KRB5_CRYPTO_TYPE_TRAILER 5
877 /* OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_CHECKSUM) */
878 #define KRB5_CRYPTO_TYPE_CHECKSUM 6
879 krb5_data data;
880 } krb5_crypto_iov;
883 /* Glue for MIT */
885 typedef struct {
886 int32_t lr_type;
887 krb5_timestamp value;
888 } krb5_last_req_entry;
890 typedef krb5_error_code
891 (KRB5_CALLCONV * krb5_gic_process_last_req)(krb5_context, krb5_last_req_entry **, void *);
893 typedef struct {
894 krb5_enctype ks_enctype;
895 krb5int32 ks_salttype;
896 }krb5_key_salt_tuple;
902 struct hx509_certs_data;
904 #include <krb5-protos.h>
906 /* variables */
908 extern KRB5_LIB_VARIABLE const char *krb5_config_file;
909 extern KRB5_LIB_VARIABLE const char *krb5_defkeyname;
912 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_acc_ops;
913 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_fcc_ops;
914 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_mcc_ops;
915 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_kcm_ops;
916 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_akcm_ops;
917 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_scc_ops;
919 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_fkt_ops;
920 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_wrfkt_ops;
921 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_javakt_ops;
922 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_mkt_ops;
923 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_akf_ops;
924 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_any_ops;
926 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_api;
927 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_file;
928 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_memory;
929 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_kcm;
930 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_scc;
932 #endif /* __KRB5_H__ */