KEYCTL_SE...EY_KEYRING(3)

💖 KEYCTL_SET_REQKEY_KEYRING(3) 💖

okay bestie so this is a Linux Key Management Call, it lives in section 3 of the manual, and it's the one that tells your thread where to drop keys it grabs on the sly. yes it's as iconic as it sounds. let's get into it 🦋

✨ NAME ✨

keyctl_set_reqkey_keyring — set the implicit destination keyring 👑

🌸 SYNOPSIS 🌸

#include <keyutils.h>

long keyctl_set_reqkey_keyring(int reqkey_defl);

💅 DESCRIPTION 💅

so keyctl_set_reqkey_keyring() sets the default destination for implicit key requests for the current thread, and it hands you back the old setting like a lil receipt. 🧾✨

after you've run this, keys that get acquired by implicit key requests — the kind of thing open() might do on an AFS or NFS filesystem, no cap — will by default get linked to whatever keyring you specified here. it's giving "set it and forget it" fr fr.

the valid values of reqkey_defl are:

• KEY_REQKEY_DEFL_NO_CHANGE — does absolutely nothing to your current setting. it's the "no thoughts, head empty" option 🙈
• KEY_REQKEY_DEFL_THREAD_KEYRING — makes the thread-specific keyring the default destination. very main character, very just-for-you 💜
• KEY_REQKEY_DEFL_PROCESS_KEYRING — makes the process-specific keyring the default destination.
• KEY_REQKEY_DEFL_SESSION_KEYRING — makes the session keyring the default destination.
• KEY_REQKEY_DEFL_USER_KEYRING — makes the UID-specific keyring the default destination.
• KEY_REQKEY_DEFL_USER_SESSION_KEYRING — makes the UID-specific session keyring the default destination.
• KEY_REQKEY_DEFL_DEFAULT — this one picks the default behaviour, and the priority list is giving fallback queen 👑: the thread-specific keyring if there is one, otherwise the process-specific keyring if there is one, otherwise the session keyring if there is one, otherwise the UID-specific session keyring.

also this setting is inherited across fork() and exec() — it runs in the family, periodt. 🌈

⭐ RETURN VALUE ⭐

on success, keyctl_set_reqkey_keyring() returns the serial number of the keyring which was the previous default for the current thread. slay, you get the lore. 💖

on error, the value -1 gets returned and errno will have been set to an appropriate error. not the vibe, but okay. 😭

💀 ERRORS 💀

• EINVAL — the value of reqkey_defl is invalid. wrong answer bestie, try again 🍓

🎀 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 or the linker will simply not know her 🫶

🔥 SEE ALSO 🔥

keyctl(1), add_key(2), keyctl(2), request_key(2), keyctl(3), keyutils(7), keyrings(7), request-key(8)

and that's the whole page bestie, tysm for reading 💖 this came from the Linux keyutils world, dated 4 May 2006, and the page itself is filed under KEYCTL_SE...EY_KEYRING(3). mwah, go set some keyrings 💅✨