pam_chauthtok(3) [centos man page]

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

NAME

       pam_chauthtok - updating authentication tokens

SYNOPSIS

       #include <security/pam_appl.h>

       int pam_chauthtok(pam_handle_t *pamh, int flags);

DESCRIPTION

       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:

       PAM_SILENT
	   Do not emit any messages.

       PAM_CHANGE_EXPIRED_AUTHTOK
	   This argument indicates to the modules that the users 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

       PAM_AUTHTOK_ERR
	   A module was unable to obtain the new authentication token.

       PAM_AUTHTOK_RECOVERY_ERR
	   A module was unable to obtain the old authentication token.

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

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

       PAM_PERM_DENIED
	   Permission denied.

       PAM_SUCCESS
	   The authentication token was successfully updated.

       PAM_TRY_AGAIN
	   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.

       PAM_USER_UNKNOWN
	   User unknown to password service.

SEE ALSO

       pam_start(3), pam_authenticate(3), pam_setcred(3), pam_get_item(3), pam_strerror(3), pam(8)

Linux-PAM Manual						    09/19/2013							  PAM_CHAUTHTOK(3)

PAM_SM_CHAUTHTOK(3)						 Linux-PAM Manual					       PAM_SM_CHAUTHTOK(3)

NAME

       pam_sm_chauthtok - PAM service function for authentication token management

SYNOPSIS

       #define PAM_SM_PASSWORD

       #include <security/pam_modules.h>

       PAM_EXTERN int pam_sm_chauthtok(pam_handle_t *pamh, int flags, int argc, const char **argv);

DESCRIPTION

       The pam_sm_chauthtok function is the service module's implementation of the pam_chauthtok(3) interface.

       This function is used to (re-)set the authentication token of the user.

       Valid flags, which may be logically OR'd with PAM_SILENT, are:

       PAM_SILENT
	   Do not emit any messages.

       PAM_CHANGE_EXPIRED_AUTHTOK
	   This argument indicates to the module that the users authentication token (password) should only be changed if it has expired. This
	   flag is optional and must be combined with one of the following two flags. Note, however, the following two options are mutually
	   exclusive.

       PAM_PRELIM_CHECK
	   This indicates that the modules are being probed as to their ready status for altering the user's authentication token. If the module
	   requires access to another system over some network it should attempt to verify it can connect to this system on receiving this flag.
	   If a module cannot establish it is ready to update the user's authentication token it should return PAM_TRY_AGAIN, this information
	   will be passed back to the application.

	   If the control value sufficient is used in the password stack, the PAM_PRELIM_CHECK section of the modules following that control value
	   is not always executed.

       PAM_UPDATE_AUTHTOK
	   This informs the module that this is the call it should change the authorization tokens. If the flag is logically OR'd with
	   PAM_CHANGE_EXPIRED_AUTHTOK, the token is only changed if it has actually expired.

       The PAM library calls this function twice in succession. The first time with PAM_PRELIM_CHECK and then, if the module does not return
       PAM_TRY_AGAIN, subsequently with PAM_UPDATE_AUTHTOK. It is only on the second call that the authorization token is (possibly) changed.

RETURN VALUES

       PAM_AUTHTOK_ERR
	   The module was unable to obtain the new authentication token.

       PAM_AUTHTOK_RECOVERY_ERR
	   The module was unable to obtain the old authentication token.

       PAM_AUTHTOK_LOCK_BUSY
	   Cannot change the authentication token since it is currently locked.

       PAM_AUTHTOK_DISABLE_AGING
	   Authentication token aging has been disabled.

       PAM_PERM_DENIED
	   Permission denied.

       PAM_TRY_AGAIN
	   Preliminary check was unsuccessful. Signals an immediate return to the application is desired.

       PAM_SUCCESS
	   The authentication token was successfully updated.

       PAM_USER_UNKNOWN
	   User unknown to password service.

SEE ALSO

       pam(3), pam_chauthtok(3), pam_sm_chauthtok(3), pam_strerror(3), PAM(8)

Linux-PAM Manual						    09/19/2013						       PAM_SM_CHAUTHTOK(3)