pam_putenv (3pam) manual page

Table of Contents


pam_putenv - change or add a value to the PAM environment


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

int pam_putenv(pam_handle_t *pamh, const char *name_value);


pam_putenv() function sets the value of the PAM environment variable name equal to value either by altering an existing PAM variable or by creating a new one.

The name_value argument points to a string of the form name=value. A call to pam_putenv() does not immediately change the environment. All name_value pairs are stored in the PAM handle pamh. An application such as login(1) may make a call to pam_getenv(3PAM) or pam_getenvlist(3PAM) to retrieve the PAM environment variables saved in the PAM handle and set them in the environment if appropriate. login will not set PAM environment values which overwrite the values for SHELL, HOME, LOGNAME, MAIL, CDPATH, IFS, and PATH. Nor will login set PAM environment values which overwrite any value that begins with LD_.

If name_value equals NAME=, then the value associated with NAME in the PAM handle will be set to an empty value. If name_value equals NAME, then the environment variable NAME will be removed from the PAM handle.

Return Values

The pam_putenv() function may return one of the following values:

The function returned successfully.

dlopen() failed when dynamically loading a service module.

Symbol not found.

Error in service module.

System error.

Memory buffer error.

Conversation failure.

Permission denied.


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

tab() allbox; cw(2.750000i)| cw(2.750000i) lw(2.750000i) lw(2.750000i). ATTRIBUTE TYPEATTRIBUTE VALUE Interface Stability Stable MT-LevelMT-Safe with exceptions

See Also

dlopen(3C) , pam(3PAM) , pam_getenv(3PAM) , pam_getenvlist(3PAM) , libpam(3LIB) , attributes(5)


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

Table of Contents