pam_getenvlist(3) — Linux manual page


PAM_GETENVLIST(3)           Linux-PAM Manual           PAM_GETENVLIST(3)

NAME         top

       pam_getenvlist - getting the PAM environment

SYNOPSIS         top

       #include <security/pam_appl.h>

       char **pam_getenvlist(pam_handle_t *pamh);

DESCRIPTION         top

       The pam_getenvlist function returns a complete copy of the PAM
       environment as associated with the handle pamh. The PAM
       environment variables represent the contents of the regular
       environment variables of the authenticated user when service is

       The format of the memory is a malloc()'d array of char pointers,
       the last element of which is set to NULL. Each of the non-NULL
       entries in this array point to a NUL terminated and malloc()'d
       char string of the form: "name=value".

       It should be noted that this memory will never be free()'d by
       libpam. Once obtained by a call to pam_getenvlist, it is the
       responsibility of the calling application to free() this memory.

       It is by design, and not a coincidence, that the format and
       contents of the returned array matches that required for the
       third argument of the execle(3) function call.

RETURN VALUES         top

       The pam_getenvlist function returns NULL on failure.

SEE ALSO         top

       pam_start(3), pam_getenv(3), pam_putenv(3), pam(8)

COLOPHON         top

       This page is part of the linux-pam (Pluggable Authentication
       Modules for Linux) project.  Information about the project can be
       found at ⟨⟩.  If you have a bug report
       for this manual page, see ⟨//⟩.  This page was
       obtained from the project's upstream Git repository
       ⟨⟩ 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

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

Pages that refer to this page: su(1)pam(3)pam_getenv(3)pam_misc_drop_env(3)pam_putenv(3)pam_exec(8)