krb5_crypto(3)

πŸ“¦
version 7.8.0 Β· 3 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, epel 10, epel 9, fedora 43, fedora 44

krb5_crypto(3) β€” Heimdal Kerberos 5 library

πŸ’– NAME πŸ’–

krb5_crypto β€” Heimdal Kerberos 5 cryptography functions, bestie. That's the whole vibe.

✨ SYNOPSIS ✨

okay so here's the entire cast of functions, literally every single one, no skips:

   Functions
       HEIMDAL_WARN_UNUSED_RESULT_ATTRIBUTE KRB5_LIB_FUNCTION krb5_error_code
           KRB5_LIB_CALL krb5_generate_random (void *buf, size_t len)
       KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_generate_random_block (void
           *buf, size_t len)
       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_boolean KRB5_LIB_CALL krb5_is_enctype_weak
           (krb5_context context, krb5_enctype enctype)
       KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
           _krb5_enctype_requires_random_salt (krb5_context context,
           krb5_enctype enctype)
       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)
       krb5_error_code _krb5_SP800_108_HMAC_KDF (krb5_context context, const
           krb5_data *kdf_K1, const krb5_data *kdf_label, const krb5_data
           *kdf_context, const EVP_MD *md, krb5_data *kdf_K0)

🌸 Detailed Description 🌸

okay so the original page has this heading and then literally nothing before Function Documentation. No extra lore, bestie. Just vibes. πŸ’…

πŸ‘‘ Function Documentation πŸ‘‘

_krb5_enctype_requires_random_salt

   KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL
       _krb5_enctype_requires_random_salt (krb5_context context, krb5_enctype
       enctype)

Returns whether the encryption type should use randomly generated salts. Like, does this enctype want its salt to have a random little sprinkle? ✨

Parameters

  • context β€” Kerberos 5 context. The main character.
  • enctype β€” encryption type to probe. The one we're checking.

Returns

Returns true if generated salts should have random component. So true = random salt vibes, false = no random component.


_krb5_SP800_108_HMAC_KDF

   krb5_error_code _krb5_SP800_108_HMAC_KDF (krb5_context context, const
       krb5_data * kdf_K1, const krb5_data * kdf_label, const krb5_data *
       kdf_context, const EVP_MD * md, krb5_data * kdf_K0)

As described in SP800-108 5.1 (for HMAC). That's the tea. πŸ«–

Parameters

  • context β€” Kerberos 5 context.
  • kdf_K1 β€” Base key material.
  • kdf_label β€” A string that identifies the purpose for the derived key.
  • kdf_context β€” A binary string containing parties, nonce, etc.
  • md β€” Message digest function to use for PRF.
  • kdf_K0 β€” Derived key data.

Returns

Return an error code for an failure or 0 on success. So 0 = slay, error code = not slay.


krb5_allow_weak_crypto

   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

  • context β€” Kerberos 5 context.
  • enable β€” true to enable, false to disable.

Returns

Return an error code or 0.


krb5_cksumtype_to_enctype

   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. (yes, the original says "coresponding", we're keeping the vibe.)

Parameters

  • context β€” Kerberos context.
  • ctype β€” The checksum type to get the result enctype for.
  • etype β€” The 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_copy_keyblock

   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

  • context β€” a Kerberos 5 context.
  • inblock β€” the key to copy.
  • to β€” the output key.

Returns

0 on success or a Kerberos 5 error code


krb5_copy_keyblock_contents

   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

  • context β€” a Kerberos 5 context.
  • inblock β€” the key to copy.
  • to β€” the output key.

Returns

0 on success or a Kerberos 5 error code


krb5_create_checksum_iov

   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

  • context β€” Kerberos context.
  • crypto β€” Kerberos crypto context.
  • usage β€” Key usage for this buffer.
  • data β€” array of buffers to process.
  • num_data β€” length of array.
  • type β€” output data.

Returns

Return an error code or 0.


krb5_crypto_destroy

   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

  • context β€” Kerberos context.
  • crypto β€” crypto context to free.

Returns

Return an error code or 0.


krb5_crypto_fx_cf2

   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

  • context β€” Kerberos 5 context.
  • crypto1 β€” first key to combine.
  • crypto2 β€” second key to combine.
  • pepper1 β€” factor to combine with first key to garante uniqueness.
  • pepper2 β€” factor to combine with second key to garante uniqueness.
  • enctype β€” the encryption type of the resulting key.
  • res β€” allocated key, free with krb5_free_keyblock_contents().

Returns

Return an error code or 0.


krb5_crypto_getblocksize

   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

  • context β€” Kerberos context.
  • crypto β€” crypto context to query.
  • blocksize β€” the resulting blocksize.

Returns

Return an error code or 0.


krb5_crypto_getconfoundersize

   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

  • context β€” Kerberos context.
  • crypto β€” crypto context to query.
  • confoundersize β€” the returned confounder size.

Returns

Return an error code or 0.


krb5_crypto_getenctype

   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

  • context β€” Kerberos context.
  • crypto β€” crypto context to query.
  • enctype β€” the resulting encryption type.

Returns

Return an error code or 0.


krb5_crypto_getpadsize

   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

  • context β€” Kerberos context.
  • crypto β€” crypto context to query.
  • padsize β€” the return padding size.

Returns

Return an error code or 0.


krb5_crypto_init

   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:

  • context β€” Kerberos context
  • key β€” the key block information with all key data
  • etype β€” the encryption type
  • crypto β€” the resulting crypto context

Returns: Return an error code or 0.


πŸ¦‹ krb5_decrypt_iov_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)

Inline decrypt a Kerberos message. It's giving decryption, bestie.

Parameters:

  • context β€” Kerberos context
  • crypto β€” Kerberos crypto context
  • usage β€” Key usage for this buffer
  • data β€” array of buffers to process
  • num_data β€” length of array
  • ivec β€” initial 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 has to be aware of the order. KRB5_CRYPTO_TYPE_SIGN_ONLY is commonly used for unencrypted protocol headers and trailers. The output data will be of same size as the input data or shorter.

πŸ”₯ krb5_encrypt_iov_ivec πŸ”₯

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. Yes, the encryption vibe.

Parameters:

  • context β€” Kerberos context
  • crypto β€” Kerberos crypto context
  • usage β€” Key usage for this buffer
  • data β€” array of buffers to process
  • num_data β€” length of array
  • ivec β€” initial 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 has to be aware of the order. KRB5_CRYPTO_TYPE_SIGN_ONLY is commonly used for headers and trailers.
  3. KRB5_CRYPTO_TYPE_PADDING, at least on padsize long if padsize > 1
  4. KRB5_CRYPTO_TYPE_TRAILER

πŸ’… krb5_enctype_disable πŸ’…

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_enctype_disable
    (krb5_context context, krb5_enctype enctype)

Disable encryption type. No more of that etype, periodt.

Parameters:

  • context β€” Kerberos 5 context
  • enctype β€” encryption type to disable

Returns: Return an error code or 0.


✨ krb5_enctype_enable ✨

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_enctype_enable
    (krb5_context context, krb5_enctype enctype)

Enable encryption type. Bring it back, bestie.

Parameters:

  • context β€” Kerberos 5 context
  • enctype β€” encryption type to enable

Returns: Return an error code or 0.


🌸 krb5_enctype_valid 🌸

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. It's giving validation.

Parameters:

  • context β€” Kerberos context
  • etype β€” enctype to check if its valid or not

Returns: Return an error code for an failure or 0 on success (enctype valid).


πŸŽ€ krb5_free_keyblock πŸŽ€

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:

  • context β€” a Kerberos 5 context
  • keyblock β€” keyblock to free, NULL is valid argument

🫢 krb5_free_keyblock_contents 🫢

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:

  • context β€” a Kerberos 5 context
  • keyblock β€” keyblock content to free, NULL is valid argument

🌈 krb5_generate_random 🌈

HEIMDAL_WARN_UNUSED_RESULT_ATTRIBUTE KRB5_LIB_FUNCTION krb5_error_code
    KRB5_LIB_CALL krb5_generate_random (void * buf, size_t len)

Fill buffer buf with len bytes of PRNG randomness that is ok to use for key generation, padding and public disclosing the randomness w/o disclosing the randomness source.

This function can fail, and callers must check the return value. No cap.

Parameters:

  • buf β€” a buffer to fill with randomness
  • len β€” length of memory that buf points to.

Returns: return 0 on success or HEIM_ERR_RANDOM_OFFLINE if the function failed to initialize the randomness source.


πŸ’€ krb5_generate_random_block πŸ’€

KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_generate_random_block (void * buf,
    size_t len)

Fill buffer buf with len bytes of PRNG randomness that is ok to use for key generation, padding and public disclosing the randomness w/o disclosing the randomness source.

WARNING: This function can NOT fail, instead it will abort() and program will crash. 😭

If this function is called after a successful krb5_init_context(), the chance of it failing is low due to that krb5_init_context() pulls out some random, and quite commonly the randomness sources will not fail once it have started to produce good output, /dev/urandom behaves that way.

Parameters:

  • buf β€” a buffer to fill with randomness
  • len β€” length of memory that buf points to.

🧚 krb5_generate_subkey_extended 🧚

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. It's giving subkey energy.

Parameters:

  • context β€” kerberos context
  • key β€” session key
  • etype β€” encryption type of subkey, if ETYPE_NULL, use key's enctype
  • subkey β€” returned new, free with krb5_free_keyblock().

Returns: 0 on success or a Kerberos 5 error code


πŸ‘‘ krb5_is_enctype_weak πŸ‘‘

KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_is_enctype_weak
    (krb5_context context, krb5_enctype enctype)

Returns is the encryption is strong or weak. Vibe check on that enctype.

Parameters:

  • context β€” Kerberos 5 context
  • enctype β€” encryption type to probe

Returns: Returns true if encryption type is weak or is not supported.


⭐ krb5_keyblock_get_enctype ⭐

KRB5_LIB_FUNCTION krb5_enctype KRB5_LIB_CALL krb5_keyblock_get_enctype
    (const krb5_keyblock * block)

Get encryption type of a keyblock. Simple as that.


πŸ’œ krb5_keyblock_init πŸ’œ

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_keyblock_zero πŸ“

KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_keyblock_zero (krb5_keyblock *
    keyblock)

Zero out a keyblock. Bye bye key data.

Parameters:

  • keyblock β€” keyblock to zero out

🌟 krb5_random_to_key 🌟

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:

  • context β€” Kerberos 5 context
  • type β€” the enctype resulting key will be of
  • data β€” input random data to convert to a key
  • size β€” size of input random data, at least krb5_enctype_keysize() long
  • key β€” key, output key, free with krb5_free_keyblock_contents()

Returns: Return an error code or 0.


πŸ’– krb5_verify_checksum_iov πŸ’–

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. Trust but verify, bestie.

Parameters:

  • context β€” Kerberos context
  • crypto β€” Kerberos crypto context
  • usage β€” Key usage for this buffer
  • data β€” array of buffers to process
  • num_data β€” length of array
  • type β€” return checksum type if not NULL

Returns: Return an error code or 0.


🌸 Author 🌸

Generated automatically by Doxygen for Heimdal Kerberos 5 library from the source code.


That's the vibe. This page is from Heimdal Kerberos 5 library, version 7.8.0, dated Tue Nov 15 2022. Stay slay, bestie! πŸ’–βœ¨

πŸ“¦ where this page comes from