krb5_storage(3)

📦

version 7.8.0 · 3 versions

7.8.0 · alpine 3.22, alpine 3.23, alpine 3.24, epel 10, epel 9, fedora 43, fedora 44 (latest)
14.5 · freebsd 14.5, nixpkgs unstable
11.0 · nixpkgs unstable

, in alpine 3.22, alpine 3.23, alpine 3.24, epel 10, epel 9, fedora 43, fedora 44

💾 krb5_storage — Heimdal Kerberos 5 library, section 3

okay bestie, sit DOWN, because we're about to talk about storage — the Heimdal Kerberos 5 storage functions. this is the whole vibe of krb5_storage(3), and it's a lot, so buckle up. ✨

🌸 NAME 🌸

krb5_storage — Heimdal Kerberos 5 storage functions 💖

✨ SYNOPSIS ✨

🫶 Functions

no cap, there are SO many of these. every single one of them, exactly as written, here we go:

KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_flags
    (krb5_storage *sp, krb5_flags flags)
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_clear_flags
    (krb5_storage *sp, krb5_flags flags)
KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_storage_is_flags
    (krb5_storage *sp, krb5_flags flags)
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_byteorder
    (krb5_storage *sp, krb5_flags byteorder)
KRB5_LIB_FUNCTION krb5_flags KRB5_LIB_CALL krb5_storage_get_byteorder
    (krb5_storage *sp)
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_max_alloc
    (krb5_storage *sp, size_t size)
KRB5_LIB_FUNCTION off_t KRB5_LIB_CALL krb5_storage_seek (krb5_storage
    *sp, off_t offset, int whence)
KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_truncate (krb5_storage
    *sp, off_t offset)
KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_fsync (krb5_storage
    *sp)
KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_read
    (krb5_storage *sp, void *buf, size_t len)
KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_write
    (krb5_storage *sp, const void *buf, size_t len)
KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_eof_code
    (krb5_storage *sp, int code)
KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_get_eof_code
    (krb5_storage *sp)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_free
    (krb5_storage *sp)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_to_data
    (krb5_storage *sp, krb5_data *data)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int32
    (krb5_storage *sp, int32_t value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int64
    (krb5_storage *sp, int64_t value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint32
    (krb5_storage *sp, uint32_t value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint64
    (krb5_storage *sp, uint64_t value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int64
    (krb5_storage *sp, int64_t *value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint64
    (krb5_storage *sp, uint64_t *value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int32
    (krb5_storage *sp, int32_t *value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint32
    (krb5_storage *sp, uint32_t *value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int16
    (krb5_storage *sp, int16_t value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint16
    (krb5_storage *sp, uint16_t value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int16
    (krb5_storage *sp, int16_t *value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint16
    (krb5_storage *sp, uint16_t *value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_int8
    (krb5_storage *sp, int8_t value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_uint8
    (krb5_storage *sp, uint8_t value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int8
    (krb5_storage *sp, int8_t *value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint8
    (krb5_storage *sp, uint8_t *value)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_data
    (krb5_storage *sp, krb5_data data)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_data
    (krb5_storage *sp, krb5_data *data)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_string
    (krb5_storage *sp, const char *s)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_string
    (krb5_storage *sp, char **string)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_stringz
    (krb5_storage *sp, const char *s)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_stringz
    (krb5_storage *sp, char **string)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_principal
    (krb5_storage *sp, krb5_const_principal p)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_principal
    (krb5_storage *sp, krb5_principal *princ)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_keyblock
    (krb5_storage *sp, krb5_keyblock p)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_keyblock
    (krb5_storage *sp, krb5_keyblock *p)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_times
    (krb5_storage *sp, krb5_times times)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_times
    (krb5_storage *sp, krb5_times *times)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_address
    (krb5_storage *sp, krb5_address p)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_address
    (krb5_storage *sp, krb5_address *adr)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_addrs
    (krb5_storage *sp, krb5_addresses p)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_addrs
    (krb5_storage *sp, krb5_addresses *adr)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_authdata
    (krb5_storage *sp, krb5_authdata auth)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_authdata
    (krb5_storage *sp, krb5_authdata *auth)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds
    (krb5_storage *sp, krb5_creds *creds)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds
    (krb5_storage *sp, krb5_creds *creds)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds_tag
    (krb5_storage *sp, krb5_creds *creds)
KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds_tag
    (krb5_storage *sp, krb5_creds *creds)
KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL krb5_storage_emem (void)
KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL krb5_storage_from_fd (int
    fd_in)
KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL krb5_storage_from_mem
    (void *buf, size_t len)
KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL krb5_storage_from_data
    (krb5_data *data)
KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL
    krb5_storage_from_readonly_mem (const void *buf, size_t len)
KRB5_LIB_FUNCTION krb5_storage *KRB5_LIB_CALL krb5_storage_from_socket
    (krb5_socket_t sock_in)

👑 Detailed Description

ngl, this is where it all lives. the detailed description is the big picture, and the function documentation below is the receipts. keep scrolling bestie, we got you. 💅

🎀 Function Documentation 🎀

🌈 `krb5_ret_address`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_address
    (krb5_storage * sp, krb5_address * adr)

reads an address block out of the storage. it's giving "gimme that address." 🦋

Parameters

sp — the storage buffer to write to
adr — the address block read from storage

Returns

0 on success, a Kerberos 5 error code on failure. periodt. ✨

🌈 `krb5_ret_addrs`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_addrs (krb5_storage
    * sp, krb5_addresses * adr)

reads an addresses block from the storage. plural. multiple addresses. the whole squad. 🫶

Parameters

sp — the storage buffer to write to
adr — the addresses block read from storage

Returns

0 on success, a Kerberos 5 error code on failure. 💖

🌈 `krb5_ret_authdata`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_authdata
    (krb5_storage * sp, krb5_authdata * auth)

reads the auth data from the storage. iconic. 🔥

Parameters

sp — the storage buffer to write to
auth — the auth data block read from storage

Returns

0 on success, a Kerberos 5 error code on failure. 🎀

🌈 `krb5_ret_creds`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds (krb5_storage
    * sp, krb5_creds * creds)

reads a credentials block from the storage. credentials are the main character here, fr fr. 👑

Parameters

sp — the storage buffer to write to
creds — the credentials block read from storage

Returns

0 on success, a Kerberos 5 error code on failure. 💜

🌈 `krb5_ret_creds_tag`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_creds_tag
    (krb5_storage * sp, krb5_creds * creds)

reads a tagged credentials block from the storage. tagged, as in it came with a little label, and yes that's a serve. 🌸

Parameters

sp — the storage buffer to write to
creds — the credentials block read from storage

Returns

0 on success, a Kerberos 5 error code on failure. ✨

🌈 `krb5_ret_data`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_data (krb5_storage
    * sp, krb5_data * data)

parses some data out of the storage. this one reads from the buffer, so pay attention to which direction you're going bestie. 🙈

Parameters

sp — the storage buffer to read from
data — the parsed data

Returns

0 on success, a Kerberos 5 error code on failure. 🍓

🌈 `krb5_ret_int16`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int16 (krb5_storage
    * sp, int16_t * value)

reads an int16 from storage. the byte order is controlled by the settings on the storage — see krb5_storage_set_byteorder(). iykyk. 💅

Parameters

sp — the storage to write too
value — the value read from the buffer

Returns

0 for success, or a Kerberos 5 error code on failure. 🦋

🌈 `krb5_ret_int32`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int32 (krb5_storage
    * sp, int32_t * value)

reads an int32 from storage. same deal — byte order is controlled by the settings on the storage, see krb5_storage_set_byteorder(). 🌈

Parameters

sp — the storage to write too
value — the value read from the buffer

Returns

0 for success, or a Kerberos 5 error code on failure. 💖

🌈 `krb5_ret_int64`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int64 (krb5_storage
    * sp, int64_t * value)

reads an int64 from storage. yes, still byte order-controlled by the storage settings, see krb5_storage_set_byteorder(). sixty-four whole bits of it. 😭

Parameters

sp — the storage to write too
value — the value read from the buffer

Returns

0 for success, or a Kerberos 5 error code on failure. ⭐

🌈 `krb5_ret_int8`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_int8 (krb5_storage
    * sp, int8_t * value)

reads an int8 from storage. that's it. tiny. one byte. precious. 🎀

Parameters

sp — the storage to write too
value — the value read from the buffer

Returns

0 for success, or a Kerberos 5 error code on failure. 💜

🌈 `krb5_ret_keyblock`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_keyblock
    (krb5_storage * sp, krb5_keyblock * p)

reads a keyblock from the storage. ✨ heads up bestie: you free it using krb5_free_keyblock() when you're done with it. don't ghost your memory. 🧚

Parameters

sp — the storage buffer to write to
p — the keyblock read from storage, free using krb5_free_keyblock()

Returns

0 on success, a Kerberos 5 error code on failure. 🔥

🌈 `krb5_ret_principal`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_principal
    (krb5_storage * sp, krb5_principal * princ)

parses a principal from the storage. the literal main character of Kerberos, no exaggeration. 👑

Parameters

sp — the storage buffer to read from
princ — the parsed principal

Returns

0 on success, a Kerberos 5 error code on failure. 💖

🌈 `krb5_ret_string`

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_string
    (krb5_storage * sp, char ** string)

parses a string from the storage. a whole string. slay. 🌸

Parameters

sp — the storage buffer to read from
string — the parsed string

Returns

0 on success, a Kerberos 5 error code on failure. 🫶

`krb5_ret_stringz()` — grab a lil string that knows when to stop ✨

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_stringz
    (krb5_storage * sp, char ** string)

Okay so this one parses a zero terminated string out of the storage. Cute, self-contained, knows its own boundaries. 💅

Parameters
- sp — the storage buffer to read from
- string — the parsed string
Returns — 0 on success, a Kerberos 5 error code on failure.

`krb5_ret_times()` — time block go brrr 🕰️

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_times (krb5_storage
    * sp, krb5_times * times)

Reads a whole times block out of the storage. Not one time, a block of times. she's thorough. 💖

Parameters
- sp — the storage buffer to write to
- times — the times block read from storage
Returns — 0 on success, a Kerberos 5 error code on failure.

`krb5_ret_uint16()` — smol number, big vibes 🌸

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint16
    (krb5_storage * sp, uint16_t * value)

Reads a int16 from storage. The byte order is controlled by the settings on the storage, see krb5_storage_set_byteorder(). Don't fight it, bestie, the storage decides. 🫶

Parameters
- sp — the storage to write too
- value — the value read from the buffer
Returns — 0 for success, or a Kerberos 5 error code on failure.

`krb5_ret_uint32()` — the classic ✨

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint32
    (krb5_storage * sp, uint32_t * value)

Reads a uint32 from storage. Byte order? Same deal, it's all up to the settings on the storage, peep krb5_storage_set_byteorder().

Parameters
- sp — the storage to write too
- value — the value read from the buffer
Returns — 0 for success, or a Kerberos 5 error code on failure.

`krb5_ret_uint64()` — the big one 💪

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint64
    (krb5_storage * sp, uint64_t * value)

Reads a uint64 from storage. Yup, byte order is controlled by the settings on the storage, see krb5_storage_set_byteorder(). It's giving consistency, we love that for us. 👑

Parameters
- sp — the storage to write too
- value — the value read from the buffer
Returns — 0 for success, or a Kerberos 5 error code on failure.

`krb5_ret_uint8()` — baby byte energy 🍓

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_ret_uint8 (krb5_storage
    * sp, uint8_t * value)

Reads a uint8 from storage. That's it. That's the whole job. iconic honestly.

Parameters
- sp — the storage to write too
- value — the value read from the buffer
Returns — 0 for success, or a Kerberos 5 error code on failure.

`krb5_storage_clear_flags()` — un-set those flags, periodt 🎀

KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_clear_flags (krb5_storage
    * sp, krb5_flags flags)

Clears the flags on a storage buffer. Yes it returns void, it just does the thing, no receipts needed. 💅

Parameters
- sp — the storage buffer to clear the flags on
- flags — the flags to clear

`krb5_storage_emem()` — elastic memory backend, she stretches 🧚

KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_emem (void)

Creates an elastic (allocating) memory storage backend. Memory is allocated on demand — like, when it needs it, it gets it. No hoarding. 🌈

Free the returned krb5_storage with krb5_storage_free() or it will simply live with you forever, rent free. 😭

Returns — A krb5_storage on success, or NULL on out of memory error.
See also
- krb5_storage_from_mem()
- krb5_storage_from_readonly_mem()
- krb5_storage_from_fd()
- krb5_storage_from_data()
- krb5_storage_from_socket()

`krb5_storage_free()` — release her, let her go 🦋

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_free
    (krb5_storage * sp)

Frees a krb5 storage. Closure! Growth! We love to see it. 💖

Parameters
- sp — the storage to free.
Returns — An Kerberos 5 error code.

`krb5_storage_from_data()` — fixed size memory block, no notes 💅

KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_data
    (krb5_data * data)

Creates a fixed size memory storage block. Fixed size, bestie. She's not growing, she's not shrinking, she's exactly what she is. main character energy.

Returns — A krb5_storage on success, or NULL on out of memory error.
See also
- krb5_storage_mem()
- krb5_storage_from_mem()
- krb5_storage_from_readonly_mem()
- krb5_storage_from_fd()

`krb5_storage_from_fd()` — file descriptor, but make it storage 🗂️

KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_fd (int
    fd_in)

Returns — A krb5_storage on success, or NULL on out of memory error.
See also
- krb5_storage_emem()
- krb5_storage_from_mem()
- krb5_storage_from_readonly_mem()
- krb5_storage_from_data()
- krb5_storage_from_socket()

`krb5_storage_from_mem()` — memory block, fixed size, iconic ✨

KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_mem (void *
    buf, size_t len)

Creates a fixed size memory storage block.

Returns — A krb5_storage on success, or NULL on out of memory error.
See also
- krb5_storage_mem()
- krb5_storage_from_readonly_mem()
- krb5_storage_from_data()
- krb5_storage_from_fd()
- krb5_storage_from_socket()

`krb5_storage_from_readonly_mem()` — look, don't touch 🙈

KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_readonly_mem
    (const void * buf, size_t len)

Creates a fixed size memory storage block that is read only. She's behind the velvet rope, bestie. Admire from a distance. 🎀

Returns — A krb5_storage on success, or NULL on out of memory error.
See also
- krb5_storage_mem()
- krb5_storage_from_mem()
- krb5_storage_from_data()
- krb5_storage_from_fd()

`krb5_storage_from_socket()` — socket storage, networking era 🔥

KRB5_LIB_FUNCTION krb5_storage* KRB5_LIB_CALL krb5_storage_from_socket
    (krb5_socket_t sock_in)

Returns — A krb5_storage on success, or NULL on out of memory error.
See also
- krb5_storage_emem()
- krb5_storage_from_mem()
- krb5_storage_from_readonly_mem()
- krb5_storage_from_data()
- krb5_storage_from_fd()

`krb5_storage_fsync()` — push it to the backing store 💾

KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_fsync (krb5_storage * sp)

Syncs the storage buffer to its backing store. And if there's, like, no backing store? This function will return success anyway. She's flexible like that. 🫶

Parameters
- sp — the storage buffer to sync
Returns — A Kerberos 5 error code

`krb5_storage_get_byteorder()` — which way do the bytes go 🤔

KRB5_LIB_FUNCTION krb5_flags KRB5_LIB_CALL krb5_storage_get_byteorder
    (krb5_storage * sp)

Returns the current byteorder for the buffer. For the actual list of byte order constants, go peep krb5_storage_set_byteorder().

`krb5_storage_get_eof_code()` — what happens at the end of storage 😳

KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_get_eof_code (krb5_storage
    * sp)

Gets the return code that will be used when the end of storage is reached.

Parameters
- sp — the storage
Returns — storage error code

`krb5_storage_is_flags()` — flag check, true or false, no in between 🌸

KRB5_LIB_FUNCTION krb5_boolean KRB5_LIB_CALL krb5_storage_is_flags
    (krb5_storage * sp, krb5_flags flags)

Returns true or false depending on if the storage flags is set or not.

NB — testing for the flag 0 always returns true. Every time. No exceptions. Not me finding that out the hard way. 💀

Parameters
- sp — the storage buffer to check flags on
- flags — The flags to test for
Returns — true if all the flags are set, false if not.

`krb5_storage_read()` — read era, we're reading 📖

KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_read (krb5_storage
    * sp, void * buf, size_t len)

Reads to the storage buffer.

Parameters
- sp — the storage buffer to read from
- buf — the buffer to store the data in
- len — the length to read
Returns — The length of data read (can be shorter then len), or negative on error.

Heads up bestie: shorter-than-len is normal, it's not a bug, it's just how she reads. Don't come for her. 🙈

`krb5_storage_seek()` — slide to a new offset 💅

KRB5_LIB_FUNCTION off_t KRB5_LIB_CALL krb5_storage_seek (krb5_storage * sp,
    off_t offset, int whence)

Seeks to a new offset. It's giving scroll bar but for storage.

Parameters
- sp — the storage buffer to seek in.
- offset — the offset to seek
- whence — relateive searching, SEEK_CUR from the current position, SEEK_END from the end, SEEK_SET absolute from the start.
Returns — The new current offset

`krb5_storage_set_byteorder()` — pick a lane, bytes 🎀

KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_byteorder
    (krb5_storage * sp, krb5_flags byteorder)

Sets the new byte order of the storage buffer.

Parameters
- sp — the storage buffer to set the byte order for.
- byteorder — the new byte order.

The byte order are: KRB5_STORAGE_BYTEORDER_BE, KRB5_STORAGE_BYTEORDER_LE and KRB5_STORAGE_BYTEORDER_HOST. Pick your fighter. 👑

`krb5_storage_set_eof_code()` — set the vibe for "we're done here" 🦋

KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_eof_code (krb5_storage
    * sp, int code)

Sets the return code that will be used when the end of storage is reached.

Parameters
- sp — the storage
- code — the error code to return on end of storage

`krb5_storage_set_flags()` — add flags by or-ing them in ✨

KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_flags (krb5_storage *
    sp, krb5_flags flags)

Adds the flags on a storage buffer by or-ing in the flags to the buffer.

Parameters
- sp — the storage buffer to set the flags on
- flags — the flags to set

`krb5_storage_set_max_alloc()` — set the limit, queen 💜

KRB5_LIB_FUNCTION void KRB5_LIB_CALL krb5_storage_set_max_alloc
    (krb5_storage * sp, size_t size)

Sets the max alloc value.

Parameters
- sp — the storage buffer set the max allow for
- size — maximum size to allocate, use 0 to remove limit

0 = no limit. She's unhinged and free. 😭

`krb5_storage_to_data()` — copy the content out, free it after 🌈

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_storage_to_data
    (krb5_storage * sp, krb5_data * data)

Copies the contnent of storage.

Parameters
- sp — the storage to copy to a data
- data — the copied data, free with krb5_data_free()
Returns — 0 for success, or a Kerberos 5 error code on failure.

Bestie please krb5_data_free() that data when you're done. It's not optional, it's a lifestyle. 🫶

`krb5_storage_truncate()` — chop it down to size 💀

KRB5_LIB_FUNCTION int KRB5_LIB_CALL krb5_storage_truncate (krb5_storage *
    sp, off_t offset)

Truncates the storage buffer in sp to offset. Everything past that? Gone. poof. 🎀

Parameters
- sp — the storage buffer to truncate.
- offset — the offset to truncate too.
Returns — An Kerberos 5 error code.

`krb5_storage_write()` — writing era, we're putting it in 📝

KRB5_LIB_FUNCTION krb5_ssize_t KRB5_LIB_CALL krb5_storage_write
    (krb5_storage * sp, const void * buf, size_t len)

Writes to the storage buffer.

Parameters
- sp — the storage buffer to write to
- buf — the buffer to write to the storage buffer
- len — the length to write
Returns — The length of data written (can be shorter then len), or negative on error.

Same deal as read: shorter than len is allowed and normal. It's not a personality flaw. 🦋

`krb5_store_address()` — drop an address block in there 🏠

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_address
    (krb5_storage * sp, krb5_address p)

Writes a address block to storage.

Parameters
- sp — the storage buffer to write to
- p — the address block to write.
Returns — 0 on success, a Kerberos 5 error code on failure.

`krb5_store_addrs()` — now a whole bunch of addresses 🏘️

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_addrs
    (krb5_storage * sp, krb5_addresses p)

Writes a addresses block to storage. Plural. She's bringing friends. ✨

Parameters
- sp — the storage buffer to write to
- p — the addresses block to write.
Returns — 0 on success, a Kerberos 5 error code on failure.

`krb5_store_authdata()` — auth data, stored with care 🔐

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_authdata
    (krb5_storage * sp, krb5_authdata auth)

Writes a auth data block to storage.

Parameters
- sp — the storage buffer to write to
- auth — the auth data block to write.
Returns — 0 on success, a Kerberos 5 error code on failure.

`krb5_store_creds()` — credentials, stored, slay 👑

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds
    (krb5_storage * sp, krb5_creds * creds)

Writes a credentials block to storage.

Parameters
- sp — the storage buffer to write to
- creds — the creds block to write.
Returns — 0 on success, a Kerberos 5 error code on failure.

`krb5_store_creds_tag()` — same creds, but tagged 🏷️

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_creds_tag
    (krb5_storage * sp, krb5_creds * creds)

Writes a tagged credentials block to storage.

Parameters
- sp — the storage buffer to write to
- creds — the creds block to write.
Returns — 0 on success, a Kerberos 5 error code on failure.

`krb5_store_data()` — data with a length prefix, not padded 💾

KRB5_LIB_FUNCTION krb5_error_code KRB5_LIB_CALL krb5_store_data
    (krb5_storage * sp, krb5_data data)

Stores a data to the storage. The data is stored with an int32 as lenght plus the data (not padded). So like, length first, then the actual goods. No filler, no padding, she's lean. 🔥

Parameters
- sp — the storage buffer to write to
- data — the buffer to store.
Returns — 0 on success, a Kerberos 5 error code on failure.

💾 `krb5_store_int16` ✨

krb5_error_code KRB5_LIB_CALL krb5_store_int16(krb5_storage * sp, int16_t value)

okay so this one drops an int16 into your storage bestie 💖 and the byte order? that's not its decision, that's whatever you set on the storage, see krb5_storage_set_byteorder() — the storage is the one with opinions here, fr fr.

Parameters

sp — the storage to write too
value — the value to store

Returns

0 for success, or a Kerberos 5 error code on failure. periodt.

💾 `krb5_store_int32` ✨

krb5_error_code KRB5_LIB_CALL krb5_store_int32(krb5_storage * sp, int32_t value)

same vibe, bigger number 🫶 stores an int32, and once again the byte order is completely controlled by the settings on the storage — go check krb5_storage_set_byteorder() iykyk.

Parameters

sp — the storage to write too
value — the value to store

Returns

0 for success, or a Kerberos 5 error code on failure.

💾 `krb5_store_int64` ✨

krb5_error_code KRB5_LIB_CALL krb5_store_int64(krb5_storage * sp, int64_t value)

the big one 😤 an int64 goes in, byte order still governed by the settings on the storage, see krb5_storage_set_byteorder(). she's consistent, she's iconic.

Parameters

sp — the storage to write too
value — the value to store

Returns

0 for success, or a Kerberos 5 error code on failure.

💾 `krb5_store_int8` 🌸

krb5_error_code KRB5_LIB_CALL krb5_store_int8(krb5_storage * sp, int8_t value)

tiny little int8, no byte order drama here — it just stores an int8 to storage, that's the whole post 🎀.

Parameters

sp — the storage to write too
value — the value to store

Returns

0 for success, or a Kerberos 5 error code on failure.

🔑 `krb5_store_keyblock` 👑

krb5_error_code KRB5_LIB_CALL krb5_store_keyblock(krb5_storage * sp, krb5_keyblock p)

storing a whole keyblock to the storage. main character energy honestly 💅.

Parameters

sp — the storage buffer to write to
p — the keyblock to write

Returns

0 on success, a Kerberos 5 error code on failure.

🪪 `krb5_store_principal` 🦋

krb5_error_code KRB5_LIB_CALL krb5_store_principal(krb5_storage * sp, krb5_const_principal p)

writes a principal block to storage 💜 yes bestie, the whole principal block.

Parameters

sp — the storage buffer to write to
p — the principal block to write.

Returns

0 on success, a Kerberos 5 error code on failure.

🧵 `krb5_store_string` 🍓

krb5_error_code KRB5_LIB_CALL krb5_store_string(krb5_storage * sp, const char * s)

stores a string to the buffer ✨ and the layout is very specific so listen up: the data is formated as an len:uint32 plus the string itself, not padded. that's it, that's the format, no extra padding hiding in there, no cap 🫶.

Parameters

sp — the storage buffer to write to
s — the string to store.

Returns

0 on success, a Kerberos 5 error code on failure.

🚫 `krb5_store_stringz` 🌈

krb5_error_code KRB5_LIB_CALL krb5_store_stringz(krb5_storage * sp, const char * s)

stores a zero terminated string to the buffer 💖 the data is stored one character at a time until a NUL is stored. one by one by one, she's thorough like that.

Parameters

sp — the storage buffer to write to
s — the string to store.

Returns

0 on success, a Kerberos 5 error code on failure.

⏰ `krb5_store_times` ⌛

krb5_error_code KRB5_LIB_CALL krb5_store_times(krb5_storage * sp, krb5_times times)

writes a times block to storage ⭐ time really said "let me be stored" and we said yes.

Parameters

sp — the storage buffer to write to
times — the times block to write.

Returns

0 on success, a Kerberos 5 error code on failure.

💾 `krb5_store_uint16` ✨

krb5_error_code KRB5_LIB_CALL krb5_store_uint16(krb5_storage * sp, uint16_t value)

an unsigned uint16 into storage, and you already know the drill: byte order is controlled by the settings on the storage, see krb5_storage_set_byteorder() 💅.

Parameters

sp — the storage to write too
value — the value to store

Returns

0 for success, or a Kerberos 5 error code on failure.

💾 `krb5_store_uint32` ✨

krb5_error_code KRB5_LIB_CALL krb5_store_uint32(krb5_storage * sp, uint32_t value)

stores a uint32, byte order controlled by the storage settings again — krb5_storage_set_byteorder() is literally the girl running the whole show here 😭.

Parameters

sp — the storage to write too
value — the value to store

Returns

0 for success, or a Kerberos 5 error code on failure.

💾 `krb5_store_uint64` ✨

krb5_error_code KRB5_LIB_CALL krb5_store_uint64(krb5_storage * sp, uint64_t value)

uint64 time 😤 byte order still comes from the settings on the storage, see krb5_storage_set_byteorder(). big number, big vibes.

Parameters

sp — the storage to write too
value — the value to store

Returns

0 for success, or a Kerberos 5 error code on failure.

💾 `krb5_store_uint8` 🌸

krb5_error_code KRB5_LIB_CALL krb5_store_uint8(krb5_storage * sp, uint8_t value)

just a lil uint8 going to storage, no byte order discourse, no complications, a peaceful queen 🎀.

Parameters

sp — the storage to write too
value — the value to store

Returns

0 for success, or a Kerberos 5 error code on failure.

👑 AUTHOR 👑

Generated automatically by Doxygen for Heimdal Kerberos 5 library from the source code. yes bestie the docs wrote themselves, that's the flex 💅✨

and that's the whole page!! this was Version 7.8.0, dated Tue Nov 15 2022, from the Heimdal Kerberos 5 library — mwah, slay, go store something 🫶💖

📦 where this page comes from

alpine 3.22: heimdal-doc 7.8.0-r4 · BSD-3-Clause
alpine 3.23: heimdal-doc 7.8.0-r5 · BSD-3-Clause
alpine 3.24: heimdal-doc 7.8.0-r5 · BSD-3-Clause
epel 10: heimdal-devel 7.8.0-26.el10_2 · BSD-2-Clause AND BSD-3-Clause AND HPND-export-US AND HPND-export2-US AND LicenseRef-Fedora-Public-Domain
epel 9: heimdal-devel 7.8.0-5.el9 · BSD and MIT
fedora 43: heimdal-devel 7.8.0-26.fc43 · BSD-2-Clause AND BSD-3-Clause AND HPND-export-US AND HPND-export2-US AND LicenseRef-Fedora-Public-Domain
fedora 43: heimdal-devel 7.8.0-26.fc43 · BSD-2-Clause AND BSD-3-Clause AND HPND-export-US AND HPND-export2-US AND LicenseRef-Fedora-Public-Domain
fedora 44: heimdal-devel 7.8.0-26.fc43 · BSD-2-Clause AND BSD-3-Clause AND HPND-export-US AND HPND-export2-US AND LicenseRef-Fedora-Public-Domain
fedora 44: heimdal-devel 7.8.0-26.fc43 · BSD-2-Clause AND BSD-3-Clause AND HPND-export-US AND HPND-export2-US AND LicenseRef-Fedora-Public-Domain
fedora 44: heimdal-devel 7.8.0-28.fc44 · BSD-2-Clause AND BSD-3-Clause AND HPND-export-US AND HPND-export2-US AND LicenseRef-Fedora-Public-Domain
fedora 44: heimdal-devel 7.8.0-28.fc44 · BSD-2-Clause AND BSD-3-Clause AND HPND-export-US AND HPND-export2-US AND LicenseRef-Fedora-Public-Domain
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash on 2026-10-14: a language model's rewrite of the original, under its terms

krb5_storage(3)

💾 krb5_storage — Heimdal Kerberos 5 library, section 3

🌸 NAME 🌸

✨ SYNOPSIS ✨

🫶 Functions

👑 Detailed Description

🎀 Function Documentation 🎀

🌈 krb5_ret_address

🌈 krb5_ret_addrs

🌈 krb5_ret_authdata

🌈 krb5_ret_creds

🌈 krb5_ret_creds_tag

🌈 krb5_ret_data

🌈 krb5_ret_int16

🌈 krb5_ret_int32

🌈 krb5_ret_int64

🌈 krb5_ret_int8

🌈 krb5_ret_keyblock

🌈 krb5_ret_principal

🌈 krb5_ret_string

krb5_ret_stringz()</p> — grab a lil string that knows when to stop ✨

krb5_ret_times()</p> — time block go brrr 🕰️

krb5_ret_uint16()</p> — smol number, big vibes 🌸

krb5_ret_uint32()</p> — the classic ✨

krb5_ret_uint64()</p> — the big one 💪

krb5_ret_uint8()</p> — baby byte energy 🍓

krb5_storage_clear_flags()</p> — un-set those flags, periodt 🎀

krb5_storage_emem()</p> — elastic memory backend, she stretches 🧚

krb5_storage_free()</p> — release her, let her go 🦋

krb5_storage_from_data()</p> — fixed size memory block, no notes 💅

krb5_storage_from_fd()</p> — file descriptor, but make it storage 🗂️

krb5_storage_from_mem()</p> — memory block, fixed size, iconic ✨

krb5_storage_from_readonly_mem()</p> — look, don't touch 🙈

krb5_storage_from_socket()</p> — socket storage, networking era 🔥

krb5_storage_fsync()</p> — push it to the backing store 💾

krb5_storage_get_byteorder()</p> — which way do the bytes go 🤔

krb5_storage_get_eof_code()</p> — what happens at the end of storage 😳

krb5_storage_is_flags()</p> — flag check, true or false, no in between 🌸

krb5_storage_read()</p> — read era, we're reading 📖

krb5_storage_seek()</p> — slide to a new offset 💅

krb5_storage_set_byteorder()</p> — pick a lane, bytes 🎀

krb5_storage_set_eof_code()</p> — set the vibe for "we're done here" 🦋

krb5_storage_set_flags()</p> — add flags by or-ing them in ✨

krb5_storage_set_max_alloc()</p> — set the limit, queen 💜

krb5_storage_to_data()</p> — copy the content out, free it after 🌈

krb5_storage_truncate()</p> — chop it down to size 💀

krb5_storage_write()</p> — writing era, we're putting it in 📝

krb5_store_address()</p> — drop an address block in there 🏠

krb5_store_addrs()</p> — now a whole bunch of addresses 🏘️

krb5_store_authdata()</p> — auth data, stored with care 🔐

krb5_store_creds()</p> — credentials, stored, slay 👑

krb5_store_creds_tag()</p> — same creds, but tagged 🏷️

krb5_store_data()</p> — data with a length prefix, not padded 💾

💾 krb5_store_int16 ✨

💾 krb5_store_int32 ✨

💾 krb5_store_int64 ✨

💾 krb5_store_int8 🌸

🔑 krb5_store_keyblock 👑

🪪 krb5_store_principal 🦋

🧵 krb5_store_string 🍓

🚫 krb5_store_stringz 🌈

⏰ krb5_store_times ⌛

💾 krb5_store_uint16 ✨

💾 krb5_store_uint32 ✨

💾 krb5_store_uint64 ✨

💾 krb5_store_uint8 🌸

👑 AUTHOR 👑

🌈 `krb5_ret_address`

🌈 `krb5_ret_addrs`

🌈 `krb5_ret_authdata`

🌈 `krb5_ret_creds`

🌈 `krb5_ret_creds_tag`

🌈 `krb5_ret_data`

🌈 `krb5_ret_int16`

🌈 `krb5_ret_int32`

🌈 `krb5_ret_int64`

🌈 `krb5_ret_int8`

🌈 `krb5_ret_keyblock`

🌈 `krb5_ret_principal`

🌈 `krb5_ret_string`

`krb5_ret_stringz()`</p> — grab a lil string that knows when to stop ✨

`krb5_ret_times()`</p> — time block go brrr 🕰️

`krb5_ret_uint16()`</p> — smol number, big vibes 🌸

`krb5_ret_uint32()`</p> — the classic ✨

`krb5_ret_uint64()`</p> — the big one 💪

`krb5_ret_uint8()`</p> — baby byte energy 🍓

`krb5_storage_clear_flags()`</p> — un-set those flags, periodt 🎀

`krb5_storage_emem()`</p> — elastic memory backend, she stretches 🧚

`krb5_storage_free()`</p> — release her, let her go 🦋

`krb5_storage_from_data()`</p> — fixed size memory block, no notes 💅

`krb5_storage_from_fd()`</p> — file descriptor, but make it storage 🗂️

`krb5_storage_from_mem()`</p> — memory block, fixed size, iconic ✨

`krb5_storage_from_readonly_mem()`</p> — look, don't touch 🙈

`krb5_storage_from_socket()`</p> — socket storage, networking era 🔥

`krb5_storage_fsync()`</p> — push it to the backing store 💾

`krb5_storage_get_byteorder()`</p> — which way do the bytes go 🤔

`krb5_storage_get_eof_code()`</p> — what happens at the end of storage 😳

`krb5_storage_is_flags()`</p> — flag check, true or false, no in between 🌸

`krb5_storage_read()`</p> — read era, we're reading 📖

`krb5_storage_seek()`</p> — slide to a new offset 💅

`krb5_storage_set_byteorder()`</p> — pick a lane, bytes 🎀

`krb5_storage_set_eof_code()`</p> — set the vibe for "we're done here" 🦋

`krb5_storage_set_flags()`</p> — add flags by or-ing them in ✨

`krb5_storage_set_max_alloc()`</p> — set the limit, queen 💜

`krb5_storage_to_data()`</p> — copy the content out, free it after 🌈

`krb5_storage_truncate()`</p> — chop it down to size 💀

`krb5_storage_write()`</p> — writing era, we're putting it in 📝

`krb5_store_address()`</p> — drop an address block in there 🏠

`krb5_store_addrs()`</p> — now a whole bunch of addresses 🏘️

`krb5_store_authdata()`</p> — auth data, stored with care 🔐

`krb5_store_creds()`</p> — credentials, stored, slay 👑

`krb5_store_creds_tag()`</p> — same creds, but tagged 🏷️

`krb5_store_data()`</p> — data with a length prefix, not padded 💾

💾 `krb5_store_int16` ✨

💾 `krb5_store_int32` ✨

💾 `krb5_store_int64` ✨

💾 `krb5_store_int8` 🌸

🔑 `krb5_store_keyblock` 👑

🪪 `krb5_store_principal` 🦋

🧵 `krb5_store_string` 🍓

🚫 `krb5_store_stringz` 🌈

⏰ `krb5_store_times` ⌛

💾 `krb5_store_uint16` ✨

💾 `krb5_store_uint32` ✨

💾 `krb5_store_uint64` ✨

💾 `krb5_store_uint8` 🌸