GFKEY(1)

💖 GFKEY(1) — the Gfarm session key glow-up 💖

okay bestie, welcome to gfkey, section 1 of the Gfarm manual. she's little, she's iconic, she handles your session keys. let's get into it 🎀

✨ NAME ✨

gfkey — management of Gfarm session keys 🔑

✨ SYNOPSIS ✨

gfkey [options]

✨ DESCRIPTION ✨

so gfkey manages the session key file, $HOME/.gfarm_shared_key, which is the file used for user authentication by a shared secret key in a trusted environment when you're connecting to gfsd and/or gfmd. that's the whole vibe. 🫶

ngl, the location of that session key file can be changed — it's specified by shared_key_file in gfarm2.conf. so if you moved it, that's where you tell everyone. ✨

here's the part where you gotta pay attention fr fr: when the home directory is shared among filesystem nodes, you do not need to use this command at all. it's giving effortless. but if it is not shared, then it is necessary to distribute a session key created with the -c or -f option to every filesystem node, in advance. like, before. ahead of time. do not skip this step bestie 😭

✨ OPTIONS ✨

• -c — creates a new session key when there is no valid session key. if a valid session key already exists? no operation is performed. she respects the existing key. 💅
• -f — forces the creation of a new session key, even if a valid session key already exists. no thoughts, new key, periodt. 🔥
• -p period — specifies the term of validity in seconds. this option has to be used with the -c or -f option (she doesn't work solo, she's a duo act 🫶). default is 86400 seconds (1 day).
• -l — displays the current key. 👀
• -e — displays the expiration date of the current key. when does she expire?? find out. ⏰
• -L message-priority-level — specifies a level of the log priority. the log messages that have higher or the same priority than the specified priority are displayed to the standard error. the default priority is info. for the priority level which can be specified by this option, refer to the log_level directive described in the manual page of gfarm2.conf(5). 📋
• -V — displays the version information. ⭐
• -? — displays a list of command options. the classic "help me" move 🙈

✨ FILES ✨

• $HOME/.gfarm_shared_key — a file for a session key 🔑

reminder bestie: if your home dir is not shared across filesystem nodes, that key from -c or -f has to be distributed to every filesystem node in advance. no cap. 💀

and that's the whole page!! 🌈 this was the Gfarm gfkey(1) manual, dated 13 Feb 2020, brought to you by the Gfarm girlies. stay keyed, stay valid, and don't let your session expire on you 💖✨🎀🦋🌸💅🫶👑