pam_end(3) — Linux manual page

PAM_END(3)                  Linux-PAM Manual                  PAM_END(3)

NAME

       pam_end - termination of PAM transaction

SYNOPSIS

       #include <security/pam_appl.h>

       int pam_end(pam_handle_t *pamh, int pam_status);

DESCRIPTION

       The pam_end function terminates the PAM transaction and is the
       last function an application should call in the PAM context. Upon
       return the handle pamh is no longer valid and all memory
       associated with it will be invalid.

       The pam_status argument should be set to the value returned to
       the application by the last PAM library call.

       The value taken by pam_status is used as an argument to the
       module specific callback function, cleanup() (See pam_set_data(3)
       and pam_get_data(3)). In this way the module can be given
       notification of the pass/fail nature of the tear-down process,
       and perform any last minute tasks that are appropriate to the
       module before it is unlinked. This argument can be logically OR'd
       with PAM_DATA_SILENT to indicate that the module should not treat
       the call too seriously. It is generally used to indicate that the
       current closing of the library is in a fork(2)ed process, and
       that the parent will take care of cleaning up things that exist
       outside of the current process space (files etc.).

       This function free's all memory for items associated with the
       pam_set_item(3) and pam_get_item(3) functions. Pointers
       associated with such objects are not valid anymore after pam_end
       was called.

RETURN VALUES

       PAM_SUCCESS
           Transaction was successful terminated.

       PAM_SYSTEM_ERR
           System error, for example a NULL pointer was submitted as PAM
           handle or the function was called by a module.

SEE ALSO

       pam_get_data(3), pam_set_data(3), pam_start(3), pam_strerror(3)

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_END(3)

Pages that refer to this page: pam(3), pam_authenticate(3), pam_get_data(3), pam_get_user(3), pam_set_data(3), pam_start(3)

---