PAM_GETENV(3PAM) PAM Library Functions PAM_GETENV(3PAM)

NAME

pam_getenv - returns the value for a PAM environment name

SYNOPSIS

cc [ flag ... ] file ... -lpam [ library ... ]
#include <security/pam_appl.h>


const char *pam_getenv(pam_handle_t *pamh,
const char *name);

DESCRIPTION

The pam_getenv() function searches the PAM handle pamh for a value
associated with name. If a value is present, pam_getenv() makes a
copy of the value and returns a pointer to the copy back to the
calling application. If no such entry exists, pam_getenv() returns
NULL. It is the responsibility of the calling application to free
the memory returned by pam_getenv().

RETURN VALUES

If successful, pam_getenv() returns a copy of the value associated
with name in the PAM handle; otherwise, it returns a NULL pointer.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:


+--------------------+-------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-------------------------+
|Interface Stability | Stable |
+--------------------+-------------------------+
|MT-Level | MT-Safe with exceptions |
+--------------------+-------------------------+

SEE ALSO

libpam(3LIB), pam(3PAM), pam_getenvlist(3PAM), pam_putenv(3PAM),
attributes(7)

NOTES

The interfaces in libpam are MT-Safe only if each thread within the
multithreaded application uses its own PAM handle.

July 6, 2024 PAM_GETENV(3PAM)