Diffstat (limited to 'doc/man/pam_sm_chauthtok.3')
1 files changed, 97 insertions, 0 deletions
diff --git a/doc/man/pam_sm_chauthtok.3 b/doc/man/pam_sm_chauthtok.3
new file mode 100644
@@ -0,0 +1,97 @@
+.\" Title: pam_sm_chauthtok
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\" Date: 06/19/2006
+.\" Manual: Linux\-PAM Manual
+.\" Source: Linux\-PAM Manual
+.TH "PAM_SM_CHAUTHTOK" "3" "06/19/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.\" disable justification (adjust text to left margin only)
+pam_sm_chauthtok \- PAM service function for account management
+.BI "PAM_EXTERN int pam_sm_chauthtok(pam_handle_t\ *" "pamh" ", int\ " "flags" ", int\ " "argc" ", const\ char\ **" "argv" ");"
+function is the service module's implementation of the
+This function is used to (re\-)set the authentication token of the user.
+Valid flags, which may be logically OR'd with
+Do not emit any messages.
+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
+be combined with one of the following two flags. Note, however, the following two options are
+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
+\fBPAM_TRY_AGAIN\fR, this information will be passed back to the application.
+This informs the module that this is the call it should change the authorization tokens. If the flag is logically OR'd with
+\fBPAM_CHANGE_EXPIRED_AUTHTOK\fR, the token is only changed if it has actually expired.
+The PAM library calls this function twice in succession. The first time with
+and then, if the module does not return
+\fBPAM_TRY_AGAIN\fR, subsequently with
+\fBPAM_UPDATE_AUTHTOK\fR. It is only on the second call that the authorization token is (possibly) changed.
+.SH "RETURN VALUES"
+The module was unable to obtain the new authentication token.
+The module was unable to obtain the old authentication token.
+Cannot change the authentication token since it is currently locked.
+Authentication token aging has been disabled.
+Preliminary check was unsuccessful. Signals an immediate return to the application is desired.
+The authentication token was successfully updated.
+User unknown to password service.
+.SH "SEE ALSO"