Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pam_putenv(3pam) [opensolaris man page]

pam_putenv(3PAM)					       PAM Library Functions						  pam_putenv(3PAM)

NAME
pam_putenv - change or add a value to the PAM environment SYNOPSIS
cc [ flag ... ] file ... -lpam [ library ... ] #include <security/pam_appl.h> int pam_putenv(pam_handle_t *pamh, const char *name_value); DESCRIPTION
The 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_geten- vlist(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: PAM_SUCCESS The function returned successfully. PAM_OPEN_ERR dlopen() failed when dynamically loading a service module. PAM_SYMBOL_ERR Symbol not found. PAM_SERVICE_ERR Error in service module. PAM_SYSTEM_ERR System error. PAM_BUF_ERR Memory buffer error. PAM_CONV_ERR Conversation failure. PAM_PERM_DENIED Permission denied. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability | Stable | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe with exceptions | +-----------------------------+-----------------------------+ SEE ALSO
dlopen(3C), pam(3PAM), pam_getenv(3PAM), pam_getenvlist(3PAM), libpam(3LIB), attributes(5) NOTES
The interfaces in libpam are MT-Safe only if each thread within the multithreaded application uses its own PAM handle. SunOS 5.11 1 Mar 2004 pam_putenv(3PAM)

Check Out this Related Man Page

PAM_PUTENV(3)                                                    Linux-PAM Manual                                                    PAM_PUTENV(3)

NAME
pam_putenv - set or change PAM environment variable SYNOPSIS
#include <security/pam_appl.h> int pam_putenv(pam_handle_t *pamh, const char *name_value); DESCRIPTION
The pam_putenv function is used to add or change the value of PAM environment variables as associated with the pamh handle. The pamh argument is an authentication handle obtained by a prior call to pam_start(). The name_value argument is a single NUL terminated string of one of the following forms: NAME=value of variable In this case the environment variable of the given NAME is set to the indicated value: value of variable. If this variable is already known, it is overwritten. Otherwise it is added to the PAM environment. NAME= This function sets the variable to an empty value. It is listed separately to indicate that this is the correct way to achieve such a setting. NAME Without an '=' the pam_putenv() function will delete the corresponding variable from the PAM environment. pam_putenv() operates on a copy of name_value, which means in contrast to putenv(3), the application is responsible to free the data. RETURN VALUES
PAM_PERM_DENIED Argument name_value given is a NULL pointer. PAM_BAD_ITEM Variable requested (for deletion) is not currently set. PAM_ABORT The pamh handle is corrupt. PAM_BUF_ERR Memory buffer error. PAM_SUCCESS The environment variable was successfully updated. SEE ALSO
pam_start(3), pam_getenv(3), pam_getenvlist(3), pam_strerror(3), pam(7) Linux-PAM Manual 06/04/2011 PAM_PUTENV(3)
Man Page