keyhole logo

Functions

Heimdal Kerberos 5 cryptography functions

Functions

KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_enctype_valid (krb5_context context, krb5_enctype etype)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_cksumtype_to_enctype (krb5_context context, krb5_cksumtype ctype, krb5_enctype *etype)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_encrypt_iov_ivec (krb5_context context, krb5_crypto crypto, unsigned usage, krb5_crypto_iov *data, int num_data, void *ivec)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_decrypt_iov_ivec (krb5_context context, krb5_crypto crypto, unsigned usage, krb5_crypto_iov *data, unsigned int num_data, void *ivec)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_create_checksum_iov (krb5_context context, krb5_crypto crypto, unsigned usage, krb5_crypto_iov *data, unsigned int num_data, krb5_cksumtype *type)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_verify_checksum_iov (krb5_context context, krb5_crypto crypto, unsigned usage, krb5_crypto_iov *data, unsigned int num_data, krb5_cksumtype *type)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_crypto_init (krb5_context context, const krb5_keyblock *key, krb5_enctype etype, krb5_crypto *crypto)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_crypto_destroy (krb5_context context, krb5_crypto crypto)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_crypto_getblocksize (krb5_context context, krb5_crypto crypto, size_t *blocksize)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_crypto_getenctype (krb5_context context, krb5_crypto crypto, krb5_enctype *enctype)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_crypto_getpadsize (krb5_context context, krb5_crypto crypto, size_t *padsize)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_crypto_getconfoundersize (krb5_context context, krb5_crypto crypto, size_t *confoundersize)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_enctype_disable (krb5_context context, krb5_enctype enctype)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_enctype_enable (krb5_context context, krb5_enctype enctype)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_allow_weak_crypto (krb5_context context, krb5_boolean enable)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_random_to_key (krb5_context context, krb5_enctype type, const void *data, size_t size, krb5_keyblock *key)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_crypto_fx_cf2 (krb5_context context, const krb5_crypto crypto1, const krb5_crypto crypto2, krb5_data *pepper1, krb5_data *pepper2, krb5_enctype enctype, krb5_keyblock *res)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_generate_subkey_extended (krb5_context context, const krb5_keyblock *key, krb5_enctype etype, krb5_keyblock **subkey)
KRB5_LIB_FUNCTION void
KRB5_LIB_CALL 
krb5_keyblock_zero (krb5_keyblock *keyblock)
KRB5_LIB_FUNCTION void
KRB5_LIB_CALL 
krb5_free_keyblock_contents (krb5_context context, krb5_keyblock *keyblock)
KRB5_LIB_FUNCTION void
KRB5_LIB_CALL 
krb5_free_keyblock (krb5_context context, krb5_keyblock *keyblock)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_copy_keyblock_contents (krb5_context context, const krb5_keyblock *inblock, krb5_keyblock *to)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_copy_keyblock (krb5_context context, const krb5_keyblock *inblock, krb5_keyblock **to)
KRB5_LIB_FUNCTION krb5_enctype
KRB5_LIB_CALL 
krb5_keyblock_get_enctype (const krb5_keyblock *block)
KRB5_LIB_FUNCTION
krb5_error_code KRB5_LIB_CALL 
krb5_keyblock_init (krb5_context context, krb5_enctype type, const void *data, size_t size, krb5_keyblock *key)

Function Documentation

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_allow_weak_crypto ( krb5_context  context,
krb5_boolean  enable 
)

Enable or disable all weak encryption types

Parameters:
contextKerberos 5 context
enabletrue to enable, false to disable
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_cksumtype_to_enctype ( krb5_context  context,
krb5_cksumtype  ctype,
krb5_enctype *  etype 
)

Return the coresponding encryption type for a checksum type.

Parameters:
contextKerberos context
ctypeThe checksum type to get the result enctype for
etypeThe returned encryption, when the matching etype is not found, etype is set to ETYPE_NULL.
Returns:
Return an error code for an failure or 0 on success.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_keyblock ( krb5_context  context,
const krb5_keyblock *  inblock,
krb5_keyblock **  to 
)

Copy a keyblock, free the output keyblock with krb5_free_keyblock().

Parameters:
contexta Kerberos 5 context
inblockthe key to copy
tothe output key.
Returns:
0 on success or a Kerberos 5 error code
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_copy_keyblock_contents ( krb5_context  context,
const krb5_keyblock *  inblock,
krb5_keyblock *  to 
)

Copy a keyblock, free the output keyblock with krb5_free_keyblock_contents().

Parameters:
contexta Kerberos 5 context
inblockthe key to copy
tothe output key.
Returns:
0 on success or a Kerberos 5 error code
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_create_checksum_iov ( krb5_context  context,
krb5_crypto  crypto,
unsigned  usage,
krb5_crypto_iov data,
unsigned int  num_data,
krb5_cksumtype *  type 
)

Create a Kerberos message checksum.

Parameters:
contextKerberos context
cryptoKerberos crypto context
usageKey usage for this buffer
dataarray of buffers to process
num_datalength of array
typeoutput data
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_crypto_destroy ( krb5_context  context,
krb5_crypto  crypto 
)

Free a crypto context created by krb5_crypto_init().

Parameters:
contextKerberos context
cryptocrypto context to free
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_crypto_fx_cf2 ( krb5_context  context,
const krb5_crypto  crypto1,
const krb5_crypto  crypto2,
krb5_data *  pepper1,
krb5_data *  pepper2,
krb5_enctype  enctype,
krb5_keyblock *  res 
)

The FX-CF2 key derivation function, used in FAST and preauth framework.

Parameters:
contextKerberos 5 context
crypto1first key to combine
crypto2second key to combine
pepper1factor to combine with first key to garante uniqueness
pepper2factor to combine with second key to garante uniqueness
enctypethe encryption type of the resulting key
resallocated key, free with krb5_free_keyblock_contents()
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_crypto_getblocksize ( krb5_context  context,
krb5_crypto  crypto,
size_t *  blocksize 
)

Return the blocksize used algorithm referenced by the crypto context

Parameters:
contextKerberos context
cryptocrypto context to query
blocksizethe resulting blocksize
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_crypto_getconfoundersize ( krb5_context  context,
krb5_crypto  crypto,
size_t *  confoundersize 
)

Return the confounder size used by the crypto context

Parameters:
contextKerberos context
cryptocrypto context to query
confoundersizethe returned confounder size
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_crypto_getenctype ( krb5_context  context,
krb5_crypto  crypto,
krb5_enctype *  enctype 
)

Return the encryption type used by the crypto context

Parameters:
contextKerberos context
cryptocrypto context to query
enctypethe resulting encryption type
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_crypto_getpadsize ( krb5_context  context,
krb5_crypto  crypto,
size_t *  padsize 
)

Return the padding size used by the crypto context

Parameters:
contextKerberos context
cryptocrypto context to query
padsizethe return padding size
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_crypto_init ( krb5_context  context,
const krb5_keyblock *  key,
krb5_enctype  etype,
krb5_crypto *  crypto 
)

Create a crypto context used for all encryption and signature operation. The encryption type to use is taken from the key, but can be overridden with the enctype parameter. This can be useful for encryptions types which is compatiable (DES for example).

To free the crypto context, use krb5_crypto_destroy().

Parameters:
contextKerberos context
keythe key block information with all key data
etypethe encryption type
cryptothe resulting crypto context
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_decrypt_iov_ivec ( krb5_context  context,
krb5_crypto  crypto,
unsigned  usage,
krb5_crypto_iov data,
unsigned int  num_data,
void *  ivec 
)

Inline decrypt a Kerberos message.

Parameters:
contextKerberos context
cryptoKerberos crypto context
usageKey usage for this buffer
dataarray of buffers to process
num_datalength of array
ivecinitial cbc/cts vector
Returns:
Return an error code or 0.

1. KRB5_CRYPTO_TYPE_HEADER 2. one KRB5_CRYPTO_TYPE_DATA and array [0,...] of KRB5_CRYPTO_TYPE_SIGN_ONLY in any order, however the receiver have to aware of the order. KRB5_CRYPTO_TYPE_SIGN_ONLY is commonly used unencrypoted protocol headers and trailers. The output data will be of same size as the input data or shorter.

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_encrypt_iov_ivec ( krb5_context  context,
krb5_crypto  crypto,
unsigned  usage,
krb5_crypto_iov data,
int  num_data,
void *  ivec 
)

Inline encrypt a kerberos message

Parameters:
contextKerberos context
cryptoKerberos crypto context
usageKey usage for this buffer
dataarray of buffers to process
num_datalength of array
ivecinitial cbc/cts vector
Returns:
Return an error code or 0.

Kerberos encrypted data look like this:

1. KRB5_CRYPTO_TYPE_HEADER 2. array [1,...] KRB5_CRYPTO_TYPE_DATA and array [0,...] KRB5_CRYPTO_TYPE_SIGN_ONLY in any order, however the receiver have to aware of the order. KRB5_CRYPTO_TYPE_SIGN_ONLY is commonly used headers and trailers. 3. KRB5_CRYPTO_TYPE_PADDING, at least on padsize long if padsize > 1 4. KRB5_CRYPTO_TYPE_TRAILER

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_enctype_disable ( krb5_context  context,
krb5_enctype  enctype 
)

Disable encryption type

Parameters:
contextKerberos 5 context
enctypeencryption type to disable
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_enctype_enable ( krb5_context  context,
krb5_enctype  enctype 
)

Enable encryption type

Parameters:
contextKerberos 5 context
enctypeencryption type to enable
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_enctype_valid ( krb5_context  context,
krb5_enctype  etype 
)

Check if a enctype is valid, return 0 if it is.

Parameters:
contextKerberos context
etypeenctype to check if its valid or not
Returns:
Return an error code for an failure or 0 on success (enctype valid).
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_keyblock ( krb5_context  context,
krb5_keyblock *  keyblock 
)

Free a keyblock, also zero out the content of the keyblock, uses krb5_free_keyblock_contents() to free the content.

Parameters:
contexta Kerberos 5 context
keyblockkeyblock to free, NULL is valid argument
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_free_keyblock_contents ( krb5_context  context,
krb5_keyblock *  keyblock 
)

Free a keyblock's content, also zero out the content of the keyblock.

Parameters:
contexta Kerberos 5 context
keyblockkeyblock content to free, NULL is valid argument
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_generate_subkey_extended ( krb5_context  context,
const krb5_keyblock *  key,
krb5_enctype  etype,
krb5_keyblock **  subkey 
)

Generate subkey, from keyblock

Parameters:
contextkerberos context
keysession key
etypeencryption type of subkey, if ETYPE_NULL, use key's enctype
subkeyreturned new, free with krb5_free_keyblock().
Returns:
0 on success or a Kerberos 5 error code
KRB5_LIB_FUNCTION krb5_enctype KRB5_LIB_CALL krb5_keyblock_get_enctype ( const krb5_keyblock *  block )

Get encryption type of a keyblock.

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_keyblock_init ( krb5_context  context,
krb5_enctype  type,
const void *  data,
size_t  size,
krb5_keyblock *  key 
)

Fill in `key' with key data of type `enctype' from `data' of length `size'. Key should be freed using krb5_free_keyblock_contents().

Returns:
0 on success or a Kerberos 5 error code
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_keyblock_zero ( krb5_keyblock *  keyblock )

Zero out a keyblock

Parameters:
keyblockkeyblock to zero out
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_random_to_key ( krb5_context  context,
krb5_enctype  type,
const void *  data,
size_t  size,
krb5_keyblock *  key 
)

Converts the random bytestring to a protocol key according to Kerberos crypto frame work. It may be assumed that all the bits of the input string are equally random, even though the entropy present in the random source may be limited.

Parameters:
contextKerberos 5 context
typethe enctype resulting key will be of
datainput random data to convert to a key
sizesize of input random data, at least krb5_enctype_keysize() long
keykey, output key, free with krb5_free_keyblock_contents()
Returns:
Return an error code or 0.
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_verify_checksum_iov ( krb5_context  context,
krb5_crypto  crypto,
unsigned  usage,
krb5_crypto_iov data,
unsigned int  num_data,
krb5_cksumtype *  type 
)

Verify a Kerberos message checksum.

Parameters:
contextKerberos context
cryptoKerberos crypto context
usageKey usage for this buffer
dataarray of buffers to process
num_datalength of array
typereturn checksum type if not NULL
Returns:
Return an error code or 0.

Generated on Fri Dec 6 2013 08:15:58 for HeimdalKerberos5library by doxygen 1.7.2