pam_chauthtok(3) — Linux manual page


PAM_CHAUTHTOK(3)            Linux-PAM Manual            PAM_CHAUTHTOK(3)

NAME         top

       pam_chauthtok - updating authentication tokens

SYNOPSIS         top

       #include <security/pam_appl.h>

       int pam_chauthtok(pam_handle_t *pamh, int flags);

DESCRIPTION         top

       The pam_chauthtok function is used to change the authentication
       token for a given user (as indicated by the state associated with
       the handle pamh).

       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:

           Do not emit any messages.

           This argument indicates to the modules that the user's
           authentication token (password) should only be changed if it
           has expired. If this argument is not passed, the application
           requires that all authentication tokens are to be changed.

RETURN VALUES         top

           A module was unable to obtain the new authentication token.

           A module was unable to obtain the old authentication token.

           One or more of the modules was unable to change the
           authentication token since it is currently locked.

           Authentication token aging has been disabled for at least one
           of the modules.

           Permission denied.

           The authentication token was successfully updated.

           Not all of the modules were in a position to update the
           authentication token(s). In such a case none of the user's
           authentication tokens are updated.

           User unknown to password service.

SEE ALSO         top

       pam_start(3), pam_authenticate(3), pam_setcred(3),
       pam_get_item(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 ⟨⟩.  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_CHAUTHTOK(3)

Pages that refer to this page: pam(3)pam_acct_mgmt(3)pam_authenticate(3)pam_sm_chauthtok(3)pam_filter(8)