path: root/doc/man/pam_sm_authenticate.3
diff options
authorThorsten Kukuk <>2006-06-19 15:38:33 +0000
committerThorsten Kukuk <>2006-06-19 15:38:33 +0000
commit128e2a7f40a53552dae57269aa36dc5926144329 (patch)
tree8c26177c2f734af486404d057df36e9ac2f25752 /doc/man/pam_sm_authenticate.3
parent398000908bf00d06dc32ef4b605e3f437fdc6744 (diff)
Relevant BUGIDs:
Purpose of commit: new feature Commit summary: --------------- 2006-06-19 Thorsten Kukuk <> * doc/man/pam.8.xml: Syntax cleanup. * doc/pam/PAM.8: Regenerated from xml source. * man/pam_sm_chauthtok.3: New. * man/pam_sm_chauthtok.3.xml: New. * man/pam_sm_close_session.3: New. * man/pam_sm_close_session.3.xml: New. * man/pam_sm_open_session.3: New. * man/pam_sm_open_session.3.xml: New. * man/pam_sm_authenticate.3: New. * man/pam_sm_authenticate.3.xml: New. * man/pam_sm_setcred.3: New. * man/pam_sm_setcred.3.xml: New. * man/ Add new pam_sm_* manual pages. * specs/ Fix rule to generate draft.
Diffstat (limited to 'doc/man/pam_sm_authenticate.3')
1 files changed, 80 insertions, 0 deletions
diff --git a/doc/man/pam_sm_authenticate.3 b/doc/man/pam_sm_authenticate.3
new file mode 100644
index 00000000..38cecec7
--- /dev/null
+++ b/doc/man/pam_sm_authenticate.3
@@ -0,0 +1,80 @@
+.\" Title: pam_sm_authenticate
+.\" Author:
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <>
+.\" Date: 06/19/2006
+.\" Manual: Linux\-PAM Manual
+.\" Source: Linux\-PAM Manual
+.TH "PAM_SM_AUTHENTICATE" "3" "06/19/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.\" disable hyphenation
+.\" disable justification (adjust text to left margin only) l
+pam_sm_authenticate \- PAM service function for user authentication
+.ft B
+#define PAM_SM_AUTH
+.ft B
+#include <security/pam_modules.h>
+.HP 35
+.BI "PAM_EXTERN int pam_sm_authenticate(pam_handle_t\ *" "pamh" ", int\ " "flags" ", int\ " "argc" ", const\ char\ **" "argv" ");"
+function is the service module's implementation of the
+This function performs the task of authenticating the user.
+Valid flags, which may be logically OR'd with
+\fIPAM_SILENT\fR, are:
+.TP 3n
+Do not emit any messages.
+.TP 3n
+if the database of authentication tokens for this authentication mechanism has a
+entry for the user. Without this flag, such a
+token will lead to a success without the user being prompted.
+.TP 3n
+Authentication failure.
+.TP 3n
+For some reason the application does not have sufficient credentials to authenticate the user.
+.TP 3n
+The modules were not able to access the authentication information. This might be due to a network or hardware failure etc.
+.TP 3n
+The authentication token was successfully updated.
+.TP 3n
+The supplied username is not known to the authentication service.
+.TP 3n
+One or more of the authentication modules has reached its limit of tries authenticating the user. Do not try again.