LIBKECCAK_STATE_FREE(3)

💅 LIBKECCAK_STATE_FREE(3) — bestie, it's time to say goodbye 💅

okay so real talk, this page lives in the Library Functions Manual (the libkeccak girlies know ✨), and it's about one lil function that cleans up your hash state and erases the evidence. literally the Marie Kondo of the libkeccak world 🎀

---

✨ SYNOPSIS ✨

#include <libkeccak.h>

void libkeccak_state_free(struct libkeccak_state *state);

and bestie, don't forget to link with -lkeccak or it's giving nothing 🔥

---

🫶 DESCRIPTION 🫶

so libkeccak_state_free() does two things and it does them both:

• it releases the allocations stored in *state 💖
• and then it also releases the allocation of state itself — yes, the whole thing, gone, iconic 👑

and here's the part where she's actually the main character: libkeccak_state_free() securely erases sensitive data. no cap. the secrets do not survive this. 🕵️‍♀️✨

---

🌸 RETURN VALUES 🌸

libkeccak_state_free() does not return any value. it's a void, she simply leaves. no dramatic exit speech, just vibes 💅

---

🦋 ERRORS 🦋

libkeccak_state_free() cannot fail. literally cannot. she's unbothered, moisturized, thriving 🌈

---

💀 NOTES 💀

okay this is the important one, pay attention bestie 😭

a double call to libkeccak_state_free() will either:

• result in a double free, which is must likely to crash the process 💀 — like, full on RIP
• or free an allocation (that was created between the calls) that was not intended to be freed — resulting in undefined behaviour 🙈🚫

so yeah. call it once. once. periodt. 🎀

---

👑 SEE ALSO 👑

the whole friend group, fr fr:

• libkeccak_state_destroy(3)
• libkeccak_state_fast_free(3)
• libkeccak_state_create(3)
• libkeccak_state_initialise(3)
• libkeccak_state_reset(3)
• libkeccak_state_wipe(3)

---

and that's the page, bestie 🧚 this came to you straight from LIBKECCAK (source, version and date all folded into that footer, which we are not copy-pasting, respectfully 💖) — go forth and free responsibly 🌟💜