Use anon realm for anonymous PKINIT
[heimdal.git] / lib / krb5 / krb5.h
blob71b0eb1b2961d28c869c9f71b79aca5768de2ab4
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 challenge from client */
287 KRB5_KU_ENC_CHALLENGE_KDC = 55,
288 /* fast challenge 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_KU_H5L_COOKIE = -25
298 /* encrypted foo */
299 } krb5_key_usage;
301 typedef krb5_key_usage krb5_keyusage;
303 typedef enum krb5_salttype {
304 KRB5_PW_SALT = KRB5_PADATA_PW_SALT,
305 KRB5_AFS3_SALT = KRB5_PADATA_AFS3_SALT
306 }krb5_salttype;
308 typedef struct krb5_salt {
309 krb5_salttype salttype;
310 krb5_data saltvalue;
311 } krb5_salt;
313 typedef ETYPE_INFO krb5_preauthinfo;
315 typedef struct {
316 krb5_preauthtype type;
317 krb5_preauthinfo info; /* list of preauthinfo for this type */
318 } krb5_preauthdata_entry;
320 typedef struct krb5_preauthdata {
321 unsigned len;
322 krb5_preauthdata_entry *val;
323 }krb5_preauthdata;
325 typedef enum krb5_address_type {
326 KRB5_ADDRESS_INET = 2,
327 KRB5_ADDRESS_NETBIOS = 20,
328 KRB5_ADDRESS_INET6 = 24,
329 KRB5_ADDRESS_ADDRPORT = 256,
330 KRB5_ADDRESS_IPPORT = 257
331 } krb5_address_type;
333 enum {
334 AP_OPTS_USE_SESSION_KEY = 1,
335 AP_OPTS_MUTUAL_REQUIRED = 2,
336 AP_OPTS_USE_SUBKEY = 4 /* library internal */
339 typedef HostAddress krb5_address;
341 typedef HostAddresses krb5_addresses;
343 typedef krb5_enctype krb5_keytype;
345 enum krb5_keytype_old {
346 KEYTYPE_NULL = ETYPE_NULL,
347 KEYTYPE_DES = ETYPE_DES_CBC_CRC,
348 KEYTYPE_DES3 = ETYPE_OLD_DES3_CBC_SHA1,
349 KEYTYPE_AES128 = ETYPE_AES128_CTS_HMAC_SHA1_96,
350 KEYTYPE_AES256 = ETYPE_AES256_CTS_HMAC_SHA1_96,
351 KEYTYPE_ARCFOUR = ETYPE_ARCFOUR_HMAC_MD5,
352 KEYTYPE_ARCFOUR_56 = ETYPE_ARCFOUR_HMAC_MD5_56
355 typedef EncryptionKey krb5_keyblock;
357 typedef AP_REQ krb5_ap_req;
359 struct krb5_cc_ops;
361 #ifdef _WIN32
362 #define KRB5_USE_PATH_TOKENS 1
363 #endif
365 #ifdef KRB5_USE_PATH_TOKENS
366 #define KRB5_DEFAULT_CCFILE_ROOT "%{TEMP}/krb5cc_"
367 #else
368 #define KRB5_DEFAULT_CCFILE_ROOT "/tmp/krb5cc_"
369 #endif
371 #define KRB5_DEFAULT_CCROOT "FILE:" KRB5_DEFAULT_CCFILE_ROOT
373 #define KRB5_ACCEPT_NULL_ADDRESSES(C) \
374 krb5_config_get_bool_default((C), NULL, TRUE, \
375 "libdefaults", "accept_null_addresses", \
376 NULL)
378 typedef void *krb5_cc_cursor;
379 typedef struct krb5_cccol_cursor_data *krb5_cccol_cursor;
381 typedef struct krb5_ccache_data {
382 const struct krb5_cc_ops *ops;
383 krb5_data data;
384 }krb5_ccache_data;
386 typedef struct krb5_ccache_data *krb5_ccache;
388 typedef struct krb5_context_data *krb5_context;
390 typedef Realm krb5_realm;
391 typedef const char *krb5_const_realm; /* stupid language */
393 #define krb5_realm_length(r) strlen(r)
394 #define krb5_realm_data(r) (r)
396 typedef Principal krb5_principal_data;
397 typedef struct Principal *krb5_principal;
398 typedef const struct Principal *krb5_const_principal;
399 typedef struct Principals *krb5_principals;
401 typedef time_t krb5_deltat;
402 typedef time_t krb5_timestamp;
404 typedef struct krb5_times {
405 krb5_timestamp authtime;
406 krb5_timestamp starttime;
407 krb5_timestamp endtime;
408 krb5_timestamp renew_till;
409 } krb5_times;
411 typedef union {
412 TicketFlags b;
413 krb5_flags i;
414 } krb5_ticket_flags;
416 /* options for krb5_get_in_tkt() */
417 #define KDC_OPT_FORWARDABLE (1 << 1)
418 #define KDC_OPT_FORWARDED (1 << 2)
419 #define KDC_OPT_PROXIABLE (1 << 3)
420 #define KDC_OPT_PROXY (1 << 4)
421 #define KDC_OPT_ALLOW_POSTDATE (1 << 5)
422 #define KDC_OPT_POSTDATED (1 << 6)
423 #define KDC_OPT_RENEWABLE (1 << 8)
424 #define KDC_OPT_REQUEST_ANONYMOUS (1 << 14)
425 #define KDC_OPT_DISABLE_TRANSITED_CHECK (1 << 26)
426 #define KDC_OPT_RENEWABLE_OK (1 << 27)
427 #define KDC_OPT_ENC_TKT_IN_SKEY (1 << 28)
428 #define KDC_OPT_RENEW (1 << 30)
429 #define KDC_OPT_VALIDATE (1 << 31)
431 typedef union {
432 KDCOptions b;
433 krb5_flags i;
434 } krb5_kdc_flags;
436 /* flags for krb5_verify_ap_req */
438 #define KRB5_VERIFY_AP_REQ_IGNORE_INVALID (1 << 0)
440 #define KRB5_GC_CACHED (1U << 0)
441 #define KRB5_GC_USER_USER (1U << 1)
442 #define KRB5_GC_EXPIRED_OK (1U << 2)
443 #define KRB5_GC_NO_STORE (1U << 3)
444 #define KRB5_GC_FORWARDABLE (1U << 4)
445 #define KRB5_GC_NO_TRANSIT_CHECK (1U << 5)
446 #define KRB5_GC_CONSTRAINED_DELEGATION (1U << 6)
447 #define KRB5_GC_CANONICALIZE (1U << 7)
449 /* constants for compare_creds (and cc_retrieve_cred) */
450 #define KRB5_TC_DONT_MATCH_REALM (1U << 31)
451 #define KRB5_TC_MATCH_KEYTYPE (1U << 30)
452 #define KRB5_TC_MATCH_KTYPE KRB5_TC_MATCH_KEYTYPE /* MIT name */
453 #define KRB5_TC_MATCH_SRV_NAMEONLY (1 << 29)
454 #define KRB5_TC_MATCH_FLAGS_EXACT (1 << 28)
455 #define KRB5_TC_MATCH_FLAGS (1 << 27)
456 #define KRB5_TC_MATCH_TIMES_EXACT (1 << 26)
457 #define KRB5_TC_MATCH_TIMES (1 << 25)
458 #define KRB5_TC_MATCH_AUTHDATA (1 << 24)
459 #define KRB5_TC_MATCH_2ND_TKT (1 << 23)
460 #define KRB5_TC_MATCH_IS_SKEY (1 << 22)
462 /* constants for get_flags and set_flags */
463 #define KRB5_TC_OPENCLOSE 0x00000001
464 #define KRB5_TC_NOTICKET 0x00000002
466 typedef AuthorizationData krb5_authdata;
468 typedef KRB_ERROR krb5_error;
470 typedef struct krb5_creds {
471 krb5_principal client;
472 krb5_principal server;
473 krb5_keyblock session;
474 krb5_times times;
475 krb5_data ticket;
476 krb5_data second_ticket;
477 krb5_authdata authdata;
478 krb5_addresses addresses;
479 krb5_ticket_flags flags;
480 } krb5_creds;
482 typedef struct krb5_cc_cache_cursor_data *krb5_cc_cache_cursor;
484 #define KRB5_CC_OPS_VERSION 3
486 typedef struct krb5_cc_ops {
487 int version;
488 const char *prefix;
489 const char* (KRB5_CALLCONV * get_name)(krb5_context, krb5_ccache);
490 krb5_error_code (KRB5_CALLCONV * resolve)(krb5_context, krb5_ccache *, const char *);
491 krb5_error_code (KRB5_CALLCONV * gen_new)(krb5_context, krb5_ccache *);
492 krb5_error_code (KRB5_CALLCONV * init)(krb5_context, krb5_ccache, krb5_principal);
493 krb5_error_code (KRB5_CALLCONV * destroy)(krb5_context, krb5_ccache);
494 krb5_error_code (KRB5_CALLCONV * close)(krb5_context, krb5_ccache);
495 krb5_error_code (KRB5_CALLCONV * store)(krb5_context, krb5_ccache, krb5_creds*);
496 krb5_error_code (KRB5_CALLCONV * retrieve)(krb5_context, krb5_ccache,
497 krb5_flags, const krb5_creds*, krb5_creds *);
498 krb5_error_code (KRB5_CALLCONV * get_princ)(krb5_context, krb5_ccache, krb5_principal*);
499 krb5_error_code (KRB5_CALLCONV * get_first)(krb5_context, krb5_ccache, krb5_cc_cursor *);
500 krb5_error_code (KRB5_CALLCONV * get_next)(krb5_context, krb5_ccache,
501 krb5_cc_cursor*, krb5_creds*);
502 krb5_error_code (KRB5_CALLCONV * end_get)(krb5_context, krb5_ccache, krb5_cc_cursor*);
503 krb5_error_code (KRB5_CALLCONV * remove_cred)(krb5_context, krb5_ccache,
504 krb5_flags, krb5_creds*);
505 krb5_error_code (KRB5_CALLCONV * set_flags)(krb5_context, krb5_ccache, krb5_flags);
506 int (KRB5_CALLCONV * get_version)(krb5_context, krb5_ccache);
507 krb5_error_code (KRB5_CALLCONV * get_cache_first)(krb5_context, krb5_cc_cursor *);
508 krb5_error_code (KRB5_CALLCONV * get_cache_next)(krb5_context, krb5_cc_cursor,
509 krb5_ccache *);
510 krb5_error_code (KRB5_CALLCONV * end_cache_get)(krb5_context, krb5_cc_cursor);
511 krb5_error_code (KRB5_CALLCONV * move)(krb5_context, krb5_ccache, krb5_ccache);
512 krb5_error_code (KRB5_CALLCONV * get_default_name)(krb5_context, char **);
513 krb5_error_code (KRB5_CALLCONV * set_default)(krb5_context, krb5_ccache);
514 krb5_error_code (KRB5_CALLCONV * lastchange)(krb5_context, krb5_ccache, krb5_timestamp *);
515 krb5_error_code (KRB5_CALLCONV * set_kdc_offset)(krb5_context, krb5_ccache, krb5_deltat);
516 krb5_error_code (KRB5_CALLCONV * get_kdc_offset)(krb5_context, krb5_ccache, krb5_deltat *);
517 } krb5_cc_ops;
519 struct krb5_log_facility;
521 struct krb5_config_binding {
522 enum { krb5_config_string, krb5_config_list } type;
523 char *name;
524 struct krb5_config_binding *next;
525 union {
526 char *string;
527 struct krb5_config_binding *list;
528 void *generic;
529 } u;
532 typedef struct krb5_config_binding krb5_config_binding;
534 typedef krb5_config_binding krb5_config_section;
536 typedef struct krb5_ticket {
537 EncTicketPart ticket;
538 krb5_principal client;
539 krb5_principal server;
540 } krb5_ticket;
542 typedef Authenticator krb5_authenticator_data;
544 typedef krb5_authenticator_data *krb5_authenticator;
546 struct krb5_rcache_data;
547 typedef struct krb5_rcache_data *krb5_rcache;
548 typedef Authenticator krb5_donot_replay;
550 #define KRB5_STORAGE_HOST_BYTEORDER 0x01 /* old */
551 #define KRB5_STORAGE_PRINCIPAL_WRONG_NUM_COMPONENTS 0x02
552 #define KRB5_STORAGE_PRINCIPAL_NO_NAME_TYPE 0x04
553 #define KRB5_STORAGE_KEYBLOCK_KEYTYPE_TWICE 0x08
554 #define KRB5_STORAGE_BYTEORDER_MASK 0x60
555 #define KRB5_STORAGE_BYTEORDER_BE 0x00 /* default */
556 #define KRB5_STORAGE_BYTEORDER_LE 0x20
557 #define KRB5_STORAGE_BYTEORDER_HOST 0x40
558 #define KRB5_STORAGE_CREDS_FLAGS_WRONG_BITORDER 0x80
560 struct krb5_storage_data;
561 typedef struct krb5_storage_data krb5_storage;
563 typedef struct krb5_keytab_entry {
564 krb5_principal principal;
565 krb5_kvno vno;
566 krb5_keyblock keyblock;
567 uint32_t timestamp;
568 uint32_t flags;
569 krb5_principals aliases;
570 } krb5_keytab_entry;
572 typedef struct krb5_kt_cursor {
573 int fd;
574 krb5_storage *sp;
575 void *data;
576 } krb5_kt_cursor;
578 struct krb5_keytab_data;
580 typedef struct krb5_keytab_data *krb5_keytab;
582 #define KRB5_KT_PREFIX_MAX_LEN 30
584 struct krb5_keytab_data {
585 const char *prefix;
586 krb5_error_code (KRB5_CALLCONV * resolve)(krb5_context, const char*, krb5_keytab);
587 krb5_error_code (KRB5_CALLCONV * get_name)(krb5_context, krb5_keytab, char*, size_t);
588 krb5_error_code (KRB5_CALLCONV * close)(krb5_context, krb5_keytab);
589 krb5_error_code (KRB5_CALLCONV * destroy)(krb5_context, krb5_keytab);
590 krb5_error_code (KRB5_CALLCONV * get)(krb5_context, krb5_keytab, krb5_const_principal,
591 krb5_kvno, krb5_enctype, krb5_keytab_entry*);
592 krb5_error_code (KRB5_CALLCONV * start_seq_get)(krb5_context, krb5_keytab, krb5_kt_cursor*);
593 krb5_error_code (KRB5_CALLCONV * next_entry)(krb5_context, krb5_keytab,
594 krb5_keytab_entry*, krb5_kt_cursor*);
595 krb5_error_code (KRB5_CALLCONV * end_seq_get)(krb5_context, krb5_keytab, krb5_kt_cursor*);
596 krb5_error_code (KRB5_CALLCONV * add)(krb5_context, krb5_keytab, krb5_keytab_entry*);
597 krb5_error_code (KRB5_CALLCONV * remove)(krb5_context, krb5_keytab, krb5_keytab_entry*);
598 void *data;
599 int32_t version;
602 typedef struct krb5_keytab_data krb5_kt_ops;
604 struct krb5_keytab_key_proc_args {
605 krb5_keytab keytab;
606 krb5_principal principal;
609 typedef struct krb5_keytab_key_proc_args krb5_keytab_key_proc_args;
611 typedef struct krb5_replay_data {
612 krb5_timestamp timestamp;
613 int32_t usec;
614 uint32_t seq;
615 } krb5_replay_data;
617 /* flags for krb5_auth_con_setflags */
618 enum {
619 KRB5_AUTH_CONTEXT_DO_TIME = 1,
620 KRB5_AUTH_CONTEXT_RET_TIME = 2,
621 KRB5_AUTH_CONTEXT_DO_SEQUENCE = 4,
622 KRB5_AUTH_CONTEXT_RET_SEQUENCE = 8,
623 KRB5_AUTH_CONTEXT_PERMIT_ALL = 16,
624 KRB5_AUTH_CONTEXT_USE_SUBKEY = 32,
625 KRB5_AUTH_CONTEXT_CLEAR_FORWARDED_CRED = 64
628 /* flags for krb5_auth_con_genaddrs */
629 enum {
630 KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR = 1,
631 KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR = 3,
632 KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR = 4,
633 KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR = 12
636 typedef struct krb5_auth_context_data {
637 unsigned int flags;
639 krb5_address *local_address;
640 krb5_address *remote_address;
641 int16_t local_port;
642 int16_t remote_port;
643 krb5_keyblock *keyblock;
644 krb5_keyblock *local_subkey;
645 krb5_keyblock *remote_subkey;
647 uint32_t local_seqnumber;
648 uint32_t remote_seqnumber;
650 krb5_authenticator authenticator;
652 krb5_pointer i_vector;
654 krb5_rcache rcache;
656 krb5_keytype keytype; /* ¿requested key type ? */
657 krb5_cksumtype cksumtype; /* ¡requested checksum type! */
659 AuthorizationData *auth_data;
661 }krb5_auth_context_data, *krb5_auth_context;
663 typedef struct {
664 KDC_REP kdc_rep;
665 EncKDCRepPart enc_part;
666 KRB_ERROR error;
667 } krb5_kdc_rep;
669 extern const char *heimdal_version, *heimdal_long_version;
671 typedef void (KRB5_CALLCONV * krb5_log_log_func_t)(const char*, const char*, void*);
672 typedef void (KRB5_CALLCONV * krb5_log_close_func_t)(void*);
674 typedef struct krb5_log_facility {
675 char *program;
676 int len;
677 struct facility *val;
678 } krb5_log_facility;
680 typedef EncAPRepPart krb5_ap_rep_enc_part;
682 #define KRB5_RECVAUTH_IGNORE_VERSION 1
684 #define KRB5_SENDAUTH_VERSION "KRB5_SENDAUTH_V1.0"
686 #define KRB5_TGS_NAME_SIZE (6)
687 #define KRB5_TGS_NAME ("krbtgt")
688 #define KRB5_WELLKNOWN_NAME ("WELLKNOWN")
689 #define KRB5_ANON_NAME ("ANONYMOUS")
690 #define KRB5_ANON_REALM ("WELLKNOWN:ANONYMOUS")
691 #define KRB5_WELLKNOWN_ORG_H5L_REALM ("WELLKNOWN:ORG.H5L")
692 #define KRB5_DIGEST_NAME ("digest")
695 #define KRB5_PKU2U_REALM_NAME ("WELLKNOWN:PKU2U")
696 #define KRB5_LKDC_REALM_NAME ("WELLKNOWN:COM.APPLE.LKDC")
698 #define KRB5_GSS_HOSTBASED_SERVICE_NAME ("WELLKNOWN:ORG.H5L.HOSTBASED-SERVICE")
699 #define KRB5_GSS_REFERALS_REALM_NAME ("WELLKNOWN:ORG.H5L.REFERALS-REALM")
701 typedef enum {
702 KRB5_PROMPT_TYPE_PASSWORD = 0x1,
703 KRB5_PROMPT_TYPE_NEW_PASSWORD = 0x2,
704 KRB5_PROMPT_TYPE_NEW_PASSWORD_AGAIN = 0x3,
705 KRB5_PROMPT_TYPE_PREAUTH = 0x4,
706 KRB5_PROMPT_TYPE_INFO = 0x5
707 } krb5_prompt_type;
709 typedef struct _krb5_prompt {
710 const char *prompt;
711 int hidden;
712 krb5_data *reply;
713 krb5_prompt_type type;
714 } krb5_prompt;
716 typedef int (KRB5_CALLCONV * krb5_prompter_fct)(krb5_context /*context*/,
717 void * /*data*/,
718 const char * /*name*/,
719 const char * /*banner*/,
720 int /*num_prompts*/,
721 krb5_prompt /*prompts*/[]);
722 typedef krb5_error_code (KRB5_CALLCONV * krb5_key_proc)(krb5_context /*context*/,
723 krb5_enctype /*type*/,
724 krb5_salt /*salt*/,
725 krb5_const_pointer /*keyseed*/,
726 krb5_keyblock ** /*key*/);
727 typedef krb5_error_code (KRB5_CALLCONV * krb5_decrypt_proc)(krb5_context /*context*/,
728 krb5_keyblock * /*key*/,
729 krb5_key_usage /*usage*/,
730 krb5_const_pointer /*decrypt_arg*/,
731 krb5_kdc_rep * /*dec_rep*/);
732 typedef krb5_error_code (KRB5_CALLCONV * krb5_s2k_proc)(krb5_context /*context*/,
733 krb5_enctype /*type*/,
734 krb5_const_pointer /*keyseed*/,
735 krb5_salt /*salt*/,
736 krb5_data * /*s2kparms*/,
737 krb5_keyblock ** /*key*/);
739 struct _krb5_get_init_creds_opt_private;
741 struct _krb5_get_init_creds_opt {
742 krb5_flags flags;
743 krb5_deltat tkt_life;
744 krb5_deltat renew_life;
745 int forwardable;
746 int proxiable;
747 int anonymous;
748 krb5_enctype *etype_list;
749 int etype_list_length;
750 krb5_addresses *address_list;
751 /* XXX the next three should not be used, as they may be
752 removed later */
753 krb5_preauthtype *preauth_list;
754 int preauth_list_length;
755 krb5_data *salt;
756 struct _krb5_get_init_creds_opt_private *opt_private;
759 typedef struct _krb5_get_init_creds_opt krb5_get_init_creds_opt;
761 #define KRB5_GET_INIT_CREDS_OPT_TKT_LIFE 0x0001
762 #define KRB5_GET_INIT_CREDS_OPT_RENEW_LIFE 0x0002
763 #define KRB5_GET_INIT_CREDS_OPT_FORWARDABLE 0x0004
764 #define KRB5_GET_INIT_CREDS_OPT_PROXIABLE 0x0008
765 #define KRB5_GET_INIT_CREDS_OPT_ETYPE_LIST 0x0010
766 #define KRB5_GET_INIT_CREDS_OPT_ADDRESS_LIST 0x0020
767 #define KRB5_GET_INIT_CREDS_OPT_PREAUTH_LIST 0x0040
768 #define KRB5_GET_INIT_CREDS_OPT_SALT 0x0080 /* no supported */
769 #define KRB5_GET_INIT_CREDS_OPT_ANONYMOUS 0x0100
770 #define KRB5_GET_INIT_CREDS_OPT_DISABLE_TRANSITED_CHECK 0x0200
772 /* krb5_init_creds_step flags argument */
773 #define KRB5_INIT_CREDS_STEP_FLAG_CONTINUE 0x0001
775 typedef struct _krb5_verify_init_creds_opt {
776 krb5_flags flags;
777 int ap_req_nofail;
778 } krb5_verify_init_creds_opt;
780 #define KRB5_VERIFY_INIT_CREDS_OPT_AP_REQ_NOFAIL 0x0001
782 typedef struct krb5_verify_opt {
783 unsigned int flags;
784 krb5_ccache ccache;
785 krb5_keytab keytab;
786 krb5_boolean secure;
787 const char *service;
788 } krb5_verify_opt;
790 #define KRB5_VERIFY_LREALMS 1
791 #define KRB5_VERIFY_NO_ADDRESSES 2
793 #define KRB5_KPASSWD_VERS_CHANGEPW 1
794 #define KRB5_KPASSWD_VERS_SETPW 0xff80
796 #define KRB5_KPASSWD_SUCCESS 0
797 #define KRB5_KPASSWD_MALFORMED 1
798 #define KRB5_KPASSWD_HARDERROR 2
799 #define KRB5_KPASSWD_AUTHERROR 3
800 #define KRB5_KPASSWD_SOFTERROR 4
801 #define KRB5_KPASSWD_ACCESSDENIED 5
802 #define KRB5_KPASSWD_BAD_VERSION 6
803 #define KRB5_KPASSWD_INITIAL_FLAG_NEEDED 7
805 #define KPASSWD_PORT 464
807 /* types for the new krbhst interface */
808 struct krb5_krbhst_data;
809 typedef struct krb5_krbhst_data *krb5_krbhst_handle;
811 #define KRB5_KRBHST_KDC 1
812 #define KRB5_KRBHST_ADMIN 2
813 #define KRB5_KRBHST_CHANGEPW 3
814 #define KRB5_KRBHST_KRB524 4
815 #define KRB5_KRBHST_KCA 5
817 typedef struct krb5_krbhst_info {
818 enum { KRB5_KRBHST_UDP,
819 KRB5_KRBHST_TCP,
820 KRB5_KRBHST_HTTP } proto;
821 unsigned short port;
822 unsigned short def_port;
823 struct addrinfo *ai;
824 struct krb5_krbhst_info *next;
825 char hostname[1]; /* has to come last */
826 } krb5_krbhst_info;
828 /* flags for krb5_krbhst_init_flags (and krb5_send_to_kdc_flags) */
829 enum {
830 KRB5_KRBHST_FLAGS_MASTER = 1,
831 KRB5_KRBHST_FLAGS_LARGE_MSG = 2
834 typedef krb5_error_code (*krb5_sendto_prexmit)(krb5_context, int, void *, int, krb5_data *);
835 typedef krb5_error_code
836 (KRB5_CALLCONV * krb5_send_to_kdc_func)(krb5_context, void *, krb5_krbhst_info *, time_t,
837 const krb5_data *, krb5_data *);
839 /** flags for krb5_parse_name_flags */
840 enum {
841 KRB5_PRINCIPAL_PARSE_NO_REALM = 1, /**< Require that there are no realm */
842 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM = 2, /**< Require a realm present */
843 KRB5_PRINCIPAL_PARSE_ENTERPRISE = 4, /**< Parse as a NT-ENTERPRISE name */
844 KRB5_PRINCIPAL_PARSE_IGNORE_REALM = 8, /**< Ignore realm if present */
845 KRB5_PRINCIPAL_PARSE_NO_DEF_REALM = 16 /**< Don't default the realm */
848 /** flags for krb5_unparse_name_flags */
849 enum {
850 KRB5_PRINCIPAL_UNPARSE_SHORT = 1, /**< No realm if it is the default realm */
851 KRB5_PRINCIPAL_UNPARSE_NO_REALM = 2, /**< No realm */
852 KRB5_PRINCIPAL_UNPARSE_DISPLAY = 4 /**< No quoting */
855 typedef struct krb5_sendto_ctx_data *krb5_sendto_ctx;
857 #define KRB5_SENDTO_DONE 0
858 #define KRB5_SENDTO_RESET 1
859 #define KRB5_SENDTO_CONTINUE 2
860 #define KRB5_SENDTO_TIMEOUT 3
861 #define KRB5_SENDTO_INITIAL 4
862 #define KRB5_SENDTO_FILTER 5
863 #define KRB5_SENDTO_FAILED 6
864 #define KRB5_SENDTO_KRBHST 7
866 typedef krb5_error_code
867 (KRB5_CALLCONV * krb5_sendto_ctx_func)(krb5_context, krb5_sendto_ctx, void *,
868 const krb5_data *, int *);
870 struct krb5_plugin;
871 enum krb5_plugin_type {
872 PLUGIN_TYPE_DATA = 1,
873 PLUGIN_TYPE_FUNC
876 #define KRB5_PLUGIN_INVOKE_ALL 1
878 struct credentials; /* this is to keep the compiler happy */
879 struct getargs;
880 struct sockaddr;
883 * Semi private, not stable yet
886 typedef struct krb5_crypto_iov {
887 unsigned int flags;
888 /* ignored */
889 #define KRB5_CRYPTO_TYPE_EMPTY 0
890 /* OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_HEADER) */
891 #define KRB5_CRYPTO_TYPE_HEADER 1
892 /* IN and OUT */
893 #define KRB5_CRYPTO_TYPE_DATA 2
894 /* IN */
895 #define KRB5_CRYPTO_TYPE_SIGN_ONLY 3
896 /* (only for encryption) OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_TRAILER) */
897 #define KRB5_CRYPTO_TYPE_PADDING 4
898 /* OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_TRAILER) */
899 #define KRB5_CRYPTO_TYPE_TRAILER 5
900 /* OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_CHECKSUM) */
901 #define KRB5_CRYPTO_TYPE_CHECKSUM 6
902 krb5_data data;
903 } krb5_crypto_iov;
906 /* Glue for MIT */
908 typedef struct {
909 int32_t lr_type;
910 krb5_timestamp value;
911 } krb5_last_req_entry;
913 typedef krb5_error_code
914 (KRB5_CALLCONV * krb5_gic_process_last_req)(krb5_context, krb5_last_req_entry **, void *);
916 typedef struct {
917 krb5_enctype ks_enctype;
918 krb5int32 ks_salttype;
919 }krb5_key_salt_tuple;
922 * Name canonicalization rule options
925 typedef enum krb5_name_canon_rule_options {
926 KRB5_NCRO_GC_ONLY = 1 << 0,
927 KRB5_NCRO_USE_REFERRALS = 1 << 1,
928 KRB5_NCRO_NO_REFERRALS = 1 << 2,
929 KRB5_NCRO_SECURE = 1 << 2
930 } krb5_name_canon_rule_options;
932 typedef struct krb5_name_canon_rule_data *krb5_name_canon_rule;
933 typedef struct krb5_name_canon_iterator_data *krb5_name_canon_iterator;
939 struct hx509_certs_data;
941 #include <krb5-protos.h>
943 /* variables */
945 extern KRB5_LIB_VARIABLE const char *krb5_config_file;
946 extern KRB5_LIB_VARIABLE const char *krb5_defkeyname;
949 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_acc_ops;
950 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_dcc_ops;
951 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_fcc_ops;
952 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_mcc_ops;
953 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_kcm_ops;
954 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_akcm_ops;
955 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_scc_ops;
957 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_fkt_ops;
958 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_wrfkt_ops;
959 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_javakt_ops;
960 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_mkt_ops;
961 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_akf_ops;
962 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_any_ops;
964 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_api;
965 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_file;
966 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_memory;
967 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_kcm;
968 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_scc;
969 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_dcc;
971 #endif /* __KRB5_H__ */