KEYCTL_CLEAR(3)

✨ KEYCTL_CLEAR(3) ✨

okay so bestie, welcome to the Linux Key Management Calls corner of the manual, where we talk about keyctl_clear — the girl whose whole job is clearing a keyring. that's it. that's the gig. 💅

🌸 NAME 🌸

keyctl_clear — clear a keyring 💖

🎀 SYNOPSIS 🎀

#include <keyutils.h>

long keyctl_clear(key_serial_t keyring);

🦋 DESCRIPTION 🦋

so basically keyctl_clear() clears the contents of a keyring. boom. empty. gone. iconic ✨

but hold up — the caller must have write permission on a keyring to be able to clear it. no write permission, no clearing, no exceptions, no cap. 🔒

💜 RETURN VALUE 💜

• on success, keyctl_clear() returns 0 🫶
• on error, the value -1 will be returned and errno will have been set to an appropriate error 😭

💀 ERRORS 💀

• ENOKEY — the keyring specified is invalid. it's giving "who? never heard of her" 🙈
• EKEYEXPIRED — the keyring specified has expired. she's done, she's moved on ⏳
• EKEYREVOKED — the keyring specified had been revoked. cancelled, fr fr 🚫
• EACCES — the keyring exists, but is not writable by the calling process. she's real, she's just not letting you in 💅

🔗 LINKING 🔗

this is a library function that can be found in libkeyutils. when linking, -lkeyutils should be specified to the linker. don't forget it bestie, or the linker will simply not know her 😤

👀 SEE ALSO 👀

keyctl(1), add_key(2), keyctl(2), request_key(2), keyctl(3), keyrings(7), keyutils(7)

and that's the whole page, babe 🧚💖 this one's from the Linux crew, dated 4 May 2006 — yeah she's vintage, and she still ate. periodt. 👑🌸