1 /* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */
2 /* General definitions for Kerberos version 5. */
4 * Copyright 1989, 1990, 1995, 2001, 2003, 2007, 2011 by the Massachusetts
5 * Institute of Technology. All Rights Reserved.
7 * Export of this software from the United States of America may
8 * require a specific license from the United States Government.
9 * It is the responsibility of any person or organization contemplating
10 * export to obtain such a license before exporting.
12 * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
13 * distribute this software and its documentation for any purpose and
14 * without fee is hereby granted, provided that the above copyright
15 * notice appear in all copies and that both that copyright notice and
16 * this permission notice appear in supporting documentation, and that
17 * the name of M.I.T. not be used in advertising or publicity pertaining
18 * to distribution of the software without specific, written prior
19 * permission. Furthermore if you modify this software you must label
20 * your software as modified software and not distribute it in such a
21 * fashion that it might be confused with the original M.I.T. software.
22 * M.I.T. makes no representations about the suitability of
23 * this software for any purpose. It is provided "as is" without express
24 * or implied warranty.
27 * Copyright (C) 1998 by the FundsXpress, INC.
29 * All rights reserved.
31 * Export of this software from the United States of America may require
32 * a specific license from the United States Government. It is the
33 * responsibility of any person or organization contemplating export to
34 * obtain such a license before exporting.
36 * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
37 * distribute this software and its documentation for any purpose and
38 * without fee is hereby granted, provided that the above copyright
39 * notice appear in all copies and that both that copyright notice and
40 * this permission notice appear in supporting documentation, and that
41 * the name of FundsXpress. not be used in advertising or publicity pertaining
42 * to distribution of the software without specific, written prior
43 * permission. FundsXpress makes no representations about the suitability of
44 * this software for any purpose. It is provided "as is" without express
45 * or implied warranty.
47 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
48 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
49 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
52 #ifndef KRB5_GENERAL__
53 #define KRB5_GENERAL__
55 /* By default, do not expose deprecated interfaces. */
56 #ifndef KRB5_DEPRECATED
57 #define KRB5_DEPRECATED 0
60 #if defined(__MACH__) && defined(__APPLE__)
61 # include <TargetConditionals.h>
62 # if TARGET_RT_MAC_CFM
63 # error "Use KfM 4.0 SDK headers for CFM compilation."
67 #if defined(_MSDOS) || defined(_WIN32)
74 #define KRB5_CALLCONV_C
75 #endif /* !KRB5_CALLCONV */
76 #endif /* !KRB5_CONFIG__ */
78 #ifndef KRB5_CALLCONV_WRONG
79 #define KRB5_CALLCONV_WRONG
82 #ifndef THREEPARAMOPEN
83 #define THREEPARAMOPEN(x,y,z) open(x,y,z)
86 #define KRB5_OLD_CRYPTO
89 #include <limits.h> /* for *_MAX */
92 #ifndef KRB5INT_BEGIN_DECLS
93 #if defined(__cplusplus)
94 #define KRB5INT_BEGIN_DECLS extern "C" {
95 #define KRB5INT_END_DECLS }
97 #define KRB5INT_BEGIN_DECLS
98 #define KRB5INT_END_DECLS
105 # pragma pack(push,2)
108 #if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) >= 30203
109 # define KRB5_ATTR_DEPRECATED __attribute__((deprecated))
111 # define KRB5_ATTR_DEPRECATED __declspec(deprecated)
113 # define KRB5_ATTR_DEPRECATED
118 /* typedef struct _profile_t *profile_t; */
125 * Word-size related definition.
128 typedef unsigned char krb5_octet;
130 #if INT_MAX == 0x7fff
131 typedef int krb5_int16;
132 typedef unsigned int krb5_ui_2;
133 #elif SHRT_MAX == 0x7fff
134 typedef short krb5_int16;
135 typedef unsigned short krb5_ui_2;
137 #error undefined 16 bit type
140 #if INT_MAX == 0x7fffffffL
141 typedef int krb5_int32;
142 typedef unsigned int krb5_ui_4;
143 #elif LONG_MAX == 0x7fffffffL
144 typedef long krb5_int32;
145 typedef unsigned long krb5_ui_4;
146 #elif SHRT_MAX == 0x7fffffffL
147 typedef short krb5_int32;
148 typedef unsigned short krb5_ui_4;
150 #error: undefined 32 bit type
153 #define VALID_INT_BITS INT_MAX
154 #define VALID_UINT_BITS UINT_MAX
156 #define KRB5_INT32_MAX 2147483647
157 /* this strange form is necessary since - is a unary operator, not a sign
159 #define KRB5_INT32_MIN (-KRB5_INT32_MAX-1)
161 #define KRB5_INT16_MAX 65535
162 /* this strange form is necessary since - is a unary operator, not a sign
164 #define KRB5_INT16_MIN (-KRB5_INT16_MAX-1)
171 * begin "base-defs.h"
175 * Basic definitions for Kerberos V5 library
185 typedef unsigned int krb5_boolean;
186 typedef unsigned int krb5_msgtype;
187 typedef unsigned int krb5_kvno;
189 typedef krb5_int32 krb5_addrtype;
190 typedef krb5_int32 krb5_enctype;
191 typedef krb5_int32 krb5_cksumtype;
192 typedef krb5_int32 krb5_authdatatype;
193 typedef krb5_int32 krb5_keyusage;
194 typedef krb5_int32 krb5_cryptotype;
196 typedef krb5_int32 krb5_preauthtype; /* This may change, later on */
197 typedef krb5_int32 krb5_flags;
198 typedef krb5_int32 krb5_timestamp;
199 typedef krb5_int32 krb5_error_code;
200 typedef krb5_int32 krb5_deltat;
202 typedef krb5_error_code krb5_magic;
204 typedef struct _krb5_data {
210 typedef struct _krb5_octet_data {
217 * Hack length for crypto library to use the afs_string_to_key It is
218 * equivalent to -1 without possible sign extension
219 * We also overload for an unset salt type length - which is also -1, but
222 #define SALT_TYPE_AFS_LENGTH UINT_MAX
223 #define SALT_TYPE_NO_LENGTH UINT_MAX
225 typedef void * krb5_pointer;
226 typedef void const * krb5_const_pointer;
228 typedef struct krb5_principal_data {
231 krb5_data *data; /**< An array of strings */
234 } krb5_principal_data;
236 typedef krb5_principal_data * krb5_principal;
239 * Per V5 spec on definition of principal types
242 /* Name type not known */
243 #define KRB5_NT_UNKNOWN 0
244 /* Just the name of the principal as in DCE, or for users */
245 #define KRB5_NT_PRINCIPAL 1
246 /* Service and other unique instance (krbtgt) */
247 #define KRB5_NT_SRV_INST 2
248 /* Service with host name as instance (telnet, rcommands) */
249 #define KRB5_NT_SRV_HST 3
250 /* Service with host as remaining components */
251 #define KRB5_NT_SRV_XHST 4
253 #define KRB5_NT_UID 5
255 #define KRB5_NT_X500_PRINCIPAL 6
256 /* Name in form of SMTP email name */
257 #define KRB5_NT_SMTP_NAME 7
258 /* Windows 2000 UPN */
259 #define KRB5_NT_ENTERPRISE_PRINCIPAL 10
260 #define KRB5_NT_WELLKNOWN 11
261 /* First component of NT_WELLKNOWN principals */
262 #define KRB5_WELLKNOWN_NAMESTR "WELLKNOWN"
263 /* Windows 2000 UPN and SID */
264 #define KRB5_NT_MS_PRINCIPAL -128
265 /* NT 4 style name */
266 #define KRB5_NT_MS_PRINCIPAL_AND_ID -129
267 /* NT 4 style name and SID */
268 #define KRB5_NT_ENT_PRINCIPAL_AND_ID -130
270 /** Constant version of krb5_principal_data */
271 typedef const krb5_principal_data *krb5_const_principal;
273 #define krb5_princ_realm(context, princ) (&(princ)->realm)
274 #define krb5_princ_set_realm(context, princ,value) ((princ)->realm = *(value))
275 #define krb5_princ_set_realm_length(context, princ,value) (princ)->realm.length = (value)
276 #define krb5_princ_set_realm_data(context, princ,value) (princ)->realm.data = (value)
277 #define krb5_princ_size(context, princ) (princ)->length
278 #define krb5_princ_type(context, princ) (princ)->type
279 #define krb5_princ_name(context, princ) (princ)->data
280 #define krb5_princ_component(context, princ,i) \
281 (((i) < krb5_princ_size(context, princ)) \
282 ? (princ)->data + (i) \
285 /** Constant for realm referrals. */
286 #define KRB5_REFERRAL_REALM ""
289 * Referral-specific functions.
293 * Check for a match with KRB5_REFERRAL_REALM.
295 * @param [in] r Realm to check
297 * @return @c TRUE if @a r is zero-length, @c FALSE otherwise
299 krb5_boolean KRB5_CALLCONV
300 krb5_is_referral_realm(const krb5_data *r);
303 * Return an anonymous realm data.
305 * This function returns constant storage that must not be freed.
307 * @sa #KRB5_ANONYMOUS_REALMSTR
309 const krb5_data *KRB5_CALLCONV
310 krb5_anonymous_realm(void);
313 * Build an anonymous principal.
315 * This function returns constant storage that must not be freed.
317 * @sa KRB5_ANONYMOUS_PRINCSTR
319 krb5_const_principal KRB5_CALLCONV
320 krb5_anonymous_principal(void);
322 #define KRB5_ANONYMOUS_REALMSTR "WELLKNOWN:ANONYMOUS"
323 #define KRB5_ANONYMOUS_PRINCSTR "ANONYMOUS" /* wellknown name type */
332 /** Structure for address */
333 typedef struct _krb5_address {
335 krb5_addrtype addrtype;
337 krb5_octet *contents;
340 /* per Kerberos v5 protocol spec */
341 #define ADDRTYPE_INET 0x0002
342 #define ADDRTYPE_CHAOS 0x0005
343 #define ADDRTYPE_XNS 0x0006
344 #define ADDRTYPE_ISO 0x0007
345 #define ADDRTYPE_DDP 0x0010
346 #define ADDRTYPE_NETBIOS 0x0014
347 #define ADDRTYPE_INET6 0x0018
348 /* not yet in the spec... */
349 #define ADDRTYPE_ADDRPORT 0x0100
350 #define ADDRTYPE_IPPORT 0x0101
352 /* macros to determine if a type is a local type */
353 #define ADDRTYPE_IS_LOCAL(addrtype) (addrtype & 0x8000)
360 struct _krb5_context;
361 typedef struct _krb5_context * krb5_context;
363 struct _krb5_auth_context;
364 typedef struct _krb5_auth_context * krb5_auth_context;
366 struct _krb5_cryptosystem_entry;
369 * begin "encryption.h"
372 /** Exposed contents of a key. */
373 typedef struct _krb5_keyblock {
375 krb5_enctype enctype;
377 krb5_octet *contents;
382 * Opaque identifier for a key.
384 * Use with the krb5_k APIs for better performance for repeated operations with
385 * the same key and usage. Key identifiers must not be used simultaneously
386 * within multiple threads, as they may contain mutable internal state and are
387 * not mutex-protected.
389 typedef struct krb5_key_st *krb5_key;
391 #ifdef KRB5_OLD_CRYPTO
392 typedef struct _krb5_encrypt_block {
394 krb5_enctype crypto_entry; /* to call krb5_encrypt_size, you need
395 this. it was a pointer, but it
396 doesn't have to be. gross. */
398 } krb5_encrypt_block;
401 typedef struct _krb5_checksum {
403 krb5_cksumtype checksum_type; /* checksum type */
405 krb5_octet *contents;
408 typedef struct _krb5_enc_data {
410 krb5_enctype enctype;
412 krb5_data ciphertext;
416 * Structure to describe a region of text to be encrypted or decrypted.
418 * The @a flags member describes the type of the iov.
419 * The @a data member points to the memory that will be manipulated.
420 * All iov APIs take a pointer to the first element of an array of krb5_crypto_iov's
421 * along with the size of that array. Buffer contents are manipulated in-place;
422 * data is overwritten. Callers must allocate the right number of krb5_crypto_iov
423 * structures before calling into an iov API.
425 typedef struct _krb5_crypto_iov {
426 krb5_cryptotype flags; /**< @ref KRB5_CRYPTO_TYPE type of the iov */
430 /* per Kerberos v5 protocol spec */
431 #define ENCTYPE_NULL 0x0000
432 #define ENCTYPE_DES_CBC_CRC 0x0001 /**< DES cbc mode with CRC-32 */
433 #define ENCTYPE_DES_CBC_MD4 0x0002 /**< DES cbc mode with RSA-MD4 */
434 #define ENCTYPE_DES_CBC_MD5 0x0003 /**< DES cbc mode with RSA-MD5 */
435 #define ENCTYPE_DES_CBC_RAW 0x0004 /**< @deprecated DES cbc mode raw */
436 #define ENCTYPE_DES3_CBC_SHA 0x0005 /**< @deprecated DES-3 cbc with SHA1 */
437 #define ENCTYPE_DES3_CBC_RAW 0x0006 /**< @deprecated DES-3 cbc mode raw */
438 #define ENCTYPE_DES_HMAC_SHA1 0x0008 /**< @deprecated */
440 #define ENCTYPE_DSA_SHA1_CMS 0x0009 /**< DSA with SHA1, CMS signature */
441 #define ENCTYPE_MD5_RSA_CMS 0x000a /**< MD5 with RSA, CMS signature */
442 #define ENCTYPE_SHA1_RSA_CMS 0x000b /**< SHA1 with RSA, CMS signature */
443 #define ENCTYPE_RC2_CBC_ENV 0x000c /**< RC2 cbc mode, CMS enveloped data */
444 #define ENCTYPE_RSA_ENV 0x000d /**< RSA encryption, CMS enveloped data */
445 #define ENCTYPE_RSA_ES_OAEP_ENV 0x000e /**< RSA w/OEAP encryption, CMS enveloped data */
446 #define ENCTYPE_DES3_CBC_ENV 0x000f /**< DES-3 cbc mode, CMS enveloped data */
448 #define ENCTYPE_DES3_CBC_SHA1 0x0010
449 #define ENCTYPE_AES128_CTS_HMAC_SHA1_96 0x0011 /**< RFC 3962 */
450 #define ENCTYPE_AES256_CTS_HMAC_SHA1_96 0x0012 /**< RFC 3962 */
451 #define ENCTYPE_ARCFOUR_HMAC 0x0017
452 #define ENCTYPE_ARCFOUR_HMAC_EXP 0x0018
453 #define ENCTYPE_UNKNOWN 0x01ff
455 #define CKSUMTYPE_CRC32 0x0001
456 #define CKSUMTYPE_RSA_MD4 0x0002
457 #define CKSUMTYPE_RSA_MD4_DES 0x0003
458 #define CKSUMTYPE_DESCBC 0x0004
461 #define CKSUMTYPE_RSA_MD5 0x0007
462 #define CKSUMTYPE_RSA_MD5_DES 0x0008
463 #define CKSUMTYPE_NIST_SHA 0x0009
464 #define CKSUMTYPE_HMAC_SHA1_DES3 0x000c
465 #define CKSUMTYPE_HMAC_SHA1_96_AES128 0x000f /**< RFC 3962. Used with
466 ENCTYPE_AES128_CTS_HMAC_SHA1_96 */
467 #define CKSUMTYPE_HMAC_SHA1_96_AES256 0x0010 /**< RFC 3962. Used with
468 ENCTYPE_AES256_CTS_HMAC_SHA1_96 */
469 #define CKSUMTYPE_MD5_HMAC_ARCFOUR -137 /*Microsoft netlogon cksumtype*/
470 #define CKSUMTYPE_HMAC_MD5_ARCFOUR -138 /*Microsoft md5 hmac cksumtype*/
473 * The following are entropy source designations. Whenever
474 * krb5_C_random_add_entropy is called, one of these source ids is passed in.
475 * This allows the library to better estimate bits of entropy in the sample and
476 * to keep track of what sources of entropy have contributed enough entropy.
477 * Sources marked internal MUST NOT be used by applications outside the
482 KRB5_C_RANDSOURCE_OLDAPI = 0, /*calls to krb5_C_RANDOM_SEED (INTERNAL)*/
483 KRB5_C_RANDSOURCE_OSRAND = 1, /* /dev/random or equivalent (internal)*/
484 KRB5_C_RANDSOURCE_TRUSTEDPARTY = 2, /* From KDC or other trusted party*/
486 * This source should be used carefully; data in this category
487 * should be from a third party trusted to give random bits
488 * For example keys issued by the KDC in the application server.
490 KRB5_C_RANDSOURCE_TIMING = 3, /* Timing of operations*/
491 KRB5_C_RANDSOURCE_EXTERNAL_PROTOCOL = 4, /*Protocol data possibly from attacker*/
492 KRB5_C_RANDSOURCE_MAX = 5 /*Do not use; maximum source ID*/
496 /* round x up to nearest multiple of y */
497 #define krb5_roundup(x, y) ((((x) + (y) - 1)/(y))*(y))
500 /* macro function definitions to help clean up code */
503 #define krb5_x(ptr,args) ((ptr)?((*(ptr)) args):(abort(),1))
504 #define krb5_xc(ptr,args) ((ptr)?((*(ptr)) args):(abort(),(char*)0))
506 #define krb5_x(ptr,args) ((*(ptr)) args)
507 #define krb5_xc(ptr,args) ((*(ptr)) args)
511 * Encrypt data using a key (operates on keyblock).
513 * @param [in] context Library context
514 * @param [in] key Encryption key
515 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
516 * @param [in,out] cipher_state Cipher state; specify NULL if not needed
517 * @param [in] input Data to be encrypted
518 * @param [out] output Encrypted data
520 * This function encrypts the data block @a input and stores the output into @a
521 * output. The actual encryption key will be derived from @a key and @a usage
522 * if key derivation is specified for the encryption type. If non-null, @a
523 * cipher_state specifies the beginning state for the encryption operation, and
524 * is updated with the state to be passed as input to the next operation.
526 * @note The caller must initialize @a output and allocate at least enough
527 * space for the result (using krb5_c_encrypt_length() to determine the amount
528 * of space needed). @a output->length will be set to the actual length of the
531 * @retval 0 Success; otherwise - Kerberos error codes
533 krb5_error_code KRB5_CALLCONV
534 krb5_c_encrypt(krb5_context context, const krb5_keyblock *key,
535 krb5_keyusage usage, const krb5_data *cipher_state,
536 const krb5_data *input, krb5_enc_data *output);
539 * Decrypt data using a key (operates on keyblock).
541 * @param [in] context Library context
542 * @param [in] key Encryption key
543 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
544 * @param [in,out] cipher_state Cipher state; specify NULL if not needed
545 * @param [in] input Encrypted data
546 * @param [out] output Decrypted data
548 * This function decrypts the data block @a input and stores the output into @a
549 * output. The actual decryption key will be derived from @a key and @a usage
550 * if key derivation is specified for the encryption type. If non-null, @a
551 * cipher_state specifies the beginning state for the decryption operation, and
552 * is updated with the state to be passed as input to the next operation.
554 * @note The caller must initialize @a output and allocate at least enough
555 * space for the result. The usual practice is to allocate an output buffer as
556 * long as the ciphertext, and let krb5_c_decrypt() trim @a output->length.
557 * For some enctypes, the resulting @a output->length may include padding
560 * @retval 0 Success; otherwise - Kerberos error codes
562 krb5_error_code KRB5_CALLCONV
563 krb5_c_decrypt(krb5_context context, const krb5_keyblock *key,
564 krb5_keyusage usage, const krb5_data *cipher_state,
565 const krb5_enc_data *input, krb5_data *output);
568 * Compute encrypted data length.
570 * @param [in] context Library context
571 * @param [in] enctype Encryption type
572 * @param [in] inputlen Length of the data to be encrypted
573 * @param [out] length Length of the encrypted data
575 * This function computes the length of the ciphertext produced by encrypting
576 * @a inputlen bytes including padding, confounder, and checksum.
578 * @retval 0 Success; otherwise - Kerberos error codes
580 krb5_error_code KRB5_CALLCONV
581 krb5_c_encrypt_length(krb5_context context, krb5_enctype enctype,
582 size_t inputlen, size_t *length);
585 * Return cipher block size.
587 * @param [in] context Library context
588 * @param [in] enctype Encryption type
589 * @param [out] blocksize Block size for @a enctype
591 * @retval 0 Success; otherwise - Kerberos error codes
593 krb5_error_code KRB5_CALLCONV
594 krb5_c_block_size(krb5_context context, krb5_enctype enctype,
598 * Return length of the specified key in bytes.
600 * @param [in] context Library context
601 * @param [in] enctype Encryption type
602 * @param [out] keybytes Number of bytes required to make a key
603 * @param [out] keylength Length of final key
605 * @retval 0 Success; otherwise - Kerberos error codes
607 krb5_error_code KRB5_CALLCONV
608 krb5_c_keylengths(krb5_context context, krb5_enctype enctype,
609 size_t *keybytes, size_t *keylength);
612 * Initialize a new cipher state.
614 * @param [in] context Library context
615 * @param [in] key Key
616 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
617 * @param [out] new_state New cipher state
619 * @retval 0 Success; otherwise - Kerberos error codes
621 krb5_error_code KRB5_CALLCONV
622 krb5_c_init_state(krb5_context context, const krb5_keyblock *key,
623 krb5_keyusage usage, krb5_data *new_state);
626 * Free a cipher state previously allocated by krb5_c_init_state().
628 * @param [in] context Library context
629 * @param [in] key Key
630 * @param [in] state Cipher state to be freed
632 * @retval 0 Success; otherwise - Kerberos error codes
634 krb5_error_code KRB5_CALLCONV
635 krb5_c_free_state(krb5_context context, const krb5_keyblock *key,
639 * Generate enctype-specific pseudo-random bytes.
641 * @param [in] context Library context
642 * @param [in] keyblock Key
643 * @param [in] input Input data
644 * @param [out] output Output data
646 * This function selects a pseudo-random function based on @a keyblock and
647 * computes its value over @a input, placing the result into @a output.
648 * The caller must preinitialize @a output and allocate space for the
649 * result, using krb5_c_prf_length() to determine the required length.
651 * @retval 0 Success; otherwise - Kerberos error codes
653 krb5_error_code KRB5_CALLCONV
654 krb5_c_prf(krb5_context context, const krb5_keyblock *keyblock,
655 krb5_data *input, krb5_data *output);
658 * Get the output length of pseudo-random functions for an encryption type.
660 * @param [in] context Library context
661 * @param [in] enctype Encryption type
662 * @param [out] len Length of PRF output
664 * @retval 0 Success; otherwise - Kerberos error codes
666 krb5_error_code KRB5_CALLCONV
667 krb5_c_prf_length(krb5_context context, krb5_enctype enctype, size_t *len);
670 * Compute the KRB-FX-CF2 combination of two keys and pepper strings.
672 * @param [in] context Library context
673 * @param [in] k1 KDC contribution key
674 * @param [in] pepper1 String "PKINIT"
675 * @param [in] k2 Reply key
676 * @param [in] pepper2 String "KeyExchange"
677 * @param [out] out Output key
679 * This function computes the KRB-FX-CF2 function over its inputs and places
680 * the results in a newly allocated keyblock. This function is simple in that
681 * it assumes that @a pepper1 and @a pepper2 are C strings with no internal
682 * nulls and that the enctype of the result will be the same as that of @a k1.
683 * @a k1 and @a k2 may be of different enctypes.
685 * @retval 0 Success; otherwise - Kerberos error codes
687 krb5_error_code KRB5_CALLCONV
688 krb5_c_fx_cf2_simple(krb5_context context,
689 krb5_keyblock *k1, const char *pepper1,
690 krb5_keyblock *k2, const char *pepper2,
691 krb5_keyblock **out);
694 * Generate an enctype-specific random encryption key.
696 * @param [in] context Library context
697 * @param [in] enctype Encryption type of the generated key
698 * @param [out] k5_random_key An allocated and initialized keyblock
700 * Use krb5_free_keyblock_contents() to free @a k5_random_key when
703 * @retval 0 Success; otherwise - Kerberos error codes
705 krb5_error_code KRB5_CALLCONV
706 krb5_c_make_random_key(krb5_context context, krb5_enctype enctype,
707 krb5_keyblock *k5_random_key);
710 * Generate an enctype-specific key from random data.
712 * @param [in] context Library context
713 * @param [in] enctype Encryption type
714 * @param [in] random_data Random input data
715 * @param [out] k5_random_key Resulting key
717 * This function takes random input data @a random_data and produces a valid
718 * key @a k5_random_key for a given @a enctype.
720 * @note It is assumed that @a k5_random_key has already been initialized and
721 * @a k5_random_key->contents has been allocated with the correct length.
723 * @sa krb5_c_keylengths()
725 * @retval 0 Success; otherwise - Kerberos error codes
727 krb5_error_code KRB5_CALLCONV
728 krb5_c_random_to_key(krb5_context context, krb5_enctype enctype,
729 krb5_data *random_data, krb5_keyblock *k5_random_key);
732 * Add entropy to the pseudo-random number generator.
734 * @param [in] context Library context
735 * @param [in] randsource Entropy source (see KRB5_RANDSOURCE types)
736 * @param [in] data Data
738 * Contribute entropy to the PRNG used by krb5 crypto operations. This may or
739 * may not affect the output of the next crypto operation requiring random
742 * @retval 0 Success; otherwise - Kerberos error codes
744 krb5_error_code KRB5_CALLCONV
745 krb5_c_random_add_entropy(krb5_context context, unsigned int randsource,
746 const krb5_data *data);
749 * Generate pseudo-random bytes.
751 * @param [in] context Library context
752 * @param [out] data Random data
754 * Fills in @a data with bytes from the PRNG used by krb5 crypto operations.
755 * The caller must preinitialize @a data and allocate the desired amount of
758 * @retval 0 Success; otherwise - Kerberos error codes
760 krb5_error_code KRB5_CALLCONV
761 krb5_c_random_make_octets(krb5_context context, krb5_data *data);
764 * Collect entropy from the OS if possible.
766 * @param [in] context Library context
767 * @param [in] strong Strongest available source of entropy
768 * @param [out] success 1 if OS provides entropy, 0 otherwise
770 * If @a strong is non-zero, this function attempts to use the strongest
771 * available source of entropy. Setting this flag may cause the function to
772 * block on some operating systems. Good uses include seeding the PRNG for
773 * kadmind and realm setup.
775 * @retval 0 Success; otherwise - Kerberos error codes
777 krb5_error_code KRB5_CALLCONV
778 krb5_c_random_os_entropy(krb5_context context, int strong, int *success);
780 /** @deprecated Replaced by krb5_c_ API family. */
781 krb5_error_code KRB5_CALLCONV
782 krb5_c_random_seed(krb5_context context, krb5_data *data);
785 * Convert a string (such a password) to a key.
787 * @param [in] context Library context
788 * @param [in] enctype Encryption type
789 * @param [in] string String to be converted
790 * @param [in] salt Salt value
791 * @param [out] key Generated key
793 * This function converts @a string to a @a key of encryption type @a enctype,
794 * using the specified @a salt. The newly created @a key must be released by
795 * calling krb5_free_keyblock_contents() when it is no longer needed.
797 * @retval 0 Success; otherwise - Kerberos error codes
799 krb5_error_code KRB5_CALLCONV
800 krb5_c_string_to_key(krb5_context context, krb5_enctype enctype,
801 const krb5_data *string, const krb5_data *salt,
805 * Convert a string (such as a password) to a key with additional parameters.
807 * @param [in] context Library context
808 * @param [in] enctype Encryption type
809 * @param [in] string String to be converted
810 * @param [in] salt Salt value
811 * @param [in] params Parameters
812 * @param [out] key Generated key
814 * This function is similar to krb5_c_string_to_key(), but also takes
815 * parameters which may affect the algorithm in an enctype-dependent way. The
816 * newly created @a key must be released by calling
817 * krb5_free_keyblock_contents() when it is no longer needed.
819 * @retval 0 Success; otherwise - Kerberos error codes
821 krb5_error_code KRB5_CALLCONV
822 krb5_c_string_to_key_with_params(krb5_context context,
823 krb5_enctype enctype,
824 const krb5_data *string,
825 const krb5_data *salt,
826 const krb5_data *params,
830 * Compare two encryption types.
832 * @param [in] context Library context
833 * @param [in] e1 First encryption type
834 * @param [in] e2 Second encryption type
835 * @param [out] similar @c TRUE if types are similar, @c FALSE if not
837 * This function determines whether two encryption types use the same kind of
840 * @retval 0 Success; otherwise - Kerberos error codes
842 krb5_error_code KRB5_CALLCONV
843 krb5_c_enctype_compare(krb5_context context, krb5_enctype e1, krb5_enctype e2,
844 krb5_boolean *similar);
847 * Compute a checksum (operates on keyblock).
849 * @param [in] context Library context
850 * @param [in] cksumtype Checksum type (0 for mandatory type)
851 * @param [in] key Encryption key for a keyed checksum
852 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
853 * @param [in] input Input data
854 * @param [out] cksum Generated checksum
856 * This function computes a checksum of type @a cksumtype over @a input, using
857 * @a key if the checksum type is a keyed checksum. If @a cksumtype is 0 and
858 * @a key is non-null, the checksum type will be the mandatory-to-implement
859 * checksum type for the key's encryption type. The actual checksum key will
860 * be derived from @a key and @a usage if key derivation is specified for the
861 * checksum type. The newly created @a cksum must be released by calling
862 * krb5_free_checksum_contents() when it is no longer needed.
864 * @note This function is similar to krb5_k_make_checksum(), but operates
865 * on keyblock @a key.
867 * @sa krb5_c_verify_checksum()
869 * @retval 0 Success; otherwise - Kerberos error codes
871 krb5_error_code KRB5_CALLCONV
872 krb5_c_make_checksum(krb5_context context, krb5_cksumtype cksumtype,
873 const krb5_keyblock *key, krb5_keyusage usage,
874 const krb5_data *input, krb5_checksum *cksum);
877 * Verify a checksum (operates on keyblock).
879 * @param [in] context Library context
880 * @param [in] key Encryption key for a keyed checksum
881 * @param [in] usage @a key usage
882 * @param [in] data Data to be used to compute a new checksum
883 * using @a key to compare @a cksum against
884 * @param [in] cksum Checksum to be verified
885 * @param [out] valid Non-zero for success, zero for failure
887 * This function verifies that @a cksum is a valid checksum for @a data. If
888 * the checksum type of @a cksum is a keyed checksum, @a key is used to verify
889 * the checksum. The actual checksum key will be derived from @a key and @a
890 * usage if key derivation is specified for the checksum type.
892 * @note This function is similar to krb5_k_verify_checksum(), but operates
893 * on keyblock @a key.
895 * @retval 0 Success; otherwise - Kerberos error codes
897 krb5_error_code KRB5_CALLCONV
898 krb5_c_verify_checksum(krb5_context context, const krb5_keyblock *key,
899 krb5_keyusage usage, const krb5_data *data,
900 const krb5_checksum *cksum, krb5_boolean *valid);
903 * Return the length of checksums for a checksum type.
905 * @param [in] context Library context
906 * @param [in] cksumtype Checksum type
907 * @param [out] length Checksum length
909 * @retval 0 Success; otherwise - Kerberos error codes
911 krb5_error_code KRB5_CALLCONV
912 krb5_c_checksum_length(krb5_context context, krb5_cksumtype cksumtype,
916 * Return a list of keyed checksum types usable with an encryption type.
918 * @param [in] context Library context
919 * @param [in] enctype Encryption type
920 * @param [out] count Count of allowable checksum types
921 * @param [out] cksumtypes Array of allowable checksum types
923 * Use krb5_free_cksumtypes() to free @a cksumtypes when it is no longer
926 * @retval 0 Success; otherwise - Kerberos error codes
928 krb5_error_code KRB5_CALLCONV
929 krb5_c_keyed_checksum_types(krb5_context context, krb5_enctype enctype,
930 unsigned int *count, krb5_cksumtype **cksumtypes);
932 /** @defgroup KRB5_KEYUSAGE KRB5_KEYUSAGE
935 #define KRB5_KEYUSAGE_AS_REQ_PA_ENC_TS 1
936 #define KRB5_KEYUSAGE_KDC_REP_TICKET 2
937 #define KRB5_KEYUSAGE_AS_REP_ENCPART 3
938 #define KRB5_KEYUSAGE_TGS_REQ_AD_SESSKEY 4
939 #define KRB5_KEYUSAGE_TGS_REQ_AD_SUBKEY 5
940 #define KRB5_KEYUSAGE_TGS_REQ_AUTH_CKSUM 6
941 #define KRB5_KEYUSAGE_TGS_REQ_AUTH 7
942 #define KRB5_KEYUSAGE_TGS_REP_ENCPART_SESSKEY 8
943 #define KRB5_KEYUSAGE_TGS_REP_ENCPART_SUBKEY 9
944 #define KRB5_KEYUSAGE_AP_REQ_AUTH_CKSUM 10
945 #define KRB5_KEYUSAGE_AP_REQ_AUTH 11
946 #define KRB5_KEYUSAGE_AP_REP_ENCPART 12
947 #define KRB5_KEYUSAGE_KRB_PRIV_ENCPART 13
948 #define KRB5_KEYUSAGE_KRB_CRED_ENCPART 14
949 #define KRB5_KEYUSAGE_KRB_SAFE_CKSUM 15
950 #define KRB5_KEYUSAGE_APP_DATA_ENCRYPT 16
951 #define KRB5_KEYUSAGE_APP_DATA_CKSUM 17
952 #define KRB5_KEYUSAGE_KRB_ERROR_CKSUM 18
953 #define KRB5_KEYUSAGE_AD_KDCISSUED_CKSUM 19
954 #define KRB5_KEYUSAGE_AD_MTE 20
955 #define KRB5_KEYUSAGE_AD_ITE 21
957 /* XXX need to register these */
959 #define KRB5_KEYUSAGE_GSS_TOK_MIC 22
960 #define KRB5_KEYUSAGE_GSS_TOK_WRAP_INTEG 23
961 #define KRB5_KEYUSAGE_GSS_TOK_WRAP_PRIV 24
963 /* Defined in hardware preauth draft */
965 #define KRB5_KEYUSAGE_PA_SAM_CHALLENGE_CKSUM 25
966 #define KRB5_KEYUSAGE_PA_SAM_CHALLENGE_TRACKID 26
967 #define KRB5_KEYUSAGE_PA_SAM_RESPONSE 27
969 /* Defined in KDC referrals draft */
971 * @note There is a conflict with the value of @c KRB5_KEYUSAGE_PA_REFERRAL:
972 * it is used for hardware Pre-athentication @a and KDC referrals.
974 #define KRB5_KEYUSAGE_PA_REFERRAL 26 /* XXX note conflict with above */
976 /* Defined in [MS-SFU] */
977 #define KRB5_KEYUSAGE_PA_S4U_X509_USER_REQUEST 26 /* XXX note conflict with above */
978 #define KRB5_KEYUSAGE_PA_S4U_X509_USER_REPLY 27 /* XXX note conflict with above */
980 #define KRB5_KEYUSAGE_AD_SIGNEDPATH -21
981 #define KRB5_KEYUSAGE_IAKERB_FINISHED 42
982 #define KRB5_KEYUSAGE_PA_PKINIT_KX 44
983 /* define in draft-ietf-krb-wg-preauth-framework*/
984 #define KRB5_KEYUSAGE_FAST_REQ_CHKSUM 50
985 #define KRB5_KEYUSAGE_FAST_ENC 51
986 #define KRB5_KEYUSAGE_FAST_REP 52
987 #define KRB5_KEYUSAGE_FAST_FINISHED 53
988 #define KRB5_KEYUSAGE_ENC_CHALLENGE_CLIENT 54
989 #define KRB5_KEYUSAGE_ENC_CHALLENGE_KDC 55
990 #define KRB5_KEYUSAGE_AS_REQ 56
991 /** @} */ /* end of KRB5_KEYUSAGE group */
994 * Verify that a specified encryption type is a valid Kerberos encryption type.
996 * @param [in] ktype Encryption type
998 * @return @c TRUE if @a ktype is valid, @c FALSE if not
1000 krb5_boolean KRB5_CALLCONV
1001 krb5_c_valid_enctype(krb5_enctype ktype);
1004 * Verify that specified checksum type is a valid Kerberos checksum type.
1006 * @param [in] ctype Checksum type
1008 * @return @c TRUE if @a ctype is valid, @c FALSE if not
1010 krb5_boolean KRB5_CALLCONV
1011 krb5_c_valid_cksumtype(krb5_cksumtype ctype);
1014 * Test whether a checksum type is collision-proof.
1016 * @param [in] ctype Checksum type
1018 * @return @c TRUE if @a ctype is collision-proof, @c FALSE if it is not
1019 * collision-proof or not a valid checksum type.
1021 krb5_boolean KRB5_CALLCONV
1022 krb5_c_is_coll_proof_cksum(krb5_cksumtype ctype);
1025 * Test whether a checksum type is keyed.
1027 * @param [in] ctype Checksum type
1029 * @return @c TRUE if @a ctype is a keyed checksum type, @c FALSE otherwise.
1031 krb5_boolean KRB5_CALLCONV
1032 krb5_c_is_keyed_cksum(krb5_cksumtype ctype);
1035 /** @defgroup KRB5_CRYPTO_TYPE KRB5_CRYPTO_TYPE
1038 #define KRB5_CRYPTO_TYPE_EMPTY 0 /**< [in] ignored */
1039 #define KRB5_CRYPTO_TYPE_HEADER 1 /**< [out] header */
1040 #define KRB5_CRYPTO_TYPE_DATA 2 /**< [in, out] plaintext */
1041 #define KRB5_CRYPTO_TYPE_SIGN_ONLY 3 /**< [in] associated data */
1042 #define KRB5_CRYPTO_TYPE_PADDING 4 /**< [out] padding */
1043 #define KRB5_CRYPTO_TYPE_TRAILER 5 /**< [out] checksum for encrypt */
1044 #define KRB5_CRYPTO_TYPE_CHECKSUM 6 /**< [out] checksum for MIC */
1045 #define KRB5_CRYPTO_TYPE_STREAM 7 /**< [in] entire message without
1046 decomposing the structure into
1047 header, data and trailer buffers */
1048 /** @} */ /* end of KRB5_CRYPTO_TYPE group */
1051 * Fill in a checksum element in IOV array (operates on keyblock)
1053 * @param [in] context Library context
1054 * @param [in] cksumtype Checksum type (0 for mandatory type)
1055 * @param [in] key Encryption key for a keyed checksum
1056 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1057 * @param [in,out] data IOV array
1058 * @param [in] num_data Size of @a data
1060 * Create a checksum in the #KRB5_CRYPTO_TYPE_CHECKSUM element over
1061 * #KRB5_CRYPTO_TYPE_DATA and #KRB5_CRYPTO_TYPE_SIGN_ONLY chunks in @a data.
1062 * Only the #KRB5_CRYPTO_TYPE_CHECKSUM region is modified.
1064 * @note This function is similar to krb5_k_make_checksum_iov(), but operates
1065 * on keyblock @a key.
1067 * @sa krb5_c_verify_checksum_iov()
1069 * @retval 0 Success; otherwise - Kerberos error codes
1071 krb5_error_code KRB5_CALLCONV
1072 krb5_c_make_checksum_iov(krb5_context context, krb5_cksumtype cksumtype,
1073 const krb5_keyblock *key, krb5_keyusage usage,
1074 krb5_crypto_iov *data, size_t num_data);
1077 * Validate a checksum element in IOV array (operates on keyblock).
1079 * @param [in] context Library context
1080 * @param [in] cksumtype Checksum type (0 for mandatory type)
1081 * @param [in] key Encryption key for a keyed checksum
1082 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1083 * @param [in] data IOV array
1084 * @param [in] num_data Size of @a data
1085 * @param [out] valid Non-zero for success, zero for failure
1087 * Confirm that the checksum in the #KRB5_CRYPTO_TYPE_CHECKSUM element is a
1088 * valid checksum of the #KRB5_CRYPTO_TYPE_DATA and #KRB5_CRYPTO_TYPE_SIGN_ONLY
1089 * regions in the iov.
1091 * @note This function is similar to krb5_k_verify_checksum_iov(), but operates
1092 * on keyblock @a key.
1094 * @sa krb5_c_make_checksum_iov()
1096 * @retval 0 Success; otherwise - Kerberos error codes
1098 krb5_error_code KRB5_CALLCONV
1099 krb5_c_verify_checksum_iov(krb5_context context, krb5_cksumtype cksumtype,
1100 const krb5_keyblock *key, krb5_keyusage usage,
1101 const krb5_crypto_iov *data, size_t num_data,
1102 krb5_boolean *valid);
1105 * Encrypt data in place supporting AEAD (operates on keyblock).
1107 * @param [in] context Library context
1108 * @param [in] keyblock Encryption key
1109 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1110 * @param [in] cipher_state Cipher state; specify NULL if not needed
1111 * @param [in,out] data IOV array. Modified in-place.
1112 * @param [in] num_data Size of @a data
1114 * This function encrypts the data block @a data and stores the output in-place.
1115 * The actual encryption key will be derived from @a keyblock and @a usage
1116 * if key derivation is specified for the encryption type. If non-null, @a
1117 * cipher_state specifies the beginning state for the encryption operation, and
1118 * is updated with the state to be passed as input to the next operation.
1119 * The caller must allocate the right number of krb5_crypto_iov
1120 * structures before calling into this API.
1122 * @note On return from a krb5_c_encrypt_iov() call, the @a data->length in the
1123 * iov structure are adjusted to reflect actual lengths of the ciphertext used.
1124 * For example, if the padding length is too large, the length will be reduced.
1125 * Lengths are never increased.
1127 * @note This function is similar to krb5_k_encrypt_iov(), but operates
1128 * on keyblock @a keyblock.
1130 * @sa krb5_c_decrypt_iov()
1132 * @retval 0 Success; otherwise - Kerberos error codes
1134 krb5_error_code KRB5_CALLCONV
1135 krb5_c_encrypt_iov(krb5_context context, const krb5_keyblock *keyblock,
1136 krb5_keyusage usage, const krb5_data *cipher_state,
1137 krb5_crypto_iov *data, size_t num_data);
1140 * Decrypt data in place supporting AEAD (operates on keyblock).
1142 * @param [in] context Library context
1143 * @param [in] keyblock Encryption key
1144 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1145 * @param [in] cipher_state Cipher state; specify NULL if not needed
1146 * @param [in,out] data IOV array. Modified in-place.
1147 * @param [in] num_data Size of @a data
1149 * This function decrypts the data block @a data and stores the output in-place.
1150 * The actual decryption key will be derived from @a keyblock and @a usage
1151 * if key derivation is specified for the encryption type. If non-null, @a
1152 * cipher_state specifies the beginning state for the decryption operation, and
1153 * is updated with the state to be passed as input to the next operation.
1154 * The caller must allocate the right number of krb5_crypto_iov
1155 * structures before calling into this API.
1157 * @note On return from a krb5_c_decrypt_iov() call, the @a data->length in the
1158 * iov structure are adjusted to reflect actual lengths of the ciphertext used.
1159 * For example, if the padding length is too large, the length will be reduced.
1160 * Lengths are never increased.
1162 * @note This function is similar to krb5_k_decrypt_iov(), but operates
1163 * on keyblock @a keyblock.
1165 * @sa krb5_c_decrypt_iov()
1167 * @retval 0 Success; otherwise - Kerberos error codes
1169 krb5_error_code KRB5_CALLCONV
1170 krb5_c_decrypt_iov(krb5_context context, const krb5_keyblock *keyblock,
1171 krb5_keyusage usage, const krb5_data *cipher_state,
1172 krb5_crypto_iov *data, size_t num_data);
1175 * Return a length of a message field specific to the encryption type.
1177 * @param [in] context Library context
1178 * @param [in] enctype Encryption type
1179 * @param [in] type Type field (See @ref KRB5_CRYPTO_TYPE types)
1180 * @param [out] size Length of the @a type specific to @a enctype
1182 * @retval 0 Success; otherwise - Kerberos error codes
1184 krb5_error_code KRB5_CALLCONV
1185 krb5_c_crypto_length(krb5_context context, krb5_enctype enctype,
1186 krb5_cryptotype type, unsigned int *size);
1189 * Fill in lengths for header, trailer and padding in a IOV array.
1191 * @param [in] context Library context
1192 * @param [in] enctype Encryption type
1193 * @param [in,out] data IOV array
1194 * @param [in] num_data Size of @a data
1196 * Padding is set to the actual padding required based on the provided
1197 * @a data buffers. Typically this API is used after setting up the data
1198 * buffers and #KRB5_CRYPTO_TYPE_SIGN_ONLY buffers, but before actually
1199 * allocating header, trailer and padding.
1201 * @retval 0 Success; otherwise - Kerberos error codes
1203 krb5_error_code KRB5_CALLCONV
1204 krb5_c_crypto_length_iov(krb5_context context, krb5_enctype enctype,
1205 krb5_crypto_iov *data, size_t num_data);
1208 * Return a number of padding octets.
1210 * @param [in] context Library context
1211 * @param [in] enctype Encryption type
1212 * @param [in] data_length Length of the plaintext to pad
1213 * @param [out] size Number of padding octets
1215 * This function returns the number of the padding octets required to pad
1216 * @a data_length octets of plaintext.
1218 * @retval 0 Success; otherwise - KRB5_BAD_ENCTYPE
1220 krb5_error_code KRB5_CALLCONV
1221 krb5_c_padding_length(krb5_context context, krb5_enctype enctype,
1222 size_t data_length, unsigned int *size);
1225 * Create a krb5_key from the enctype and key data in a keyblock.
1227 * @param [in] context Library context
1228 * @param [in] key_data Keyblock
1229 * @param [out] out Opaque key
1231 * The reference count on a key @a out is set to 1.
1232 * Use krb5_k_free_key() to free @a out when it is no longer needed.
1234 * @retval 0 Success; otherwise - KRB5_BAD_ENCTYPE
1236 krb5_error_code KRB5_CALLCONV
1237 krb5_k_create_key(krb5_context context, const krb5_keyblock *key_data,
1240 /** Increment the reference count on a key. */
1242 krb5_k_reference_key(krb5_context context, krb5_key key);
1244 /** Decrement the reference count on a key and free it if it hits zero. */
1246 krb5_k_free_key(krb5_context context, krb5_key key);
1248 /** Retrieve a copy of the keyblock from a krb5_key structure. */
1249 krb5_error_code KRB5_CALLCONV
1250 krb5_k_key_keyblock(krb5_context context, krb5_key key,
1251 krb5_keyblock **key_data);
1253 /** Retrieve the enctype of a krb5_key structure. */
1254 krb5_enctype KRB5_CALLCONV
1255 krb5_k_key_enctype(krb5_context context, krb5_key key);
1258 * Encrypt data using a key (operates on opaque key).
1260 * @param [in] context Library context
1261 * @param [in] key Encryption key
1262 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1263 * @param [in,out] cipher_state Cipher state; specify NULL if not needed
1264 * @param [in] input Data to be encrypted
1265 * @param [out] output Encrypted data
1267 * This function encrypts the data block @a input and stores the output into @a
1268 * output. The actual encryption key will be derived from @a key and @a usage
1269 * if key derivation is specified for the encryption type. If non-null, @a
1270 * cipher_state specifies the beginning state for the encryption operation, and
1271 * is updated with the state to be passed as input to the next operation.
1273 * @note The caller must initialize @a output and allocate at least enough
1274 * space for the result (using krb5_c_encrypt_length() to determine the amount
1275 * of space needed). @a output->length will be set to the actual length of the
1278 * @retval 0 Success; otherwise - Kerberos error codes
1280 krb5_error_code KRB5_CALLCONV
1281 krb5_k_encrypt(krb5_context context, krb5_key key, krb5_keyusage usage,
1282 const krb5_data *cipher_state, const krb5_data *input,
1283 krb5_enc_data *output);
1286 * Encrypt data in place supporting AEAD (operates on opaque key).
1288 * @param [in] context Library context
1289 * @param [in] key Encryption key
1290 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1291 * @param [in] cipher_state Cipher state; specify NULL if not needed
1292 * @param [in,out] data IOV array. Modified in-place.
1293 * @param [in] num_data Size of @a data
1295 * This function encrypts the data block @a data and stores the output in-place.
1296 * The actual encryption key will be derived from @a key and @a usage
1297 * if key derivation is specified for the encryption type. If non-null, @a
1298 * cipher_state specifies the beginning state for the encryption operation, and
1299 * is updated with the state to be passed as input to the next operation.
1300 * The caller must allocate the right number of krb5_crypto_iov
1301 * structures before calling into this API.
1303 * @note On return from a krb5_c_encrypt_iov() call, the @a data->length in the
1304 * iov structure are adjusted to reflect actual lengths of the ciphertext used.
1305 * For example, if the padding length is too large, the length will be reduced.
1306 * Lengths are never increased.
1308 * @note This function is similar to krb5_c_encrypt_iov(), but operates
1309 * on opaque key @a key.
1311 * @sa krb5_k_decrypt_iov()
1313 * @retval 0 Success; otherwise - Kerberos error codes
1315 krb5_error_code KRB5_CALLCONV
1316 krb5_k_encrypt_iov(krb5_context context, krb5_key key, krb5_keyusage usage,
1317 const krb5_data *cipher_state, krb5_crypto_iov *data,
1321 * Decrypt data using a key (operates on opaque key).
1323 * @param [in] context Library context
1324 * @param [in] key Encryption key
1325 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1326 * @param [in,out] cipher_state Cipher state; specify NULL if not needed
1327 * @param [in] input Encrypted data
1328 * @param [out] output Decrypted data
1330 * This function decrypts the data block @a input and stores the output into @a
1331 * output. The actual decryption key will be derived from @a key and @a usage
1332 * if key derivation is specified for the encryption type. If non-null, @a
1333 * cipher_state specifies the beginning state for the decryption operation, and
1334 * is updated with the state to be passed as input to the next operation.
1336 * @note The caller must initialize @a output and allocate at least enough
1337 * space for the result. The usual practice is to allocate an output buffer as
1338 * long as the ciphertext, and let krb5_c_decrypt() trim @a output->length.
1339 * For some enctypes, the resulting @a output->length may include padding
1342 * @retval 0 Success; otherwise - Kerberos error codes
1344 krb5_error_code KRB5_CALLCONV
1345 krb5_k_decrypt(krb5_context context, krb5_key key, krb5_keyusage usage,
1346 const krb5_data *cipher_state, const krb5_enc_data *input,
1350 * Decrypt data in place supporting AEAD (operates on opaque key).
1352 * @param [in] context Library context
1353 * @param [in] key Encryption key
1354 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1355 * @param [in] cipher_state Cipher state; specify NULL if not needed
1356 * @param [in,out] data IOV array. Modified in-place.
1357 * @param [in] num_data Size of @a data
1359 * This function decrypts the data block @a data and stores the output in-place.
1360 * The actual decryption key will be derived from @a key and @a usage
1361 * if key derivation is specified for the encryption type. If non-null, @a
1362 * cipher_state specifies the beginning state for the decryption operation, and
1363 * is updated with the state to be passed as input to the next operation.
1364 * The caller must allocate the right number of krb5_crypto_iov
1365 * structures before calling into this API.
1367 * @note On return from a krb5_c_decrypt_iov() call, the @a data->length in the
1368 * iov structure are adjusted to reflect actual lengths of the ciphertext used.
1369 * For example, if the padding length is too large, the length will be reduced.
1370 * Lengths are never increased.
1372 * @note This function is similar to krb5_c_decrypt_iov(), but operates
1373 * on opaque key @a key.
1375 * @sa krb5_k_encrypt_iov()
1377 * @retval 0 Success; otherwise - Kerberos error codes
1379 krb5_error_code KRB5_CALLCONV
1380 krb5_k_decrypt_iov(krb5_context context, krb5_key key, krb5_keyusage usage,
1381 const krb5_data *cipher_state, krb5_crypto_iov *data,
1384 * Compute a checksum (operates on opaque key).
1386 * @param [in] context Library context
1387 * @param [in] cksumtype Checksum type (0 for mandatory type)
1388 * @param [in] key Encryption key for a keyed checksum
1389 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1390 * @param [in] input Input data
1391 * @param [out] cksum Generated checksum
1393 * This function computes a checksum of type @a cksumtype over @a input, using
1394 * @a key if the checksum type is a keyed checksum. If @a cksumtype is 0 and
1395 * @a key is non-null, the checksum type will be the mandatory-to-implement
1396 * checksum type for the key's encryption type. The actual checksum key will
1397 * be derived from @a key and @a usage if key derivation is specified for the
1398 * checksum type. The newly created @a cksum must be released by calling
1399 * krb5_free_checksum_contents() when it is no longer needed.
1401 * @note This function is similar to krb5_c_make_checksum(), but operates
1404 * @sa krb5_c_verify_checksum()
1406 * @retval 0 Success; otherwise - Kerberos error codes
1408 krb5_error_code KRB5_CALLCONV
1409 krb5_k_make_checksum(krb5_context context, krb5_cksumtype cksumtype,
1410 krb5_key key, krb5_keyusage usage, const krb5_data *input,
1411 krb5_checksum *cksum);
1414 * Fill in a checksum element in IOV array (operates on opaque key)
1416 * @param [in] context Library context
1417 * @param [in] cksumtype Checksum type (0 for mandatory type)
1418 * @param [in] key Encryption key for a keyed checksum
1419 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1420 * @param [in,out] data IOV array
1421 * @param [in] num_data Size of @a data
1423 * Create a checksum in the #KRB5_CRYPTO_TYPE_CHECKSUM element over
1424 * #KRB5_CRYPTO_TYPE_DATA and #KRB5_CRYPTO_TYPE_SIGN_ONLY chunks in @a data.
1425 * Only the #KRB5_CRYPTO_TYPE_CHECKSUM region is modified.
1427 * @note This function is similar to krb5_c_make_checksum_iov(), but operates
1430 * @sa krb5_k_verify_checksum_iov()
1432 * @retval 0 Success; otherwise - Kerberos error codes
1434 krb5_error_code KRB5_CALLCONV
1435 krb5_k_make_checksum_iov(krb5_context context, krb5_cksumtype cksumtype,
1436 krb5_key key, krb5_keyusage usage,
1437 krb5_crypto_iov *data, size_t num_data);
1440 * Verify a checksum (operates on opaque key).
1442 * @param [in] context Library context
1443 * @param [in] key Encryption key for a keyed checksum
1444 * @param [in] usage @a key usage
1445 * @param [in] data Data to be used to compute a new checksum
1446 * using @a key to compare @a cksum against
1447 * @param [in] cksum Checksum to be verified
1448 * @param [out] valid Non-zero for success, zero for failure
1450 * This function verifies that @a cksum is a valid checksum for @a data. If
1451 * the checksum type of @a cksum is a keyed checksum, @a key is used to verify
1452 * the checksum. The actual checksum key will be derived from @a key and @a
1453 * usage if key derivation is specified for the checksum type.
1455 * @note This function is similar to krb5_c_verify_checksum(), but operates
1458 * @retval 0 Success; otherwise - Kerberos error codes
1460 krb5_error_code KRB5_CALLCONV
1461 krb5_k_verify_checksum(krb5_context context, krb5_key key, krb5_keyusage usage,
1462 const krb5_data *data, const krb5_checksum *cksum,
1463 krb5_boolean *valid);
1466 * Validate a checksum element in IOV array (operates on opaque key).
1468 * @param [in] context Library context
1469 * @param [in] cksumtype Checksum type (0 for mandatory type)
1470 * @param [in] key Encryption key for a keyed checksum
1471 * @param [in] usage Key usage (see @ref KRB5_KEYUSAGE types)
1472 * @param [in] data IOV array
1473 * @param [in] num_data Size of @a data
1474 * @param [out] valid Non-zero for success, zero for failure
1476 * Confirm that the checksum in the #KRB5_CRYPTO_TYPE_CHECKSUM element is a
1477 * valid checksum of the #KRB5_CRYPTO_TYPE_DATA and #KRB5_CRYPTO_TYPE_SIGN_ONLY
1478 * regions in the iov.
1480 * @note This function is similar to krb5_c_verify_checksum_iov(), but operates
1483 * @sa krb5_k_make_checksum_iov()
1485 * @retval 0 Success; otherwise - Kerberos error codes
1487 krb5_error_code KRB5_CALLCONV
1488 krb5_k_verify_checksum_iov(krb5_context context, krb5_cksumtype cksumtype,
1489 krb5_key key, krb5_keyusage usage,
1490 const krb5_crypto_iov *data, size_t num_data,
1491 krb5_boolean *valid);
1494 * Generate enctype-specific pseudo-random bytes (operates on opaque key).
1496 * @param [in] context Library context
1497 * @param [in] key Key
1498 * @param [in] input Input data
1499 * @param [out] output Output data
1501 * This function selects a pseudo-random function based on @a key and
1502 * computes its value over @a input, placing the result into @a output.
1503 * The caller must preinitialize @a output and allocate space for the
1506 * @note This function is similar to krb5_c_prf(), but operates
1509 * @retval 0 Success; otherwise - Kerberos error codes
1511 krb5_error_code KRB5_CALLCONV
1512 krb5_k_prf(krb5_context context, krb5_key key, krb5_data *input, krb5_data *output);
1514 #ifdef KRB5_OLD_CRYPTO
1516 * old cryptosystem routine prototypes. These are now layered
1517 * on top of the functions above.
1519 /** @deprecated Replaced by krb5_c_ API family.*/
1520 krb5_error_code KRB5_CALLCONV
1521 krb5_encrypt(krb5_context context, krb5_const_pointer inptr,
1522 krb5_pointer outptr, size_t size, krb5_encrypt_block *eblock,
1525 /** @deprecated Replaced by krb5_c_ API family. */
1526 krb5_error_code KRB5_CALLCONV
1527 krb5_decrypt(krb5_context context, krb5_const_pointer inptr,
1528 krb5_pointer outptr, size_t size, krb5_encrypt_block *eblock,
1531 /** @deprecated Replaced by krb5_c_ API family. */
1532 krb5_error_code KRB5_CALLCONV
1533 krb5_process_key(krb5_context context, krb5_encrypt_block *eblock,
1534 const krb5_keyblock * key);
1536 /** @deprecated Replaced by krb5_c_ API family. */
1537 krb5_error_code KRB5_CALLCONV
1538 krb5_finish_key(krb5_context context, krb5_encrypt_block * eblock);
1540 /** @deprecated See krb5_c_string_to_key() */
1541 krb5_error_code KRB5_CALLCONV
1542 krb5_string_to_key(krb5_context context, const krb5_encrypt_block *eblock,
1543 krb5_keyblock * keyblock, const krb5_data *data,
1544 const krb5_data *salt);
1546 /** @deprecated Replaced by krb5_c_ API family. */
1547 krb5_error_code KRB5_CALLCONV
1548 krb5_init_random_key(krb5_context context, const krb5_encrypt_block *eblock,
1549 const krb5_keyblock *keyblock, krb5_pointer *ptr);
1551 /** @deprecated Replaced by krb5_c_ API family. */
1552 krb5_error_code KRB5_CALLCONV
1553 krb5_finish_random_key(krb5_context context, const krb5_encrypt_block *eblock,
1556 /** @deprecated Replaced by krb5_c_ API family. */
1557 krb5_error_code KRB5_CALLCONV
1558 krb5_random_key(krb5_context context, const krb5_encrypt_block *eblock,
1559 krb5_pointer ptr, krb5_keyblock **keyblock);
1561 /** @deprecated Replaced by krb5_c_ API family. */
1562 krb5_enctype KRB5_CALLCONV
1563 krb5_eblock_enctype(krb5_context context, const krb5_encrypt_block *eblock);
1565 /** @deprecated Replaced by krb5_c_ API family. */
1566 krb5_error_code KRB5_CALLCONV
1567 krb5_use_enctype(krb5_context context, krb5_encrypt_block *eblock,
1568 krb5_enctype enctype);
1570 /** @deprecated Replaced by krb5_c_ API family. */
1571 size_t KRB5_CALLCONV
1572 krb5_encrypt_size(size_t length, krb5_enctype crypto);
1574 /** @deprecated See krb5_c_checksum_length() */
1575 size_t KRB5_CALLCONV
1576 krb5_checksum_size(krb5_context context, krb5_cksumtype ctype);
1578 /** @deprecated See krb5_c_make_checksum() */
1579 krb5_error_code KRB5_CALLCONV
1580 krb5_calculate_checksum(krb5_context context, krb5_cksumtype ctype,
1581 krb5_const_pointer in, size_t in_length,
1582 krb5_const_pointer seed, size_t seed_length,
1583 krb5_checksum * outcksum);
1585 /** @deprecated See krb5_c_verify_checksum() */
1586 krb5_error_code KRB5_CALLCONV
1587 krb5_verify_checksum(krb5_context context, krb5_cksumtype ctype,
1588 const krb5_checksum * cksum, krb5_const_pointer in,
1589 size_t in_length, krb5_const_pointer seed,
1590 size_t seed_length);
1592 #endif /* KRB5_OLD_CRYPTO */
1595 * end "encryption.h"
1599 * begin "fieldbits.h"
1602 /* kdc_options for kdc_request */
1603 /* options is 32 bits; each host is responsible to put the 4 bytes
1604 representing these bits into net order before transmission */
1605 /* #define KDC_OPT_RESERVED 0x80000000 */
1606 #define KDC_OPT_FORWARDABLE 0x40000000
1607 #define KDC_OPT_FORWARDED 0x20000000
1608 #define KDC_OPT_PROXIABLE 0x10000000
1609 #define KDC_OPT_PROXY 0x08000000
1610 #define KDC_OPT_ALLOW_POSTDATE 0x04000000
1611 #define KDC_OPT_POSTDATED 0x02000000
1612 /* #define KDC_OPT_UNUSED 0x01000000 */
1613 #define KDC_OPT_RENEWABLE 0x00800000
1614 /* #define KDC_OPT_UNUSED 0x00400000 */
1615 /* #define KDC_OPT_RESERVED 0x00200000 */
1616 /* #define KDC_OPT_RESERVED 0x00100000 */
1617 /* #define KDC_OPT_RESERVED 0x00080000 */
1618 /* #define KDC_OPT_RESERVED 0x00040000 */
1619 #define KDC_OPT_CNAME_IN_ADDL_TKT 0x00020000
1620 #define KDC_OPT_CANONICALIZE 0x00010000
1621 #define KDC_OPT_REQUEST_ANONYMOUS 0x00008000
1622 /* #define KDC_OPT_RESERVED 0x00004000 */
1623 /* #define KDC_OPT_RESERVED 0x00002000 */
1624 /* #define KDC_OPT_RESERVED 0x00001000 */
1625 /* #define KDC_OPT_RESERVED 0x00000800 */
1626 /* #define KDC_OPT_RESERVED 0x00000400 */
1627 /* #define KDC_OPT_RESERVED 0x00000200 */
1628 /* #define KDC_OPT_RESERVED 0x00000100 */
1629 /* #define KDC_OPT_RESERVED 0x00000080 */
1630 /* #define KDC_OPT_RESERVED 0x00000040 */
1631 #define KDC_OPT_DISABLE_TRANSITED_CHECK 0x00000020
1632 #define KDC_OPT_RENEWABLE_OK 0x00000010
1633 #define KDC_OPT_ENC_TKT_IN_SKEY 0x00000008
1634 /* #define KDC_OPT_UNUSED 0x00000004 */
1635 #define KDC_OPT_RENEW 0x00000002
1636 #define KDC_OPT_VALIDATE 0x00000001
1639 * Mask of ticket flags in the TGT which should be converted into KDC
1640 * options when using the TGT to get derivitive tickets.
1642 * New mask = KDC_OPT_FORWARDABLE | KDC_OPT_PROXIABLE |
1643 * KDC_OPT_ALLOW_POSTDATE | KDC_OPT_RENEWABLE
1645 #define KDC_TKT_COMMON_MASK 0x54800000
1647 /* definitions for ap_options fields */
1649 /** @defgroup AP_OPTS AP_OPTS
1651 * ap_options are 32 bits; each host is responsible to put the 4 bytes
1652 * representing these bits into net order before transmission
1655 #define AP_OPTS_RESERVED 0x80000000
1656 #define AP_OPTS_USE_SESSION_KEY 0x40000000 /**< Use session key */
1657 #define AP_OPTS_MUTUAL_REQUIRED 0x20000000 /**< Perform a mutual
1658 authentication exchange */
1659 #define AP_OPTS_ETYPE_NEGOTIATION 0x00000002
1660 #define AP_OPTS_USE_SUBKEY 0x00000001 /**< Generate a subsession key
1661 from the current session key
1664 /* #define AP_OPTS_RESERVED 0x10000000 */
1665 /* #define AP_OPTS_RESERVED 0x08000000 */
1666 /* #define AP_OPTS_RESERVED 0x04000000 */
1667 /* #define AP_OPTS_RESERVED 0x02000000 */
1668 /* #define AP_OPTS_RESERVED 0x01000000 */
1669 /* #define AP_OPTS_RESERVED 0x00800000 */
1670 /* #define AP_OPTS_RESERVED 0x00400000 */
1671 /* #define AP_OPTS_RESERVED 0x00200000 */
1672 /* #define AP_OPTS_RESERVED 0x00100000 */
1673 /* #define AP_OPTS_RESERVED 0x00080000 */
1674 /* #define AP_OPTS_RESERVED 0x00040000 */
1675 /* #define AP_OPTS_RESERVED 0x00020000 */
1676 /* #define AP_OPTS_RESERVED 0x00010000 */
1677 /* #define AP_OPTS_RESERVED 0x00008000 */
1678 /* #define AP_OPTS_RESERVED 0x00004000 */
1679 /* #define AP_OPTS_RESERVED 0x00002000 */
1680 /* #define AP_OPTS_RESERVED 0x00001000 */
1681 /* #define AP_OPTS_RESERVED 0x00000800 */
1682 /* #define AP_OPTS_RESERVED 0x00000400 */
1683 /* #define AP_OPTS_RESERVED 0x00000200 */
1684 /* #define AP_OPTS_RESERVED 0x00000100 */
1685 /* #define AP_OPTS_RESERVED 0x00000080 */
1686 /* #define AP_OPTS_RESERVED 0x00000040 */
1687 /* #define AP_OPTS_RESERVED 0x00000020 */
1688 /* #define AP_OPTS_RESERVED 0x00000010 */
1689 /* #define AP_OPTS_RESERVED 0x00000008 */
1690 /* #define AP_OPTS_RESERVED 0x00000004 */
1693 #define AP_OPTS_WIRE_MASK 0xfffffff0
1694 /** @} */ /* end of AP_OPTS group */
1696 /* definitions for ad_type fields. */
1697 #define AD_TYPE_RESERVED 0x8000
1698 #define AD_TYPE_EXTERNAL 0x4000
1699 #define AD_TYPE_REGISTERED 0x2000
1701 #define AD_TYPE_FIELD_TYPE_MASK 0x1fff
1704 /* flags are 32 bits; each host is responsible to put the 4 bytes
1705 representing these bits into net order before transmission */
1706 /* #define TKT_FLG_RESERVED 0x80000000 */
1707 #define TKT_FLG_FORWARDABLE 0x40000000
1708 #define TKT_FLG_FORWARDED 0x20000000
1709 #define TKT_FLG_PROXIABLE 0x10000000
1710 #define TKT_FLG_PROXY 0x08000000
1711 #define TKT_FLG_MAY_POSTDATE 0x04000000
1712 #define TKT_FLG_POSTDATED 0x02000000
1713 #define TKT_FLG_INVALID 0x01000000
1714 #define TKT_FLG_RENEWABLE 0x00800000
1715 #define TKT_FLG_INITIAL 0x00400000
1716 #define TKT_FLG_PRE_AUTH 0x00200000
1717 #define TKT_FLG_HW_AUTH 0x00100000
1718 #define TKT_FLG_TRANSIT_POLICY_CHECKED 0x00080000
1719 #define TKT_FLG_OK_AS_DELEGATE 0x00040000
1720 #define TKT_FLG_ENC_PA_REP 0x00010000
1721 #define TKT_FLG_ANONYMOUS 0x00008000
1722 /* #define TKT_FLG_RESERVED 0x00004000 */
1723 /* #define TKT_FLG_RESERVED 0x00002000 */
1724 /* #define TKT_FLG_RESERVED 0x00001000 */
1725 /* #define TKT_FLG_RESERVED 0x00000800 */
1726 /* #define TKT_FLG_RESERVED 0x00000400 */
1727 /* #define TKT_FLG_RESERVED 0x00000200 */
1728 /* #define TKT_FLG_RESERVED 0x00000100 */
1729 /* #define TKT_FLG_RESERVED 0x00000080 */
1730 /* #define TKT_FLG_RESERVED 0x00000040 */
1731 /* #define TKT_FLG_RESERVED 0x00000020 */
1732 /* #define TKT_FLG_RESERVED 0x00000010 */
1733 /* #define TKT_FLG_RESERVED 0x00000008 */
1734 /* #define TKT_FLG_RESERVED 0x00000004 */
1735 /* #define TKT_FLG_RESERVED 0x00000002 */
1736 /* #define TKT_FLG_RESERVED 0x00000001 */
1738 /* definitions for lr_type fields. */
1739 #define LR_TYPE_THIS_SERVER_ONLY 0x8000
1741 #define LR_TYPE_INTERPRETATION_MASK 0x7fff
1743 /* definitions for msec direction bit for KRB_SAFE, KRB_PRIV */
1744 #define MSEC_DIRBIT 0x8000
1745 #define MSEC_VAL_MASK 0x7fff
1755 /** Protocol version number */
1760 #define KRB5_AS_REQ ((krb5_msgtype)10) /**< Initial authentication request */
1761 #define KRB5_AS_REP ((krb5_msgtype)11) /**< Response to AS request */
1762 #define KRB5_TGS_REQ ((krb5_msgtype)12) /**< Ticket granting server request */
1763 #define KRB5_TGS_REP ((krb5_msgtype)13) /**< Response to TGS request */
1764 #define KRB5_AP_REQ ((krb5_msgtype)14) /**< Auth req to application server */
1765 #define KRB5_AP_REP ((krb5_msgtype)15) /**< Response to mutual AP request */
1766 #define KRB5_SAFE ((krb5_msgtype)20) /**< Safe application message */
1767 #define KRB5_PRIV ((krb5_msgtype)21) /**< Private application message */
1768 #define KRB5_CRED ((krb5_msgtype)22) /**< Cred forwarding message */
1769 #define KRB5_ERROR ((krb5_msgtype)30) /**< Error response */
1772 #define KRB5_LRQ_NONE 0
1773 #define KRB5_LRQ_ALL_LAST_TGT 1
1774 #define KRB5_LRQ_ONE_LAST_TGT (-1)
1775 #define KRB5_LRQ_ALL_LAST_INITIAL 2
1776 #define KRB5_LRQ_ONE_LAST_INITIAL (-2)
1777 #define KRB5_LRQ_ALL_LAST_TGT_ISSUED 3
1778 #define KRB5_LRQ_ONE_LAST_TGT_ISSUED (-3)
1779 #define KRB5_LRQ_ALL_LAST_RENEWAL 4
1780 #define KRB5_LRQ_ONE_LAST_RENEWAL (-4)
1781 #define KRB5_LRQ_ALL_LAST_REQ 5
1782 #define KRB5_LRQ_ONE_LAST_REQ (-5)
1783 #define KRB5_LRQ_ALL_PW_EXPTIME 6
1784 #define KRB5_LRQ_ONE_PW_EXPTIME (-6)
1785 #define KRB5_LRQ_ALL_ACCT_EXPTIME 7
1786 #define KRB5_LRQ_ONE_ACCT_EXPTIME (-7)
1789 #define KRB5_PADATA_NONE 0
1790 #define KRB5_PADATA_AP_REQ 1
1791 #define KRB5_PADATA_TGS_REQ KRB5_PADATA_AP_REQ
1792 #define KRB5_PADATA_ENC_TIMESTAMP 2
1793 #define KRB5_PADATA_PW_SALT 3
1794 #if 0 /* Not used */
1795 #define KRB5_PADATA_ENC_ENCKEY 4 /* Key encrypted within itself */
1797 #define KRB5_PADATA_ENC_UNIX_TIME 5 /**< timestamp encrypted in key */
1798 #define KRB5_PADATA_ENC_SANDIA_SECURID 6 /**< SecurId passcode */
1799 #define KRB5_PADATA_SESAME 7 /**< Sesame project */
1800 #define KRB5_PADATA_OSF_DCE 8 /**< OSF DCE */
1801 #define KRB5_CYBERSAFE_SECUREID 9 /**< Cybersafe */
1802 #define KRB5_PADATA_AFS3_SALT 10 /**< Cygnus */
1803 #define KRB5_PADATA_ETYPE_INFO 11 /**< Etype info for preauth */
1804 #define KRB5_PADATA_SAM_CHALLENGE 12 /**< draft challenge system */
1805 #define KRB5_PADATA_SAM_RESPONSE 13 /**< draft challenge system response */
1806 #define KRB5_PADATA_PK_AS_REQ_OLD 14 /**< PKINIT */
1807 #define KRB5_PADATA_PK_AS_REP_OLD 15 /**< PKINIT */
1808 #define KRB5_PADATA_PK_AS_REQ 16 /**< PKINIT */
1809 #define KRB5_PADATA_PK_AS_REP 17 /**< PKINIT */
1810 #define KRB5_PADATA_ETYPE_INFO2 19
1811 #define KRB5_PADATA_USE_SPECIFIED_KVNO 20
1812 #define KRB5_PADATA_SVR_REFERRAL_INFO 20 /**< Windows 2000 referrals */
1813 #define KRB5_PADATA_SAM_REDIRECT 21
1814 #define KRB5_PADATA_GET_FROM_TYPED_DATA 22
1815 #define KRB5_PADATA_REFERRAL 25 /**< draft referral system */
1816 #define KRB5_PADATA_SAM_CHALLENGE_2 30 /**< draft challenge system, updated */
1817 #define KRB5_PADATA_SAM_RESPONSE_2 31 /**< draft challenge system, updated */
1818 #define KRB5_PADATA_PAC_REQUEST 128 /**< include Windows PAC */
1819 #define KRB5_PADATA_FOR_USER 129 /**< username protocol transition request */
1820 #define KRB5_PADATA_S4U_X509_USER 130 /**< certificate protocol transition request */
1821 #define KRB5_PADATA_FX_COOKIE 133
1822 #define KRB5_PADATA_FX_FAST 136
1823 #define KRB5_PADATA_FX_ERROR 137
1824 #define KRB5_PADATA_ENCRYPTED_CHALLENGE 138
1825 #define KRB5_PADATA_PKINIT_KX 147
1826 #define KRB5_ENCPADATA_REQ_ENC_PA_REP 149
1828 #define KRB5_SAM_USE_SAD_AS_KEY 0x80000000
1829 #define KRB5_SAM_SEND_ENCRYPTED_SAD 0x40000000
1830 #define KRB5_SAM_MUST_PK_ENCRYPT_SAD 0x20000000 /* currently must be zero */
1832 /** Transited encoding types */
1833 #define KRB5_DOMAIN_X500_COMPRESS 1
1835 /** alternate authentication types */
1836 #define KRB5_ALTAUTH_ATT_CHALLENGE_RESPONSE 64
1838 /* authorization data types. See RFC 4120 section 5.2.6 */
1840 /** @defgroup KRB5_AUTHDATA KRB5_AUTHDATA
1843 #define KRB5_AUTHDATA_IF_RELEVANT 1
1844 #define KRB5_AUTHDATA_KDC_ISSUED 4
1845 #define KRB5_AUTHDATA_AND_OR 5
1846 #define KRB5_AUTHDATA_MANDATORY_FOR_KDC 8
1847 #define KRB5_AUTHDATA_INITIAL_VERIFIED_CAS 9
1848 #define KRB5_AUTHDATA_OSF_DCE 64
1849 #define KRB5_AUTHDATA_SESAME 65
1850 #define KRB5_AUTHDATA_WIN2K_PAC 128
1851 #define KRB5_AUTHDATA_ETYPE_NEGOTIATION 129 /* RFC 4537 */
1852 #define KRB5_AUTHDATA_SIGNTICKET 512 /**< formerly 142 in krb5 1.8 */
1853 #define KRB5_AUTHDATA_FX_ARMOR 71
1854 /** @} */ /* end of KRB5_AUTHDATA group */
1856 /* password change constants */
1857 #define KRB5_KPASSWD_SUCCESS 0
1858 #define KRB5_KPASSWD_MALFORMED 1
1859 #define KRB5_KPASSWD_HARDERROR 2
1860 #define KRB5_KPASSWD_AUTHERROR 3
1861 #define KRB5_KPASSWD_SOFTERROR 4
1862 /* These are Microsoft's extensions in RFC 3244, and it looks like
1863 they'll become standardized, possibly with other additions. */
1864 #define KRB5_KPASSWD_ACCESSDENIED 5 /* unused */
1865 #define KRB5_KPASSWD_BAD_VERSION 6
1866 #define KRB5_KPASSWD_INITIAL_FLAG_NEEDED 7 /* unused */
1873 /** Ticket start time, end time, and renewal duration. */
1874 typedef struct _krb5_ticket_times {
1875 krb5_timestamp authtime; /**< Time at which KDC issued the initial ticket that corresponds to this ticket */
1876 /* XXX ? should ktime in KDC_REP == authtime
1877 in ticket? otherwise client can't get this */
1878 krb5_timestamp starttime; /**< optional in ticket, if not present, use @a authtime */
1879 krb5_timestamp endtime; /**< Ticket expiration time */
1880 krb5_timestamp renew_till; /**< Latest time at which renewal of ticket can be valid */
1881 } krb5_ticket_times;
1883 /** Structure for auth data */
1884 typedef struct _krb5_authdata {
1886 krb5_authdatatype ad_type; /**< ADTYPE */
1887 unsigned int length; /**< Length of data */
1888 krb5_octet *contents; /**< Data */
1891 /** Structure for transited encoding */
1892 typedef struct _krb5_transited {
1894 krb5_octet tr_type; /**< Transited encoding type */
1895 krb5_data tr_contents; /**< Contents */
1898 /** Encrypted part of ticket. */
1899 typedef struct _krb5_enc_tkt_part {
1901 /* to-be-encrypted portion */
1902 krb5_flags flags; /**< flags */
1903 krb5_keyblock *session; /**< session key: includes enctype */
1904 krb5_principal client; /**< client name/realm */
1905 krb5_transited transited; /**< list of transited realms */
1906 krb5_ticket_times times; /**< auth, start, end, renew_till */
1907 krb5_address **caddrs; /**< array of ptrs to addresses */
1908 krb5_authdata **authorization_data; /**< auth data */
1909 } krb5_enc_tkt_part;
1914 * The C representation of the ticket message, with a pointer to the
1915 * C representation of the encrypted part.
1917 typedef struct _krb5_ticket {
1919 /* cleartext portion */
1920 krb5_principal server; /**< server name/realm */
1921 krb5_enc_data enc_part; /**< encryption type, kvno, encrypted encoding */
1922 krb5_enc_tkt_part *enc_part2; /**< ptr to decrypted version, if available */
1925 /* the unencrypted version */
1927 * Ticket authenticator.
1929 * The C representation of an unencrypted authenticator.
1931 typedef struct _krb5_authenticator {
1933 krb5_principal client; /**< client name/realm */
1934 krb5_checksum *checksum; /**< checksum, includes type, optional */
1935 krb5_int32 cusec; /**< client usec portion */
1936 krb5_timestamp ctime; /**< client sec portion */
1937 krb5_keyblock *subkey; /**< true session key, optional */
1938 krb5_ui_4 seq_number; /**< sequence #, optional */
1939 krb5_authdata **authorization_data; /**< authoriazation data */
1940 } krb5_authenticator;
1942 /** Ticket authentication data. */
1943 typedef struct _krb5_tkt_authent {
1945 krb5_ticket *ticket;
1946 krb5_authenticator *authenticator;
1947 krb5_flags ap_options;
1950 /** Credentials structure including ticket, session key, and lifetime info. */
1951 typedef struct _krb5_creds {
1953 krb5_principal client; /**< client's principal identifier */
1954 krb5_principal server; /**< server's principal identifier */
1955 krb5_keyblock keyblock; /**< session encryption key info */
1956 krb5_ticket_times times; /**< lifetime info */
1957 krb5_boolean is_skey; /**< true if ticket is encrypted in
1958 another ticket's skey */
1959 krb5_flags ticket_flags; /**< flags in ticket */
1960 krb5_address **addresses; /**< addrs in ticket */
1961 krb5_data ticket; /**< ticket string itself */
1962 krb5_data second_ticket; /**< second ticket, if related to
1963 ticket (via DUPLICATE-SKEY or
1965 krb5_authdata **authdata; /**< authorization data */
1968 /** Last request entry */
1969 typedef struct _krb5_last_req_entry {
1971 krb5_int32 lr_type; /**< LR type */
1972 krb5_timestamp value; /**< Timestamp */
1973 } krb5_last_req_entry;
1975 /** Pre-authentication data */
1976 typedef struct _krb5_pa_data {
1978 krb5_preauthtype pa_type; /**< Preauthentication data type */
1979 unsigned int length; /**< Length of data */
1980 krb5_octet *contents; /**< Data */
1984 * The FAST error handling logic currently assumes that pointers to this
1985 * structure and krb5_pa_data can be safely cast to each other. If this
1986 * structure changes, that code needs to be updated to copy.
1989 typedef struct _krb5_typed_data {
1992 unsigned int length;
1996 /** C representation of KDC-REQ protocol message, including KDC-REQ-BODY */
1997 typedef struct _krb5_kdc_req {
1999 krb5_msgtype msg_type; /**< KRB5_AS_REQ or KRB5_TGS_REQ */
2000 krb5_pa_data **padata; /**< Preauthentication data */
2002 krb5_flags kdc_options; /**< Requested options */
2003 krb5_principal client; /**< Client principal and realm */
2004 krb5_principal server; /**< Server principal and realm */
2005 krb5_timestamp from; /**< Requested start time */
2006 krb5_timestamp till; /**< Requested end time */
2007 krb5_timestamp rtime; /**< Requested renewable end time */
2008 krb5_int32 nonce; /**< Nonce to match request andresponse */
2009 int nktypes; /**< Number of enctypes */
2010 krb5_enctype *ktype; /**< Requested enctypes */
2011 krb5_address **addresses; /**< Requested addresses (optional) */
2012 krb5_enc_data authorization_data; /**< Encrypted authz data (optional) */
2013 krb5_authdata **unenc_authdata; /**< Unencrypted authz data */
2014 krb5_ticket **second_ticket; /**< Second ticket array (optional) */
2018 * C representation of @c EncKDCRepPart protocol message.
2020 * This is the cleartext message that is encrypted and inserted in @c KDC-REP.
2022 typedef struct _krb5_enc_kdc_rep_part {
2024 /* encrypted part: */
2025 krb5_msgtype msg_type; /**< krb5 message type */
2026 krb5_keyblock *session; /**< Session key */
2027 krb5_last_req_entry **last_req; /**< Array of pointers to entries */
2028 krb5_int32 nonce; /**< Nonce from request */
2029 krb5_timestamp key_exp; /**< Expiration date */
2030 krb5_flags flags; /**< Ticket flags */
2031 krb5_ticket_times times; /**< Lifetime info */
2032 krb5_principal server; /**< Server's principal identifier */
2033 krb5_address **caddrs; /**< Array of ptrs to addrs, optional */
2034 krb5_pa_data **enc_padata; /**< Encrypted preauthentication data */
2035 } krb5_enc_kdc_rep_part;
2037 /** Representation of the @c KDC-REP protocol message. */
2038 typedef struct _krb5_kdc_rep {
2040 /* cleartext part: */
2041 krb5_msgtype msg_type; /**< KRB5_AS_REP or KRB5_KDC_REP */
2042 krb5_pa_data **padata; /**< Preauthentication data from KDC */
2043 krb5_principal client; /**< Client principal and realm */
2044 krb5_ticket *ticket; /**< Ticket */
2045 krb5_enc_data enc_part; /**< Encrypted part of reply */
2046 krb5_enc_kdc_rep_part *enc_part2; /**< Unencrypted version, if available */
2049 /** Error message structure */
2050 typedef struct _krb5_error {
2052 /* some of these may be meaningless in certain contexts */
2053 krb5_timestamp ctime; /**< Client sec portion; optional */
2054 krb5_int32 cusec; /**< Client usec portion; optional */
2055 krb5_int32 susec; /**< Server usec portion */
2056 krb5_timestamp stime; /**< Server sec portion */
2057 krb5_ui_4 error; /**< Error code (protocol error #'s) */
2058 krb5_principal client; /**< Client principal and realm */
2059 krb5_principal server; /**< Server principal and realm */
2060 krb5_data text; /**< Descriptive text */
2061 krb5_data e_data; /**< Additional error-describing data */
2064 /** Authentication header. */
2065 typedef struct _krb5_ap_req {
2067 krb5_flags ap_options; /**< Requested options */
2068 krb5_ticket *ticket; /**< Ticket */
2069 krb5_enc_data authenticator; /**< Encrypted authenticator */
2073 * C representaton of AP-REP message.
2075 * The server's response to a client's request for mutual authentication.
2077 typedef struct _krb5_ap_rep {
2079 krb5_enc_data enc_part; /**< Ciphertext of ApRepEncPart */
2082 /** Cleartext that is encrypted and put into @c _krb5_ap_rep. */
2083 typedef struct _krb5_ap_rep_enc_part {
2085 krb5_timestamp ctime; /**< Client time, seconds portion */
2086 krb5_int32 cusec; /**< Client time, microseconds portion */
2087 krb5_keyblock *subkey; /**< Subkey (optional) */
2088 krb5_ui_4 seq_number; /**< Sequence number */
2089 } krb5_ap_rep_enc_part;
2092 typedef struct _krb5_response {
2094 krb5_octet message_type;
2096 krb5_int32 expected_nonce;
2097 krb5_timestamp request_time;
2100 /** Credentials information inserted into @c EncKrbCredPart. */
2101 typedef struct _krb5_cred_info {
2103 krb5_keyblock *session; /**< Session key used to encrypt ticket */
2104 krb5_principal client; /**< Client principal and realm */
2105 krb5_principal server; /**< Server principal and realm */
2106 krb5_flags flags; /**< Ticket flags */
2107 krb5_ticket_times times; /**< Auth, start, end, renew_till */
2108 krb5_address **caddrs; /**< Array of pointers to addrs (optional) */
2111 /** Cleartext credentials information. */
2112 typedef struct _krb5_cred_enc_part {
2114 krb5_int32 nonce; /**< Nonce (optional) */
2115 krb5_timestamp timestamp; /**< Generation time, seconds portion */
2116 krb5_int32 usec; /**< Generation time, microseconds portion */
2117 krb5_address *s_address; /**< Sender address (optional) */
2118 krb5_address *r_address; /**< Recipient address (optional) */
2119 krb5_cred_info **ticket_info;
2120 } krb5_cred_enc_part;
2122 /** Credentials data structure.*/
2123 typedef struct _krb5_cred {
2125 krb5_ticket **tickets; /**< Tickets */
2126 krb5_enc_data enc_part; /**< Encrypted part */
2127 krb5_cred_enc_part *enc_part2; /**< Unencrypted version, if available */
2131 * Sandia password generation structure
2132 * Used by internal functions only
2134 typedef struct _passwd_phrase_element {
2138 } passwd_phrase_element;
2142 * Used by internal functions only
2144 typedef struct _krb5_pwd_data {
2147 passwd_phrase_element **element;
2150 /* these need to be here so the typedefs are available for the prototypes */
2152 * Note for Windows 2000 compatibility this is encoded
2153 * in the enc_padata field of the krb5_enc_kdc_rep_part.
2155 typedef struct _krb5_pa_svr_referral_data {
2156 /** Referred name, only realm is required */
2157 krb5_principal principal;
2158 } krb5_pa_svr_referral_data;
2160 typedef struct _krb5_pa_server_referral_data {
2161 krb5_data *referred_realm;
2162 krb5_principal true_principal_name;
2163 krb5_principal requested_principal_name;
2164 krb5_timestamp referral_valid_until;
2165 krb5_checksum rep_cksum;
2166 } krb5_pa_server_referral_data;
2168 typedef struct _krb5_pa_pac_req {
2169 /** TRUE if a PAC should be included in TGS-REP */
2170 krb5_boolean include_pac;
2174 * begin "safepriv.h"
2177 /** @defgroup KRB5_AUTH_CONTEXT KRB5_AUTH_CONTEXT
2180 #define KRB5_AUTH_CONTEXT_DO_TIME 0x00000001 /**< set timestamp in the message */
2181 #define KRB5_AUTH_CONTEXT_RET_TIME 0x00000002
2182 #define KRB5_AUTH_CONTEXT_DO_SEQUENCE 0x00000004 /**< set sequence number in the message */
2183 #define KRB5_AUTH_CONTEXT_RET_SEQUENCE 0x00000008
2184 #define KRB5_AUTH_CONTEXT_PERMIT_ALL 0x00000010
2185 #define KRB5_AUTH_CONTEXT_USE_SUBKEY 0x00000020
2186 /** @} */ /* end of KRB5_AUTH_CONTEXT group */
2191 * Sequence number and timestamp information output by krb5_rd_priv() and
2194 typedef struct krb5_replay_data {
2195 krb5_timestamp timestamp; /**< Timestamp, seconds portion */
2196 krb5_int32 usec; /**< Timestamp, microseconds portion */
2197 krb5_ui_4 seq; /**< Sequence number */
2200 /* Flags for krb5_auth_con_genaddrs(). */
2202 /** Generate the local network address. */
2203 #define KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR 0x00000001
2204 /** Generate the remote network address. */
2205 #define KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR 0x00000002
2206 /** Generate the local network address and the local port. */
2207 #define KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR 0x00000004
2208 /** Generate the remote network address and the remote port. */
2209 #define KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR 0x00000008
2211 /** Type of function used as a callback to generate checksum data for mk_req */
2212 typedef krb5_error_code
2213 (KRB5_CALLCONV * krb5_mk_req_checksum_func)(krb5_context, krb5_auth_context,
2214 void *, krb5_data **);
2225 /** Cursor for sequential lookup */
2226 typedef krb5_pointer krb5_cc_cursor;
2228 struct _krb5_ccache;
2229 typedef struct _krb5_ccache *krb5_ccache;
2230 struct _krb5_cc_ops;
2231 typedef struct _krb5_cc_ops krb5_cc_ops;
2233 struct _krb5_cccol_cursor;
2234 /** Cursor for iterating over all ccaches */
2235 typedef struct _krb5_cccol_cursor *krb5_cccol_cursor;
2237 /* Flags for krb5_cc_retrieve_cred. */
2238 /** The requested lifetime must be at least as great as the time specified. */
2239 #define KRB5_TC_MATCH_TIMES 0x00000001
2240 /** The is_skey field must match exactly. */
2241 #define KRB5_TC_MATCH_IS_SKEY 0x00000002
2242 /** All the flags set in the match credentials must be set. */
2243 #define KRB5_TC_MATCH_FLAGS 0x00000004
2244 /** All the time fields must match exactly. */
2245 #define KRB5_TC_MATCH_TIMES_EXACT 0x00000008
2246 /** All the flags must match exactly. */
2247 #define KRB5_TC_MATCH_FLAGS_EXACT 0x00000010
2248 /** The authorization data must match. */
2249 #define KRB5_TC_MATCH_AUTHDATA 0x00000020
2250 /** Only the name portion of the principal name must match. */
2251 #define KRB5_TC_MATCH_SRV_NAMEONLY 0x00000040
2252 /** The second ticket must match. */
2253 #define KRB5_TC_MATCH_2ND_TKT 0x00000080
2254 /** The encryption key type must match. */
2255 #define KRB5_TC_MATCH_KTYPE 0x00000100
2256 /** The supported key types must match. */
2257 #define KRB5_TC_SUPPORTED_KTYPES 0x00000200
2259 /* Flags for krb5_cc_set_flags and similar. */
2260 /** Open and close the file for each cache operation. */
2261 #define KRB5_TC_OPENCLOSE 0x00000001
2262 #define KRB5_TC_NOTICKET 0x00000002
2265 * Retrieve the name, but not type of a credential cache.
2267 * @param [in] context Library context
2268 * @param [in] cache Credential cache handle
2270 * @warning Returns the name of the credential cache. The result is an alias
2271 * into @a cache and should not be freed or modified by the caller. This name
2272 * does not include the cache type, so should not be used as input to
2273 * krb5_cc_resolve().
2276 * On success - the name of the credential cache.
2278 const char * KRB5_CALLCONV
2279 krb5_cc_get_name(krb5_context context, krb5_ccache cache);
2282 * Retrieve the full name of a credential cache.
2284 * @param [in] context Library context
2285 * @param [in] cache Credential cache handle
2286 * @param [out] fullname_out Full name of cache
2289 krb5_error_code KRB5_CALLCONV
2290 krb5_cc_get_full_name(krb5_context context, krb5_ccache cache,
2291 char **fullname_out);
2294 krb5_error_code KRB5_CALLCONV
2295 krb5_cc_gen_new(krb5_context context, krb5_ccache *cache);
2296 #endif /* KRB5_DEPRECATED */
2299 * Initialize a credential cache.
2301 * @param [in] context Library context
2302 * @param [in] cache Credential cache handle
2303 * @param [in] principal Default principal name
2305 * Destroy any existing contents of @a cache and initialize it for the default
2306 * principal @a principal.
2311 * System errors; Permission errors; Kerberos error codes
2313 krb5_error_code KRB5_CALLCONV
2314 krb5_cc_initialize(krb5_context context, krb5_ccache cache,
2315 krb5_principal principal);
2318 * Destroy a credential cache.
2320 * @param [in] context Library context
2321 * @param [in] cache Credential cache handle
2323 * This function destroys any existing contents of @a cache and closes the
2331 krb5_error_code KRB5_CALLCONV
2332 krb5_cc_destroy(krb5_context context, krb5_ccache cache);
2335 * Close a credential cache handle.
2337 * @param [in] context Library context
2338 * @param [in] cache Credential cache handle
2340 * This function closes a credential cache handle @a cache without affecting
2341 * the contents of the cache.
2346 * Kerberos error codes
2348 krb5_error_code KRB5_CALLCONV
2349 krb5_cc_close(krb5_context context, krb5_ccache cache);
2352 * Store credentials in a credential cache.
2354 * @param [in] context Library context
2355 * @param [in,out] cache Credential cache handle
2356 * @param [in] creds Credentials to be stored in cache
2358 * This function stores @a creds into @a cache. If @a creds->server and the
2359 * server in the decoded ticket @a creds->ticket differ, the credentials will
2360 * be stored under both server principal names.
2364 * @return Permission errors; storage failure errors; Kerberos error codes
2366 krb5_error_code KRB5_CALLCONV
2367 krb5_cc_store_cred(krb5_context context, krb5_ccache cache, krb5_creds *creds);
2370 * Retrieve a specified credentials from a credential cache.
2372 * @param [in] context Library context
2373 * @param [in] cache Credential cache handle
2374 * @param [in] flags Flags bit mask
2375 * @param [in] mcreds Credentials to match
2376 * @param [out] creds Credentials matching the requested value
2378 * This function searches a credential cache for credentials matching @a mcreds
2379 * and returns it if found.
2381 * Valid values for @a flags are:
2383 * @li #KRB5_TC_MATCH_TIMES The requested lifetime must be at least as
2384 * great as in @a mcreds .
2385 * @li #KRB5_TC_MATCH_IS_SKEY The @a is_skey field much match exactly.
2386 * @li #KRB5_TC_MATCH_FLAGS Flags set in @a mcreds must be set.
2387 * @li #KRB5_TC_MATCH_TIMES_EXACT The requested lifetime must match exactly.
2388 * @li #KRB5_TC_MATCH_FLAGS_EXACT Flags must match exactly.
2389 * @li #KRB5_TC_MATCH_AUTHDATA The authorization data must match.
2390 * @li #KRB5_TC_MATCH_SRV_NAMEONLY Only the name portion of the principal
2391 * name must match, not the realm.
2392 * @li #KRB5_TC_MATCH_2ND_TKT The second tickets must match.
2393 * @li #KRB5_TC_MATCH_KTYPE The encryption key types must match.
2394 * @li #KRB5_TC_SUPPORTED_KTYPES Check all matching entries that have any
2395 * supported encryption type and return the
2396 * one with the encryption type listed earliest.
2398 * Use krb5_free_cred_contents() to free @a creds when it is no longer needed.
2400 * @retval 0 Success; otherwise - Kerberos error codes
2402 krb5_error_code KRB5_CALLCONV
2403 krb5_cc_retrieve_cred(krb5_context context, krb5_ccache cache,
2404 krb5_flags flags, krb5_creds *mcreds,
2408 * Get the default principal of a credential cache.
2410 * @param [in] context Library context
2411 * @param [in] cache Credential cache handle
2412 * @param [out] principal Primary principal
2414 * Returns the default client principal of a credential cache as set by
2415 * krb5_cc_initialize().
2417 * Use krb5_free_principal() to free @a principal when it is no longer needed.
2422 * Kerberos error codes
2424 krb5_error_code KRB5_CALLCONV
2425 krb5_cc_get_principal(krb5_context context, krb5_ccache cache,
2426 krb5_principal *principal);
2429 * Prepare to sequentially read every credential in a credential cache.
2431 * @param [in] context Library context
2432 * @param [in] cache Credential cache handle
2433 * @param [out] cursor Cursor
2435 * krb5_cc_end_seq_get() must be called to complete the retrieve operation.
2437 * @note If @a cache is modified between the time of the call to this function
2438 * and the time of the final krb5_cc_end_seq_get(), the results are undefined.
2440 * @retval 0 Success; otherwise - Kerberos error codes
2442 krb5_error_code KRB5_CALLCONV
2443 krb5_cc_start_seq_get(krb5_context context, krb5_ccache cache,
2444 krb5_cc_cursor *cursor);
2447 * Retrieve the next entry from the credential cache.
2449 * @param [in] context Library context
2450 * @param [in] cache Credential cache handle
2451 * @param [in,out] cursor Cursor
2452 * @param [out] creds Next credential cache entry
2454 * This function fills in @a creds with the next entry in @a cache and advances
2457 * Use krb5_free_cred_contents() to free @a creds when it is no longer needed.
2459 * @sa krb5_cc_start_seq_get(), krb5_end_seq_get()
2461 * @retval 0 Success; otherwise - Kerberos error codes
2463 krb5_error_code KRB5_CALLCONV
2464 krb5_cc_next_cred(krb5_context context, krb5_ccache cache,
2465 krb5_cc_cursor *cursor, krb5_creds *creds);
2468 * Finish a series of sequential processing credential cache entries.
2470 * @param [in] context Library context
2471 * @param [in] cache Credential cache handle
2472 * @param [in,out] cursor Cursor
2474 * This function finishes processing credential cache entries and invalidates
2477 * @sa krb5_cc_start_seq_get(), krb5_cc_next_cred()
2479 * @retval 0 (always)
2481 krb5_error_code KRB5_CALLCONV
2482 krb5_cc_end_seq_get(krb5_context context, krb5_ccache cache,
2483 krb5_cc_cursor *cursor);
2486 * Remove credentials from a credential cache.
2488 * @param [in] context Library context
2489 * @param [in] cache Credential cache handle
2490 * @param [in] flags Bitwise-ORed search flags
2491 * @param [in] creds Credentials to be matched
2493 * @warning This function is not implemented for some cache types.
2495 * This function accepts the same flag values as krb5_cc_retrieve_cred().
2497 * @retval KRB5_CC_NOSUPP Not implemented for this cache type
2498 * @return No matches found; Data cannot be deleted; Kerberos error codes
2500 krb5_error_code KRB5_CALLCONV
2501 krb5_cc_remove_cred(krb5_context context, krb5_ccache cache, krb5_flags flags,
2505 * Set options flags on a credential cache.
2507 * @param [in] context Library context
2508 * @param [in,out] cache Credential cache handle
2509 * @param [in] flags Flag bit mask
2511 * This function resets @a cache flags to @a flags.
2513 * @retval 0 Success; otherwise - Kerberos error codes
2515 krb5_error_code KRB5_CALLCONV
2516 krb5_cc_set_flags(krb5_context context, krb5_ccache cache, krb5_flags flags);
2519 * Retrieve flags from a credential cache structure.
2521 * @param [in] context Library context
2522 * @param [in] cache Credential cache handle
2523 * @param [out] flags Flag bit mask
2525 * @warning For memory credential cache always returns a flag mask of 0.
2527 * @retval 0 Success; otherwise - Kerberos error codes
2529 krb5_error_code KRB5_CALLCONV
2530 krb5_cc_get_flags(krb5_context context, krb5_ccache cache, krb5_flags *flags);
2533 * Retrieve the type of a credential cache.
2535 * @param [in] context Library context
2536 * @param [in] cache Credential cache handle
2538 * @return The type of a credential cache as an alias that must not be modified
2539 * or freed by the caller.
2541 const char * KRB5_CALLCONV
2542 krb5_cc_get_type(krb5_context context, krb5_ccache cache);
2545 * Move a credential cache.
2547 * @param [in] context Library context
2548 * @param [in] src The credential cache to move the content from
2549 * @param [in] dst The credential cache to move the content to
2551 * This function reinitializes @a dst and populates it with the credentials and
2552 * default principal of @a src; then, if successful, destroys @a src.
2555 * 0 Success; @a src is closed.
2557 * Kerberos error codes; @a src is still allocated.
2559 krb5_error_code KRB5_CALLCONV
2560 krb5_cc_move(krb5_context context, krb5_ccache src, krb5_ccache dst);
2563 * Return a timestamp of the last modification to a credential cache.
2565 * @param [in] context Library context
2566 * @param [in] ccache Credential cache handle
2567 * @param [out] change_time The last change time of @a ccache
2569 * If an error occurs, @a change_time is set to 0.
2571 krb5_error_code KRB5_CALLCONV
2572 krb5_cc_last_change_time(krb5_context context, krb5_ccache ccache,
2573 krb5_timestamp *change_time);
2576 * Lock a credential cache.
2578 * @param [in] context Library context
2579 * @param [in] ccache Credential cache handle
2581 * Use krb5_cc_unlock() to unlock the lock.
2583 * @retval 0 Success; otherwise - Kerberos error codes
2585 krb5_error_code KRB5_CALLCONV
2586 krb5_cc_lock(krb5_context context, krb5_ccache ccache);
2589 * Unlock a credential cache.
2591 * @param [in] context Library context
2592 * @param [in] ccache Credential cache handle
2594 * This function unlocks the @a ccache locked by krb5_cc_lock().
2596 * @retval 0 Success; otherwise - Kerberos error codes
2598 krb5_error_code KRB5_CALLCONV
2599 krb5_cc_unlock(krb5_context context, krb5_ccache ccache);
2602 * Prepare to iterate over the collection of known credential caches.
2604 * @param [in] context Library context
2605 * @param [in,out] cursor Cursor
2607 * Get a new cache iteration @a cursor that will iterate over all known
2608 * credential caches independent of type.
2610 * Use krb5_cccol_cursor_free() to release @a cursor when it is no longer
2613 * @sa krb5_cccol_cursor_next()
2615 * @retval 0 Success; otherwise - Kerberos error codes
2617 krb5_error_code KRB5_CALLCONV
2618 krb5_cccol_cursor_new(krb5_context context, krb5_cccol_cursor *cursor);
2621 * Get the next credential cache in the collection.
2623 * @param [in] context Library context
2624 * @param [in,out] cursor Cursor
2625 * @param [out] ccache Credential cache handle
2627 * @note When all caches are iterated over and the end of the list is reached,
2628 * @a ccache is set to NULL.
2630 * Use krb5_cc_close() to close @a ccache when it is no longer needed.
2632 * @sa krb5_cccol_cursor_new(), krb5_cccol_cursor_free()
2634 * @retval 0 Success; otherwise - Kerberos error codes
2636 krb5_error_code KRB5_CALLCONV
2637 krb5_cccol_cursor_next(krb5_context context, krb5_cccol_cursor cursor,
2638 krb5_ccache *ccache);
2641 * Free a credential cache collection cursor.
2643 * @param [in] context Library context
2644 * @param [in] cursor Cursor
2646 * @sa krb5_cccol_cursor_new(), krb5_cccol_cursor_next()
2648 * @retval 0 Success; otherwise - Kerberos error codes
2650 krb5_error_code KRB5_CALLCONV
2651 krb5_cccol_cursor_free(krb5_context context, krb5_cccol_cursor *cursor);
2654 * Return a timestamp of the last modification of any known credential cache.
2656 * @param [in] context Library context
2657 * @param [out] change_time Last modification timestamp
2659 * This function returns the most recent modification time of any known
2660 * credential cache, ignoring any caches which cannot supply a last
2661 * modification time.
2663 * If there are no known credential caches, @a change_time is set to 0.
2665 * @retval 0 Success; otherwise - Kerberos error codes
2667 krb5_error_code KRB5_CALLCONV
2668 krb5_cccol_last_change_time(krb5_context context, krb5_timestamp *change_time);
2671 * Acquire a global lock for credential caches.
2673 * @param [in] context Library context
2675 * This function locks the global credential cache collection, ensuring
2676 * that no ccaches are added to or removed from it until the collection
2679 * Use krb5_cccol_unlock() to unlock the lock.
2681 * @retval 0 Success; otherwise - Kerberos error codes
2684 krb5_error_code KRB5_CALLCONV
2685 krb5_cccol_lock(krb5_context context);
2688 * Release a global lock for credential caches.
2690 * @param [in] context Library context
2692 * This function unlocks the lock from krb5_cccol_lock().
2694 * @retval 0 Success; otherwise - Kerberos error codes
2696 krb5_error_code KRB5_CALLCONV
2697 krb5_cccol_unlock(krb5_context context);
2700 * Create a new credential cache of the specified type with a unique name.
2702 * @param [in] context Library context
2703 * @param [in] type Credential cache type name
2704 * @param [in] hint Unused
2705 * @param [out] id Credential cache handle
2710 * Kerberos error codes
2712 krb5_error_code KRB5_CALLCONV
2713 krb5_cc_new_unique(krb5_context context, const char *type, const char *hint,
2725 typedef struct krb5_rc_st *krb5_rcache;
2737 #define MAX_KEYTAB_NAME_LEN 1100 /* Long enough for MAXPATHLEN + some extra */
2739 typedef krb5_pointer krb5_kt_cursor;
2741 /** A key table entry. */
2742 typedef struct krb5_keytab_entry_st {
2744 krb5_principal principal; /**< Principal of this key */
2745 krb5_timestamp timestamp; /**< Time entry written to keytable */
2746 krb5_kvno vno; /**< Key version number */
2747 krb5_keyblock key; /**< The secret key */
2748 } krb5_keytab_entry;
2751 typedef struct _krb5_kt *krb5_keytab;
2754 * Return the type of a key table.
2756 * @param [in] context Library context
2757 * @param [in] keytab Key table handle
2759 * @return The type of a key table as an alias that must not be modified or
2760 * freed by the caller.
2762 const char * KRB5_CALLCONV
2763 krb5_kt_get_type(krb5_context context, krb5_keytab keytab);
2766 * Get a key table name.
2768 * @param [in] context Library context
2769 * @param [in] keytab Key table handle
2770 * @param [out] name Key table name
2771 * @param [in] namelen Maximum length to fill in name
2773 * Fills in @a name with the name of @a keytab including the type and delimiter.
2775 * @sa MAX_KEYTAB_NAME_LEN
2780 * KRB5_KT_NAME_TOOLONG Key table name does not fit in @a namelen bytes
2783 * Kerberos error codes
2785 krb5_error_code KRB5_CALLCONV
2786 krb5_kt_get_name(krb5_context context, krb5_keytab keytab, char *name,
2787 unsigned int namelen);
2790 * Close a key table handle.
2792 * @param [in] context Library context
2793 * @param [in] keytab Key table handle
2797 krb5_error_code KRB5_CALLCONV
2798 krb5_kt_close(krb5_context context, krb5_keytab keytab);
2801 * Get an entry from a key table.
2803 * @param [in] context Library context
2804 * @param [in] keytab Key table handle
2805 * @param [in] principal Principal name
2806 * @param [in] vno Key version number (0 for highest available)
2807 * @param [in] enctype Encryption type (0 zero for any enctype)
2808 * @param [out] entry Returned entry from key table
2810 * Retrieve an entry from a key table which matches the @a keytab, @a
2811 * principal, @a vno, and @a enctype. If @a vno is zero, retrieve the
2812 * highest-numbered kvno matching the other fields. If @a enctype is 0, match
2815 * Use krb5_free_keytab_entry_contents() to free @a entry when it is no longer
2818 * @note If @a vno is zero, the function retrieves the highest-numbered-kvno
2819 * entry that matches the specified principal.
2824 * Kerberos error codes on failure
2826 krb5_error_code KRB5_CALLCONV
2827 krb5_kt_get_entry(krb5_context context, krb5_keytab keytab,
2828 krb5_const_principal principal, krb5_kvno vno,
2829 krb5_enctype enctype, krb5_keytab_entry *entry);
2832 * Start a sequential retrieval of key table entries.
2834 * @param [in] context Library context
2835 * @param [in] keytab Key table handle
2836 * @param [out] cursor Cursor
2838 * Prepare to read sequentially every key in the specified key table. Use
2839 * krb5_kt_end_seq_get() to release the cursor when it is no longer needed.
2841 * @sa krb5_kt_next_entry(), krb5_kt_end_seq_get()
2846 * Kerberos error codes
2848 krb5_error_code KRB5_CALLCONV
2849 krb5_kt_start_seq_get(krb5_context context, krb5_keytab keytab,
2850 krb5_kt_cursor *cursor);
2853 * Retrieve the next entry from the key table.
2855 * @param [in] context Library context
2856 * @param [in] keytab Key table handle
2857 * @param [out] entry Returned key table entry
2858 * @param [in,out] cursor Key table cursor
2860 * Return the next sequential entry in @a keytab and advance @a cursor.
2862 * @sa krb5_kt_start_seq_get(), krb5_kt_end_seq_get()
2867 * KRB5_KT_END - if the last entry was reached
2869 * Kerberos error codes
2871 krb5_error_code KRB5_CALLCONV
2872 krb5_kt_next_entry(krb5_context context, krb5_keytab keytab,
2873 krb5_keytab_entry *entry, krb5_kt_cursor *cursor);
2876 * Release a keytab cursor.
2878 * @param [in] context Library context
2879 * @param [in] keytab Key table handle
2880 * @param [out] cursor Cursor
2882 * This function should be called to release the cursor created by
2883 * krb5_kt_start_seq_get().
2888 * Kerberos error codes
2890 krb5_error_code KRB5_CALLCONV
2891 krb5_kt_end_seq_get(krb5_context context, krb5_keytab keytab,
2892 krb5_kt_cursor *cursor);
2899 * begin "func-proto.h"
2902 #define KRB5_INIT_CONTEXT_SECURE 0x1 /**< Use secure context configuration */
2903 #define KRB5_INIT_CONTEXT_KDC 0x2 /**< Use KDC configuration if available */
2906 * Create a krb5 library context.
2908 * @param [out] context Library context
2910 * The @a context must be released by calling krb5_free_context() when
2911 * it is no longer needed.
2913 * @warning Any program or module that needs the Kerberos code to not trust the
2914 * environment must use krb5_init_secure_context(), or clean out the
2920 * Kerberos error codes
2922 krb5_error_code KRB5_CALLCONV
2923 krb5_init_context(krb5_context *context);
2926 * Create a krb5 library context using only configuration files.
2928 * @param [out] context Library context
2930 * Create a context structure, using only system configuration files. All
2931 * information passed through the environment variables is ignored.
2933 * The @a context must be released by calling krb5_free_context() when
2934 * it is no longer needed.
2939 * Kerberos error codes
2941 krb5_error_code KRB5_CALLCONV
2942 krb5_init_secure_context(krb5_context *context);
2945 * Create a krb5 library context using a specified profile.
2947 * @param [in] profile Profile object (NULL to create default profile)
2948 * @param [in] flags Context initialization flags
2949 * @param [out] context Library context
2951 * Create a context structure, optionally using a specified profile and
2952 * initialization flags. If @a profile is NULL, the default profile will be
2953 * created from config files. If @a profile is non-null, a copy of it will be
2954 * made for the new context; the caller should still clean up its copy. Valid
2957 * @li #KRB5_INIT_CONTEXT_SECURE Ignore environment variables
2958 * @li #KRB5_INIT_CONTEXT_KDC Use KDC configuration if creating profile
2960 krb5_error_code KRB5_CALLCONV
2961 krb5_init_context_profile(struct _profile_t *profile, krb5_flags flags,
2962 krb5_context *context);
2965 * Free a krb5 library context.
2967 * @param [in] context Library context
2969 * This function frees a @a context that was created by krb5_init_context()
2970 * or krb5_init_secure_context().
2973 krb5_free_context(krb5_context context);
2976 * Copy a krb5_context structure.
2978 * @param [in] ctx Library context
2979 * @param [out] nctx_out New context structure
2981 * The newly created context must be released by calling krb5_free_context()
2982 * when it is no longer needed.
2987 * Kerberos error codes
2989 krb5_error_code KRB5_CALLCONV
2990 krb5_copy_context(krb5_context ctx, krb5_context *nctx_out);
2993 * Set default TGS encryption types in a krb5_context structure.
2995 * @param [in,out] context Library context
2996 * @param [in] etypes Encryption type(s) to set
2998 * This function sets the default enctype list for TGS requests
2999 * made using @a context to @a etypes.
3001 * @note This overrides the default list (from config file or built-in).
3006 * KRB5_PROG_ETYPE_NOSUPP Program lacks support for encryption type
3008 * Kerberos error codes
3010 krb5_error_code KRB5_CALLCONV
3011 krb5_set_default_tgs_enctypes(krb5_context context, const krb5_enctype *etypes);
3014 * Return a list of encryption types permitted for session keys.
3016 * @param [in] context Library context
3017 * @param [out] ktypes Zero-terminated list of encryption types
3019 * This function returns the list of encryption types permitted for session
3020 * keys within @a context, as determined by configuration or by a previous call
3021 * to krb5_set_default_tgs_enctypes().
3023 * @retval 0 Success; otherwise - Kerberos error codes
3025 krb5_error_code KRB5_CALLCONV
3026 krb5_get_permitted_enctypes(krb5_context context, krb5_enctype **ktypes);
3029 * Test whether the Kerberos library was built with multithread support.
3032 * TRUE if the library is threadsafe; FALSE otherwise
3034 krb5_boolean KRB5_CALLCONV
3035 krb5_is_thread_safe(void);
3040 * Decrypt a ticket using the specified key table.
3042 * @param [in] context Library context
3043 * @param [in] kt Key table
3044 * @param [in,out] ticket Ticket to be decrypted
3046 * This function takes a @a ticket as input and decrypts it using
3047 * key data from @a kt. The result is placed into @a ticket->enc_part2.
3049 * @retval 0 Success; otherwise - Kerberos error codes
3051 krb5_error_code KRB5_CALLCONV
3052 krb5_server_decrypt_ticket_keytab(krb5_context context, const krb5_keytab kt,
3053 krb5_ticket *ticket);
3056 * Free an array of credential structures.
3058 * @param [in] context Library context
3059 * @param [in] tgts Null-terminated array of credentials to free
3061 * @note The last entry in the array @a tgts must be a NULL pointer.
3064 krb5_free_tgt_creds(krb5_context context, krb5_creds **tgts);
3066 /** @defgroup KRB5_GC KRB5_GC
3069 #define KRB5_GC_USER_USER 1 /**< Want user-user ticket */
3070 #define KRB5_GC_CACHED 2 /**< Want cached ticket only */
3071 #define KRB5_GC_CANONICALIZE 4 /**< Set canonicalize KDC option */
3072 #define KRB5_GC_NO_STORE 8 /**< Do not store in credential cache */
3073 #define KRB5_GC_FORWARDABLE 16 /**< Acquire forwardable tickets */
3074 #define KRB5_GC_NO_TRANSIT_CHECK 32 /**< Disable transited check */
3075 #define KRB5_GC_CONSTRAINED_DELEGATION 64 /**< Constrained delegation */
3076 /** @} */ /* end of KRB5_GC group */
3079 * Get an additional ticket.
3081 * @param [in] context Library context
3082 * @param [in] options Options
3083 * @param [in,out] ccache Credential cache handle
3084 * @param [in] in_creds Input credentials
3085 * @param [out] out_creds Output updated credentials
3087 * Use @a ccache or a TGS exchange to get a service ticket matching @a
3090 * Valid values for @a options are:
3091 * @li #KRB5_GC_CACHED Search only credential cache for the ticket
3092 * @li #KRB5_GC_USER_USER Return a user to user authentication ticket
3094 * @a in_creds must be non-null. @a in_creds->client and @a in_creds->server
3095 * must be filled in to specify the client and the server respectively. If any
3096 * authorization data needs to be requested for the service ticket (such as
3097 * restrictions on how the ticket can be used), specify it in @a
3098 * in_creds->authdata; otherwise set @a in_creds->authdata to NULL. The
3099 * session key type is specified in @a in_creds->keyblock.enctype, if it is
3102 * The expiration date is specified in @a in_creds->times.endtime.
3103 * The KDC may return tickets with an earlier expiration date.
3104 * If @a in_creds->times.endtime is set to 0, the latest possible
3105 * expiration date will be requested.
3107 * Any returned ticket and intermediate ticket-granting tickets are stored
3110 * Use krb5_free_creds() to free @a out_creds when it is no longer needed.
3115 * Kerberos error codes
3117 krb5_error_code KRB5_CALLCONV
3118 krb5_get_credentials(krb5_context context, krb5_flags options,
3119 krb5_ccache ccache, krb5_creds *in_creds,
3120 krb5_creds **out_creds);
3122 /** @deprecated Replaced by krb5_get_validated_creds. */
3123 krb5_error_code KRB5_CALLCONV
3124 krb5_get_credentials_validate(krb5_context context, krb5_flags options,
3125 krb5_ccache ccache, krb5_creds *in_creds,
3126 krb5_creds **out_creds);
3128 /** @deprecated Replaced by krb5_get_renewed_creds. */
3129 krb5_error_code KRB5_CALLCONV
3130 krb5_get_credentials_renew(krb5_context context, krb5_flags options,
3131 krb5_ccache ccache, krb5_creds *in_creds,
3132 krb5_creds **out_creds);
3135 * Create a @c KRB_AP_REQ message.
3137 * @param [in] context Library context
3138 * @param [in,out] auth_context Pre-existing or newly created auth context
3139 * @param [in] ap_req_options @ref AP_OPTS options
3140 * @param [in] service Service name, or NULL to use @c "host"
3141 * @param [in] hostname Host name, or NULL to use local hostname
3142 * @param [in] in_data Application data to be checksummed in the
3143 * authenticator, or NULL
3144 * @param [in] ccache Credential cache used to obtain credentials
3145 * for the desired service.
3146 * @param [out] outbuf @c AP-REQ message
3148 * This function is similar to krb5_mk_req_extended() except that it uses a
3149 * given @a hostname, @a service, and @a ccache to construct a service
3150 * principal name and obtain credentials.
3152 * Use krb5_free_data_contents() to free @a outbuf when it is no longer needed.
3154 * @retval 0 Success; otherwise - Kerberos error codes
3156 krb5_error_code KRB5_CALLCONV
3157 krb5_mk_req(krb5_context context, krb5_auth_context *auth_context,
3158 krb5_flags ap_req_options, char *service, char *hostname,
3159 krb5_data *in_data, krb5_ccache ccache, krb5_data *outbuf);
3162 * Create a @c KRB_AP_REQ message using supplied credentials.
3164 * @param [in] context Library context
3165 * @param [in,out] auth_context Pre-existing or newly created auth context
3166 * @param [in] ap_req_options @ref AP_OPTS options
3167 * @param [in] in_data Application data to be checksummed in the
3168 * authenticator, or NULL
3169 * @param [in] in_creds Credentials for the service with valid ticket
3171 * @param [out] outbuf @c AP-REQ message
3173 * Valid @a ap_req_options are:
3174 * @li #AP_OPTS_USE_SESSION_KEY - Use the session key when creating the
3175 * request used for user to user
3177 * @li #AP_OPTS_MUTUAL_REQUIRED - Request a mutual authentication packet from
3179 * @li #AP_OPTS_USE_SUBKEY - Generate a subsession key from the current
3180 * session key obtained from the credentials.
3182 * This function creates a KRB_AP_REQ message using supplied credentials @a
3183 * in_creds. @a auth_context may point to an existing auth context or to NULL,
3184 * in which case a new one will be created. If @a in_data is non-null, a
3185 * checksum of it will be included in the authenticator contained in the
3186 * KRB_AP_REQ message. Use krb5_free_data_contents() to free @a outbuf when it
3187 * is no longer needed.
3189 * On successful return, the authenticator is stored in @a auth_context with
3190 * the @a client and @a checksum fields nulled out. (This is to prevent
3191 * pointer-sharing problems; the caller should not need these fields anyway,
3192 * since the caller supplied them.)
3196 * @retval 0 Success; otherwise - Kerberos error codes
3198 krb5_error_code KRB5_CALLCONV
3199 krb5_mk_req_extended(krb5_context context, krb5_auth_context *auth_context,
3200 krb5_flags ap_req_options, krb5_data *in_data,
3201 krb5_creds *in_creds, krb5_data *outbuf);
3204 * Format and encrypt a @c KRB_AP_REP message.
3206 * @param [in] context Library context
3207 * @param [in,out] auth_context Authentication context
3208 * @param [out] outbuf @c AP-REP message
3210 * This function fills in @a outbuf with an AP-REP message using information
3211 * from @a auth_context.
3213 * If the flags in @a auth_context indicate that a sequence number should be
3214 * used (either #KRB5_AUTH_CONTEXT_DO_SEQUENCE or
3215 * #KRB5_AUTH_CONTEXT_RET_SEQUENCE) and the local sequence number in @a
3216 * auth_context is 0, a new number will be generated with
3217 * krb5_generate_seq_number().
3219 * Use krb5_free_data_contents() to free @a outbuf when it is no longer needed.
3221 * @retval 0 Success; otherwise - Kerberos error codes
3223 krb5_error_code KRB5_CALLCONV
3224 krb5_mk_rep(krb5_context context, krb5_auth_context auth_context, krb5_data *outbuf);
3227 * Format and encrypt a @c KRB_AP_REP message for DCE RPC.
3229 * @param [in] context Library context
3230 * @param [in,out] auth_context Authentication context
3231 * @param [out] outbuf @c AP-REP message
3233 * Use krb5_free_data_contents() to free @a outbuf when it is no longer needed.
3235 * @retval 0 Success; otherwise - Kerberos error codes
3237 krb5_error_code KRB5_CALLCONV
3238 krb5_mk_rep_dce(krb5_context context, krb5_auth_context auth_context, krb5_data *outbuf);
3241 * Parse and decrypt a @c KRB_AP_REP message.
3243 * @param [in] context Library context
3244 * @param [in,out] auth_context Authentication context
3245 * @param [in] inbuf AP-REP message
3246 * @param [out] repl Decrypted reply message
3248 * This function parses, decrypts and verifies a message from @a inbuf and
3249 * fills in @a repl with a pointer to allocated memory containing the fields
3250 * from the encrypted response.
3252 * Use krb5_free_ap_rep_enc_part() to free @a repl when it is no longer needed.
3254 * @retval 0 Success; otherwise - Kerberos error codes
3256 krb5_error_code KRB5_CALLCONV
3257 krb5_rd_rep(krb5_context context, krb5_auth_context auth_context,
3258 const krb5_data *inbuf, krb5_ap_rep_enc_part **repl);
3261 * Parse and decrypt a @c KRB_AP_REP message for DCE RPC.
3263 * @param [in] context Library context
3264 * @param [in,out] auth_context Authentication context
3265 * @param [in] inbuf AP-REP message
3266 * @param [out] nonce Sequence number from the decrypted reply
3268 * This function parses, decrypts and verifies a message from @a inbuf and
3269 * fills in @a nonce with a decrypted reply sequence number.
3271 * @retval 0 Success; otherwise - Kerberos error codes
3273 krb5_error_code KRB5_CALLCONV
3274 krb5_rd_rep_dce(krb5_context context, krb5_auth_context auth_context,
3275 const krb5_data *inbuf, krb5_ui_4 *nonce);
3278 * Format and encode a @c KRB_ERROR message.
3280 * @param [in] context Library context
3281 * @param [in] dec_err Error structure to be encoded
3282 * @param [out] enc_err Encoded error structure
3284 * This function creates a @c KRB_ERROR message in @a enc_err. Use
3285 * krb5_free_data_contents() to free @a enc_err when it is no longer needed.
3287 * @retval 0 Success; otherwise - Kerberos error codes
3289 krb5_error_code KRB5_CALLCONV
3290 krb5_mk_error(krb5_context context, const krb5_error *dec_err,
3291 krb5_data *enc_err);
3294 * Decode a @c KRB-ERROR message.
3296 * @param [in] context Library context
3297 * @param [in] enc_errbuf Encoded error message
3298 * @param [out] dec_error Decoded error message
3300 * This function processes @c KRB-ERROR message @a enc_errbuf and returns
3301 * an allocated structure @a dec_error containing the error message.
3302 * Use krb5_free_error() to free @a dec_error when it is no longer needed.
3304 * @retval 0 Success; otherwise - Kerberos error codes
3306 krb5_error_code KRB5_CALLCONV
3307 krb5_rd_error(krb5_context context, const krb5_data *enc_errbuf,
3308 krb5_error **dec_error);
3311 * Process @c KRB-SAFE message.
3313 * @param [in] context Library context
3314 * @param [in,out] auth_context Authentication structure
3315 * @param [in] inbuf @c KRB-SAFE message to be parsed
3316 * @param [out] outbuf Data parsed from @c KRB-SAFE message
3317 * @param [out] outdata Replay data. Specify NULL if not needed
3319 * This function parses a @c KRB-SAFE message, verifies its integrity, and
3320 * stores its data into @a outbuf.
3322 * @note The @a outdata argument is required if #KRB5_AUTH_CONTEXT_RET_TIME or
3323 * #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in the @a auth_context.
3325 * @note @a auth_context must have a remote address set. This address will be
3326 * used to verify the sender address in the KRB-SAFE message. If @a
3327 * auth_context has a local address set, it will be used to verify the
3328 * receiver address in the KRB-SAFE message if the message contains one.
3329 * Both addresses must use type @c ADDRTYPE_ADDRPORT.
3331 * If the #KRB5_AUTH_CONTEXT_DO_SEQUENCE flag is set in @a auth_context, the
3332 * sequence number of the KRB-SAFE message is checked against the remote
3333 * sequence number field of @a auth_context. Otherwise, the sequence number is
3336 * If the #KRB5_AUTH_CONTEXT_DO_TIME flag is set in @a auth_context,
3337 * then two additional checks are performed:
3338 * @li The timestamp in the message must be within the permitted clock skew
3339 * (which is usually five minutes).
3340 * @li The message must not be a replayed message field in @a auth_context.
3342 * Use krb5_free_data_contents() to free @a outbuf when it is no longer needed.
3344 * @retval 0 Success; otherwise - Kerberos error codes
3346 krb5_error_code KRB5_CALLCONV
3347 krb5_rd_safe(krb5_context context, krb5_auth_context auth_context,
3348 const krb5_data *inbuf, krb5_data *outbuf,
3349 krb5_replay_data *outdata);
3352 * Process a @c KRB-PRIV message.
3354 * @param [in] context Library context
3355 * @param [in,out] auth_context Authentication structure
3356 * @param [in] inbuf @c KRB-PRIV message to be parsed
3357 * @param [out] outbuf Data parsed from @c KRB-PRIV message
3358 * @param [out] outdata Replay data. Specify NULL if not needed
3360 * This function parses a @c KRB-PRIV message, verifies its integrity, and
3361 * stores its unencrypted data into @a outbuf.
3363 * @note If the #KRB5_AUTH_CONTEXT_RET_TIME or @c
3364 * #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in @a auth_context, @a
3365 * outdata is required.
3367 * @note @a auth_context must have a remote address set. This address will be
3368 * used to verify the sender address in the KRB-PRIV message. If @a
3369 * auth_context has a local address set, it will be used to verify the
3370 * receiver address in the KRB-PRIV message if the message contains one.
3371 * Both addresses must use type @c ADDRTYPE_ADDRPORT.
3373 * If the #KRB5_AUTH_CONTEXT_DO_SEQUENCE flag is set in @a auth_context, the
3374 * sequence number of the KRB-SAFE message is checked against the remote
3375 * sequence number field of @a auth_context. Otherwise, the sequence number is
3378 * If the #KRB5_AUTH_CONTEXT_DO_TIME flag is set in @a auth_context,
3379 * then two additional checks are performed:
3380 * @li The timestamp in the message must be within the permitted clock skew
3381 * (which is usually five minutes).
3382 * @li The message must not be a replayed message field in @a auth_context.
3384 * @retval 0 Success; otherwise - Kerberos error codes
3386 krb5_error_code KRB5_CALLCONV
3387 krb5_rd_priv(krb5_context context, krb5_auth_context auth_context,
3388 const krb5_data *inbuf, krb5_data *outbuf,
3389 krb5_replay_data *outdata);
3392 * Convert a string principal name to a krb5_principal structure.
3394 * @param [in] context Library context
3395 * @param [in] name String representation of a principal name
3396 * @param [out] nprincipal Principal
3398 * Convert a string representation of a principal name to a krb5_principal
3401 * A string representation of a Kerberos name consists of one or more principal
3402 * name components, separated by slashes, optionally followed by the \@
3403 * character and a realm name. If the realm name is not specified, the local
3406 * To use the slash and \@ symbols as part of a component (quoted) instead of
3407 * using them as a component separator or as a realm prefix), put a backslash
3408 * (\) character in front of the symbol. Similarly, newline, tab, backspace,
3409 * and NULL characters can be included in a component by using @c n, @c t, @c b
3410 * or @c 0, respectively.
3412 * @note The realm in a Kerberos @a name cannot contain slash, colon,
3413 * or NULL characters.
3415 * Use krb5_free_principal() to free @a nprincipal when it is no longer needed.
3420 * Kerberos error codes
3422 krb5_error_code KRB5_CALLCONV
3423 krb5_parse_name(krb5_context context, const char *name, krb5_principal *nprincipal);
3425 #define KRB5_PRINCIPAL_PARSE_NO_REALM 0x1 /**< Error if realm is present */
3426 #define KRB5_PRINCIPAL_PARSE_REQUIRE_REALM 0x2 /**< Error if realm is not present */
3427 #define KRB5_PRINCIPAL_PARSE_ENTERPRISE 0x4 /**< Create single-component
3428 enterprise principle */
3431 * Convert a string principal name to a krb5_principal with flags
3433 * @param [in] context Library context
3434 * @param [in] name String representation of a principal name
3435 * @param [in] flags Flag
3436 * @param [out] nprincipal Principal
3438 * Similar to krb5_parse_name(), this function converts a single-string
3439 * representation of a principal name to a krb5_principal structure.
3441 * The following flags are valid:
3442 * @li #KRB5_PRINCIPAL_PARSE_NO_REALM - no realm must be present in @a name
3443 * @li #KRB5_PRINCIPAL_PARSE_REQUIRE_REALM - realm must be present in @a name
3444 * @li #KRB5_PRINCIPAL_PARSE_ENTERPRISE - create single-component enterprise
3447 * Use krb5_free_principal() to free @a nprincipal when it is no longer needed.
3452 * Kerberos error codes
3454 krb5_error_code KRB5_CALLCONV
3455 krb5_parse_name_flags(krb5_context context, const char *name,
3456 int flags, krb5_principal *nprincipal);
3459 * Convert a krb5_principal structure to a string representation.
3461 * @param [in] context Library context
3462 * @param [in] principal Principal
3463 * @param [out] name String representation of principal name
3465 * The resulting string representation uses the format and quoting conventions
3466 * described for krb5_parse_name().
3468 * Use krb5_free_unparsed_name() to free @a name when it is no longer needed.
3473 * Kerberos error codes
3475 krb5_error_code KRB5_CALLCONV
3476 krb5_unparse_name(krb5_context context, krb5_const_principal principal,
3477 register char **name);
3480 * Convert krb5_principal structure to string and length.
3482 * @param [in] context Library context
3483 * @param [in] principal Principal
3484 * @param [out] name String representation of principal name
3485 * @param [out] size Size of unparsed name
3487 * This function is similar to krb5_unparse_name(), but also returns the length
3488 * of the string representation.
3493 * Kerberos error codes. On failure @a name is set to NULL
3495 krb5_error_code KRB5_CALLCONV
3496 krb5_unparse_name_ext(krb5_context context, krb5_const_principal principal,
3497 char **name, unsigned int *size);
3499 #define KRB5_PRINCIPAL_UNPARSE_SHORT 0x1 /**< Omit realm if it is the local realm */
3500 #define KRB5_PRINCIPAL_UNPARSE_NO_REALM 0x2 /**< Omit realm always */
3501 #define KRB5_PRINCIPAL_UNPARSE_DISPLAY 0x4 /**< Don't escape special characters */
3504 * Convert krb5_principal structure to a string with flags.
3506 * @param [in] context Library context
3507 * @param [in] principal Principal
3508 * @param [in] flags Flags
3509 * @param [out] name String representation of principal name
3511 * Similar to krb5_unparse_name(), this function converts a krb5_principal
3512 * structure to a string representation.
3514 * The following flags are valid:
3515 * @li #KRB5_PRINCIPAL_UNPARSE_SHORT - omit realm if it is the local realm
3516 * @li #KRB5_PRINCIPAL_UNPARSE_NO_REALM - omit realm
3517 * @li #KRB5_PRINCIPAL_UNPARSE_DISPLAY - do not quote special characters
3519 * Use krb5_free_unparsed_name() to free @a name when it is no longer needed.
3524 * Kerberos error codes. On failure @a name is set to NULL
3526 krb5_error_code KRB5_CALLCONV
3527 krb5_unparse_name_flags(krb5_context context, krb5_const_principal principal,
3528 int flags, char **name);
3531 * Convert krb5_principal structure to string format with flags.
3533 * @param [in] context Library context
3534 * @param [in] principal Principal
3535 * @param [in] flags Flags
3536 * @param [out] name Single string format of principal name
3537 * @param [out] size Size of unparsed name buffer
3539 * @sa krb5_unparse_name() krb5_unparse_name_flags() krb5_unparse_name_ext()
3544 * Kerberos error codes. On failure @a name is set to NULL
3546 krb5_error_code KRB5_CALLCONV
3547 krb5_unparse_name_flags_ext(krb5_context context, krb5_const_principal principal,
3548 int flags, char **name, unsigned int *size);
3551 * Set the realm field of a principal
3553 * @param [in,out] context Library context
3554 * @param [in] principal Principal name
3555 * @param [in] realm Realm name
3557 * Set the realm name part of @a principal to @a realm, overwriting the
3563 * Kerberos error codes
3565 krb5_error_code KRB5_CALLCONV
3566 krb5_set_principal_realm(krb5_context context, krb5_principal principal,
3570 * Search a list of addresses for a specified address.
3572 * @param [in] context Library context
3573 * @param [in] addr Address to search for
3574 * @param [in] addrlist Address list to be searched (or NULL)
3576 * @note If @a addrlist contains only a NetBIOS addresses, it will be treated
3580 * TRUE if @a addr is listed in @a addrlist, or @c addrlist is NULL; FALSE
3583 krb5_boolean KRB5_CALLCONV_WRONG
3584 krb5_address_search(krb5_context context, const krb5_address *addr,
3585 krb5_address *const *addrlist);
3588 * Compare two Kerberos addresses.
3590 * @param [in] context Library context
3591 * @param [in] addr1 First address to be compared
3592 * @param [in] addr2 Second address to be compared
3595 * TRUE if the addresses are the same, FALSE otherwise
3597 krb5_boolean KRB5_CALLCONV
3598 krb5_address_compare(krb5_context context, const krb5_address *addr1,
3599 const krb5_address *addr2);
3602 * Return an ordering of the specified addresses.
3604 * @param [in] context Library context
3605 * @param [in] addr1 First address
3606 * @param [in] addr2 Second address
3609 * 0 The two addresses are the same
3611 * \< 0 First address is less than second
3613 * \> 0 First address is greater than second
3616 krb5_address_order(krb5_context context, const krb5_address *addr1,
3617 const krb5_address *addr2);
3620 * Compare the realms of two principals.
3622 * @param [in] context Library context
3623 * @param [in] princ1 First principal
3624 * @param [in] princ2 Second principal
3627 * TRUE if the realm names are the same; FALSE otherwise
3629 krb5_boolean KRB5_CALLCONV
3630 krb5_realm_compare(krb5_context context, krb5_const_principal princ1,
3631 krb5_const_principal princ2);
3634 * Compare two principals.
3636 * @param [in] context Library context
3637 * @param [in] princ1 First principal
3638 * @param [in] princ2 Second principal
3641 * TRUE if the principals are the same; FALSE otherwise
3643 krb5_boolean KRB5_CALLCONV
3644 krb5_principal_compare(krb5_context context,
3645 krb5_const_principal princ1,
3646 krb5_const_principal princ2);
3649 * Compare two principals ignoring realm components.
3651 * @param [in] context Library context
3652 * @param [in] princ1 First principal
3653 * @param [in] princ2 Second principal
3655 * Similar to krb5_principal_compare(), but do not compare the realm
3656 * components of the principals.
3659 * TRUE if the principals are the same; FALSE otherwise
3661 krb5_boolean KRB5_CALLCONV
3662 krb5_principal_compare_any_realm(krb5_context context,
3663 krb5_const_principal princ1,
3664 krb5_const_principal princ2);
3666 #define KRB5_PRINCIPAL_COMPARE_IGNORE_REALM 1 /**< ignore realm component */
3667 #define KRB5_PRINCIPAL_COMPARE_ENTERPRISE 2 /**< UPNs as real principals */
3668 #define KRB5_PRINCIPAL_COMPARE_CASEFOLD 4 /**< case-insensitive */
3669 #define KRB5_PRINCIPAL_COMPARE_UTF8 8 /**< treat principals as UTF-8 */
3672 * Compare two principals with additional flags.
3674 * @param [in] context Library context
3675 * @param [in] princ1 First principal
3676 * @param [in] princ2 Second principal
3677 * @param [in] flags Flags
3680 * @li #KRB5_PRINCIPAL_COMPARE_IGNORE_REALM - ignore realm component
3681 * @li #KRB5_PRINCIPAL_COMPARE_ENTERPRISE - UPNs as real principals
3682 * @li #KRB5_PRINCIPAL_COMPARE_CASEFOLD case-insensitive
3683 * @li #KRB5_PRINCIPAL_COMPARE_UTF8 - treat principals as UTF-8
3685 * @sa krb5_principal_compare()
3688 * TRUE if the principal names are the same; FALSE otherwise
3690 krb5_boolean KRB5_CALLCONV
3691 krb5_principal_compare_flags(krb5_context context,
3692 krb5_const_principal princ1,
3693 krb5_const_principal princ2,
3697 * Initialize an empty @c krb5_keyblock.
3699 * @param [in] context Library context
3700 * @param [in] enctype Encryption type
3701 * @param [in] length Length of keyblock (or 0)
3702 * @param [out] out New keyblock structure
3704 * Initialize a new keyblock and allocate storage for the contents of the key.
3705 * It is legal to pass in a length of 0, in which case contents are left
3706 * unallocated. Use krb5_free_keyblock() to free @a out when it is no longer
3709 * @note If @a length is set to 0, contents are left unallocated.
3711 * @retval 0 Success; otherwise - Kerberos error codes
3713 krb5_error_code KRB5_CALLCONV
3714 krb5_init_keyblock(krb5_context context, krb5_enctype enctype,
3715 size_t length, krb5_keyblock **out);
3720 * @param [in] context Library context
3721 * @param [in] from Keyblock to be copied
3722 * @param [out] to Copy of keyblock @a from
3724 * This function creates a new keyblock with the same contents as @a from. Use
3725 * krb5_free_keyblock() to free @a to when it is no longer needed.
3727 * @retval 0 Success; otherwise - Kerberos error codes
3729 krb5_error_code KRB5_CALLCONV
3730 krb5_copy_keyblock(krb5_context context, const krb5_keyblock *from,
3731 krb5_keyblock **to);
3734 * Copy the contents of a keyblock.
3736 * @param [in] context Library context
3737 * @param [in] from Key to be copied
3738 * @param [out] to Output key
3740 * This function copies the contents of @a from to @a to. Use
3741 * krb5_free_keyblock_contents() to free @a to when it is no longer needed.
3743 * @retval 0 Success; otherwise - Kerberos error codes
3745 krb5_error_code KRB5_CALLCONV
3746 krb5_copy_keyblock_contents(krb5_context context, const krb5_keyblock *from,
3750 * Copy a krb5_creds structure.
3752 * @param [in] context Library context
3753 * @param [in] incred Credentials structure to be copied
3754 * @param [out] outcred Copy of @a incred
3756 * This function creates a new credential with the contents of @a incred. Use
3757 * krb5_free_creds() to free @a outcred when it is no longer needed.
3759 * @retval 0 Success; otherwise - Kerberos error codes
3761 krb5_error_code KRB5_CALLCONV
3762 krb5_copy_creds(krb5_context context, const krb5_creds *incred, krb5_creds **outcred);
3765 * Copy a krb5_data object.
3767 * @param [in] context Library context
3768 * @param [in] indata Data object to be copied
3769 * @param [out] outdata Copy of @a indata
3771 * This function creates a new krb5_data object with the contents of @a indata.
3772 * Use krb5_free_data() to free @a outdata when it is no longer needed.
3774 * @retval 0 Success; otherwise - Kerberos error codes
3776 krb5_error_code KRB5_CALLCONV
3777 krb5_copy_data(krb5_context context, const krb5_data *indata, krb5_data **outdata);
3782 * @param [in] context Library context
3783 * @param [in] inprinc Principal to be copied
3784 * @param [out] outprinc Copy of @a inprinc
3786 * This function creates a new principal structure with the contents of @a
3787 * inprinc. Use krb5_free_principal() to free @a outprinc when it is no longer
3790 * @retval 0 Success; otherwise - Kerberos error codes
3792 krb5_error_code KRB5_CALLCONV
3793 krb5_copy_principal(krb5_context context, krb5_const_principal inprinc,
3794 krb5_principal *outprinc);
3797 * Copy an array of addresses.
3799 * @param [in] context Library context
3800 * @param [in] inaddr Array of addresses to be copied
3801 * @param [out] outaddr Copy of array of addresses
3803 * This function creates a new address array containing a copy of @a inaddr.
3804 * Use krb5_free_addresses() to free @a outaddr when it is no longer needed.
3806 * @retval 0 Success; otherwise - Kerberos error codes
3808 krb5_error_code KRB5_CALLCONV
3809 krb5_copy_addresses(krb5_context context, krb5_address *const *inaddr,
3810 krb5_address ***outaddr);
3813 * Copy a krb5_ticket structure.
3815 * @param [in] context Library context
3816 * @param [in] from Ticket to be copied
3817 * @param [out] pto Copy of ticket
3819 * This function creates a new krb5_ticket structure containing the contents of
3820 * @a from. Use krb5_free_ticket() to free @a pto when it is no longer needed.
3822 * @retval 0 Success; otherwise - Kerberos error codes
3824 krb5_error_code KRB5_CALLCONV
3825 krb5_copy_ticket(krb5_context context, const krb5_ticket *from, krb5_ticket **pto);
3828 * Copy an authorization data list.
3830 * @param [in] context Library context
3831 * @param [in] in_authdat List of @a krb5_authdata structures
3832 * @param [out] out New array of @a krb5_authdata structures
3834 * This function creates a new authorization data list containing a copy of @a
3835 * in_authdat, which must be null-terminated. Use krb5_free_authdata() to free
3836 * @a out when it is no longer needed.
3838 * @note The last array entry in @a in_authdat must be a NULL pointer.
3840 * @retval 0 Success; otherwise - Kerberos error codes
3842 krb5_error_code KRB5_CALLCONV
3843 krb5_copy_authdata(krb5_context context,
3844 krb5_authdata *const *in_authdat, krb5_authdata ***out);
3847 * Find authorization data elements.
3849 * @param [in] context Library context
3850 * @param [in] ticket_authdata Authorization data list from ticket
3851 * @param [in] ap_req_authdata Authorization data list from AP request
3852 * @param [in] ad_type Authorization data type to find
3853 * @param [out] results List of matching entries
3855 * This function searches @a ticket_authdata and @a ap_req_authdata for
3856 * elements of type @a ad_type. Either input list may be NULL, in which case
3857 * it will not be searched; otherwise, the input lists must be terminated by
3858 * NULL entries. This function will search inside AD-IF-RELEVANT containers if
3859 * found in either list. Use krb5_free_authdata() to free @a results when it
3860 * is no longer needed.
3862 krb5_error_code KRB5_CALLCONV
3863 krb5_find_authdata(krb5_context context, krb5_authdata *const *ticket_authdata,
3864 krb5_authdata *const *ap_req_authdata,
3865 krb5_authdatatype ad_type, krb5_authdata ***results);
3868 * Merge two authorization data lists into a new list.
3870 * @param [in] context Library context
3871 * @param [in] inauthdat1 First list of @a krb5_authdata structures
3872 * @param [in] inauthdat2 Second list of @a krb5_authdata structures
3873 * @param [out] outauthdat Merged list of @a krb5_authdata structures
3875 * Merge two authdata arrays, such as the array from a ticket
3876 * and authenticator.
3877 * Use krb5_free_authdata() to free @a outauthdat when it is no longer needed.
3879 * @note The last array entry in @a inauthdat1 and @a inauthdat2
3880 * must be a NULL pointer.
3882 * @retval 0 Success; otherwise - Kerberos error codes
3884 krb5_error_code KRB5_CALLCONV
3885 krb5_merge_authdata(krb5_context context,
3886 krb5_authdata *const *inauthdat1,
3887 krb5_authdata * const *inauthdat2,
3888 krb5_authdata ***outauthdat);
3891 * Copy a krb5_authenticator structure.
3893 * @param [in] context Library context
3894 * @param [in] authfrom krb5_authenticator structure to be copied
3895 * @param [out] authto Copy of krb5_authenticator structure
3897 * This function creates a new krb5_authenticator structure with the content of
3898 * @a authfrom. Use krb5_free_authenticator() to free @a authto when it is no
3901 * @retval 0 Success; otherwise - Kerberos error codes
3903 krb5_error_code KRB5_CALLCONV
3904 krb5_copy_authenticator(krb5_context context, const krb5_authenticator *authfrom,
3905 krb5_authenticator **authto);
3908 * Copy a krb5_checksum structure.
3910 * @param [in] context Library context
3911 * @param [in] ckfrom Checksum to be copied
3912 * @param [out] ckto Copy of krb5_checksum structure
3914 * This function creates a new krb5_checksum structure with the contents of @a
3915 * ckfrom. Use krb5_free_checksum() to free @a ckto when it is no longer
3918 * @retval 0 Success; otherwise - Kerberos error codes
3920 krb5_error_code KRB5_CALLCONV
3921 krb5_copy_checksum(krb5_context context, const krb5_checksum *ckfrom,
3922 krb5_checksum **ckto);
3925 * Generate a replay cache object for server use and open it.
3927 * @param [in] context Library context
3928 * @param [in] piece Unique identifier for replay cache
3929 * @param [out] rcptr Handle to an open rcache
3931 * This function generates a replay cache name based on @a piece and opens a
3932 * handle to it. Typically @a piece is the first component of the service
3933 * principal name. Use krb5_rc_close() to close @a rcptr when it is no longer
3936 * @retval 0 Success; otherwise - Kerberos error codes
3938 krb5_error_code KRB5_CALLCONV
3939 krb5_get_server_rcache(krb5_context context, const krb5_data *piece,
3940 krb5_rcache *rcptr);
3943 * Build a principal name using length-counted strings.
3945 * @param [in] context Library context
3946 * @param [out] princ Principal name
3947 * @param [in] rlen Realm name length
3948 * @param [in] realm Realm name
3949 * @param [in] ... List of unsigned int/char * components, followed by 0
3951 * This function creates a principal from a length-counted string and a
3952 * variable-length list of length-counted components. The list of components
3953 * ends with the first 0 length argument (so it is not possible to specify an
3954 * empty component with this function). Call krb5_free_principal() to free
3955 * allocated memory for principal when it is no longer needed.
3958 * Example of how to build principal WELLKNOWN/ANONYMOUS@R
3959 * krb5_build_principal_ext(context, &principal, strlen("R"), "R",
3960 * (unsigned int)strlen(KRB5_WELLKNOWN_NAMESTR),
3961 * KRB5_WELLKNOWN_NAMESTR,
3962 * (unsigned int)strlen(KRB5_ANONYMOUS_PRINCSTR),
3963 * KRB5_ANONYMOUS_PRINCSTR, 0);
3969 * Kerberos error codes
3971 krb5_error_code KRB5_CALLCONV_C
3972 krb5_build_principal_ext(krb5_context context, krb5_principal * princ,
3973 unsigned int rlen, const char * realm, ...);
3976 * Build a principal name using null-terminated strings.
3978 * @param [in] context Library context
3979 * @param [out] princ Principal name
3980 * @param [in] rlen Realm name length
3981 * @param [in] realm Realm name
3982 * @param [in] ... List of char * components, ending with NULL
3984 * Call krb5_free_principal() to free @a princ when it is no longer needed.
3986 * @note krb5_build_principal() and krb5_build_principal_alloc_va() perform the
3987 * same task. krb5_build_principal() takes variadic arguments.
3988 * krb5_build_principal_alloc_va() takes a pre-computed @a varargs pointer.
3991 * Example of how to build principal H/S@R
3992 * krb5_build_principal(context, &principal,
3993 * strlen("R"), "R", "H", "S", (char*)NULL);
3999 * Kerberos error codes
4001 krb5_error_code KRB5_CALLCONV_C
4002 krb5_build_principal(krb5_context context,
4003 krb5_principal * princ,
4005 const char * realm, ...)
4007 __attribute__ ((sentinel))
4011 /** @deprecated Replaced by krb5_build_principal_alloc_va(). */
4012 KRB5_ATTR_DEPRECATED krb5_error_code KRB5_CALLCONV
4013 krb5_build_principal_va(krb5_context context,
4014 krb5_principal princ,
4021 * Build a principal name, using a precomputed variable argument list
4023 * @param [in] context Library context
4024 * @param [out] princ Principal structure
4025 * @param [in] rlen Realm name length
4026 * @param [in] realm Realm name
4027 * @param [in] ap List of char * components, ending with NULL
4029 * Similar to krb5_build_principal(), this function builds a principal name,
4030 * but its name components are specified as a va_list.
4032 * Use krb5_free_principal() to deallocate @a princ when it is no longer
4036 * Function usage example:
4038 * va_start(ap, realm);
4039 * krb5_build_principal_alloc_va(context, princ, rlen, realm, ap);
4046 * Kerberos error codes
4048 krb5_error_code KRB5_CALLCONV
4049 krb5_build_principal_alloc_va(krb5_context context,
4050 krb5_principal *princ,
4056 * Convert a Kerberos V4 principal to a Kerberos V5 principal.
4058 * @param [in] context Library context
4059 * @param [in] name V4 name
4060 * @param [in] instance V4 instance
4061 * @param [in] realm Realm
4062 * @param [out] princ V5 principal
4064 * This function builds a @a princ from V4 specification based on given input
4065 * @a name.instance\@realm.
4067 * Use krb5_free_principal() to free @a princ when it is no longer needed.
4069 * @retval 0 Success; otherwise - Kerberos error codes
4071 krb5_error_code KRB5_CALLCONV
4072 krb5_425_conv_principal(krb5_context context, const char *name,
4073 const char *instance, const char *realm,
4074 krb5_principal *princ);
4077 * Convert a Kerberos V5 principal to a Kerberos V4 principal.
4079 * @param [in] context Library context
4080 * @param [in] princ V5 Principal
4081 * @param [out] name V4 principal's name to be filled in
4082 * @param [out] inst V4 principal's instance name to be filled in
4083 * @param [out] realm Principal's realm name to be filled in
4085 * This function separates a V5 principal @a princ into @a name, @a instance,
4091 * KRB5_INVALID_PRINCIPAL Invalid principal name
4093 * KRB5_CONFIG_CANTOPEN Can't open or find Kerberos configuration file
4095 * Kerberos error codes
4097 krb5_error_code KRB5_CALLCONV
4098 krb5_524_conv_principal(krb5_context context, krb5_const_principal princ,
4099 char *name, char *inst, char *realm);
4106 * Convert a Kerberos V5 credentials to a Kerberos V4 credentials
4108 * @note Not implemented
4110 * @retval KRB524_KRB4_DISABLED (always)
4113 krb5_524_convert_creds(krb5_context context, krb5_creds *v5creds,
4114 struct credentials *v4creds);
4117 #define krb524_convert_creds_kdc krb5_524_convert_creds
4118 #define krb524_init_ets(x) (0)
4124 * Get a handle for a key table.
4126 * @param [in] context Library context
4127 * @param [in] name Name of the key table
4128 * @param [out] ktid Key table handle
4130 * Resolve the key table name @a name and fill in a handle identifying the key
4131 * table. The key table is not opened.
4133 * @note @a name must be of the form @c type:residual, where @a type must be a
4134 * type known to the library and @a residual portion should be specific to the
4135 * particular keytab type.
4137 * @sa krb5_kt_close()
4140 * Example: krb5_kt_resolve(context, "FILE:/tmp/filename",&ktid);
4146 * Kerberos error codes
4148 krb5_error_code KRB5_CALLCONV
4149 krb5_kt_resolve(krb5_context context, const char *name, krb5_keytab *ktid);
4152 * Get default key table name.
4154 * @param [in] context Library context
4155 * @param [in,out] name Key table name to be resolved
4156 * @param [in] name_size Size of @a name to return
4158 * Fill @a name with the first @a name_size bytes of the name of the default
4159 * key table for the current user.
4161 * @sa MAX_KEYTAB_NAME_LEN
4166 * KRB5_CONFIG_NOTENUFSPACE Buffer is too short
4168 * Kerberos error codes
4170 krb5_error_code KRB5_CALLCONV
4171 krb5_kt_default_name(krb5_context context, char *name, int name_size);
4174 * Resolve default key table.
4176 * @param [in] context Library context
4177 * @param [in,out] id Key table handle
4179 * Fill @a keytab with the default key table's @a handle.
4184 * Kerberos error codes
4186 krb5_error_code KRB5_CALLCONV
4187 krb5_kt_default(krb5_context context, krb5_keytab *id);
4190 * Free the contents of a key table entry.
4192 * @param [in] context Library context
4193 * @param [in] entry Key table entry whose contents are to be freed
4195 * @note The pointer is not freed.
4197 * @retval 0 Success; otherwise - Kerberos error codes
4199 krb5_error_code KRB5_CALLCONV
4200 krb5_free_keytab_entry_contents(krb5_context context, krb5_keytab_entry *entry);
4202 /** @deprecated Use krb5_free_keytab_entry_contents instead. */
4203 krb5_error_code KRB5_CALLCONV
4204 krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *entry);
4207 /* remove and add are functions, so that they can return NOWRITE
4208 if not a writable keytab */
4211 * Remove an entry from a key table.
4213 * @param [in] context Library context
4214 * @param [in] id Key table handle
4215 * @param [in] entry Entry to remove from key table
4220 * KRB5_KT_NOWRITE Key table is not writable
4222 * Kerberos error codes
4224 krb5_error_code KRB5_CALLCONV
4225 krb5_kt_remove_entry(krb5_context context, krb5_keytab id, krb5_keytab_entry *entry);
4228 * Add a new entry to a key table.
4230 * @param [in] context Library context
4231 * @param [in] id Key table handle
4232 * @param [in] entry Entry to be added
4237 * ENOMEM Insufficient memory
4239 * KRB5_KT_NOWRITE Key table is not writeable
4241 * Kerberos error codes
4243 krb5_error_code KRB5_CALLCONV
4244 krb5_kt_add_entry(krb5_context context, krb5_keytab id, krb5_keytab_entry *entry);
4247 * Convert a principal name into the default salt for that principal.
4249 * @param [in] context Library context
4250 * @param [in] pr Principal name
4251 * @param [out] ret Default salt for @a pr to be filled in
4253 * @retval 0 Success; otherwise - Kerberos error codes
4255 krb5_error_code KRB5_CALLCONV_WRONG
4256 krb5_principal2salt(krb5_context context,
4257 register krb5_const_principal pr, krb5_data *ret);
4258 /* librc.spec--see rcache.h */
4263 * Resolve a credential cache name.
4265 * @param [in] context Library context
4266 * @param [in] name Credential cache name to be resolved
4267 * @param [out] cache Credential cache handle
4269 * Fills in @a cache with a @a cache handle that corresponds to the name in @a
4270 * name. @a name should be of the form @c type:residual, and @a type must be a
4271 * type known to the library. If the @a name does not contain a colon,
4272 * interpret it as a file name.
4275 * Example: krb5_cc_resolve(context, "MEMORY:C_", &cache);
4281 * Kerberos error codes
4283 krb5_error_code KRB5_CALLCONV
4284 krb5_cc_resolve(krb5_context context, const char *name, krb5_ccache *cache);
4287 * Duplicate ccache handle.
4289 * @param [in] context Library context
4290 * @param [in] in Credential cache handle to be duplicated
4291 * @param [out] out Credential cache handle
4293 * Create a new handle referring to the same cache as @a in.
4294 * The new handle and @a in can be closed independently.
4296 krb5_error_code KRB5_CALLCONV
4297 krb5_cc_dup(krb5_context context, krb5_ccache in, krb5_ccache *out);
4300 * Return the name of the default credential cache.
4302 * @param [in] context Library context
4304 * Try the environment variable @a KRB5CCNAME first then, if it is not set,
4305 * fall back on the default ccache name for the OS.
4308 * Name of default credential cache for the current user.
4310 const char *KRB5_CALLCONV
4311 krb5_cc_default_name(krb5_context context);
4314 * Set the default credential cache name.
4316 * @param [in,out] context Library context
4317 * @param [in] name Default credential cache name
4319 * This function frees the old default credential cache name and then sets it
4325 * KV5M_CONTEXT Bad magic number for @c _krb5_context structure
4327 * Kerberos error codes
4329 krb5_error_code KRB5_CALLCONV
4330 krb5_cc_set_default_name(krb5_context context, const char *name);
4333 * Resolve the default crendentials cache name.
4335 * @param [in,out] context Library context
4336 * @param [out] ccache Pointer to credential cache name
4341 * KV5M_CONTEXT Bad magic number for @c _krb5_context structure
4343 * KRB5_FCC_INTERNAL The name of the default credential cache cannot be
4346 * Kerberos error codes
4348 krb5_error_code KRB5_CALLCONV
4349 krb5_cc_default(krb5_context context, krb5_ccache *ccache);
4352 * Copy a credential cache.
4354 * @param [in] context Library context
4355 * @param [in] incc Credential cache to be copied
4356 * @param [out] outcc Copy of credential cache to be filled in
4358 * @retval 0 Success; otherwise - Kerberos error codes
4360 krb5_error_code KRB5_CALLCONV
4361 krb5_cc_copy_creds(krb5_context context, krb5_ccache incc, krb5_ccache outcc);
4364 * Get a configuration value from a credential cache.
4366 * @param [in] context Library context
4367 * @param [in] id Credential cache handle
4368 * @param [in] principal Configuration for this principal;
4369 * if NULL, global for the whole cache
4370 * @param [in] key Name of config variable
4371 * @param [out] data Data to be fetched
4373 * Use krb5_free_data_contents() to free @a data when it is no longer needed.
4378 * Kerberos error codes
4380 krb5_error_code KRB5_CALLCONV
4381 krb5_cc_get_config(krb5_context context, krb5_ccache id,
4382 krb5_const_principal principal,
4383 const char *key, krb5_data *data);
4386 * Store a configuration value in a credential cache.
4388 * @param [in] context Library context
4389 * @param [in] id Credential cache handle
4390 * @param [in] principal Configuration for a specific principal;
4391 * if NULL, global for the whole cache
4392 * @param [in] key Name of config variable
4393 * @param [in] data Data to store, or NULL to remove
4395 * @note Existing configuration under the same key is over-written.
4397 * @warning Before version 1.10 @a data was assumed to be always non-null.
4402 * Kerberos error codes
4404 krb5_error_code KRB5_CALLCONV
4405 krb5_cc_set_config(krb5_context context, krb5_ccache id,
4406 krb5_const_principal principal,
4407 const char *key, krb5_data *data);
4410 * Test whether a principal is a configuration principal.
4412 * @param [in] context Library context
4413 * @param [in] principal Principal to check
4416 * @c TRUE if the principal is a configuration principal (generated part of
4417 * krb5_cc_set_config()); @c FALSE otherwise.
4419 krb5_boolean KRB5_CALLCONV
4420 krb5_is_config_principal(krb5_context context, krb5_const_principal principal);
4423 * Make a credential cache the primary cache for its collection.
4425 * @param [in] context Library context
4426 * @param [in] cache Credential cache handle
4428 * If the type of @a cache supports it, set @a cache to be the primary
4429 * credential cache for the collection it belongs to.
4432 * 0 Success, or the type of @a cache doesn't support switching
4434 * Kerberos error codes
4436 krb5_error_code KRB5_CALLCONV
4437 krb5_cc_switch(krb5_context context, krb5_ccache cache);
4440 * Determine whether a credential cache type supports switching.
4442 * @param [in] context Library context
4443 * @param [in] type Credential cache type
4445 * @retval TRUE if @a type supports switching
4446 * @retval FALSE if it does not or is not a valid credential cache type.
4448 krb5_boolean KRB5_CALLCONV
4449 krb5_cc_support_switch(krb5_context context, const char *type);
4452 * Find a credential cache with a specified client principal.
4454 * @param [in] context Library context
4455 * @param [in] client Client principal
4456 * @param [out] cache_out Credential cache handle
4458 * Find a cache within the collection whose default principal is @a client.
4459 * Use @a krb5_cc_close to close @a ccache when it is no longer needed.
4462 * @retval KRB5_CC_NOTFOUND
4464 * @sa krb5_cccol_cursor_new
4466 krb5_error_code KRB5_CALLCONV
4467 krb5_cc_cache_match(krb5_context context, krb5_principal client,
4468 krb5_ccache *cache_out);
4471 * Select a credential cache to use with a server principal.
4473 * @param [in] context Library context
4474 * @param [in] server Server principal
4475 * @param [out] cache_out Credential cache handle
4476 * @param [out] princ_out Client principal
4478 * Select a cache within the collection containing credentials most appropriate
4479 * for use with @a server, according to configured rules and heuristics.
4481 * Use krb5_cc_close() to release @a cache_out when it is no longer needed.
4482 * Use krb5_free_principal() to release @a princ_out when it is no longer
4483 * needed. Note that @a princ_out is set in some error conditions.
4486 * If an appropriate cache is found, 0 is returned, @a cache_out is set to the
4487 * selected cache, and @a princ_out is set to the default principal of that
4490 * If the appropriate client principal can be authoritatively determined but
4491 * the cache collection contains no credentials for that principal, then
4492 * KRB5_CC_NOTFOUND is returned, @a cache_out is set to NULL, and @a princ_out
4493 * is set to the appropriate client principal.
4495 * If no configured mechanism can determine the appropriate cache or principal,
4496 * KRB5_CC_NOTFOUND is returned and @a cache_out and @a princ_out are set to
4499 * Any other error code indicates a fatal error in the processing of a cache
4500 * selection mechanism.
4502 krb5_error_code KRB5_CALLCONV
4503 krb5_cc_select(krb5_context context, krb5_principal server,
4504 krb5_ccache *cache_out, krb5_principal *princ_out);
4508 * Free the storage assigned to a principal.
4510 * @param [in] context Library context
4511 * @param [in] val Principal to be freed
4514 krb5_free_principal(krb5_context context, krb5_principal val);
4517 * Free a krb5_authenticator structure.
4519 * @param [in] context Library context
4520 * @param [in] val Authenticator structure to be freed
4522 * This function frees the contents of @a val and the structure itself.
4525 krb5_free_authenticator(krb5_context context, krb5_authenticator *val);
4528 * Free the data stored in array of addresses.
4530 * @param [in] context Library context
4531 * @param [in] val Array of addresses to be freed
4533 * This function frees the contents of @a val and the array itself.
4535 * @note The last entry in the array must be a NULL pointer.
4538 krb5_free_addresses(krb5_context context, krb5_address **val);
4541 * Free the storage assigned to array of authentication data.
4543 * @param [in] context Library context
4544 * @param [in] val Array of authentication data to be freed
4546 * This function frees the contents of @a val and the array itself.
4548 * @note The last entry in the array must be a NULL pointer.
4551 krb5_free_authdata(krb5_context context, krb5_authdata **val);
4556 * @param [in] context Library context
4557 * @param [in] val Ticket to be freed
4559 * This function frees the contents of @a val and the structure itself.
4562 krb5_free_ticket(krb5_context context, krb5_ticket *val);
4565 * Free an error allocated by krb5_read_error() or krb5_sendauth().
4567 * @param [in] context Library context
4568 * @param [in] val Error data structure to be freed
4570 * This function frees the contents of @a val and the structure itself.
4573 krb5_free_error(krb5_context context, register krb5_error *val);
4576 * Free a krb5_creds structure.
4578 * @param [in] context Library context
4579 * @param [in] val Credential structure to be freed.
4581 * This function frees the contents of @a val and the structure itself.
4584 krb5_free_creds(krb5_context context, krb5_creds *val);
4587 * Free the contents of a krb5_creds structure.
4589 * @param [in] context Library context
4590 * @param [in] val Credential structure to free contents of
4592 * This function frees the contents of @a val, but not the structure itself.
4595 krb5_free_cred_contents(krb5_context context, krb5_creds *val);
4598 * Free a krb5_checksum structure.
4600 * @param [in] context Library context
4601 * @param [in] val Checksum structure to be freed
4603 * This function frees the contents of @a val and the structure itself.
4606 krb5_free_checksum(krb5_context context, register krb5_checksum *val);
4609 * Free the contents of a krb5_checksum structure.
4611 * @param [in] context Library context
4612 * @param [in] val Checksum structure to free contents of
4614 * This function frees the contents of @a val, but not the structure itself.
4617 krb5_free_checksum_contents(krb5_context context, register krb5_checksum *val);
4620 * Free a krb5_keyblock structure.
4622 * @param [in] context Library context
4623 * @param [in] val Keyblock to be freed
4625 * This function frees the contents of @a val and the structure itself.
4628 krb5_free_keyblock(krb5_context context, register krb5_keyblock *val);
4631 * Free the contents of a krb5_keyblock structure.
4633 * @param [in] context Library context
4634 * @param [in] key Keyblock to be freed
4636 * This function frees the contents of @a key, but not the structure itself.
4639 krb5_free_keyblock_contents(krb5_context context, register krb5_keyblock *key);
4642 * Free a krb5_ap_rep_enc_part structure.
4644 * @param [in] context Library context
4645 * @param [in] val AP-REP enc part to be freed
4647 * This function frees the contents of @a val and the structure itself.
4650 krb5_free_ap_rep_enc_part(krb5_context context, krb5_ap_rep_enc_part *val);
4653 * Free a krb5_data structure.
4655 * @param [in] context Library context
4656 * @param [in] val Data structure to be freed
4658 * This function frees the contents of @a val and the structure itself.
4661 krb5_free_data(krb5_context context, krb5_data *val);
4664 * Free storage associated with a @c krb5_octet_data structure and its pointer.
4666 * @param [in] context Context structure
4667 * @param [in] val Data structure to be freed
4673 krb5_free_octet_data(krb5_context context, krb5_octet_data *val);
4676 * Free the contents of a krb5_data structure and zero the data field.
4678 * @param [in] context Library context
4679 * @param [in] val Data structure to free contents of
4681 * This function frees the contents of @a val, but not the structure itself.
4684 krb5_free_data_contents(krb5_context context, krb5_data *val);
4687 * Free a string representation of a principal.
4689 * @param [in] context Library context
4690 * @param [in] val Name string to be freed
4693 krb5_free_unparsed_name(krb5_context context, char *val);
4696 * Free a string allocated by a krb5 function.
4698 * @param [in] context Library context
4699 * @param [in] val String to be freed
4702 krb5_free_string(krb5_context context, char *val);
4705 * Free an array of checksum types.
4707 * @param [in] context Library context
4708 * @param [in] val Array of checksum types to be freed
4711 krb5_free_cksumtypes(krb5_context context, krb5_cksumtype *val);
4713 /* From krb5/os, but needed by the outside world */
4715 * Retrieve the system time of day, in sec and ms, since the epoch.
4717 * @param [in] context Library context
4718 * @param [out] seconds System timeofday, seconds portion
4719 * @param [out] microseconds System timeofday, microseconds portion
4721 * This function retrieves the system time of day with the context
4722 * specific time offset adjustment.
4724 * @sa krb5_crypto_us_timeofday()
4729 * Kerberos error codes
4731 krb5_error_code KRB5_CALLCONV
4732 krb5_us_timeofday(krb5_context context,
4733 krb5_timestamp *seconds, krb5_int32 *microseconds);
4736 * Retrieve the current time with context specific time offset adjustment.
4738 * @param [in] context Library context
4739 * @param [in,out] timeret Timestamp to fill in
4741 * This function retrieves the system time of day with the context specific
4742 * time offset adjustment.
4747 * Kerberos error codes
4749 krb5_error_code KRB5_CALLCONV
4750 krb5_timeofday(krb5_context context, register krb5_timestamp *timeret);
4753 * Check if a timestamp is within the allowed clock skew of the current time.
4755 * @param [in] context Library context
4756 * @param [in] date Timestamp to check
4758 * This function checks if @a date is close enough to the current time
4759 * according to the configured allowable clock skew.
4762 * @retval KRB5KRB_AP_ERR_SKEW @a date is not within allowable clock skew
4764 krb5_error_code KRB5_CALLCONV
4765 krb5_check_clockskew(krb5_context context, krb5_timestamp date);
4768 * Return all interface addresses for this host.
4770 * @param [in] context Library context
4771 * @param [out] addr Array of krb5_address pointers, ending with
4774 * Use krb5_free_addresses() to free @a addr when it is no longer needed.
4776 * @retval 0 Success; otherwise - Kerberos error codes
4778 krb5_error_code KRB5_CALLCONV
4779 krb5_os_localaddr(krb5_context context, krb5_address ***addr);
4782 * Retrieve the default realm.
4784 * @param [in] context Library context
4785 * @param [out] lrealm Default realm name
4787 * Retrieves the default realm to be used if no user-specified realm is
4790 * Use krb5_free_default_realm() to free @a lrealm when it is no longer needed.
4795 * Kerberos error codes
4797 krb5_error_code KRB5_CALLCONV
4798 krb5_get_default_realm(krb5_context context, char **lrealm);
4801 * Override the default realm for the specified context.
4803 * @param [in] context Library context
4804 * @param [in] lrealm Realm name for the default realm
4806 * If @a lrealm is NULL, clear the default realm setting.
4811 * Kerberos error codes
4813 krb5_error_code KRB5_CALLCONV
4814 krb5_set_default_realm(krb5_context context, const char *lrealm);
4817 * Free a default realm string returned by krb5_get_default_realm().
4819 * @param [in] context Library context
4820 * @param [in] lrealm Realm to be freed
4823 krb5_free_default_realm(krb5_context context, char *lrealm);
4826 * Generate a full principal name from a service name.
4828 * @param [in] context Library context
4829 * @param [in] hostname Host name, or NULL to use local host
4830 * @param [in] sname Service name, or NULL to use @c "host"
4831 * @param [in] type Principal type
4832 * @param [out] ret_princ Generated principal
4834 * This function converts a @a hostname and @a sname into @a krb5_principal
4835 * structure @a ret_princ. The returned principal will be of the form @a
4836 * sname\/hostname\@REALM where REALM is determined by krb5_get_host_realm().
4837 * In some cases this may be the referral (empty) realm.
4839 * The @a type can be one of the following:
4841 * @li #KRB5_NT_SRV_HOST canonicalizes the host name before looking up the
4842 * realm and generating the principal.
4844 * @li #KRB5_NT_UNKNOWN accepts the hostname as given, and does not
4847 * Use krb5_free_principal to free @a ret_princ when it is no longer needed.
4852 * Kerberos error codes
4854 krb5_error_code KRB5_CALLCONV
4855 krb5_sname_to_principal(krb5_context context, const char *hostname, const char *sname,
4856 krb5_int32 type, krb5_principal *ret_princ);
4859 * Test whether a principal matches a matching principal.
4861 * @param [in] context Library context
4862 * @param [in] matching Matching principal
4863 * @param [in] princ Principal to test
4865 * @note A matching principal is a host-based principal with an empty realm
4866 * and/or second data component (hostname). Profile configuration may cause
4867 * the hostname to be ignored even if it is present. A principal matches a
4868 * matching principal if the former has the same non-empty (and non-ignored)
4869 * components of the latter.
4871 * If @a matching is NULL, return TRUE. If @a matching is not a matching
4872 * principal, return the value of krb5_principal_compare(context, matching,
4876 * TRUE if @a princ matches @a matching, FALSE otherwise.
4878 krb5_boolean KRB5_CALLCONV
4879 krb5_sname_match(krb5_context context, krb5_const_principal matching,
4880 krb5_const_principal princ);
4883 * Change a password for an existing Kerberos account.
4885 * @param [in] context Library context
4886 * @param [in] creds Credentials for kadmin/changepw service
4887 * @param [in] newpw New password
4888 * @param [out] result_code Numeric error code from server
4889 * @param [out] result_code_string String equivalent to @a result_code
4890 * @param [out] result_string Change password response from the KDC
4892 * Change the password for the existing principal identified by @a creds.
4894 * The possible values of the output @a result_code are:
4896 * @li #KRB5_KPASSWD_SUCCESS (0) - success
4897 * @li #KRB5_KPASSWD_MALFORMED (1) - Malformed request error
4898 * @li #KRB5_KPASSWD_HARDERROR (2) - Server error
4899 * @li #KRB5_KPASSWD_AUTHERROR (3) - Authentication error
4900 * @li #KRB5_KPASSWD_SOFTERROR (4) - Password change rejected
4902 * @retval 0 Success; otherwise - Kerberos error codes
4904 krb5_error_code KRB5_CALLCONV
4905 krb5_change_password(krb5_context context, krb5_creds *creds, char *newpw,
4906 int *result_code, krb5_data *result_code_string,
4907 krb5_data *result_string);
4910 * Set a password for a principal using specified credentials.
4912 * @param [in] context Library context
4913 * @param [in] creds Credentials for kadmin/changepw service
4914 * @param [in] newpw New password
4915 * @param [in] change_password_for Change the password for this principal
4916 * @param [out] result_code Numeric error code from server
4917 * @param [out] result_code_string String equivalent to @a result_code
4918 * @param [out] result_string Data returned from the remote system
4920 * This function uses the credentials @a creds to set the password @a newpw for
4921 * the principal @a change_password_for. It implements the set password
4922 * operation of RFC 3244, for interoperability with Microsoft Windows
4925 * @note If @a change_password_for is NULL, the change is performed on the
4926 * current principal. If @a change_password_for is non-null, the change is
4927 * performed on the principal name passed in @a change_password_for.
4929 * The error code and strings are returned in @a result_code,
4930 * @a result_code_string and @a result_string.
4932 * @sa krb5_set_password_using_ccache()
4935 * 0 Success and result_code is set to #KRB5_KPASSWD_SUCCESS.
4937 * Kerberos error codes.
4939 krb5_error_code KRB5_CALLCONV
4940 krb5_set_password(krb5_context context, krb5_creds *creds, char *newpw,
4941 krb5_principal change_password_for, int *result_code,
4942 krb5_data *result_code_string, krb5_data *result_string);
4945 * Set a password for a principal using cached credentials.
4947 * @param [in] context Library context
4948 * @param [in] ccache Credential cache
4949 * @param [in] newpw New password
4950 * @param [in] change_password_for Change the password for this principal
4951 * @param [out] result_code Numeric error code from server
4952 * @param [out] result_code_string String equivalent to @a result_code
4953 * @param [out] result_string Data returned from the remote system
4955 * This function uses the cached credentials from @a ccache to set the password
4956 * @a newpw for the principal @a change_password_for. It implements RFC 3244
4957 * set password operation (interoperable with MS Windows implementations) using
4958 * the credential cache.
4960 * The error code and strings are returned in @a result_code,
4961 * @a result_code_string and @a result_string.
4963 * @note If @a change_password_for is set to NULL, the change is performed on
4964 * the default principal in @a ccache. If @a change_password_for is non null,
4965 * the change is performed on the specified principal.
4967 * @sa krb5_set_password()
4972 * Kerberos error codes
4974 krb5_error_code KRB5_CALLCONV
4975 krb5_set_password_using_ccache(krb5_context context, krb5_ccache ccache,
4976 char *newpw, krb5_principal change_password_for,
4977 int *result_code, krb5_data *result_code_string,
4978 krb5_data *result_string);
4981 * Retrieve configuration profile from the context.
4983 * @param [in] context Library context
4984 * @param [out] profile Pointer to data read from a configuration file
4986 * This function creates a new @a profile object that reflects profile
4987 * in the supplied @a context.
4989 * The @a profile object may be freed with profile_release() function.
4990 * See profile.h and profile API for more details.
4995 * Kerberos error codes
4997 krb5_error_code KRB5_CALLCONV
4998 krb5_get_profile(krb5_context context, struct _profile_t ** profile);
5001 /** @deprecated Replaced by krb5_get_init_creds_password().*/
5002 KRB5_ATTR_DEPRECATED krb5_error_code KRB5_CALLCONV
5003 krb5_get_in_tkt_with_password(krb5_context context, krb5_flags options,
5004 krb5_address *const *addrs, krb5_enctype *ktypes,
5005 krb5_preauthtype *pre_auth_types,
5006 const char *password, krb5_ccache ccache,
5007 krb5_creds *creds, krb5_kdc_rep **ret_as_reply);
5009 /** @deprecated Replaced by krb5_get_init_creds(). */
5010 KRB5_ATTR_DEPRECATED krb5_error_code KRB5_CALLCONV
5011 krb5_get_in_tkt_with_skey(krb5_context context, krb5_flags options,
5012 krb5_address *const *addrs, krb5_enctype *ktypes,
5013 krb5_preauthtype *pre_auth_types,
5014 const krb5_keyblock *key, krb5_ccache ccache,
5015 krb5_creds *creds, krb5_kdc_rep **ret_as_reply);
5017 /** @deprecated Replaced by krb5_get_init_creds_keytab(). */
5018 KRB5_ATTR_DEPRECATED krb5_error_code KRB5_CALLCONV
5019 krb5_get_in_tkt_with_keytab(krb5_context context, krb5_flags options,
5020 krb5_address *const *addrs, krb5_enctype *ktypes,
5021 krb5_preauthtype *pre_auth_types,
5022 krb5_keytab arg_keytab, krb5_ccache ccache,
5023 krb5_creds *creds, krb5_kdc_rep **ret_as_reply);
5025 #endif /* KRB5_DEPRECATED */
5028 * Parse and decrypt a @c KRB_AP_REQ message.
5030 * @param [in] context Library context
5031 * @param [in,out] auth_context Pre-existing or newly created auth context
5032 * @param [in] inbuf AP-REQ message to be parsed
5033 * @param [in] server Matching principal for server, or NULL to
5034 * allow any principal in keytab
5035 * @param [in] keytab Key table, or NULL to use the default
5036 * @param [out] ap_req_options If non-null, the AP-REQ flags on output
5037 * @param [out] ticket If non-null, ticket from the AP-REQ message
5039 * This function parses, decrypts and verifies a AP-REQ message from @a inbuf
5040 * and stores the authenticator in @a auth_context.
5042 * If a keyblock is present in the @a auth_context, it is used to decrypt the
5043 * ticket in AP-REQ message. (This is useful for user-to-user authentication.)
5044 * Otherwise, the decryption key is obtained from the @a keytab. If @a keytab
5045 * is iterable, all of its key entries it will be tried against the ticket;
5046 * otherwise, the server principal in the ticket will be looked up in the
5047 * keytab and that key will be tried.
5049 * The client specified in the decrypted authenticator must match the client
5050 * specified in the decrypted ticket. If @a server is non-null, the key in
5051 * which the ticket is encrypted must correspond to a principal in @a keytab
5052 * matching @a server according to the rules of krb5_sname_match().
5054 * If the @a remote_addr field of @a auth_context is set, the request must come
5055 * from that address.
5057 * If a replay cache handle is provided in the @a auth_context, the
5058 * authenticator and ticket are verified against it. If no conflict is found,
5059 * the new authenticator is then stored in the replay cash of @a auth_context.
5061 * Various other checks are performed on the decoded data, including
5062 * cross-realm policy, clockskew, and ticket validation times.
5064 * On success the authenticator, subkey, and remote sequence number of the
5065 * request are stored in @a auth_context. If the #AP_OPTS_MUTUAL_REQUIRED
5066 * bit is set, the local sequence number is XORed with the remote sequence
5067 * number in the request.
5069 * Use krb5_free_ticket() to free @a ticket when it is no longer needed.
5071 * @retval 0 Success; otherwise - Kerberos error codes
5073 krb5_error_code KRB5_CALLCONV
5074 krb5_rd_req(krb5_context context, krb5_auth_context *auth_context,
5075 const krb5_data *inbuf, krb5_const_principal server,
5076 krb5_keytab keytab, krb5_flags *ap_req_options,
5077 krb5_ticket **ticket);
5080 * Retrieve a service key from a key table.
5082 * @param [in] context Library context
5083 * @param [in] keyprocarg Name of a key table (NULL to use default name)
5084 * @param [in] principal Service principal
5085 * @param [in] vno Key version number (0 for highest available)
5086 * @param [in] enctype Encryption type (0 for any type)
5087 * @param [out] key Service key from key table
5089 * Open and search the specified key table for the entry identified by @a
5090 * principal, @a enctype, and @a vno. If no key is found, return an error code.
5092 * The default key table is used, unless @a keyprocarg is non-null.
5093 * @a keyprocarg designates a specific key table.
5095 * Use krb5_free_keyblock() to free @a key when it is no longer needed.
5099 * @return Kerberos error code if not found or @a keyprocarg is invalid.
5101 krb5_error_code KRB5_CALLCONV
5102 krb5_kt_read_service_key(krb5_context context, krb5_pointer keyprocarg,
5103 krb5_principal principal, krb5_kvno vno,
5104 krb5_enctype enctype, krb5_keyblock **key);
5107 * Format a @c KRB-SAFE message.
5109 * @param [in] context Library context
5110 * @param [in,out] auth_context Authentication context
5111 * @param [in] userdata User data in the message
5112 * @param [out] outbuf Formatted @c KRB-SAFE buffer
5113 * @param [out] outdata Replay data. Specify NULL if not needed
5115 * This function creates an integrity protected @c KRB-SAFE message
5116 * using data supplied by the application.
5118 * Fields in @a auth_context specify the checksum type, the keyblock that
5119 * can be used to seed the checksum, full addresses (host and port) for
5120 * the sender and receiver, and @ref KRB5_AUTH_CONTEXT flags.
5122 * The local address in @a auth_context must be set, and is used to form the
5123 * sender address used in the KRB-SAFE message. The remote address is
5124 * optional; if specified, it will be used to form the receiver address used in
5127 * If #KRB5_AUTH_CONTEXT_DO_TIME flag is set in the @a auth_context, an entry
5128 * describing the message is entered in the replay cache @a
5129 * auth_context->rcache which enables the caller to detect if this message is
5130 * reflected by an attacker. If #KRB5_AUTH_CONTEXT_DO_TIME is not set, the
5131 * replay cache is not used.
5133 * If either #KRB5_AUTH_CONTEXT_DO_SEQUENCE or
5134 * #KRB5_AUTH_CONTEXT_RET_SEQUENCE is set, the @a auth_context local sequence
5135 * number will be placed in @a outdata as its sequence number.
5137 * @note The @a outdata argument is required if #KRB5_AUTH_CONTEXT_RET_TIME or
5138 * #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in the @a auth_context.
5140 * Use krb5_free_data_contents() to free @a outbuf when it is no longer needed.
5142 * @retval 0 Success; otherwise - Kerberos error codes
5144 krb5_error_code KRB5_CALLCONV
5145 krb5_mk_safe(krb5_context context, krb5_auth_context auth_context,
5146 const krb5_data *userdata, krb5_data *outbuf,
5147 krb5_replay_data *outdata);
5150 * Format a @c KRB-PRIV message.
5152 * @param [in] context Library context
5153 * @param [in,out] auth_context Authentication context
5154 * @param [in] userdata User data for @c KRB-PRIV message
5155 * @param [out] outbuf Formatted @c KRB-PRIV message
5156 * @param [out] outdata Replay cache handle (NULL if not needed)
5158 * This function is similar to krb5_mk_safe(), but the message is encrypted and
5159 * integrity-protected, not just integrity-protected.
5161 * The local address in @a auth_context must be set, and is used to form the
5162 * sender address used in the KRB-SAFE message. The remote address is
5163 * optional; if specified, it will be used to form the receiver address used in
5166 * @note If the #KRB5_AUTH_CONTEXT_RET_TIME or
5167 * #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in @a auth_context, the @a
5168 * outdata is required.
5170 * @note The flags from @a auth_context specify whether sequence numbers or
5171 * timestamps will be used to identify the message. Valid values are:
5173 * @li #KRB5_AUTH_CONTEXT_DO_TIME - Use timestamps in @a outdata
5174 * @li #KRB5_AUTH_CONTEXT_RET_TIME - Copy timestamp to @a outdata.
5175 * @li #KRB5_AUTH_CONTEXT_DO_SEQUENCE - Use local sequence numbers from
5176 * @a auth_context in replay cache.
5177 * @li #KRB5_AUTH_CONTEXT_RET_SEQUENCE - Use local sequence numbers from
5178 * @a auth_context as a sequence number
5179 * in the encrypted message @a outbuf.
5181 * @retval 0 Success; otherwise - Kerberos error codes
5183 krb5_error_code KRB5_CALLCONV
5184 krb5_mk_priv(krb5_context context, krb5_auth_context auth_context,
5185 const krb5_data *userdata, krb5_data *outbuf,
5186 krb5_replay_data *outdata);
5189 * Client function for @c sendauth protocol.
5191 * @param [in] context Library context
5192 * @param [in,out] auth_context Authentication context
5193 * @param [in] fd File descriptor that describes network socket
5194 * @param [in] appl_version Application protocol version to be matched
5195 * with the receiver's application version
5196 * @param [in] client Client principal
5197 * @param [in] server Server principal
5198 * @param [in] ap_req_options @ref AP_OPTS options
5199 * @param [in] in_data Data to be sent to the server
5200 * @param [in] in_creds Input credentials, or NULL to use @a ccache
5201 * @param [in] ccache Credential cache
5202 * @param [out] error If non-null, contains KRB_ERROR message
5203 * returned from server
5204 * @param [out] rep_result If non-null and @a ap_req_options is
5205 * #AP_OPTS_MUTUAL_REQUIRED, contains the result
5206 * of mutual authentication exchange
5207 * @param [out] out_creds If non-null, the retrieved credentials
5209 * This function performs the client side of a sendauth/recvauth exchange by
5210 * sending and receiving messages over @a fd.
5212 * Credentials may be specified in three ways:
5214 * @li If @a in_creds is NULL, credentials are obtained with
5215 * krb5_get_credentials() using the principals @a client and @a server. @a
5216 * server must be non-null; @a client may NULL to use the default principal of
5219 * @li If @a in_creds is non-null, but does not contain a ticket, credentials
5220 * for the exchange are obtained with krb5_get_credentials() using @a in_creds.
5221 * In this case, the values of @a client and @a server are unused.
5223 * @li If @a in_creds is a complete credentials structure, it used directly.
5224 * In this case, the values of @a client, @a server, and @a ccache are unused.
5226 * If the server is using a different application protocol than that specified
5227 * in @a appl_version, an error will be returned.
5229 * Use krb5_free_creds() to free @a out_creds, krb5_free_ap_rep_enc_part() to
5230 * free @a rep_result, and krb5_free_error() to free @a error when they are no
5233 * @sa krb5_recvauth()
5235 * @retval 0 Success; otherwise - Kerberos error codes
5237 krb5_error_code KRB5_CALLCONV
5238 krb5_sendauth(krb5_context context, krb5_auth_context *auth_context,
5239 krb5_pointer fd, char *appl_version, krb5_principal client,
5240 krb5_principal server, krb5_flags ap_req_options,
5241 krb5_data *in_data, krb5_creds *in_creds, krb5_ccache ccache,
5242 krb5_error **error, krb5_ap_rep_enc_part **rep_result,
5243 krb5_creds **out_creds);
5246 * Server function for @a sendauth protocol.
5248 * @param [in] context Library context
5249 * @param [in,out] auth_context Authentication context
5250 * @param [in] fd File descriptor
5251 * @param [in] appl_version Application protocol version to be matched
5252 * against the client's application version
5253 * @param [in] server Server principal (NULL for any in @a keytab)
5254 * @param [in] flags Additional specifications
5255 * @param [in] keytab Key table containing service keys
5256 * @param [out] ticket Ticket (NULL if not needed)
5258 * This function performs the srever side of a sendauth/recvauth exchange by
5259 * sending and receiving messages over @a fd.
5261 * Use krb5_free_ticket() to free @a ticket when it is no longer needed.
5263 * @sa krb5_sendauth()
5265 * @retval 0 Success; otherwise - Kerberos error codes
5267 krb5_error_code KRB5_CALLCONV
5268 krb5_recvauth(krb5_context context, krb5_auth_context *auth_context,
5269 krb5_pointer fd, char *appl_version, krb5_principal server,
5270 krb5_int32 flags, krb5_keytab keytab, krb5_ticket **ticket);
5273 * Server function for @a sendauth protocol with version parameter.
5275 * @param [in] context Library context
5276 * @param [in,out] auth_context Authentication context
5277 * @param [in] fd File descriptor
5278 * @param [in] server Server principal (NULL for any in @a keytab)
5279 * @param [in] flags Additional specifications
5280 * @param [in] keytab Decryption key
5281 * @param [out] ticket Ticket (NULL if not needed)
5282 * @param [out] version sendauth protocol version (NULL if not needed)
5284 * This function is similar to krb5_recvauth() with the additional output
5285 * information place into @a version.
5287 * @retval 0 Success; otherwise - Kerberos error codes
5289 krb5_error_code KRB5_CALLCONV
5290 krb5_recvauth_version(krb5_context context,
5291 krb5_auth_context *auth_context,
5293 krb5_principal server,
5296 krb5_ticket **ticket,
5297 krb5_data *version);
5300 * Format a @c KRB-CRED message for an array of credentials.
5302 * @param [in] context Library context
5303 * @param [in,out] auth_context Authentication context
5304 * @param [in] ppcreds Null-terminated array of credentials
5305 * @param [out] ppdata Encoded credentials
5306 * @param [out] outdata Replay cache information (NULL if not needed)
5308 * This function takes an array of credentials @a ppcreds and formats
5309 * a @c KRB-CRED message @a ppdata to pass to krb5_rd_cred().
5311 * @note If the #KRB5_AUTH_CONTEXT_RET_TIME or #KRB5_AUTH_CONTEXT_RET_SEQUENCE
5312 * flag is set in @a auth_context, @a outdata is required.
5314 * The message will be encrypted using the send subkey of @a auth_context if it
5315 * is present, or the session key otherwise.
5320 * ENOMEM Insufficient memory
5322 * KRB5_RC_REQUIRED Message replay detection requires @a rcache parameter
5324 * Kerberos error codes
5326 krb5_error_code KRB5_CALLCONV
5327 krb5_mk_ncred(krb5_context context, krb5_auth_context auth_context,
5328 krb5_creds **ppcreds, krb5_data **ppdata,
5329 krb5_replay_data *outdata);
5332 * Format a @c KRB-CRED message for a single set of credentials.
5334 * @param [in] context Library context
5335 * @param [in,out] auth_context Authentication context
5336 * @param [in] pcreds Pointer to credentials
5337 * @param [out] ppdata Encoded credentials
5338 * @param [out] outdata Replay cache data (NULL if not needed)
5340 * This is a convenience function that calls krb5_mk_ncred() with a single set
5346 * ENOMEM Insufficient memory
5348 * KRB5_RC_REQUIRED Message replay detection requires @a rcache parameter
5350 * Kerberos error codes
5352 krb5_error_code KRB5_CALLCONV
5353 krb5_mk_1cred(krb5_context context, krb5_auth_context auth_context,
5354 krb5_creds *pcreds, krb5_data **ppdata,
5355 krb5_replay_data *outdata);
5358 * Read and validate a @c KRB-CRED message.
5360 * @param [in] context Library context
5361 * @param [in,out] auth_context Authentication context
5362 * @param [in] pcreddata @c KRB-CRED message
5363 * @param [out] pppcreds Null-terminated array of forwarded credentials
5364 * @param [out] outdata Replay data (NULL if not needed)
5366 * @note The @a outdata argument is required if #KRB5_AUTH_CONTEXT_RET_TIME or
5367 * #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in the @a auth_context.`
5369 * @a pcreddata will be decrypted using the receiving subkey if it is present
5370 * in @a auth_context, or the session key if the receiving subkey is not
5371 * present or fails to decrypt the message.
5373 * Use krb5_free_tgt_creds() to free @a pppcreds when it is no longer needed.
5375 * @retval 0 Success; otherwise - Kerberos error codes
5377 krb5_error_code KRB5_CALLCONV
5378 krb5_rd_cred(krb5_context context, krb5_auth_context auth_context,
5379 krb5_data *pcreddata, krb5_creds ***pppcreds,
5380 krb5_replay_data *outdata);
5383 * Get a forwarded TGT and format a @c KRB-CRED message.
5385 * @param [in] context Library context
5386 * @param [in] auth_context Authentication context
5387 * @param [in] rhost Remote host
5388 * @param [in] client Client principal of TGT
5389 * @param [in] server Principal of server to receive TGT
5390 * @param [in] cc Credential cache handle (NULL to use default)
5391 * @param [in] forwardable Whether TGT should be forwardable
5392 * @param [out] outbuf KRB-CRED message
5394 * Get a TGT for use at the remote host @a rhost and format it into a KRB-CRED
5395 * message. If @a rhost is NULL and @a server is of type #KRB5_NT_SRV_HST,
5396 * the second component of @a server will be used.
5401 * ENOMEM Insufficient memory
5403 * KRB5_PRINC_NOMATCH Requested principal and ticket do not match
5405 * KRB5_NO_TKT_SUPPLIED Request did not supply a ticket
5407 * KRB5_CC_BADNAME Credential cache name or principal name malformed
5409 * Kerberos error codes
5411 krb5_error_code KRB5_CALLCONV
5412 krb5_fwd_tgt_creds(krb5_context context, krb5_auth_context auth_context,
5413 char *rhost, krb5_principal client, krb5_principal server,
5414 krb5_ccache cc, int forwardable, krb5_data *outbuf);
5417 * Create and initialize an authentication context.
5419 * @param [in] context Library context
5420 * @param [out] auth_context Authentication context
5422 * This function creates an authentication context to hold configuration and
5423 * state relevant to krb5 functions for authenticating principals and
5424 * protecting messages once authentication has occurred.
5426 * By default, flags for the context are set to enable the use of the replay
5427 * cache (#KRB5_AUTH_CONTEXT_DO_TIME), but not sequence numbers. Use
5428 * krb5_auth_con_setflags() to change the flags.
5430 * The allocated @a auth_context must be freed with krb5_auth_con_free() when
5431 * it is no longer needed.
5433 * @retval 0 Success; otherwise - Kerberos error codes
5435 krb5_error_code KRB5_CALLCONV
5436 krb5_auth_con_init(krb5_context context, krb5_auth_context *auth_context);
5439 * Free a krb5_auth_context structure.
5441 * @param [in] context Library context
5442 * @param [in] auth_context Authentication context to be freed
5444 * This function frees an auth context allocated by krb5_auth_con_init().
5446 * @retval 0 (always)
5448 krb5_error_code KRB5_CALLCONV
5449 krb5_auth_con_free(krb5_context context, krb5_auth_context auth_context);
5452 * Set a flags field in a krb5_auth_context structure.
5454 * @param [in] context Library context
5455 * @param [in,out] auth_context Authentication context
5456 * @param [in] flags Flags bit mask
5458 * Valid values for @a flags are:
5459 * @li #KRB5_AUTH_CONTEXT_DO_TIME Use timestamps
5460 * @li #KRB5_AUTH_CONTEXT_RET_TIME Save timestamps
5461 * @li #KRB5_AUTH_CONTEXT_DO_SEQUENCE Use sequence numbers
5462 * @li #KRB5_AUTH_CONTEXT_RET_SEQUENCE Save sequence numbers
5464 * @retval 0 (always)
5466 krb5_error_code KRB5_CALLCONV
5467 krb5_auth_con_setflags(krb5_context context, krb5_auth_context auth_context, krb5_int32 flags);
5470 * Retrieve flags from a krb5_auth_context structure.
5472 * @param [in] context Library context
5473 * @param [in] auth_context Authentication context
5474 * @param [out] flags Flags bit mask
5476 * Valid values for @a flags are:
5477 * @li #KRB5_AUTH_CONTEXT_DO_TIME Use timestamps
5478 * @li #KRB5_AUTH_CONTEXT_RET_TIME Save timestamps
5479 * @li #KRB5_AUTH_CONTEXT_DO_SEQUENCE Use sequence numbers
5480 * @li #KRB5_AUTH_CONTEXT_RET_SEQUENCE Save sequence numbers
5482 * @retval 0 (always)
5484 krb5_error_code KRB5_CALLCONV
5485 krb5_auth_con_getflags(krb5_context context, krb5_auth_context auth_context,
5489 * Set a checksum callback in an auth context.
5491 * @param [in] context Library context
5492 * @param [in] auth_context Authentication context
5493 * @param [in] func Checksum callback
5494 * @param [in] data Callback argument
5496 * Set a callback to obtain checksum data in krb5_mk_req(). The callback will
5497 * be invoked after the subkey and local sequence number are stored in @a
5500 * @retval 0 (always)
5502 krb5_error_code KRB5_CALLCONV
5503 krb5_auth_con_set_checksum_func( krb5_context context,
5504 krb5_auth_context auth_context,
5505 krb5_mk_req_checksum_func func,
5509 * Get the checksum callback from an auth context.
5511 * @param [in] context Library context
5512 * @param [in] auth_context Authentication context
5513 * @param [out] func Checksum callback
5514 * @param [out] data Callback argument
5516 * @retval 0 (always)
5518 krb5_error_code KRB5_CALLCONV
5519 krb5_auth_con_get_checksum_func( krb5_context context,
5520 krb5_auth_context auth_context,
5521 krb5_mk_req_checksum_func *func,
5525 * Set the local and remote addresses in an auth context.
5527 * @param [in] context Library context
5528 * @param [in] auth_context Authentication context
5529 * @param [in] local_addr Local address
5530 * @param [in] remote_addr Remote address
5532 * This function releases the storage assigned to the contents of the local and
5533 * remote addresses of @a auth_context and then sets them to @a local_addr and
5534 * @a remote_addr respectively.
5536 * @sa krb5_auth_con_genaddrs()
5538 * @retval 0 Success; otherwise - Kerberos error codes
5540 krb5_error_code KRB5_CALLCONV_WRONG
5541 krb5_auth_con_setaddrs(krb5_context context, krb5_auth_context auth_context,
5542 krb5_address *local_addr, krb5_address *remote_addr);
5545 * Retrieve address fields from an auth context.
5547 * @param [in] context Library context
5548 * @param [in] auth_context Authentication context
5549 * @param [out] local_addr Local address (NULL if not needed)
5550 * @param [out] remote_addr Remote address (NULL if not needed)
5552 * @retval 0 Success; otherwise - Kerberos error codes
5554 krb5_error_code KRB5_CALLCONV
5555 krb5_auth_con_getaddrs(krb5_context context, krb5_auth_context auth_context,
5556 krb5_address **local_addr, krb5_address **remote_addr);
5559 * Set local and remote port fields in an auth context.
5561 * @param [in] context Library context
5562 * @param [in] auth_context Authentication context
5563 * @param [in] local_port Local port
5564 * @param [in] remote_port Remote port
5566 * This function releases the storage assigned to the contents of the local and
5567 * remote ports of @a auth_context and then sets them to @a local_port and @a
5568 * remote_port respectively.
5570 * @sa krb5_auth_con_genaddrs()
5572 * @retval 0 Success; otherwise - Kerberos error codes
5574 krb5_error_code KRB5_CALLCONV
5575 krb5_auth_con_setports(krb5_context context, krb5_auth_context auth_context,
5576 krb5_address *local_port, krb5_address *remote_port);
5579 * Set the session key in an auth context.
5581 * @param [in] context Library context
5582 * @param [in] auth_context Authentication context
5583 * @param [in] keyblock User key
5585 * @retval 0 Success; otherwise - Kerberos error codes
5587 krb5_error_code KRB5_CALLCONV
5588 krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context,
5589 krb5_keyblock *keyblock);
5592 * Retrieve the session key from an auth context as a keyblock.
5594 * @param [in] context Library context
5595 * @param [in] auth_context Authentication context
5596 * @param [out] keyblock Session key
5598 * This function creates a keyblock containing the session key from @a
5599 * auth_context. Use krb5_free_keyblock() to free @a keyblock when it is no
5602 * @retval 0 Success. Otherwise - Kerberos error codes
5604 krb5_error_code KRB5_CALLCONV
5605 krb5_auth_con_getkey(krb5_context context, krb5_auth_context auth_context,
5606 krb5_keyblock **keyblock);
5609 * Retrieve the session key from an auth context.
5611 * @param [in] context Library context
5612 * @param [in] auth_context Authentication context
5613 * @param [out] key Session key
5615 * This function sets @a key to the session key from @a auth_context. Use
5616 * krb5_k_free_key() to release @a key when it is no longer needed.
5618 * @retval 0 (always)
5620 krb5_error_code KRB5_CALLCONV
5621 krb5_auth_con_getkey_k(krb5_context context, krb5_auth_context auth_context,
5625 * Retrieve the send subkey from an auth context as a keyblock.
5627 * @param [in] ctx Library context
5628 * @param [in] ac Authentication context
5629 * @param [out] keyblock Send subkey
5631 * This function creates a keyblock containing the send subkey from @a
5632 * auth_context. Use krb5_free_keyblock() to free @a keyblock when it is no
5635 * @retval 0 Success; otherwise - Kerberos error codes
5637 krb5_error_code KRB5_CALLCONV
5638 krb5_auth_con_getsendsubkey(krb5_context ctx, krb5_auth_context ac, krb5_keyblock **keyblock);
5641 * Retrieve the send subkey from an auth context.
5643 * @param [in] ctx Library context
5644 * @param [in] ac Authentication context
5645 * @param [out] key Send subkey
5647 * This function sets @a key to the send subkey from @a auth_context. Use
5648 * krb5_k_free_key() to release @a key when it is no longer needed.
5650 * @retval 0 Success; otherwise - Kerberos error codes
5652 krb5_error_code KRB5_CALLCONV
5653 krb5_auth_con_getsendsubkey_k(krb5_context ctx, krb5_auth_context ac,
5657 * Retrieve the receiving subkey from an auth context as a keyblock.
5659 * @param [in] ctx Library context
5660 * @param [in] ac Authentication context
5661 * @param [out] keyblock Receiving subkey
5663 * This function creates a keyblock containing the receiving subkey from @a
5664 * auth_context. Use krb5_free_keyblock() to free @a keyblock when it is no
5667 * @retval 0 Success; otherwise - Kerberos error codes
5669 krb5_error_code KRB5_CALLCONV
5670 krb5_auth_con_getrecvsubkey(krb5_context ctx, krb5_auth_context ac, krb5_keyblock **keyblock);
5673 * Retrieve the receiving subkey from an auth context as a keyblock.
5675 * @param [in] ctx Library context
5676 * @param [in] ac Authentication context
5677 * @param [out] key Receiving subkey
5679 * This function sets @a key to the receiving subkey from @a auth_context. Use
5680 * krb5_k_free_key() to release @a key when it is no longer needed.
5682 * @retval 0 Success; otherwise - Kerberos error codes
5684 krb5_error_code KRB5_CALLCONV
5685 krb5_auth_con_getrecvsubkey_k(krb5_context ctx, krb5_auth_context ac, krb5_key *key);
5688 * Set the send subkey in an auth context with a keyblock.
5690 * @param [in] ctx Library context
5691 * @param [in] ac Authentication context
5692 * @param [in] keyblock Send subkey
5694 * This function sets the send subkey in @a ac to a copy of @a keyblock.
5696 * @retval 0 Success. Otherwise - Kerberos error codes
5698 krb5_error_code KRB5_CALLCONV
5699 krb5_auth_con_setsendsubkey(krb5_context ctx, krb5_auth_context ac,
5700 krb5_keyblock *keyblock);
5703 * Set the send subkey in an auth context.
5705 * @param [in] ctx Library context
5706 * @param [in] ac Authentication context
5707 * @param [out] key Send subkey
5709 * This function sets the send subkey in @a ac to @a key, incrementing its
5712 * @retval 0 Success; otherwise - Kerberos error codes
5714 krb5_error_code KRB5_CALLCONV
5715 krb5_auth_con_setsendsubkey_k(krb5_context ctx, krb5_auth_context ac, krb5_key key);
5718 * Set the receiving subkey in an auth context with a keyblock.
5720 * @param [in] ctx Library context
5721 * @param [in] ac Authentication context
5722 * @param [in] keyblock Receiving subkey
5724 * This function sets the receiving subkey in @a ac to a copy of @a keyblock.
5726 * @retval 0 Success; otherwise - Kerberos error codes
5728 krb5_error_code KRB5_CALLCONV
5729 krb5_auth_con_setrecvsubkey(krb5_context ctx, krb5_auth_context ac,
5730 krb5_keyblock *keyblock);
5733 * Set the receiving subkey in an auth context.
5735 * @param [in] ctx Library context
5736 * @param [in] ac Authentication context
5737 * @param [in] key Receiving subkey
5739 * This function sets the receiving subkey in @a ac to @a key, incrementing its
5742 * @retval 0 Success; otherwise - Kerberos error codes
5744 krb5_error_code KRB5_CALLCONV
5745 krb5_auth_con_setrecvsubkey_k(krb5_context ctx, krb5_auth_context ac,
5749 /** @deprecated Replaced by krb5_auth_con_getsendsubkey(). */
5750 KRB5_ATTR_DEPRECATED krb5_error_code KRB5_CALLCONV
5751 krb5_auth_con_getlocalsubkey(krb5_context context, krb5_auth_context auth_context,
5752 krb5_keyblock **keyblock);
5754 /** @deprecated Replaced by krb5_auth_con_getrecvsubkey(). */
5755 KRB5_ATTR_DEPRECATED krb5_error_code KRB5_CALLCONV
5756 krb5_auth_con_getremotesubkey(krb5_context context, krb5_auth_context auth_context,
5757 krb5_keyblock **keyblock);
5761 * Retrieve the local sequence number from an auth context.
5763 * @param [in] context Library context
5764 * @param [in] auth_context Authentication context
5765 * @param [out] seqnumber Local sequence number
5767 * Retrieve the local sequence number from @a auth_context and return it in @a
5768 * seqnumber. The #KRB5_AUTH_CONTEXT_DO_SEQUENCE flag must be set in @a
5769 * auth_context for this function to be useful.
5771 * @retval 0 Success; otherwise - Kerberos error codes
5773 krb5_error_code KRB5_CALLCONV
5774 krb5_auth_con_getlocalseqnumber(krb5_context context, krb5_auth_context auth_context,
5775 krb5_int32 *seqnumber);
5778 * Retrieve the remote sequence number from an auth context.
5780 * @param [in] context Library context
5781 * @param [in] auth_context Authentication context
5782 * @param [out] seqnumber Remote sequence number
5784 * Retrieve the remote sequence number from @a auth_context and return it in @a
5785 * seqnumber. The #KRB5_AUTH_CONTEXT_DO_SEQUENCE flag must be set in @a
5786 * auth_context for this function to be useful.
5788 * @retval 0 Success; otherwise - Kerberos error codes
5790 krb5_error_code KRB5_CALLCONV
5791 krb5_auth_con_getremoteseqnumber(krb5_context context, krb5_auth_context auth_context,
5792 krb5_int32 *seqnumber);
5795 /** @deprecated Not replaced.
5797 * RFC 4120 doesn't have anything like the initvector concept;
5798 * only really old protocols may need this API.
5800 KRB5_ATTR_DEPRECATED krb5_error_code KRB5_CALLCONV
5801 krb5_auth_con_initivector(krb5_context context, krb5_auth_context auth_context);
5805 * Set the replay cache in an auth context.
5807 * @param [in] context Library context
5808 * @param [in] auth_context Authentication context
5809 * @param [in] rcache Replay cache haddle
5811 * This function sets the replay cache in @a auth_context to @a rcache. @a
5812 * rcache will be closed when @a auth_context is freed, so the caller should
5813 * relinguish that responsibility.
5815 * @retval 0 Success; otherwise - Kerberos error codes
5817 krb5_error_code KRB5_CALLCONV
5818 krb5_auth_con_setrcache(krb5_context context, krb5_auth_context auth_context,
5819 krb5_rcache rcache);
5822 * Retrieve the replay cache from an auth context.
5824 * @param [in] context Library context
5825 * @param [in] auth_context Authentication context
5826 * @param [out] rcache Replay cache handle
5828 * This function fetches the replay cache from @a auth_context. The caller
5829 * should not close @a rcache.
5831 * @retval 0 (always)
5833 krb5_error_code KRB5_CALLCONV_WRONG
5834 krb5_auth_con_getrcache(krb5_context context, krb5_auth_context auth_context,
5835 krb5_rcache *rcache);
5838 * Retrieve the authenticator from an auth context.
5840 * @param [in] context Library context
5841 * @param [in] auth_context Authentication context
5842 * @param [out] authenticator Authenticator
5844 * Use krb5_free_authenticator() to free @a authenticator when it is no longer
5847 * @retval 0 Success. Otherwise - Kerberos error codes
5849 krb5_error_code KRB5_CALLCONV
5850 krb5_auth_con_getauthenticator(krb5_context context, krb5_auth_context auth_context,
5851 krb5_authenticator **authenticator);
5854 * Set checksum type in an an auth context.
5856 * @param [in] context Library context
5857 * @param [in] auth_context Authentication context
5858 * @param [in] cksumtype Checksum type
5860 * This function sets the checksum type in @a auth_context to be used by
5861 * krb5_mk_req() for the authenticator checksum.
5863 * @retval 0 Success. Otherwise - Kerberos error codes
5865 krb5_error_code KRB5_CALLCONV
5866 krb5_auth_con_set_req_cksumtype(krb5_context context, krb5_auth_context auth_context,
5867 krb5_cksumtype cksumtype);
5869 #define KRB5_REALM_BRANCH_CHAR '.'
5872 * end "func-proto.h"
5876 * begin stuff from libos.h
5880 * @brief Read a password from keyboard input.
5882 * @param [in] context Library context
5883 * @param [in] prompt First user prompt when reading password
5884 * @param [in] prompt2 Second user prompt (NULL to prompt only once)
5885 * @param [out] return_pwd Returned password
5886 * @param [in,out] size_return On input, maximum size of password; on output,
5887 * size of password read
5889 * This function reads a password from keyboard input and stores it in @a
5890 * return_pwd. @a size_return should be set by the caller to the amount of
5891 * storage space available in @a return_pwd; on successful return, it will be
5892 * set to the length of the password read.
5894 * @a prompt is printed to the terminal, followed by ": ", and then a password
5895 * is read from the keyboard.
5897 * If @a prompt2 is NULL, the password is read only once. Otherwise, @a
5898 * prompt2 is printed to the terminal and a second password is read. If the
5899 * two passwords entered are not identical, KRB5_LIBOS_BADPWDMATCH is returned.
5901 * Echoing is turned off when the password is read.
5906 * Error in reading or verifying the password
5908 * Kerberos error codes
5910 krb5_error_code KRB5_CALLCONV
5911 krb5_read_password(krb5_context context,
5912 const char *prompt, const char *prompt2,
5913 char *return_pwd, unsigned int *size_return);
5916 * Convert a principal name to a local name.
5918 * @param [in] context Library context
5919 * @param [in] aname Principal name
5920 * @param [in] lnsize_in Space available in @a lname
5921 * @param [out] lname Local name buffer to be filled in
5923 * If @a aname does not correspond to any local account, KRB5_LNAME_NOTRANS is
5924 * returned. If @a lnsize_in is too small for the local name,
5925 * KRB5_CONFIG_NOTENUFSPACE is returned.
5927 * Local names, rather than principal names, can be used by programs that
5928 * translate to an environment-specific name (for example, a user account
5936 * Kerberos error codes
5938 krb5_error_code KRB5_CALLCONV
5939 krb5_aname_to_localname(krb5_context context, krb5_const_principal aname,
5940 int lnsize_in, char *lname);
5943 * Get the Kerberos realm names for a host.
5945 * @param [in] context Library context
5946 * @param [in] host Host name (or NULL)
5947 * @param [out] realmsp Null-terminated list of realm names
5949 * Fill in @a realmsp with a pointer to a null-terminated list of realm names.
5950 * If there are no known realms for the host, a list containing the referral
5951 * (empty) realm is returned.
5953 * If @a host is NULL, the local host's realms are determined.
5955 * Use krb5_free_host_realm() to release @a realmsp when it is no longer
5961 * ENOMEM Insufficient memory
5963 * Kerberos error codes
5965 krb5_error_code KRB5_CALLCONV
5966 krb5_get_host_realm(krb5_context context, const char *host, char ***realmsp);
5970 * @param [in] context Library context
5971 * @param [in] hdata Host name (or NULL)
5972 * @param [out] realmsp Null-terminated list of realm names
5974 * Fill in @a realmsp with a pointer to a null-terminated list of realm names
5975 * obtained through heuristics or insecure resolution methods which have lower
5976 * priority than KDC referrals.
5978 * If @a host is NULL, the local host's realms are determined.
5980 * Use krb5_free_host_realm() to release @a realmsp when it is no longer
5983 krb5_error_code KRB5_CALLCONV
5984 krb5_get_fallback_host_realm(krb5_context context,
5985 krb5_data *hdata, char ***realmsp);
5988 * Free the memory allocated by krb5_get_host_realm().
5990 * @param [in] context Library context
5991 * @param [in] realmlist List of realm names to be released
5996 * Kerberos error codes
5998 krb5_error_code KRB5_CALLCONV
5999 krb5_free_host_realm(krb5_context context, char *const *realmlist);
6002 * Determine if a principal is authorized to log in as a local user.
6004 * @param [in] context Library context
6005 * @param [in] principal Principal name
6006 * @param [in] luser Local username
6008 * Determine whether @a principal is authorized to log in as a local user @a
6012 * TRUE Principal is authorized to log in as user; FALSE otherwise.
6014 krb5_boolean KRB5_CALLCONV
6015 krb5_kuserok(krb5_context context, krb5_principal principal, const char *luser);
6018 * Generate auth context addresses from a connected socket.
6020 * @param [in] context Library context
6021 * @param [in] auth_context Authentication context
6022 * @param [in] infd Connected socket descriptor
6023 * @param [in] flags Flags
6025 * This function sets the local and/or remote addresses in @a auth_context
6026 * based on the local and remote endpoints of the socket @a infd. The
6027 * following flags determine the operations performed:
6029 * @li #KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR Generate local address.
6030 * @li #KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR Generate remote address.
6031 * @li #KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR Generate local address and port.
6032 * @li #KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR Generate remote address and port.
6034 * @retval 0 Success; otherwise - Kerberos error codes
6036 krb5_error_code KRB5_CALLCONV
6037 krb5_auth_con_genaddrs(krb5_context context, krb5_auth_context auth_context,
6038 int infd, int flags);
6041 * Set time offset field in a krb5_context structure.
6043 * @param [in] context Library context
6044 * @param [in] seconds Real time, seconds portion
6045 * @param [in] microseconds Real time, microseconds portion
6047 * This function sets the time offset in @a context to the difference between
6048 * the system time and the real time as determined by @a seconds and @a
6051 * @retval 0 Success; otherwise - Kerberos error codes
6053 krb5_error_code KRB5_CALLCONV
6054 krb5_set_real_time(krb5_context context, krb5_timestamp seconds,
6055 krb5_int32 microseconds);
6058 * Return the time offsets from the os context.
6060 * @param [in] context Library context
6061 * @param [out] seconds Time offset, seconds portion
6062 * @param [out] microseconds Time offset, microseconds portion
6064 * This function returns the time offsets in @a context.
6066 * @retval 0 Success; otherwise - Kerberos error codes
6068 krb5_error_code KRB5_CALLCONV
6069 krb5_get_time_offsets(krb5_context context, krb5_timestamp *seconds, krb5_int32 *microseconds);
6073 * Convert a string to an encryption type.
6075 * @param [in] string String to convert to an encryption type
6076 * @param [out] enctypep Encryption type
6078 * @retval 0 Success; otherwise - EINVAL
6080 krb5_error_code KRB5_CALLCONV
6081 krb5_string_to_enctype(char *string, krb5_enctype *enctypep);
6084 * Convert a string to a salt type.
6086 * @param [in] string String to convert to an encryption type
6087 * @param [out] salttypep Salt type to be filled in
6089 * @retval 0 Success; otherwise - EINVAL
6091 krb5_error_code KRB5_CALLCONV
6092 krb5_string_to_salttype(char *string, krb5_int32 *salttypep);
6095 * Convert a string to a checksum type.
6097 * @param [in] string String to be converted
6098 * @param [out] cksumtypep Checksum type to be filled in
6100 * @retval 0 Success; otherwise - EINVAL
6102 krb5_error_code KRB5_CALLCONV
6103 krb5_string_to_cksumtype(char *string, krb5_cksumtype *cksumtypep);
6106 * Convert a string to a timestamp.
6108 * @param [in] string String to be converted
6109 * @param [out] timestampp Pointer to timestamp
6111 * @retval 0 Success; otherwise - EINVAL
6113 krb5_error_code KRB5_CALLCONV
6114 krb5_string_to_timestamp(char *string, krb5_timestamp *timestampp);
6117 * Convert a string to a delta time value.
6119 * @param [in] string String to be converted
6120 * @param [out] deltatp Delta time to be filled in
6122 * @retval 0 Success; otherwise - KRB5_DELTAT_BADFORMAT
6124 krb5_error_code KRB5_CALLCONV
6125 krb5_string_to_deltat(char *string, krb5_deltat *deltatp);
6128 * Convert an encryption type to a string.
6130 * @param [in] enctype Encryption type
6131 * @param [out] buffer Buffer to hold encryption type string
6132 * @param [in] buflen Storage available in @a buffer
6134 * @retval 0 Success; otherwise - Kerberos error codes
6136 krb5_error_code KRB5_CALLCONV
6137 krb5_enctype_to_string(krb5_enctype enctype, char *buffer, size_t buflen);
6140 * Convert an encryption type to a name or alias.
6142 * @param [in] enctype Encryption type
6143 * @param [in] shortest Flag
6144 * @param [out] buffer Buffer to hold encryption type string
6145 * @param [in] buflen Storage available in @a buffer
6147 * If @a shortest is FALSE, this function returns the enctype's canonical name
6148 * (like "aes128-cts-hmac-sha1-96"). If @a shortest is TRUE, it return the
6149 * enctype's shortest alias (like "aes128-cts").
6151 * @retval 0 Success; otherwise - Kerberos error codes
6153 krb5_error_code KRB5_CALLCONV
6154 krb5_enctype_to_name(krb5_enctype enctype, krb5_boolean shortest,
6155 char *buffer, size_t buflen);
6158 * Convert a salt type to a string.
6160 * @param [in] salttype Salttype to convert
6161 * @param [out] buffer Buffer to receive the converted string
6162 * @param [in] buflen Storage available in @a buffer
6164 * @retval 0 Success; otherwise - Kerberos error codes
6166 krb5_error_code KRB5_CALLCONV
6167 krb5_salttype_to_string(krb5_int32 salttype, char *buffer, size_t buflen);
6170 * Convert a checksum type to a string.
6172 * @param [in] cksumtype Checksum type
6173 * @param [out] buffer Buffer to hold converted checksum type
6174 * @param [in] buflen Storage available in @a buffer
6176 * @retval 0 Success; otherwise - Kerberos error codes
6178 krb5_error_code KRB5_CALLCONV
6179 krb5_cksumtype_to_string(krb5_cksumtype cksumtype, char *buffer, size_t buflen);
6182 * Convert a timestamp to a string.
6184 * @param [in] timestamp Timestamp to convert
6185 * @param [out] buffer Buffer to hold converted timestamp
6186 * @param [in] buflen Storage available in @a buffer
6188 * The string is returned in the locale's appropriate date and time
6191 * @retval 0 Success; otherwise - Kerberos error codes
6193 krb5_error_code KRB5_CALLCONV
6194 krb5_timestamp_to_string(krb5_timestamp timestamp, char *buffer, size_t buflen);
6197 * Convert a timestamp to a string, with optional output padding
6199 * @param [in] timestamp Timestamp to convert
6200 * @param [out] buffer Buffer to hold the converted timestamp
6201 * @param [in] buflen Length of buffer
6202 * @param [in] pad Optional value to pad @a buffer if converted
6203 * timestamp does not fill it
6205 * If @a pad is not NULL, @a buffer is padded out to @a buflen - 1 characters
6206 * with the value of *@a pad.
6208 * @retval 0 Success; otherwise - Kerberos error codes
6210 krb5_error_code KRB5_CALLCONV
6211 krb5_timestamp_to_sfstring(krb5_timestamp timestamp, char *buffer,
6212 size_t buflen, char *pad);
6215 * Convert a relative time value to a string.
6217 * @param [in] deltat Relative time value to convert
6218 * @param [out] buffer Buffer to hold time string
6219 * @param [in] buflen Storage available in @a buffer
6221 * @retval 0 Success; otherwise - Kerberos error codes
6223 krb5_error_code KRB5_CALLCONV
6224 krb5_deltat_to_string(krb5_deltat deltat, char *buffer, size_t buflen);
6226 /* The name of the Kerberos ticket granting service... and its size */
6227 #define KRB5_TGS_NAME "krbtgt"
6228 #define KRB5_TGS_NAME_SIZE 6
6230 /* flags for recvauth */
6231 #define KRB5_RECVAUTH_SKIP_VERSION 0x0001
6232 #define KRB5_RECVAUTH_BADAUTHVERS 0x0002
6233 /* initial ticket api functions */
6235 /** Text for prompt used in prompter callback function. */
6236 typedef struct _krb5_prompt {
6237 char *prompt; /**< The prompt to show to the user */
6238 int hidden; /**< Boolean; informative prompt or hidden (e.g. PIN) */
6239 krb5_data *reply; /**< Must be allocated before call to prompt routine */
6242 /** Pointer to a prompter callback function. */
6243 typedef krb5_error_code
6244 (KRB5_CALLCONV *krb5_prompter_fct)(krb5_context context, void *data,
6245 const char *name, const char *banner,
6246 int num_prompts, krb5_prompt prompts[]);
6249 * Prompt user for password.
6251 * @param [in] context Library context
6252 * @param data Unused (callback argument)
6253 * @param [in] name Name to output during prompt
6254 * @param [in] banner Banner to output during prompt
6255 * @param [in] num_prompts Number of prompts in @a prompts
6256 * @param [in,out] prompts Array of output prompts and replies
6258 * This function is intended to be used as a prompter callback for
6259 * krb5_get_init_creds_password() or krb5_init_creds_init().
6261 * Writes @a name and @a banner to stdout, each followed by a newline, then
6262 * writes each prompt field in the @a prompts array, followed by ": ", and sets
6263 * the reply field of the entry to a line of input read from stdin. If the
6264 * hidden flag is set for a prompt, then terminal echoing is turned off when
6270 * Kerberos error codes
6273 krb5_error_code KRB5_CALLCONV
6274 krb5_prompter_posix(krb5_context context, void *data, const char *name,
6275 const char *banner, int num_prompts,
6276 krb5_prompt prompts[]);
6278 /** Store options for @c _krb5_get_init_creds */
6279 typedef struct _krb5_get_init_creds_opt {
6281 krb5_deltat tkt_life;
6282 krb5_deltat renew_life;
6285 krb5_enctype *etype_list;
6286 int etype_list_length;
6287 krb5_address **address_list;
6288 krb5_preauthtype *preauth_list;
6289 int preauth_list_length;
6291 } krb5_get_init_creds_opt;
6293 #define KRB5_GET_INIT_CREDS_OPT_TKT_LIFE 0x0001
6294 #define KRB5_GET_INIT_CREDS_OPT_RENEW_LIFE 0x0002
6295 #define KRB5_GET_INIT_CREDS_OPT_FORWARDABLE 0x0004
6296 #define KRB5_GET_INIT_CREDS_OPT_PROXIABLE 0x0008
6297 #define KRB5_GET_INIT_CREDS_OPT_ETYPE_LIST 0x0010
6298 #define KRB5_GET_INIT_CREDS_OPT_ADDRESS_LIST 0x0020
6299 #define KRB5_GET_INIT_CREDS_OPT_PREAUTH_LIST 0x0040
6300 #define KRB5_GET_INIT_CREDS_OPT_SALT 0x0080
6301 #define KRB5_GET_INIT_CREDS_OPT_CHG_PWD_PRMPT 0x0100
6302 #define KRB5_GET_INIT_CREDS_OPT_CANONICALIZE 0x0200
6303 #define KRB5_GET_INIT_CREDS_OPT_ANONYMOUS 0x0400
6307 * Allocate a new initial credential options structure.
6309 * @param [in] context Library context
6310 * @param [out] opt New options structure
6312 * This function is the preferred way to create an options structure for
6313 * getting initial credentials, and is required to make use of certain options.
6314 * Use krb5_get_init_creds_opt_free() to free @a opt when it is no longer
6317 * @retval 0 - Success; Kerberos errors otherwise.
6319 krb5_error_code KRB5_CALLCONV
6320 krb5_get_init_creds_opt_alloc(krb5_context context,
6321 krb5_get_init_creds_opt **opt);
6324 * Free initial credential options.
6326 * @param [in] context Library context
6327 * @param [in] opt Options structure to free
6329 * @sa krb5_get_init_creds_opt_alloc()
6332 krb5_get_init_creds_opt_free(krb5_context context,
6333 krb5_get_init_creds_opt *opt);
6335 /** @deprecated Use krb5_get_init_creds_opt_alloc() instead. */
6337 krb5_get_init_creds_opt_init(krb5_get_init_creds_opt *opt);
6340 * Set the ticket lifetime in initial credential options.
6342 * @param [in] opt Options structure
6343 * @param [in] tkt_life Ticket lifetime
6346 krb5_get_init_creds_opt_set_tkt_life(krb5_get_init_creds_opt *opt,
6347 krb5_deltat tkt_life);
6350 * Set the ticket renewal lifetime in initial credential options.
6352 * @param [in] opt Pointer to @a options field
6353 * @param [in] renew_life Ticket renewal lifetime
6356 krb5_get_init_creds_opt_set_renew_life(krb5_get_init_creds_opt *opt,
6357 krb5_deltat renew_life);
6360 * Set or unset the forwardable flag in initial credential options.
6362 * @param [in] opt Options structure
6363 * @param [in] forwardable Whether credentials should be forwardable
6366 krb5_get_init_creds_opt_set_forwardable(krb5_get_init_creds_opt *opt,
6370 * Set or unset the proxiable flag in initial credential options.
6372 * @param [in] opt Options structure
6373 * @param [in] proxiable Whether credentials should be proxiable
6376 krb5_get_init_creds_opt_set_proxiable(krb5_get_init_creds_opt *opt,
6380 * Set or unset the canonicalize flag in initial credential options.
6382 * @param [in] opt Options structure
6383 * @param [in] canonicalize Whether to canonicalize client principal
6386 krb5_get_init_creds_opt_set_canonicalize(krb5_get_init_creds_opt *opt,
6390 * Set or unset the anonymous flag in initial credential options.
6392 * @param [in] opt Options structure
6393 * @param [in] anonymous Whether to make an anonymous request
6395 * This function may be used to request anonymous credentials from the KDC by
6396 * setting @a anonymous to non-zero. Note that anonymous credentials are only
6397 * a request; clients must verify that credentials are anonymous if that is a
6401 krb5_get_init_creds_opt_set_anonymous(krb5_get_init_creds_opt *opt,
6405 * Set allowable encryption types in initial credential options.
6407 * @param [in] opt Options structure
6408 * @param [in] etype_list Array of encryption types
6409 * @param [in] etype_list_length Length of @a etype_list
6412 krb5_get_init_creds_opt_set_etype_list(krb5_get_init_creds_opt *opt,
6413 krb5_enctype *etype_list,
6414 int etype_list_length);
6417 * Set address restrictions in initial credential options.
6419 * @param [in] opt Options structure
6420 * @param [in] addresses Null-terminated array of addresses
6423 krb5_get_init_creds_opt_set_address_list(krb5_get_init_creds_opt *opt,
6424 krb5_address **addresses);
6427 * Set preauthentication types in initial credential options.
6429 * @param [in] opt Options structure
6430 * @param [in] preauth_list Array of preauthentication types
6431 * @param [in] preauth_list_length Length of @a preauth_list
6433 * This function can be used to perform optimistic preauthentication when
6434 * getting initial credentials, in combination with
6435 * krb5_get_init_creds_opt_set_salt() and krb5_get_init_creds_opt_set_pa().
6438 krb5_get_init_creds_opt_set_preauth_list(krb5_get_init_creds_opt *opt,
6439 krb5_preauthtype *preauth_list,
6440 int preauth_list_length);
6443 * Set salt for optimistic preauthentication in initial credential options.
6445 * @param [in] opt Options structure
6446 * @param [in] salt Salt data
6448 * When getting initial credentials with a password, a salt string it used to
6449 * convert the password to a key. Normally this salt is obtained from the
6450 * first KDC reply, but when performing optimistic preauthentication, the
6451 * client may need to supply the salt string with this function.
6454 krb5_get_init_creds_opt_set_salt(krb5_get_init_creds_opt *opt,
6458 * Set or unset change-password-prompt flag in initial credential options.
6460 * @param [in] opt Options structure
6461 * @param [in] prompt Whether to prompt to change password
6463 * This flag is on by default. It controls whether
6464 * krb5_get_init_creds_password() will react to an expired-password error by
6465 * prompting for a new password and attempting to change the old one.
6468 krb5_get_init_creds_opt_set_change_password_prompt(krb5_get_init_creds_opt *opt,
6471 /** Generic preauth option attribute/value pairs */
6472 typedef struct _krb5_gic_opt_pa_data {
6475 } krb5_gic_opt_pa_data;
6478 * Supply options for preauthentication in initial credential options.
6480 * @param [in] context Library context
6481 * @param [in] opt Options structure
6482 * @param [in] attr Preauthentication option name
6483 * @param [in] value Preauthentication option value
6485 * This function allows the caller to supply options for preauthentication.
6486 * The values of @a attr and @a value are supplied to each preauthentication
6487 * module available within @a context.
6489 krb5_error_code KRB5_CALLCONV
6490 krb5_get_init_creds_opt_set_pa(krb5_context context,
6491 krb5_get_init_creds_opt *opt, const char *attr,
6495 * Set location of FAST armor ccache in initial credential options.
6497 * @param [in] context Library context
6498 * @param [in] opt Options
6499 * @param [in] fast_ccache_name Credential cache name
6501 * Sets the location of a credential cache containing an armor ticket to
6502 * protect an initial credential exchange using the FAST protocol extension.
6504 * In version 1.7, setting an armor ccache requires that FAST be used for the
6505 * exchange. In version 1.8 or later, setting the armor ccache causes FAST to
6506 * be used if the KDC supports it; krb5_get_init_creds_opt_set_fast_flags()
6507 * must be used to require that FAST be used.
6509 krb5_error_code KRB5_CALLCONV
6510 krb5_get_init_creds_opt_set_fast_ccache_name(krb5_context context,
6511 krb5_get_init_creds_opt *opt,
6512 const char *fast_ccache_name);
6515 * Set FAST armor cache in initial credential options.
6517 * @param [in] context Library context
6518 * @param [in] opt Options
6519 * @param [in] ccache Credential cache handle
6521 * This function is similar to krb5_get_init_creds_opt_set_fast_ccache_name(),
6522 * but uses a credential cache handle instead of a name.
6524 krb5_error_code KRB5_CALLCONV
6525 krb5_get_init_creds_opt_set_fast_ccache(krb5_context context,
6526 krb5_get_init_creds_opt *opt,
6527 krb5_ccache ccache);
6530 * Set an output credential cache in initial credential options.
6532 * @param [in] context Library context
6533 * @param [in] opt Options
6534 * @param [in] ccache Credential cache handle
6536 * If an output credential cache is set, then the krb5_get_init_creds family of
6537 * APIs will write credentials to it. Setting an output ccache is desirable
6538 * both because it simplifies calling code and because it permits the
6539 * krb5_get_init_creds APIs to write out configuration information about the
6540 * realm to the ccache.
6542 krb5_error_code KRB5_CALLCONV
6543 krb5_get_init_creds_opt_set_out_ccache(krb5_context context,
6544 krb5_get_init_creds_opt *opt,
6545 krb5_ccache ccache);
6548 * Set FAST flags in initial credential options.
6550 * @param [in] context Library context
6551 * @param [in] opt Options
6552 * @param [in] flags FAST flags
6554 * The following flag values are valid:
6555 * @li #KRB5_FAST_REQUIRED - Require FAST to be used
6558 * 0 - Success; Kerberos errors otherwise.
6560 krb5_error_code KRB5_CALLCONV
6561 krb5_get_init_creds_opt_set_fast_flags(krb5_context context,
6562 krb5_get_init_creds_opt *opt,
6566 * Retrieve FAST flags from initial credential options.
6568 * @param [in] context Library context
6569 * @param [in] opt Options
6570 * @param [out] out_flags FAST flags
6573 * 0 - Success; Kerberos errors otherwise.
6575 krb5_error_code KRB5_CALLCONV
6576 krb5_get_init_creds_opt_get_fast_flags(krb5_context context,
6577 krb5_get_init_creds_opt *opt,
6578 krb5_flags *out_flags);
6581 #define KRB5_FAST_REQUIRED 1l<<0 /**< Require KDC to support FAST*/
6584 (KRB5_CALLCONV *krb5_expire_callback_func)(krb5_context context, void *data,
6585 krb5_timestamp password_expiration,
6586 krb5_timestamp account_expiration,
6587 krb5_boolean is_last_req);
6590 * Set an expiration callback in initial credential options.
6592 * @param [in] context Library context
6593 * @param [in] opt Options structure
6594 * @param [in] cb Callback function
6595 * @param [in] data Callback argument
6597 * Set a callback to receive password and account expiration times.
6599 * This option only applies to krb5_get_init_creds_password(). @a cb will be
6600 * invoked if and only if credentials are successfully acquired. The callback
6601 * will receive the @a context from the krb5_get_init_creds_password() call and
6602 * the @a data argument supplied with this API. The remaining arguments should
6603 * be interpreted as follows:
6605 * If @a is_last_req is true, then the KDC reply contained last-req entries
6606 * which unambiguously indicated the password expiration, account expiration,
6607 * or both. (If either value was not present, the corresponding argument will
6608 * be 0.) Furthermore, a non-zero @a password_expiration should be taken as a
6609 * suggestion from the KDC that a warning be displayed.
6611 * If @a is_last_req is false, then @a account_expiration will be 0 and @a
6612 * password_expiration will contain the expiration time of either the password
6613 * or account, or 0 if no expiration time was indicated in the KDC reply. The
6614 * callback should independently decide whether to display a password
6615 * expiration warning.
6617 * Note that @a cb may be invoked even if credentials are being acquired for
6618 * the kadmin/changepw service in order to change the password. It is the
6619 * caller's responsibility to avoid displaying a password expiry warning in
6622 * @warning Setting an expire callback with this API will cause
6623 * krb5_get_init_creds_password() not to send password expiry warnings to the
6624 * prompter, as it ordinarily may.
6626 krb5_error_code KRB5_CALLCONV
6627 krb5_get_init_creds_opt_set_expire_callback(krb5_context context,
6628 krb5_get_init_creds_opt *opt,
6629 krb5_expire_callback_func cb,
6633 * Get initial credentials using a password.
6635 * @param [in] context Library context
6636 * @param [out] creds New credentials
6637 * @param [in] client Client principal
6638 * @param [in] password Password (or NULL)
6639 * @param [in] prompter Prompter function
6640 * @param [in] data Prompter callback data
6641 * @param [in] start_time Time when ticket becomes valid (0 for now)
6642 * @param [in] in_tkt_service Service name of initial credentials (or NULL)
6643 * @param [in] k5_gic_options Initial credential options
6645 * This function requests KDC for an initial credentials for @a client using @a
6646 * password. If @a password is NULL, a password will be prompted for using @a
6647 * prompter if necessary. If @a in_tkt_service is specified, it is parsed as a
6648 * principal name (with the realm ignored) and used as the service principal
6649 * for the request; otherwise the ticket-granting service is used.
6651 * @sa krb5_verify_init_creds()
6656 * EINVAL Invalid argument
6658 * KRB5_KDC_UNREACH Cannot contact any KDC for requested realm
6660 * KRB5_PREAUTH_FAILED Generic Pre-athentication failure
6662 * KRB5_LIBOS_PWDINTR Password read interrupted
6664 * KRB5_REALM_CANT_RESOLVE Cannot resolve network address for KDC in requested realm
6666 * KRB5KDC_ERR_KEY_EXP Password has expired
6668 * KRB5_LIBOS_BADPWDMATCH Password mismatch
6670 * KRB5_CHPW_PWDNULL New password cannot be zero length
6672 * KRB5_CHPW_FAIL Password change failed
6674 * Kerberos error codes
6676 krb5_error_code KRB5_CALLCONV
6677 krb5_get_init_creds_password(krb5_context context, krb5_creds *creds,
6678 krb5_principal client, char *password,
6679 krb5_prompter_fct prompter, void *data,
6680 krb5_deltat start_time, char *in_tkt_service,
6681 krb5_get_init_creds_opt *k5_gic_options);
6683 struct _krb5_init_creds_context;
6684 typedef struct _krb5_init_creds_context *krb5_init_creds_context;
6686 #define KRB5_INIT_CREDS_STEP_FLAG_CONTINUE 0x1 /* More responses needed */
6689 * Free an initial credentials context.
6691 * @param [in] context Library context
6692 * @param [in] ctx Initial credentials context
6695 krb5_init_creds_free(krb5_context context, krb5_init_creds_context ctx);
6698 * Acquire credentials using an initial credentials context.
6700 * @param [in] context Library context
6701 * @param [in] ctx Initial credentials context
6703 * This function synchronously obtains credentials using a context created by
6704 * krb5_init_creds_init(). On successful return, the credentials can be
6705 * retrieved with krb5_init_creds_get_creds().
6707 * @retval 0 Success; otherwise - Kerberos error codes
6709 krb5_error_code KRB5_CALLCONV
6710 krb5_init_creds_get(krb5_context context, krb5_init_creds_context ctx);
6713 * Retrieve acquired credentials from an initial credentials context.
6715 * @param [in] context Library context
6716 * @param [in] ctx Initial credentials context
6717 * @param [out] creds Acquired credentials
6719 * This function copies the acquired initial credentials from @a ctx into @a
6720 * creds, after the successful completion of krb5_init_creds_get() or
6721 * krb5_init_creds_step(). Use krb5_free_cred_contents() to free @a creds when
6722 * it is no longer needed.
6724 * @retval 0 Success; otherwise - Kerberos error codes
6726 krb5_error_code KRB5_CALLCONV
6727 krb5_init_creds_get_creds(krb5_context context, krb5_init_creds_context ctx,
6731 * Get the last error from KDC from an initial credentials context.
6733 * @param [in] context Library context
6734 * @param [in] ctx Initial credentials context
6735 * @param [out] error Error from KDC, or NULL if none was received
6737 * @retval 0 Success; otherwise - Kerberos error codes
6739 krb5_error_code KRB5_CALLCONV
6740 krb5_init_creds_get_error(krb5_context context, krb5_init_creds_context ctx,
6741 krb5_error **error);
6744 * Create a context for acquiring initial credentials.
6746 * @param [in] context Library context
6747 * @param [in] client Client principal to get initial creds for
6748 * @param [in] prompter Prompter callback
6749 * @param [in] data Prompter callback argument
6750 * @param [in] start_time Time when credentials become valid (0 for now)
6751 * @param [in] options Options structure (NULL for default)
6752 * @param [out] ctx New initial credentials context
6754 * This function creates a new context for acquiring initial credentials. Use
6755 * krb5_init_creds_free() to free @a ctx when it is no longer needed.
6757 * @retval 0 Success; otherwise - Kerberos error codes
6759 krb5_error_code KRB5_CALLCONV
6760 krb5_init_creds_init(krb5_context context, krb5_principal client,
6761 krb5_prompter_fct prompter, void *data,
6762 krb5_deltat start_time, krb5_get_init_creds_opt *options,
6763 krb5_init_creds_context *ctx);
6766 * Specify a keytab to use for acquiring initial credentials.
6768 * @param [in] context Library context
6769 * @param [in] ctx Initial credentials context
6770 * @param [in] keytab Key table handle
6772 * This function supplies a keytab containing the client key for an initial
6773 * credentials request.
6775 * @retval 0 Success; otherwise - Kerberos error codes
6777 krb5_error_code KRB5_CALLCONV
6778 krb5_init_creds_set_keytab(krb5_context context, krb5_init_creds_context ctx,
6779 krb5_keytab keytab);
6782 * Get the next KDC request for acquiring initial credentials.
6784 * @param [in] context Library context
6785 * @param [in] ctx Initial credentials context
6786 * @param [in] in KDC response (empty on the first call)
6787 * @param [out] out Next KDC request
6788 * @param [out] realm Realm for next KDC request
6789 * @param [out] flags Output flags
6791 * This function constructs the next KDC request in an initial credential
6792 * exchange, allowing the caller to control the transport of KDC requests and
6793 * replies. On the first call, @a in should be set to an empty buffer; on
6794 * subsequent calls, it should be set to the KDC's reply to the previous
6797 * If more requests are needed, @a flags will be set to
6798 * #KRB5_INIT_CREDS_STEP_FLAG_CONTINUE and the next request will be placed in
6799 * @a out. If no more requests are needed, @a flags will not contain
6800 * #KRB5_INIT_CREDS_STEP_FLAG_CONTINUE and @a out will be empty.
6802 * If this function returns @c KRB5KRB_ERR_RESPONSE_TOO_BIG, the caller should
6803 * transmit the next request using TCP rather than UDP. If this function
6804 * returns any other error, the initial credential exchange has failed.
6806 * @retval 0 Success; otherwise - Kerberos error codes
6808 krb5_error_code KRB5_CALLCONV
6809 krb5_init_creds_step(krb5_context context, krb5_init_creds_context ctx,
6810 krb5_data *in, krb5_data *out, krb5_data *realm,
6811 unsigned int *flags);
6814 * Set a password for acquiring initial credentials.
6816 * @param [in] context Library context
6817 * @param [in] ctx Initial credentials context
6818 * @param [in] password Password
6820 * This function supplies a password to be used to construct the client key for
6821 * an initial credentials request.
6823 * @retval 0 Success; otherwise - Kerberos error codes
6825 krb5_error_code KRB5_CALLCONV
6826 krb5_init_creds_set_password(krb5_context context, krb5_init_creds_context ctx,
6827 const char *password);
6830 * Specify a service principal for acquiring initial credentials.
6832 * @param [in] context Library context
6833 * @param [in] ctx Initial credentials context
6834 * @param [in] service Service principal string
6836 * This function supplies a service principal string to acquire initial
6837 * credentials for instead of the default krbtgt service. @a service is parsed
6838 * as a principal name; any realm part is ignored.
6840 * @retval 0 Success; otherwise - Kerberos error codes
6842 krb5_error_code KRB5_CALLCONV
6843 krb5_init_creds_set_service(krb5_context context, krb5_init_creds_context ctx,
6844 const char *service);
6847 * Retrieve ticket times from an initial credentials context.
6849 * @param [in] context Library context
6850 * @param [in] ctx Initial credentials context
6851 * @param [out] times Ticket times for acquired credentials
6853 * The initial credentials context must have completed obtaining credentials
6854 * via either krb5_init_creds_get() or krb5_init_creds_step().
6856 * @retval 0 Success; otherwise - Kerberos error codes
6858 krb5_error_code KRB5_CALLCONV
6859 krb5_init_creds_get_times(krb5_context context, krb5_init_creds_context ctx,
6860 krb5_ticket_times *times);
6862 struct _krb5_tkt_creds_context;
6863 typedef struct _krb5_tkt_creds_context *krb5_tkt_creds_context;
6866 * Create a context to get credentials from a KDC's Ticket Granting Service.
6868 * @param[in] context Library context
6869 * @param[in] ccache Credential cache handle
6870 * @param[in] creds Input credentials
6871 * @param[in] options @ref KRB5_GC options for this request.
6872 * @param[out] ctx New TGS request context
6874 * This function prepares to obtain credentials matching @a creds, either by
6875 * retrieving them from @a ccache or by making requests to ticket-granting
6876 * services beginning with a ticket-granting ticket for the client principal's
6879 * The resulting TGS acquisition context can be used asynchronously with
6880 * krb5_tkt_creds_step() or synchronously with krb5_tkt_creds_get(). See also
6881 * krb5_get_credentials() for synchronous use.
6883 * Use krb5_tkt_creds_free() to free @a ctx when it is no longer needed.
6885 * @retval 0 Success; otherwise - Kerberos error codes
6887 krb5_error_code KRB5_CALLCONV
6888 krb5_tkt_creds_init(krb5_context context, krb5_ccache ccache,
6889 krb5_creds *creds, krb5_flags options,
6890 krb5_tkt_creds_context *ctx);
6893 * Synchronously obtain credentials using a TGS request context.
6895 * @param[in] context Library context
6896 * @param[in] ctx TGS request context
6898 * This function synchronously obtains credentials using a context created by
6899 * krb5_tkt_creds_init(). On successful return, the credentials can be
6900 * retrieved with krb5_tkt_creds_get_creds().
6902 * @retval 0 Success; otherwise - Kerberos error codes
6904 krb5_error_code KRB5_CALLCONV
6905 krb5_tkt_creds_get(krb5_context context, krb5_tkt_creds_context ctx);
6908 * Retrieve acquired credentials from a TGS request context.
6910 * @param[in] context Library context
6911 * @param[in] ctx TGS request context
6912 * @param[out] creds Acquired credentials
6914 * This function copies the acquired initial credentials from @a ctx into @a
6915 * creds, after the successful completion of krb5_tkt_creds_get() or
6916 * krb5_tkt_creds_step(). Use krb5_free_cred_contents() to free @a creds when
6917 * it is no longer needed.
6919 * @retval 0 Success; otherwise - Kerberos error codes
6921 krb5_error_code KRB5_CALLCONV
6922 krb5_tkt_creds_get_creds(krb5_context context, krb5_tkt_creds_context ctx,
6926 * Free a TGS request context.
6928 * @param[in] context Library context
6929 * @param[in] ctx TGS request context
6932 krb5_tkt_creds_free(krb5_context context, krb5_tkt_creds_context ctx);
6934 #define KRB5_TKT_CREDS_STEP_FLAG_CONTINUE 0x1 /* More responses needed. */
6937 * Get the next KDC request in a TGS exchange.
6939 * @param[in] context Library context
6940 * @param[in] ctx TGS request context
6941 * @param[in] in KDC response (empty on the first call)
6942 * @param[out] out Next KDC request
6943 * @param[out] realm Realm for next KDC request
6944 * @param[out] flags Output flags
6946 * This function constructs the next KDC request for a TGS exchange, allowing
6947 * the caller to control the transport of KDC requests and replies. On the
6948 * first call, @a in should be set to an empty buffer; on subsequent calls, it
6949 * should be set to the KDC's reply to the previous request.
6951 * If more requests are needed, @a flags will be set to
6952 * #KRB5_TKT_CREDS_STEP_FLAG_CONTINUE and the next request will be placed in @a
6953 * out. If no more requests are needed, @a flags will not contain
6954 * #KRB5_TKT_CREDS_STEP_FLAG_CONTINUE and @a out will be empty.
6956 * If this function returns @c KRB5KRB_ERR_RESPONSE_TOO_BIG, the caller should
6957 * transmit the next request using TCP rather than UDP. If this function
6958 * returns any other error, the TGS exchange has failed.
6960 * @retval 0 Success; otherwise - Kerberos error codes
6962 krb5_error_code KRB5_CALLCONV
6963 krb5_tkt_creds_step(krb5_context context, krb5_tkt_creds_context ctx,
6964 krb5_data *in, krb5_data *out, krb5_data *realm,
6965 unsigned int *flags);
6968 * Retrieve ticket times from a TGS request context.
6970 * @param[in] context Library context
6971 * @param[in] ctx TGS request context
6972 * @param[out] times Ticket times for acquired credentials
6974 * The TGS request context must have completed obtaining credentials via either
6975 * krb5_tkt_creds_get() or krb5_tkt_creds_step().
6977 * @retval 0 Success; otherwise - Kerberos error codes
6979 krb5_error_code KRB5_CALLCONV
6980 krb5_tkt_creds_get_times(krb5_context context, krb5_tkt_creds_context ctx,
6981 krb5_ticket_times *times);
6984 * Get initial credentials using a key table.
6986 * @param [in] context Library context
6987 * @param [out] creds New credentials
6988 * @param [in] client Client principal
6989 * @param [in] arg_keytab Key table handle
6990 * @param [in] start_time Time when ticket becomes valid (0 for now)
6991 * @param [in] in_tkt_service Service name of initial credentials (or NLUL)
6992 * @param [in] k5_gic_options Initial credential options
6994 * This function requests KDC for an initial credentials for @a client using a
6995 * client key stored in @a arg_keytab. If @a in_tkt_service is specified, it
6996 * is parsed as a principal name (with the realm ignored) and used as the
6997 * service principal for the request; otherwise the ticket-granting service is
7000 * @sa krb5_verify_init_creds()
7005 * Kerberos error codes
7007 krb5_error_code KRB5_CALLCONV
7008 krb5_get_init_creds_keytab(krb5_context context, krb5_creds *creds,
7009 krb5_principal client, krb5_keytab arg_keytab,
7010 krb5_deltat start_time, char *in_tkt_service,
7011 krb5_get_init_creds_opt *k5_gic_options);
7013 typedef struct _krb5_verify_init_creds_opt {
7015 int ap_req_nofail; /**< boolean */
7016 } krb5_verify_init_creds_opt;
7018 #define KRB5_VERIFY_INIT_CREDS_OPT_AP_REQ_NOFAIL 0x0001
7021 * Initialize a credential verification options structure.
7023 * @param [in] k5_vic_options Verification options structure
7026 krb5_verify_init_creds_opt_init(krb5_verify_init_creds_opt *k5_vic_options);
7029 * Set whether credential verification is required.
7031 * @param [in] k5_vic_options Verification options structure
7032 * @param [in] ap_req_nofail Whether to require successful verification
7034 * This function determines how krb5_verify_init_creds() behaves if no keytab
7035 * information is available. If @a ap_req_nofail is @c FALSE, verification
7036 * will be skipped in this case and krb5_verify_init_creds() will return
7037 * successfully. If @a ap_req_nofail is @c TRUE, krb5_verify_init_creds() will
7038 * not return successfully unless verification can be performed.
7040 * If this function is not used, the behavior of krb5_verify_init_creds() is
7041 * determined through configuration.
7044 krb5_verify_init_creds_opt_set_ap_req_nofail(krb5_verify_init_creds_opt * k5_vic_options,
7048 * Verify initial credentials against a keytab.
7050 * @param [in] context Library context
7051 * @param [in] creds Initial credentials to be verified
7052 * @param [in] server_arg Server principal (or NULL)
7053 * @param [in] keytab_arg Key table (NULL to use default keytab)
7054 * @param [in,out] ccache_arg Credential cache for fetched creds (or NULL)
7055 * @param [in] options Verification options (NULL for default options)
7057 * This function attempts to verify that @a creds were obtained from a KDC with
7058 * knowledge of a key in @a keytab_arg. If @a server_arg is provided, the
7059 * highest-kvno key entry for that principal name is used to verify the
7060 * credentials; otherwise, the highest-kvno key entry for the first principal
7061 * listed in @a keytab_arg is used.
7063 * If the specified keytab does not exist, or is empty, or cannot be read, or
7064 * does not contain an entry for @a server_arg, then credential verification
7065 * may be skipped unless configuration demands that it succeed. The caller can
7066 * control this behavior by providing a verification options structure; see
7067 * krb5_verify_init_creds_opt_init() and
7068 * krb5_verify_init_creds_opt_set_ap_req_nofail().
7070 * If @a ccache_arg is NULL, any additional credentials fetched during the
7071 * verification process will be destroyed. If @a ccache_arg points to NULL, a
7072 * memory ccache will be created for the additional credentials and returned in
7073 * @a ccache_arg. If @a ccache_arg points to a valid credential cache handle,
7074 * the additional credentials will be stored in that cache.
7076 * @retval 0 Success; otherwise - Kerberos error codes
7078 krb5_error_code KRB5_CALLCONV
7079 krb5_verify_init_creds(krb5_context context, krb5_creds *creds,
7080 krb5_principal server_arg, krb5_keytab keytab_arg,
7081 krb5_ccache *ccache_arg, krb5_verify_init_creds_opt *options);
7084 * Get validated credentials from the KDC.
7086 * @param [in] context Library context
7087 * @param [out] creds Validated credentials
7088 * @param [in] client Client principal name
7089 * @param [in] ccache Credential cache
7090 * @param [in] in_tkt_service Server principal string (or NULL)
7092 * This function gets a validated credential using a postdated credential from
7093 * @a ccache. If @a in_tkt_service is specified, it is parsed (with the realm
7094 * part ignored) and used as the server principal of the credential;
7095 * otherwise, the ticket-granting service is used.
7097 * If successful, the validated credential is placed in @a creds.
7099 * @sa krb5_get_renewed_creds()
7104 * KRB5_NO_2ND_TKT Request missing second ticket
7106 * KRB5_NO_TKT_SUPPLIED Request did not supply a ticket
7108 * KRB5_PRINC_NOMATCH Requested principal and ticket do not match
7110 * KRB5_KDCREP_MODIFIED KDC reply did not match expectations
7112 * KRB5_KDCREP_SKEW Clock skew too great in KDC reply
7114 * Kerberos error codes
7116 krb5_error_code KRB5_CALLCONV
7117 krb5_get_validated_creds(krb5_context context, krb5_creds *creds,
7118 krb5_principal client, krb5_ccache ccache,
7119 char *in_tkt_service);
7122 * Get renewed credential from KDC using an existing credential.
7124 * @param [in] context Library context
7125 * @param [out] creds Renewed credentials
7126 * @param [in] client Client principal name
7127 * @param [in] ccache Credential cache
7128 * @param [in] in_tkt_service Server principal string (or NULL)
7130 * This function gets a renewed credential using an existing one from @a
7131 * ccache. If @a in_tkt_service is specified, it is parsed (with the realm
7132 * part ignored) and used as the server principal of the credential; otherwise,
7133 * the ticket-granting service is used.
7135 * If successful, the renewed credential is placed in @a creds.
7140 * Kerberos error codes
7142 krb5_error_code KRB5_CALLCONV
7143 krb5_get_renewed_creds(krb5_context context, krb5_creds *creds,
7144 krb5_principal client, krb5_ccache ccache,
7145 char *in_tkt_service);
7148 * Decode an ASN.1-formatted ticket.
7150 * @param [in] code ASN.1-formatted ticket
7151 * @param [out] rep Decoded ticket information
7153 * @retval 0 Success; otherwise - Kerberos error codes
7155 krb5_error_code KRB5_CALLCONV
7156 krb5_decode_ticket(const krb5_data *code, krb5_ticket **rep);
7159 * Retrieve a string value from the appdefaults section of krb5.conf.
7161 * @param [in] context Library context
7162 * @param [in] appname Application name
7163 * @param [in] realm Realm name
7164 * @param [in] option Option to be checked
7165 * @param [in] default_value Default value to return if no match is found
7166 * @param [out] ret_value String value of @a option
7168 * This function gets the application defaults for @a option based on the given
7169 * @a appname and/or @a realm.
7171 * @sa krb5_appdefault_boolean()
7174 krb5_appdefault_string(krb5_context context, const char *appname,
7175 const krb5_data *realm, const char *option,
7176 const char *default_value, char ** ret_value);
7179 * Retrieve a boolean value from the appdefaults section of krb5.conf.
7181 * @param [in] context Library context
7182 * @param [in] appname Application name
7183 * @param [in] realm Realm name
7184 * @param [in] option Option to be checked
7185 * @param [in] default_value Default value to return if no match is found
7186 * @param [out] ret_value Boolean value of @a option
7188 * This function gets the application defaults for @a option based on the given
7189 * @a appname and/or @a realm.
7191 * @sa krb5_appdefault_string()
7194 krb5_appdefault_boolean(krb5_context context, const char *appname,
7195 const krb5_data *realm, const char *option,
7196 int default_value, int *ret_value);
7199 * Prompter enhancements
7201 #define KRB5_PROMPT_TYPE_PASSWORD 0x1
7202 #define KRB5_PROMPT_TYPE_NEW_PASSWORD 0x2
7203 #define KRB5_PROMPT_TYPE_NEW_PASSWORD_AGAIN 0x3
7204 #define KRB5_PROMPT_TYPE_PREAUTH 0x4
7206 typedef krb5_int32 krb5_prompt_type;
7209 * Get prompt types array from a context.
7211 * @param [in] context Library context
7214 * Pointer to an array of prompt types corresponding to the prompter's @a
7215 * prompts arguments. Each type has one of the following values:
7216 * @li #KRB5_PROMPT_TYPE_PASSWORD
7217 * @li #KRB5_PROMPT_TYPE_NEW_PASSWORD
7218 * @li #KRB5_PROMPT_TYPE_NEW_PASSWORD_AGAIN
7219 * @li #KRB5_PROMPT_TYPE_PREAUTH
7221 krb5_prompt_type* KRB5_CALLCONV
7222 krb5_get_prompt_types(krb5_context context);
7224 /* Error reporting */
7226 * Set an extended error message for an error code.
7228 * @param [in] ctx Library context
7229 * @param [in] code Error code
7230 * @param [in] fmt Error string for the error code
7231 * @param [in] ... printf(3) style parameters
7233 void KRB5_CALLCONV_C
7234 krb5_set_error_message(krb5_context ctx, krb5_error_code code, const char *fmt, ...)
7235 #if !defined(__cplusplus) && (__GNUC__ > 2)
7236 __attribute__((__format__(__printf__, 3, 4)))
7241 * Set an extended error message for an error code using a va_list.
7243 * @param [in] ctx Library context
7244 * @param [in] code Error code
7245 * @param [in] fmt Error string for the error code
7246 * @param [in] args List of vprintf(3) style arguments
7249 krb5_vset_error_message(krb5_context ctx, krb5_error_code code,
7250 const char *fmt, va_list args)
7251 #if !defined(__cplusplus) && (__GNUC__ > 2)
7252 __attribute__((__format__(__printf__, 3, 0)))
7257 * Copy the most recent extended error message from one context to another.
7259 * @param [in] dest_ctx Library context to copy message to
7260 * @param [in] src_ctx Library context with current message
7263 krb5_copy_error_message(krb5_context dest_ctx, krb5_context src_ctx);
7266 * Get the (possibly extended) error message for a code.
7268 * @param [in] ctx Library context
7269 * @param [in] code Error code
7271 * The behavior of krb5_get_error_message() is only defined the first time it
7272 * is called after a failed call to a krb5 function using the same context, and
7273 * only when the error code passed in is the same as that returned by the krb5
7276 * This function never returns NULL, so its result may be used unconditionally
7279 * The string returned by this function must be freed using
7280 * krb5_free_error_message()
7282 * @note Future versions may return the same string for the second
7283 * and following calls.
7285 const char * KRB5_CALLCONV
7286 krb5_get_error_message(krb5_context ctx, krb5_error_code code);
7289 * Free an error message generated by krb5_get_error_message().
7291 * @param [in] ctx Library context
7292 * @param [in] msg Pointer to error message
7295 krb5_free_error_message(krb5_context ctx, const char *msg);
7298 * Clear the extended error message in a context.
7300 * @param [in] ctx Library context
7302 * This function unsets the extended error message in a context, to ensure that
7303 * it is not mistakenly applied to another occurrence of the same error code.
7306 krb5_clear_error_message(krb5_context ctx);
7309 * Unwrap authorization data.
7311 * @param [in] context Library context
7312 * @param [in] type @ref KRB5_AUTHDATA type of @a container
7313 * @param [in] container Authorization data to be decoded
7314 * @param [out] authdata List of decoded authorization data
7316 * @sa krb5_encode_authdata_container()
7318 * @retval 0 Success; otherwise - Kerberos error codes
7320 krb5_error_code KRB5_CALLCONV
7321 krb5_decode_authdata_container(krb5_context context,
7322 krb5_authdatatype type,
7323 const krb5_authdata *container,
7324 krb5_authdata ***authdata);
7326 * Wrap authorization data in a container.
7328 * @param [in] context Library context
7329 * @param [in] type @ref KRB5_AUTHDATA type of @a container
7330 * @param [in] authdata List of authorization data to be encoded
7331 * @param [out] container List of encoded authorization data
7333 * The result is returned in @a container as a single-element list.
7335 * @sa krb5_decode_authdata_container()
7337 * @retval 0 Success; otherwise - Kerberos error codes
7339 krb5_error_code KRB5_CALLCONV
7340 krb5_encode_authdata_container(krb5_context context,
7341 krb5_authdatatype type,
7342 krb5_authdata * const*authdata,
7343 krb5_authdata ***container);
7349 * Encode and sign AD-KDCIssued authorization data.
7351 * @param [in] context Library context
7352 * @param [in] key Session key
7353 * @param [in] issuer The name of the issuing principal
7354 * @param [in] authdata List of authorization data to be signed
7355 * @param [out] ad_kdcissued List containing AD-KDCIssued authdata
7357 * This function wraps a list of authorization data entries @a authdata in an
7358 * AD-KDCIssued container (see RFC 4120 section 5.2.6.2) signed with @a key.
7359 * The result is returned in @a ad_kdcissued as a single-element list.
7361 krb5_error_code KRB5_CALLCONV
7362 krb5_make_authdata_kdc_issued(krb5_context context,
7363 const krb5_keyblock *key,
7364 krb5_const_principal issuer,
7365 krb5_authdata *const *authdata,
7366 krb5_authdata ***ad_kdcissued);
7369 * Unwrap and verify AD-KDCIssued authorization data.
7371 * @param [in] context Library context
7372 * @param [in] key Session key
7373 * @param [in] ad_kdcissued AD-KDCIssued authorization data to be unwrapped
7374 * @param [out] issuer Name of issuing principal (or NULL)
7375 * @param [out] authdata Unwrapped list of authorization data
7377 * This function unwraps an AD-KDCIssued authdatum (see RFC 4120 section
7378 * 5.2.6.2) and verifies its signature against @a key. The issuer field of the
7379 * authdatum element is returned in @a issuer, and the unwrapped list of
7380 * authdata is returned in @a authdata.
7382 krb5_error_code KRB5_CALLCONV
7383 krb5_verify_authdata_kdc_issued(krb5_context context,
7384 const krb5_keyblock *key,
7385 const krb5_authdata *ad_kdcissued,
7386 krb5_principal *issuer,
7387 krb5_authdata ***authdata);
7393 /* Microsoft defined types of data */
7394 #define KRB5_PAC_LOGON_INFO 1 /**< Logon information */
7395 #define KRB5_PAC_CREDENTIALS_INFO 2 /**< Credentials information */
7396 #define KRB5_PAC_SERVER_CHECKSUM 6 /**< Server checksum */
7397 #define KRB5_PAC_PRIVSVR_CHECKSUM 7 /**< KDC checksum */
7398 #define KRB5_PAC_CLIENT_INFO 10 /**< Client name and ticket info */
7399 #define KRB5_PAC_DELEGATION_INFO 11 /**< Constrained delegation info */
7400 #define KRB5_PAC_UPN_DNS_INFO 12 /**< User principal name and DNS info */
7402 struct krb5_pac_data;
7403 /** PAC data structure to convey authorization information */
7404 typedef struct krb5_pac_data *krb5_pac;
7407 * Add a buffer to a PAC handle.
7409 * @param [in] context Library context
7410 * @param [in] pac PAC handle
7411 * @param [in] type Buffer type
7412 * @param [in] data contents
7414 * This function adds a buffer of type @a type and contents @a data to @a pac
7415 * if there isn't already a buffer of this type present.
7417 * The valid values of @a type is one of the following:
7418 * @li #PAC_LOGON_INFO - Logon information
7419 * @li #PAC_CREDENTIALS_INFO - Credentials information
7420 * @li #PAC_SERVER_CHECKSUM - Server checksum
7421 * @li #PAC_PRIVSVR_CHECKSUM - KDC checksum
7422 * @li #PAC_CLIENT_INFO - Client name and ticket information
7423 * @li #PAC_DELEGATION_INFO - Constrained delegation information
7424 * @li #PAC_UPN_DNS_INFO - User principal name and DNS information
7426 * @retval 0 Success; otherwise - Kerberos error codes
7428 krb5_error_code KRB5_CALLCONV
7429 krb5_pac_add_buffer(krb5_context context, krb5_pac pac, krb5_ui_4 type,
7430 const krb5_data *data);
7433 * Free a PAC handle.
7435 * @param [in] context Library context
7436 * @param [in] pac PAC to be freed
7438 * This function frees the contents of @a pac and the structure itself.
7441 krb5_pac_free(krb5_context context, krb5_pac pac);
7444 * Retrieve a buffer value from a PAC.
7446 * @param [in] context Library context
7447 * @param [in] pac PAC handle
7448 * @param [in] type Type of buffer to retrieve
7449 * @param [out] data Buffer value
7451 * Use krb5_free_data_contents() to free @a data when it is no longer needed.
7453 * @retval 0 Success; otherwise - Kerberos error codes
7455 krb5_error_code KRB5_CALLCONV
7456 krb5_pac_get_buffer(krb5_context context, krb5_pac pac, krb5_ui_4 type,
7460 * Return an array of buffer types in a PAC handle.
7462 * @param [in] context Library context
7463 * @param [in] pac PAC handle
7464 * @param [out] len Number of entries in @a types
7465 * @param [out] types Array of buffer types
7467 * @retval 0 Success; otherwise - Kerberos error codes
7469 krb5_error_code KRB5_CALLCONV
7470 krb5_pac_get_types(krb5_context context, krb5_pac pac, size_t *len,
7474 * Create an empty Privilege Attribute Certificate (PAC) handle.
7476 * @param [in] context Library context
7477 * @param [out] pac New PAC handle
7479 * Use krb5_pac_free() to free @a pac when it is no longer needed.
7481 * @retval 0 Success; otherwise - Kerberos error codes
7483 krb5_error_code KRB5_CALLCONV
7484 krb5_pac_init(krb5_context context, krb5_pac *pac);
7487 * Unparse an encoded PAC into a new handle.
7489 * @param [in] context Library context
7490 * @param [in] ptr PAC buffer
7491 * @param [in] len Length of @a ptr
7492 * @param [out] pac PAC handle
7494 * Use krb5_pac_free() to free @a pac when it is no longer needed.
7496 * @retval 0 Success; otherwise - Kerberos error codes
7498 krb5_error_code KRB5_CALLCONV
7499 krb5_pac_parse(krb5_context context, const void *ptr, size_t len,
7505 * @param [in] context Library context
7506 * @param [in] pac PAC handle
7507 * @param [in] authtime Expected timestamp
7508 * @param [in] principal Expected principal name (or NULL)
7509 * @param [in] server Key to validate server checksum (or NULL)
7510 * @param [in] privsvr Key to validate KDC checksum (or NULL)
7512 * This function validates @a pac against the supplied @a server, @a privsvr,
7513 * @a principal and @a authtime. If @a principal is NULL, the principal and
7514 * authtime are not verified. If @a server or @a privsvr is NULL, the
7515 * corresponding checksum is not verified.
7517 * If successful, @a pac is marked as verified.
7519 * @note A checksum mismatch can occur if the PAC was copied from a cross-realm
7520 * TGT by an ignorant KDC; also Apple Mac OS X Server Open Directory (as of
7521 * 10.6) generates PACs with no server checksum at all. One should consider
7522 * not failing the whole authentication because of this reason, but, instead,
7523 * treating the ticket as if it did not contain a PAC or marking the PAC
7524 * information as non-verified.
7526 * @retval 0 Success; otherwise - Kerberos error codes
7528 krb5_error_code KRB5_CALLCONV
7529 krb5_pac_verify(krb5_context context, const krb5_pac pac,
7530 krb5_timestamp authtime, krb5_const_principal principal,
7531 const krb5_keyblock *server, const krb5_keyblock *privsvr);
7536 * @param [in] context Library context
7537 * @param [in] pac PAC handle
7538 * @param [in] authtime Expected timestamp
7539 * @param [in] principal Expected principal name (or NULL)
7540 * @param [in] server_key Key for server checksum
7541 * @param [in] privsvr_key Key for KDC checksum
7542 * @param [out] data Signed PAC encoding
7544 * This function signs @a pac using the keys @a server_key and @a privsvr_key
7545 * and returns the signed encoding in @a data. @a pac is modified to include
7546 * the server and KDC checksum buffers. Use krb5_free_data_contents() to free
7547 * @a data when it is no longer needed.
7549 krb5_error_code KRB5_CALLCONV
7550 krb5_pac_sign(krb5_context context, krb5_pac pac, krb5_timestamp authtime,
7551 krb5_const_principal principal, const krb5_keyblock *server_key,
7552 const krb5_keyblock *privsvr_key, krb5_data *data);
7555 * Allow the appplication to override the profile's allow_weak_crypto setting.
7557 * @param [in] context Library context
7558 * @param [in] enable Boolean flag
7560 * This function allows an application to override the allow_weak_crypto
7561 * setting. It is primarily for use by aklog.
7563 * @retval 0 (always)
7565 krb5_error_code KRB5_CALLCONV
7566 krb5_allow_weak_crypto(krb5_context context, krb5_boolean enable);
7568 /* This structure may be extended to contain more fields in the future. */
7569 struct krb5_trace_info {
7570 const char *message;
7574 (KRB5_CALLCONV *krb5_trace_callback)(krb5_context context,
7575 const struct krb5_trace_info *info,
7579 * Specify a callback function for trace events.
7581 * @param [in] context Library context
7582 * @param [in] fn Callback function
7583 * @param [in] cb_data Callback data
7585 * Specify a callback for trace events occurring in krb5 operations performed
7586 * within @a context. @a fn will be invoked with @a context as the first
7587 * argument, @a cb_data as the last argument, and a pointer to a struct
7588 * krb5_trace_info as the second argument. If the trace callback is reset via
7589 * this function or @a context is destroyed, @a fn will be invoked with a NULL
7590 * second argument so it can clean up @a cb_data. Supply a NULL value for @a
7591 * fn to disable trace callbacks within @a context.
7593 * @note This function overrides the information passed through the
7594 * @a KRB5_TRACE environment variable.
7596 * @return Returns KRB5_TRACE_NOSUPP if tracing is not supported in the library
7597 * (unless @a fn is NULL).
7599 krb5_error_code KRB5_CALLCONV
7600 krb5_set_trace_callback(krb5_context context, krb5_trace_callback fn,
7604 * Specify a file name for directing trace events.
7606 * @param [in] context Library context
7607 * @param [in] filename File name
7609 * Open @a filename for appending (creating it, if necessary) and set up a
7610 * callback to write trace events to it.
7612 * @note This function overrides the information passed through the
7613 * @a KRB5_TRACE environment variable.
7615 * @retval KRB5_TRACE_NOSUPP Tracing is not supported in the library.
7617 krb5_error_code KRB5_CALLCONV
7618 krb5_set_trace_filename(krb5_context context, const char *filename);
7626 /* Don't use this! We're going to phase it out. It's just here to keep
7627 applications from breaking right away. */
7628 #define krb5_const const
7630 #undef KRB5_ATTR_DEPRECATED
7632 #endif /* KRB5_GENERAL__ */