lib/krb5/krb5.h

   1 /*
   2  * Copyright (c) 1997 - 2007 Kungliga Tekniska Högskolan
   3  * (Royal Institute of Technology, Stockholm, Sweden).
   4  * All rights reserved.
   5  *
   6  * Portions Copyright (c) 2009 Apple Inc. All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  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.
  18  *
  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.
  22  *
  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.
  34  */
  35
  36 /* $Id$ */
  37
  38 #ifndef __KRB5_H__
  39 #define __KRB5_H__
  40
  41 #include <time.h>
  42 #include <krb5-types.h>
  43
  44 #include <asn1_err.h>
  45 #include <krb5_err.h>
  46 #include <heim_err.h>
  47 #include <k524_err.h>
  48
  49 #include <krb5_asn1.h>
  50
  51 /* name confusion with MIT */
  52 #ifndef KRB5KDC_ERR_KEY_EXP
  53 #define KRB5KDC_ERR_KEY_EXP KRB5KDC_ERR_KEY_EXPIRED
  54 #endif
  55
  56 #ifdef _WIN32
  57 #define KRB5_CALLCONV __stdcall
  58 #else
  59 #define KRB5_CALLCONV
  60 #endif
  61
  62 /* simple constants */
  63
  64 #ifndef TRUE
  65 #define TRUE  1
  66 #define FALSE 0
  67 #endif
  68
  69 typedef int krb5_boolean;
  70
  71 typedef int32_t krb5_error_code;
  72
  73 typedef int32_t krb5_kvno;
  74
  75 typedef uint32_t krb5_flags;
  76
  77 typedef void *krb5_pointer;
  78 typedef const void *krb5_const_pointer;
  79
  80 struct krb5_crypto_data;
  81 typedef struct krb5_crypto_data *krb5_crypto;
  82
  83 struct krb5_get_creds_opt_data;
  84 typedef struct krb5_get_creds_opt_data *krb5_get_creds_opt;
  85
  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;
  90
  91 struct krb5_pac_data;
  92 typedef struct krb5_pac_data *krb5_pac;
  93
  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;
  96
  97 typedef CKSUMTYPE krb5_cksumtype;
  98
  99 typedef Checksum krb5_checksum;
 100
 101 typedef ENCTYPE krb5_enctype;
 102
 103 typedef struct krb5_get_init_creds_ctx *krb5_init_creds_context;
 104
 105 typedef heim_octet_string krb5_data;
 106
 107 /* PKINIT related forward declarations */
 108 struct ContentInfo;
 109 struct krb5_pk_identity;
 110 struct krb5_pk_cert;
 111
 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;
 118
 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
 165
 166 };
 167
 168 typedef PADATA_TYPE krb5_preauthtype;
 169
 170 typedef enum krb5_key_usage {
 171     KRB5_KU_PA_ENC_TIMESTAMP = 1,
 172     /* AS-REQ PA-ENC-TIMESTAMP padata timestamp, encrypted with the
 173        client key (section 5.4.1) */
 174     KRB5_KU_TICKET = 2,
 175     /* AS-REP Ticket and TGS-REP Ticket (includes tgs session key or
 176        application session key), encrypted with the service key
 177        (section 5.4.2) */
 178     KRB5_KU_AS_REP_ENC_PART = 3,
 179     /* AS-REP encrypted part (includes tgs session key or application
 180        session key), encrypted with the client key (section 5.4.2) */
 181     KRB5_KU_TGS_REQ_AUTH_DAT_SESSION = 4,
 182     /* TGS-REQ KDC-REQ-BODY AuthorizationData, encrypted with the tgs
 183        session key (section 5.4.1) */
 184     KRB5_KU_TGS_REQ_AUTH_DAT_SUBKEY = 5,
 185     /* TGS-REQ KDC-REQ-BODY AuthorizationData, encrypted with the tgs
 186           authenticator subkey (section 5.4.1) */
 187     KRB5_KU_TGS_REQ_AUTH_CKSUM = 6,
 188     /* TGS-REQ PA-TGS-REQ padata AP-REQ Authenticator cksum, keyed
 189        with the tgs session key (sections 5.3.2, 5.4.1) */
 190     KRB5_KU_TGS_REQ_AUTH = 7,
 191     /* TGS-REQ PA-TGS-REQ padata AP-REQ Authenticator (includes tgs
 192        authenticator subkey), encrypted with the tgs session key
 193        (section 5.3.2) */
 194     KRB5_KU_TGS_REP_ENC_PART_SESSION = 8,
 195     /* TGS-REP encrypted part (includes application session key),
 196        encrypted with the tgs session key (section 5.4.2) */
 197     KRB5_KU_TGS_REP_ENC_PART_SUB_KEY = 9,
 198     /* TGS-REP encrypted part (includes application session key),
 199        encrypted with the tgs authenticator subkey (section 5.4.2) */
 200     KRB5_KU_AP_REQ_AUTH_CKSUM = 10,
 201     /* AP-REQ Authenticator cksum, keyed with the application session
 202        key (section 5.3.2) */
 203     KRB5_KU_AP_REQ_AUTH = 11,
 204     /* AP-REQ Authenticator (includes application authenticator
 205        subkey), encrypted with the application session key (section
 206        5.3.2) */
 207     KRB5_KU_AP_REQ_ENC_PART = 12,
 208     /* AP-REP encrypted part (includes application session subkey),
 209        encrypted with the application session key (section 5.5.2) */
 210     KRB5_KU_KRB_PRIV = 13,
 211     /* KRB-PRIV encrypted part, encrypted with a key chosen by the
 212        application (section 5.7.1) */
 213     KRB5_KU_KRB_CRED = 14,
 214     /* KRB-CRED encrypted part, encrypted with a key chosen by the
 215        application (section 5.8.1) */
 216     KRB5_KU_KRB_SAFE_CKSUM = 15,
 217     /* KRB-SAFE cksum, keyed with a key chosen by the application
 218        (section 5.6.1) */
 219     KRB5_KU_OTHER_ENCRYPTED = 16,
 220     /* Data which is defined in some specification outside of
 221        Kerberos to be encrypted using an RFC1510 encryption type. */
 222     KRB5_KU_OTHER_CKSUM = 17,
 223     /* Data which is defined in some specification outside of
 224        Kerberos to be checksummed using an RFC1510 checksum type. */
 225     KRB5_KU_KRB_ERROR = 18,
 226     /* Krb-error checksum */
 227     KRB5_KU_AD_KDC_ISSUED = 19,
 228     /* AD-KDCIssued checksum */
 229     KRB5_KU_MANDATORY_TICKET_EXTENSION = 20,
 230     /* Checksum for Mandatory Ticket Extensions */
 231     KRB5_KU_AUTH_DATA_TICKET_EXTENSION = 21,
 232     /* Checksum in Authorization Data in Ticket Extensions */
 233     KRB5_KU_USAGE_SEAL = 22,
 234     /* seal in GSSAPI krb5 mechanism */
 235     KRB5_KU_USAGE_SIGN = 23,
 236     /* sign in GSSAPI krb5 mechanism */
 237     KRB5_KU_USAGE_SEQ = 24,
 238     /* SEQ in GSSAPI krb5 mechanism */
 239     KRB5_KU_USAGE_ACCEPTOR_SEAL = 22,
 240     /* acceptor sign in GSSAPI CFX krb5 mechanism */
 241     KRB5_KU_USAGE_ACCEPTOR_SIGN = 23,
 242     /* acceptor seal in GSSAPI CFX krb5 mechanism */
 243     KRB5_KU_USAGE_INITIATOR_SEAL = 24,
 244     /* initiator sign in GSSAPI CFX krb5 mechanism */
 245     KRB5_KU_USAGE_INITIATOR_SIGN = 25,
 246     /* initiator seal in GSSAPI CFX krb5 mechanism */
 247     KRB5_KU_PA_SERVER_REFERRAL_DATA = 22,
 248     /* encrypted server referral data */
 249     KRB5_KU_SAM_CHECKSUM = 25,
 250     /* Checksum for the SAM-CHECKSUM field */
 251     KRB5_KU_SAM_ENC_TRACK_ID = 26,
 252     /* Encryption of the SAM-TRACK-ID field */
 253     KRB5_KU_PA_SERVER_REFERRAL = 26,
 254     /* Keyusage for the server referral in a TGS req */
 255     KRB5_KU_SAM_ENC_NONCE_SAD = 27,
 256     /* Encryption of the SAM-NONCE-OR-SAD field */
 257     KRB5_KU_PA_PKINIT_KX = 44,
 258     /* Encryption type of the kdc session contribution in pk-init */
 259     KRB5_KU_AS_REQ = 56,
 260     /* Checksum of over the AS-REQ send by the KDC in PA-REQ-ENC-PA-REP */
 261     KRB5_KU_DIGEST_ENCRYPT = -18,
 262     /* Encryption key usage used in the digest encryption field */
 263     KRB5_KU_DIGEST_OPAQUE = -19,
 264     /* Checksum key usage used in the digest opaque field */
 265     KRB5_KU_KRB5SIGNEDPATH = -21,
 266     /* Checksum key usage on KRB5SignedPath */
 267     KRB5_KU_CANONICALIZED_NAMES = -23
 268     /* Checksum key usage on PA-CANONICALIZED */
 269 } krb5_key_usage;
 270
 271 typedef krb5_key_usage krb5_keyusage;
 272
 273 typedef enum krb5_salttype {
 274     KRB5_PW_SALT = KRB5_PADATA_PW_SALT,
 275     KRB5_AFS3_SALT = KRB5_PADATA_AFS3_SALT
 276 }krb5_salttype;
 277
 278 typedef struct krb5_salt {
 279     krb5_salttype salttype;
 280     krb5_data saltvalue;
 281 } krb5_salt;
 282
 283 typedef ETYPE_INFO krb5_preauthinfo;
 284
 285 typedef struct {
 286     krb5_preauthtype type;
 287     krb5_preauthinfo info; /* list of preauthinfo for this type */
 288 } krb5_preauthdata_entry;
 289
 290 typedef struct krb5_preauthdata {
 291     unsigned len;
 292     krb5_preauthdata_entry *val;
 293 }krb5_preauthdata;
 294
 295 typedef enum krb5_address_type {
 296     KRB5_ADDRESS_INET     =   2,
 297     KRB5_ADDRESS_NETBIOS  =  20,
 298     KRB5_ADDRESS_INET6    =  24,
 299     KRB5_ADDRESS_ADDRPORT = 256,
 300     KRB5_ADDRESS_IPPORT   = 257
 301 } krb5_address_type;
 302
 303 enum {
 304   AP_OPTS_USE_SESSION_KEY = 1,
 305   AP_OPTS_MUTUAL_REQUIRED = 2,
 306   AP_OPTS_USE_SUBKEY = 4                /* library internal */
 307 };
 308
 309 typedef HostAddress krb5_address;
 310
 311 typedef HostAddresses krb5_addresses;
 312
 313 typedef enum krb5_keytype {
 314     KEYTYPE_NULL        = ETYPE_NULL,
 315     KEYTYPE_DES         = ETYPE_DES_CBC_CRC,
 316     KEYTYPE_DES3        = ETYPE_OLD_DES3_CBC_SHA1,
 317     KEYTYPE_AES128      = ETYPE_AES128_CTS_HMAC_SHA1_96,
 318     KEYTYPE_AES256      = ETYPE_AES256_CTS_HMAC_SHA1_96,
 319     KEYTYPE_ARCFOUR     = ETYPE_ARCFOUR_HMAC_MD5,
 320     KEYTYPE_ARCFOUR_56  = ETYPE_ARCFOUR_HMAC_MD5_56
 321 } krb5_keytype;
 322
 323 typedef EncryptionKey krb5_keyblock;
 324
 325 typedef AP_REQ krb5_ap_req;
 326
 327 struct krb5_cc_ops;
 328
 329 #ifdef _WIN32
 330 #define KRB5_USE_PATH_TOKENS 1
 331 #endif
 332
 333 #ifdef KRB5_USE_PATH_TOKENS
 334 #define KRB5_DEFAULT_CCFILE_ROOT "%{TEMP}/krb5cc_"
 335 #else
 336 #define KRB5_DEFAULT_CCFILE_ROOT "/tmp/krb5cc_"
 337 #endif
 338
 339 #define KRB5_DEFAULT_CCROOT "FILE:" KRB5_DEFAULT_CCFILE_ROOT
 340
 341 #define KRB5_ACCEPT_NULL_ADDRESSES(C)                                    \
 342     krb5_config_get_bool_default((C), NULL, TRUE,                        \
 343                                  "libdefaults", "accept_null_addresses", \
 344                                  NULL)
 345
 346 typedef void *krb5_cc_cursor;
 347 typedef struct krb5_cccol_cursor_data *krb5_cccol_cursor;
 348
 349 typedef struct krb5_ccache_data {
 350     const struct krb5_cc_ops *ops;
 351     krb5_data data;
 352 }krb5_ccache_data;
 353
 354 typedef struct krb5_ccache_data *krb5_ccache;
 355
 356 typedef struct krb5_context_data *krb5_context;
 357
 358 typedef Realm krb5_realm;
 359 typedef const char *krb5_const_realm; /* stupid language */
 360
 361 #define krb5_realm_length(r) strlen(r)
 362 #define krb5_realm_data(r) (r)
 363
 364 typedef Principal krb5_principal_data;
 365 typedef struct Principal *krb5_principal;
 366 typedef const struct Principal *krb5_const_principal;
 367 typedef struct Principals *krb5_principals;
 368
 369 typedef time_t krb5_deltat;
 370 typedef time_t krb5_timestamp;
 371
 372 typedef struct krb5_times {
 373   krb5_timestamp authtime;
 374   krb5_timestamp starttime;
 375   krb5_timestamp endtime;
 376   krb5_timestamp renew_till;
 377 } krb5_times;
 378
 379 typedef union {
 380     TicketFlags b;
 381     krb5_flags i;
 382 } krb5_ticket_flags;
 383
 384 /* options for krb5_get_in_tkt() */
 385 #define KDC_OPT_FORWARDABLE             (1 << 1)
 386 #define KDC_OPT_FORWARDED               (1 << 2)
 387 #define KDC_OPT_PROXIABLE               (1 << 3)
 388 #define KDC_OPT_PROXY                   (1 << 4)
 389 #define KDC_OPT_ALLOW_POSTDATE          (1 << 5)
 390 #define KDC_OPT_POSTDATED               (1 << 6)
 391 #define KDC_OPT_RENEWABLE               (1 << 8)
 392 #define KDC_OPT_REQUEST_ANONYMOUS       (1 << 14)
 393 #define KDC_OPT_DISABLE_TRANSITED_CHECK (1 << 26)
 394 #define KDC_OPT_RENEWABLE_OK            (1 << 27)
 395 #define KDC_OPT_ENC_TKT_IN_SKEY         (1 << 28)
 396 #define KDC_OPT_RENEW                   (1 << 30)
 397 #define KDC_OPT_VALIDATE                (1 << 31)
 398
 399 typedef union {
 400     KDCOptions b;
 401     krb5_flags i;
 402 } krb5_kdc_flags;
 403
 404 /* flags for krb5_verify_ap_req */
 405
 406 #define KRB5_VERIFY_AP_REQ_IGNORE_INVALID       (1 << 0)
 407
 408 #define KRB5_GC_CACHED                  (1U << 0)
 409 #define KRB5_GC_USER_USER               (1U << 1)
 410 #define KRB5_GC_EXPIRED_OK              (1U << 2)
 411 #define KRB5_GC_NO_STORE                (1U << 3)
 412 #define KRB5_GC_FORWARDABLE             (1U << 4)
 413 #define KRB5_GC_NO_TRANSIT_CHECK        (1U << 5)
 414 #define KRB5_GC_CONSTRAINED_DELEGATION  (1U << 6)
 415 #define KRB5_GC_CANONICALIZE            (1U << 7)
 416
 417 /* constants for compare_creds (and cc_retrieve_cred) */
 418 #define KRB5_TC_DONT_MATCH_REALM        (1U << 31)
 419 #define KRB5_TC_MATCH_KEYTYPE           (1U << 30)
 420 #define KRB5_TC_MATCH_KTYPE             KRB5_TC_MATCH_KEYTYPE    /* MIT name */
 421 #define KRB5_TC_MATCH_SRV_NAMEONLY      (1 << 29)
 422 #define KRB5_TC_MATCH_FLAGS_EXACT       (1 << 28)
 423 #define KRB5_TC_MATCH_FLAGS             (1 << 27)
 424 #define KRB5_TC_MATCH_TIMES_EXACT       (1 << 26)
 425 #define KRB5_TC_MATCH_TIMES             (1 << 25)
 426 #define KRB5_TC_MATCH_AUTHDATA          (1 << 24)
 427 #define KRB5_TC_MATCH_2ND_TKT           (1 << 23)
 428 #define KRB5_TC_MATCH_IS_SKEY           (1 << 22)
 429
 430 /* constants for get_flags and set_flags */
 431 #define KRB5_TC_OPENCLOSE 0x00000001
 432 #define KRB5_TC_NOTICKET  0x00000002
 433
 434 typedef AuthorizationData krb5_authdata;
 435
 436 typedef KRB_ERROR krb5_error;
 437
 438 typedef struct krb5_creds {
 439     krb5_principal client;
 440     krb5_principal server;
 441     krb5_keyblock session;
 442     krb5_times times;
 443     krb5_data ticket;
 444     krb5_data second_ticket;
 445     krb5_authdata authdata;
 446     krb5_addresses addresses;
 447     krb5_ticket_flags flags;
 448 } krb5_creds;
 449
 450 typedef struct krb5_cc_cache_cursor_data *krb5_cc_cache_cursor;
 451
 452 #define KRB5_CC_OPS_VERSION 3
 453
 454 typedef struct krb5_cc_ops {
 455     int version;
 456     const char *prefix;
 457     const char* (KRB5_CALLCONV * get_name)(krb5_context, krb5_ccache);
 458     krb5_error_code (KRB5_CALLCONV * resolve)(krb5_context, krb5_ccache *, const char *);
 459     krb5_error_code (KRB5_CALLCONV * gen_new)(krb5_context, krb5_ccache *);
 460     krb5_error_code (KRB5_CALLCONV * init)(krb5_context, krb5_ccache, krb5_principal);
 461     krb5_error_code (KRB5_CALLCONV * destroy)(krb5_context, krb5_ccache);
 462     krb5_error_code (KRB5_CALLCONV * close)(krb5_context, krb5_ccache);
 463     krb5_error_code (KRB5_CALLCONV * store)(krb5_context, krb5_ccache, krb5_creds*);
 464     krb5_error_code (KRB5_CALLCONV * retrieve)(krb5_context, krb5_ccache,
 465                                                krb5_flags, const krb5_creds*, krb5_creds *);
 466     krb5_error_code (KRB5_CALLCONV * get_princ)(krb5_context, krb5_ccache, krb5_principal*);
 467     krb5_error_code (KRB5_CALLCONV * get_first)(krb5_context, krb5_ccache, krb5_cc_cursor *);
 468     krb5_error_code (KRB5_CALLCONV * get_next)(krb5_context, krb5_ccache,
 469                                                krb5_cc_cursor*, krb5_creds*);
 470     krb5_error_code (KRB5_CALLCONV * end_get)(krb5_context, krb5_ccache, krb5_cc_cursor*);
 471     krb5_error_code (KRB5_CALLCONV * remove_cred)(krb5_context, krb5_ccache,
 472                                                   krb5_flags, krb5_creds*);
 473     krb5_error_code (KRB5_CALLCONV * set_flags)(krb5_context, krb5_ccache, krb5_flags);
 474     int (KRB5_CALLCONV * get_version)(krb5_context, krb5_ccache);
 475     krb5_error_code (KRB5_CALLCONV * get_cache_first)(krb5_context, krb5_cc_cursor *);
 476     krb5_error_code (KRB5_CALLCONV * get_cache_next)(krb5_context, krb5_cc_cursor,
 477                                                      krb5_ccache *);
 478     krb5_error_code (KRB5_CALLCONV * end_cache_get)(krb5_context, krb5_cc_cursor);
 479     krb5_error_code (KRB5_CALLCONV * move)(krb5_context, krb5_ccache, krb5_ccache);
 480     krb5_error_code (KRB5_CALLCONV * get_default_name)(krb5_context, char **);
 481     krb5_error_code (KRB5_CALLCONV * set_default)(krb5_context, krb5_ccache);
 482     krb5_error_code (KRB5_CALLCONV * lastchange)(krb5_context, krb5_ccache, krb5_timestamp *);
 483     krb5_error_code (KRB5_CALLCONV * set_kdc_offset)(krb5_context, krb5_ccache, krb5_deltat);
 484     krb5_error_code (KRB5_CALLCONV * get_kdc_offset)(krb5_context, krb5_ccache, krb5_deltat *);
 485 } krb5_cc_ops;
 486
 487 struct krb5_log_facility;
 488
 489 struct krb5_config_binding {
 490     enum { krb5_config_string, krb5_config_list } type;
 491     char *name;
 492     struct krb5_config_binding *next;
 493     union {
 494         char *string;
 495         struct krb5_config_binding *list;
 496         void *generic;
 497     } u;
 498 };
 499
 500 typedef struct krb5_config_binding krb5_config_binding;
 501
 502 typedef krb5_config_binding krb5_config_section;
 503
 504 typedef struct krb5_ticket {
 505     EncTicketPart ticket;
 506     krb5_principal client;
 507     krb5_principal server;
 508 } krb5_ticket;
 509
 510 typedef Authenticator krb5_authenticator_data;
 511
 512 typedef krb5_authenticator_data *krb5_authenticator;
 513
 514 struct krb5_rcache_data;
 515 typedef struct krb5_rcache_data *krb5_rcache;
 516 typedef Authenticator krb5_donot_replay;
 517
 518 #define KRB5_STORAGE_HOST_BYTEORDER                     0x01 /* old */
 519 #define KRB5_STORAGE_PRINCIPAL_WRONG_NUM_COMPONENTS     0x02
 520 #define KRB5_STORAGE_PRINCIPAL_NO_NAME_TYPE             0x04
 521 #define KRB5_STORAGE_KEYBLOCK_KEYTYPE_TWICE             0x08
 522 #define KRB5_STORAGE_BYTEORDER_MASK                     0x60
 523 #define KRB5_STORAGE_BYTEORDER_BE                       0x00 /* default */
 524 #define KRB5_STORAGE_BYTEORDER_LE                       0x20
 525 #define KRB5_STORAGE_BYTEORDER_HOST                     0x40
 526 #define KRB5_STORAGE_CREDS_FLAGS_WRONG_BITORDER         0x80
 527
 528 struct krb5_storage_data;
 529 typedef struct krb5_storage_data krb5_storage;
 530
 531 typedef struct krb5_keytab_entry {
 532     krb5_principal principal;
 533     krb5_kvno vno;
 534     krb5_keyblock keyblock;
 535     uint32_t timestamp;
 536     uint32_t flags;
 537     krb5_principals aliases;
 538 } krb5_keytab_entry;
 539
 540 typedef struct krb5_kt_cursor {
 541     int fd;
 542     krb5_storage *sp;
 543     void *data;
 544 } krb5_kt_cursor;
 545
 546 struct krb5_keytab_data;
 547
 548 typedef struct krb5_keytab_data *krb5_keytab;
 549
 550 #define KRB5_KT_PREFIX_MAX_LEN  30
 551
 552 struct krb5_keytab_data {
 553     const char *prefix;
 554     krb5_error_code (KRB5_CALLCONV * resolve)(krb5_context, const char*, krb5_keytab);
 555     krb5_error_code (KRB5_CALLCONV * get_name)(krb5_context, krb5_keytab, char*, size_t);
 556     krb5_error_code (KRB5_CALLCONV * close)(krb5_context, krb5_keytab);
 557     krb5_error_code (KRB5_CALLCONV * destroy)(krb5_context, krb5_keytab);
 558     krb5_error_code (KRB5_CALLCONV * get)(krb5_context, krb5_keytab, krb5_const_principal,
 559                                           krb5_kvno, krb5_enctype, krb5_keytab_entry*);
 560     krb5_error_code (KRB5_CALLCONV * start_seq_get)(krb5_context, krb5_keytab, krb5_kt_cursor*);
 561     krb5_error_code (KRB5_CALLCONV * next_entry)(krb5_context, krb5_keytab,
 562                                                  krb5_keytab_entry*, krb5_kt_cursor*);
 563     krb5_error_code (KRB5_CALLCONV * end_seq_get)(krb5_context, krb5_keytab, krb5_kt_cursor*);
 564     krb5_error_code (KRB5_CALLCONV * add)(krb5_context, krb5_keytab, krb5_keytab_entry*);
 565     krb5_error_code (KRB5_CALLCONV * remove)(krb5_context, krb5_keytab, krb5_keytab_entry*);
 566     void *data;
 567     int32_t version;
 568 };
 569
 570 typedef struct krb5_keytab_data krb5_kt_ops;
 571
 572 struct krb5_keytab_key_proc_args {
 573     krb5_keytab keytab;
 574     krb5_principal principal;
 575 };
 576
 577 typedef struct krb5_keytab_key_proc_args krb5_keytab_key_proc_args;
 578
 579 typedef struct krb5_replay_data {
 580     krb5_timestamp timestamp;
 581     int32_t usec;
 582     uint32_t seq;
 583 } krb5_replay_data;
 584
 585 /* flags for krb5_auth_con_setflags */
 586 enum {
 587     KRB5_AUTH_CONTEXT_DO_TIME                   = 1,
 588     KRB5_AUTH_CONTEXT_RET_TIME                  = 2,
 589     KRB5_AUTH_CONTEXT_DO_SEQUENCE               = 4,
 590     KRB5_AUTH_CONTEXT_RET_SEQUENCE              = 8,
 591     KRB5_AUTH_CONTEXT_PERMIT_ALL                = 16,
 592     KRB5_AUTH_CONTEXT_USE_SUBKEY                = 32,
 593     KRB5_AUTH_CONTEXT_CLEAR_FORWARDED_CRED      = 64
 594 };
 595
 596 /* flags for krb5_auth_con_genaddrs */
 597 enum {
 598     KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR       = 1,
 599     KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR  = 3,
 600     KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR      = 4,
 601     KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR = 12
 602 };
 603
 604 typedef struct krb5_auth_context_data {
 605     unsigned int flags;
 606
 607     krb5_address *local_address;
 608     krb5_address *remote_address;
 609     int16_t local_port;
 610     int16_t remote_port;
 611     krb5_keyblock *keyblock;
 612     krb5_keyblock *local_subkey;
 613     krb5_keyblock *remote_subkey;
 614
 615     uint32_t local_seqnumber;
 616     uint32_t remote_seqnumber;
 617
 618     krb5_authenticator authenticator;
 619
 620     krb5_pointer i_vector;
 621
 622     krb5_rcache rcache;
 623
 624     krb5_keytype keytype;       /* ¿requested key type ? */
 625     krb5_cksumtype cksumtype;   /* ¡requested checksum type! */
 626
 627 }krb5_auth_context_data, *krb5_auth_context;
 628
 629 typedef struct {
 630     KDC_REP kdc_rep;
 631     EncKDCRepPart enc_part;
 632     KRB_ERROR error;
 633 } krb5_kdc_rep;
 634
 635 extern const char *heimdal_version, *heimdal_long_version;
 636
 637 typedef void (KRB5_CALLCONV * krb5_log_log_func_t)(const char*, const char*, void*);
 638 typedef void (KRB5_CALLCONV * krb5_log_close_func_t)(void*);
 639
 640 typedef struct krb5_log_facility {
 641     char *program;
 642     int len;
 643     struct facility *val;
 644 } krb5_log_facility;
 645
 646 typedef EncAPRepPart krb5_ap_rep_enc_part;
 647
 648 #define KRB5_RECVAUTH_IGNORE_VERSION 1
 649
 650 #define KRB5_SENDAUTH_VERSION "KRB5_SENDAUTH_V1.0"
 651
 652 #define KRB5_TGS_NAME_SIZE (6)
 653 #define KRB5_TGS_NAME ("krbtgt")
 654 #define KRB5_WELLKNOWN_NAME ("WELLKNOWN")
 655 #define KRB5_ANON_NAME ("ANONYMOUS")
 656 #define KRB5_DIGEST_NAME ("digest")
 657
 658 typedef enum {
 659     KRB5_PROMPT_TYPE_PASSWORD           = 0x1,
 660     KRB5_PROMPT_TYPE_NEW_PASSWORD       = 0x2,
 661     KRB5_PROMPT_TYPE_NEW_PASSWORD_AGAIN = 0x3,
 662     KRB5_PROMPT_TYPE_PREAUTH            = 0x4,
 663     KRB5_PROMPT_TYPE_INFO               = 0x5
 664 } krb5_prompt_type;
 665
 666 typedef struct _krb5_prompt {
 667     const char *prompt;
 668     int hidden;
 669     krb5_data *reply;
 670     krb5_prompt_type type;
 671 } krb5_prompt;
 672
 673 typedef int (KRB5_CALLCONV * krb5_prompter_fct)(krb5_context /*context*/,
 674                                                 void * /*data*/,
 675                                                 const char * /*name*/,
 676                                                 const char * /*banner*/,
 677                                                 int /*num_prompts*/,
 678                                                 krb5_prompt /*prompts*/[]);
 679 typedef krb5_error_code (KRB5_CALLCONV * krb5_key_proc)(krb5_context /*context*/,
 680                                                         krb5_enctype /*type*/,
 681                                                         krb5_salt /*salt*/,
 682                                                         krb5_const_pointer /*keyseed*/,
 683                                                         krb5_keyblock ** /*key*/);
 684 typedef krb5_error_code (KRB5_CALLCONV * krb5_decrypt_proc)(krb5_context /*context*/,
 685                                                             krb5_keyblock * /*key*/,
 686                                                             krb5_key_usage /*usage*/,
 687                                                             krb5_const_pointer /*decrypt_arg*/,
 688                                                             krb5_kdc_rep * /*dec_rep*/);
 689 typedef krb5_error_code (KRB5_CALLCONV * krb5_s2k_proc)(krb5_context /*context*/,
 690                                                         krb5_enctype /*type*/,
 691                                                         krb5_const_pointer /*keyseed*/,
 692                                                         krb5_salt /*salt*/,
 693                                                         krb5_data * /*s2kparms*/,
 694                                                         krb5_keyblock ** /*key*/);
 695
 696 struct _krb5_get_init_creds_opt_private;
 697
 698 struct _krb5_get_init_creds_opt {
 699     krb5_flags flags;
 700     krb5_deltat tkt_life;
 701     krb5_deltat renew_life;
 702     int forwardable;
 703     int proxiable;
 704     int anonymous;
 705     krb5_enctype *etype_list;
 706     int etype_list_length;
 707     krb5_addresses *address_list;
 708     /* XXX the next three should not be used, as they may be
 709        removed later */
 710     krb5_preauthtype *preauth_list;
 711     int preauth_list_length;
 712     krb5_data *salt;
 713     struct _krb5_get_init_creds_opt_private *opt_private;
 714 };
 715
 716 typedef struct _krb5_get_init_creds_opt krb5_get_init_creds_opt;
 717
 718 #define KRB5_GET_INIT_CREDS_OPT_TKT_LIFE        0x0001
 719 #define KRB5_GET_INIT_CREDS_OPT_RENEW_LIFE      0x0002
 720 #define KRB5_GET_INIT_CREDS_OPT_FORWARDABLE     0x0004
 721 #define KRB5_GET_INIT_CREDS_OPT_PROXIABLE       0x0008
 722 #define KRB5_GET_INIT_CREDS_OPT_ETYPE_LIST      0x0010
 723 #define KRB5_GET_INIT_CREDS_OPT_ADDRESS_LIST    0x0020
 724 #define KRB5_GET_INIT_CREDS_OPT_PREAUTH_LIST    0x0040
 725 #define KRB5_GET_INIT_CREDS_OPT_SALT            0x0080 /* no supported */
 726 #define KRB5_GET_INIT_CREDS_OPT_ANONYMOUS       0x0100
 727 #define KRB5_GET_INIT_CREDS_OPT_DISABLE_TRANSITED_CHECK 0x0200
 728
 729 /* krb5_init_creds_step flags argument */
 730 #define KRB5_INIT_CREDS_STEP_FLAG_CONTINUE      0x0001
 731
 732 typedef struct _krb5_verify_init_creds_opt {
 733     krb5_flags flags;
 734     int ap_req_nofail;
 735 } krb5_verify_init_creds_opt;
 736
 737 #define KRB5_VERIFY_INIT_CREDS_OPT_AP_REQ_NOFAIL        0x0001
 738
 739 typedef struct krb5_verify_opt {
 740     unsigned int flags;
 741     krb5_ccache ccache;
 742     krb5_keytab keytab;
 743     krb5_boolean secure;
 744     const char *service;
 745 } krb5_verify_opt;
 746
 747 #define KRB5_VERIFY_LREALMS             1
 748 #define KRB5_VERIFY_NO_ADDRESSES        2
 749
 750 #define KRB5_KPASSWD_VERS_CHANGEPW      1
 751 #define KRB5_KPASSWD_VERS_SETPW         0xff80
 752
 753 #define KRB5_KPASSWD_SUCCESS    0
 754 #define KRB5_KPASSWD_MALFORMED  1
 755 #define KRB5_KPASSWD_HARDERROR  2
 756 #define KRB5_KPASSWD_AUTHERROR  3
 757 #define KRB5_KPASSWD_SOFTERROR  4
 758 #define KRB5_KPASSWD_ACCESSDENIED 5
 759 #define KRB5_KPASSWD_BAD_VERSION 6
 760 #define KRB5_KPASSWD_INITIAL_FLAG_NEEDED 7
 761
 762 #define KPASSWD_PORT 464
 763
 764 /* types for the new krbhst interface */
 765 struct krb5_krbhst_data;
 766 typedef struct krb5_krbhst_data *krb5_krbhst_handle;
 767
 768 #define KRB5_KRBHST_KDC         1
 769 #define KRB5_KRBHST_ADMIN       2
 770 #define KRB5_KRBHST_CHANGEPW    3
 771 #define KRB5_KRBHST_KRB524      4
 772 #define KRB5_KRBHST_KCA         5
 773
 774 typedef struct krb5_krbhst_info {
 775     enum { KRB5_KRBHST_UDP,
 776            KRB5_KRBHST_TCP,
 777            KRB5_KRBHST_HTTP } proto;
 778     unsigned short port;
 779     unsigned short def_port;
 780     struct addrinfo *ai;
 781     struct krb5_krbhst_info *next;
 782     char hostname[1]; /* has to come last */
 783 } krb5_krbhst_info;
 784
 785 /* flags for krb5_krbhst_init_flags (and krb5_send_to_kdc_flags) */
 786 enum {
 787     KRB5_KRBHST_FLAGS_MASTER      = 1,
 788     KRB5_KRBHST_FLAGS_LARGE_MSG   = 2
 789 };
 790
 791 typedef krb5_error_code
 792 (KRB5_CALLCONV * krb5_send_to_kdc_func)(krb5_context, void *, krb5_krbhst_info *, time_t,
 793                                         const krb5_data *, krb5_data *);
 794
 795 /** flags for krb5_parse_name_flags */
 796 enum {
 797     KRB5_PRINCIPAL_PARSE_NO_REALM = 1, /**< Require that there are no realm */
 798     KRB5_PRINCIPAL_PARSE_REQUIRE_REALM = 2, /**< Require a realm present */
 799     KRB5_PRINCIPAL_PARSE_ENTERPRISE = 4 /**< Parse as a NT-ENTERPRISE name */
 800 };
 801
 802 /** flags for krb5_unparse_name_flags */
 803 enum {
 804     KRB5_PRINCIPAL_UNPARSE_SHORT = 1, /**< No realm if it is the default realm */
 805     KRB5_PRINCIPAL_UNPARSE_NO_REALM = 2, /**< No realm */
 806     KRB5_PRINCIPAL_UNPARSE_DISPLAY = 4 /**< No quoting */
 807 };
 808
 809 typedef struct krb5_sendto_ctx_data *krb5_sendto_ctx;
 810
 811 #define KRB5_SENDTO_DONE        0
 812 #define KRB5_SENDTO_RESTART     1
 813 #define KRB5_SENDTO_CONTINUE    2
 814
 815 typedef krb5_error_code
 816 (KRB5_CALLCONV * krb5_sendto_ctx_func)(krb5_context, krb5_sendto_ctx, void *,
 817                                        const krb5_data *, int *);
 818
 819 struct krb5_plugin;
 820 enum krb5_plugin_type {
 821     PLUGIN_TYPE_DATA = 1,
 822     PLUGIN_TYPE_FUNC
 823 };
 824
 825 struct credentials; /* this is to keep the compiler happy */
 826 struct getargs;
 827 struct sockaddr;
 828
 829 /**
 830  * Semi private, not stable yet
 831  */
 832
 833 typedef struct krb5_crypto_iov {
 834     unsigned int flags;
 835     /* ignored */
 836 #define KRB5_CRYPTO_TYPE_EMPTY          0
 837     /* OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_HEADER) */
 838 #define KRB5_CRYPTO_TYPE_HEADER         1
 839     /* IN and OUT */
 840 #define KRB5_CRYPTO_TYPE_DATA           2
 841     /* IN */
 842 #define KRB5_CRYPTO_TYPE_SIGN_ONLY      3
 843    /* (only for encryption) OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_TRAILER) */
 844 #define KRB5_CRYPTO_TYPE_PADDING        4
 845    /* OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_TRAILER) */
 846 #define KRB5_CRYPTO_TYPE_TRAILER        5
 847    /* OUT krb5_crypto_length(KRB5_CRYPTO_TYPE_CHECKSUM) */
 848 #define KRB5_CRYPTO_TYPE_CHECKSUM       6
 849     krb5_data data;
 850 } krb5_crypto_iov;
 851
 852
 853 /* Glue for MIT */
 854
 855 typedef struct {
 856     int32_t lr_type;
 857     krb5_timestamp value;
 858 } krb5_last_req_entry;
 859
 860 typedef krb5_error_code
 861 (KRB5_CALLCONV * krb5_gic_process_last_req)(krb5_context, krb5_last_req_entry **, void *);
 862
 863 /*
 864  *
 865  */
 866
 867 struct hx509_certs_data;
 868
 869 #include <krb5-protos.h>
 870
 871 /* variables */
 872
 873 extern KRB5_LIB_VARIABLE const char *krb5_config_file;
 874 extern KRB5_LIB_VARIABLE const char *krb5_defkeyname;
 875
 876
 877 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_acc_ops;
 878 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_fcc_ops;
 879 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_mcc_ops;
 880 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_kcm_ops;
 881 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_akcm_ops;
 882 extern KRB5_LIB_VARIABLE const krb5_cc_ops krb5_scc_ops;
 883
 884 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_fkt_ops;
 885 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_wrfkt_ops;
 886 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_javakt_ops;
 887 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_mkt_ops;
 888 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_akf_ops;
 889 extern KRB5_LIB_VARIABLE const krb5_kt_ops krb5_any_ops;
 890
 891 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_api;
 892 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_file;
 893 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_memory;
 894 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_kcm;
 895 extern KRB5_LIB_VARIABLE const char *krb5_cc_type_scc;
 896
 897 #endif /* __KRB5_H__ */
 898