pam_putenv(3) — Linux manual 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 for freeing
       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(8)

COLOPHON

       This page is part of the linux-pam (Pluggable Authentication
       Modules for Linux) project.  Information about the project can be
       found at ⟨http://www.linux-pam.org/⟩.  If you have a bug report
       for this manual page, see ⟨//www.linux-pam.org/⟩.  This page was
       obtained from the project's upstream Git repository
       ⟨https://github.com/linux-pam/linux-pam.git⟩ on 2023-12-22.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2023-12-18.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

Linux-PAM Manual               12/22/2023                  PAM_PUTENV(3)

Pages that refer to this page: pam(3), pam_getenv(3), pam_getenvlist(3), pam_misc_paste_env(3), pam_misc_setenv(3)

---