OPENPAM_GET_OPTION(3)

πŸ“¦
version 14.5 Β· 2 versions
, in freebsd 14.5, nixos 26.05, nixpkgs unstable

✨ OPENPAM_GET_OPTION(3) ✨

ok so this is a page from the Library Functions Manual and it's literally about one little function, bestie. sit down, it's gonna be quick but cute πŸ’…


🌸 NAME 🌸

openpam_get_option β€” returns the value of a module option. that's it. that's the whole job. she's focused, she's efficient, she's an icon πŸ‘‘


πŸŽ€ SYNOPSIS πŸŽ€

like, the way you summon her is:

#include <sys/types.h>
#include <security/pam_appl.h>
#include <security/openpam.h>

const char *
openpam_get_option(pam_handle_t *pamh, const char *option);

all three includes, no skimping, she needs them all fr fr 🫢


πŸ¦‹ DESCRIPTION πŸ¦‹

okay so here's the tea: openpam_get_option() returns the value of the option you name β€” but like, specifically in the context of the currently executing service module. it's not a global thing, she's very much in her context era 😌

and if the option isn't set? or if there's literally no module currently executing at all? she returns NULL. no drama, no error page, just NULL. vibe check failed, moving on πŸ’€


⭐ RETURN VALUES ⭐

openpam_get_option() returns NULL on failure. that's the whole section. short, sweet, and slightly ominous ngl πŸ™ˆ


πŸ”₯ SEE ALSO πŸ”₯

  • openpam_set_option(3) β€” her partner in crime, the setter to her getter πŸ’–
  • pam(3) β€” the whole big picture, go read it, iykyk

πŸ‘‘ STANDARDS πŸ‘‘

openpam_get_option() is an OpenPAM extension ✨ so like, don't expect everybody else's PAM to have her, she's OpenPAM-exclusive and honestly that's main character energy.


🌈 AUTHORS 🌈

the openpam_get_option() function and this very manual page were developed for the FreeBSD Project by ThinkSec AS and Network Associates Laboratories, the Security Research Division of Network Associates, Inc., under DARPA/SPAWAR contract N66001-01-C-8035 (β€œCBOSS”), as part of the DARPA CHATS research program. okay that's a lot of words but we respect the pipeline 🫑

the OpenPAM library is maintained by Dag-Erling SmΓΈrgrav <des@des.no> β€” shoutout to the maintainer, keeping the lights on πŸ’œ


and that's the whole page bestie, no cap. tiny function, big legacy. go call openpam_get_option() responsibly 🧚

β€” with love from the Debian crew, dated June 27, 2023, signed off on OPENPAM_GET_OPTION(3) πŸ“βœ¨

πŸ“¦ where this page comes from