pam_acct_mgmt(3) — Linux manual page

PAM_ACCT_MGMT(3)            Linux-PAM Manual            PAM_ACCT_MGMT(3)

NAME         top

       pam_acct_mgmt - PAM account validation management

SYNOPSIS         top

       #include <security/pam_appl.h>

       int pam_acct_mgmt(pam_handle_t *pamh, int flags);

DESCRIPTION         top

       The pam_acct_mgmt function is used to determine if the user's
       account is valid. It checks for authentication token and account
       expiration and verifies access restrictions. It is typically
       called after the user has been authenticated.

       The pamh argument is an authentication handle obtained by a prior
       call to pam_start(). The flags argument is the binary or of zero
       or more of the following values:

       PAM_SILENT
           Do not emit any messages.

       PAM_DISALLOW_NULL_AUTHTOK
           The PAM module service should return PAM_NEW_AUTHTOK_REQD if
           the user has a null authentication token.

RETURN VALUES         top

       PAM_ACCT_EXPIRED
           User account has expired.

       PAM_AUTH_ERR
           Authentication failure.

       PAM_NEW_AUTHTOK_REQD
           The user account is valid but their authentication token is
           expired. The correct response to this return-value is to
           require that the user satisfies the pam_chauthtok() function
           before obtaining service. It may not be possible for some
           applications to do this. In such cases, the user should be
           denied access until such time as they can update their
           password.

       PAM_PERM_DENIED
           Permission denied.

       PAM_SUCCESS
           The authentication token was successfully updated.

       PAM_USER_UNKNOWN
           User unknown to password service.

SEE ALSO         top

       pam_start(3), pam_authenticate(3), pam_chauthtok(3),
       pam_strerror(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 ⟨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_ACCT_MGMT(3)

Pages that refer to this page: pam(3),  pam_sm_acct_mgmt(3)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.