summaryrefslogtreecommitdiff
path: root/Linux-PAM/doc/man/pam_sm_authenticate.3
diff options
context:
space:
mode:
Diffstat (limited to 'Linux-PAM/doc/man/pam_sm_authenticate.3')
-rw-r--r--Linux-PAM/doc/man/pam_sm_authenticate.372
1 files changed, 44 insertions, 28 deletions
diff --git a/Linux-PAM/doc/man/pam_sm_authenticate.3 b/Linux-PAM/doc/man/pam_sm_authenticate.3
index 7487f6af..a61e9a2c 100644
--- a/Linux-PAM/doc/man/pam_sm_authenticate.3
+++ b/Linux-PAM/doc/man/pam_sm_authenticate.3
@@ -1,17 +1,17 @@
.\" Title: pam_sm_authenticate
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
-.\" Date: 06/27/2006
-.\" Manual: Linux\-PAM Manual
-.\" Source: Linux\-PAM Manual
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <http://docbook.sf.net/>
+.\" Date: 02/04/2008
+.\" Manual: Linux-PAM Manual
+.\" Source: Linux-PAM Manual
.\"
-.TH "PAM_SM_AUTHENTICATE" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual"
+.TH "PAM_SM_AUTHENTICATE" "3" "02/04/2008" "Linux-PAM Manual" "Linux-PAM Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-pam_sm_authenticate \- PAM service function for user authentication
+pam_sm_authenticate - PAM service function for user authentication
.SH "SYNOPSIS"
.sp
.ft B
@@ -22,7 +22,7 @@ pam_sm_authenticate \- PAM service function for user authentication
.sp
.ft B
.nf
-#include <security/pam_modules.h>
+#include <security/pam_modules\.h>
.fi
.ft
.HP 35
@@ -31,45 +31,61 @@ pam_sm_authenticate \- PAM service function for user authentication
.PP
The
\fBpam_sm_authenticate\fR
-function is the service module's implementation of the
+function is the service module\'s implementation of the
\fBpam_authenticate\fR(3)
-interface.
+interface\.
.PP
-This function performs the task of authenticating the user.
+This function performs the task of authenticating the user\.
.PP
-Valid flags, which may be logically OR'd with
+Valid flags, which may be logically OR\'d with
\fIPAM_SILENT\fR, are:
-.TP 3n
+.PP
PAM_SILENT
-Do not emit any messages.
-.TP 3n
+.RS 4
+Do not emit any messages\.
+.RE
+.PP
PAM_DISALLOW_NULL_AUTHTOK
+.RS 4
Return
\fBPAM_AUTH_ERR\fR
if the database of authentication tokens for this authentication mechanism has a
\fINULL\fR
-entry for the user. Without this flag, such a
+entry for the user\. Without this flag, such a
\fINULL\fR
-token will lead to a success without the user being prompted.
+token will lead to a success without the user being prompted\.
+.RE
.SH "RETURN VALUES"
-.TP 3n
+.PP
PAM_AUTH_ERR
-Authentication failure.
-.TP 3n
+.RS 4
+Authentication failure\.
+.RE
+.PP
PAM_CRED_INSUFFICIENT
-For some reason the application does not have sufficient credentials to authenticate the user.
-.TP 3n
+.RS 4
+For some reason the application does not have sufficient credentials to authenticate the user\.
+.RE
+.PP
PAM_AUTHINFO_UNAVAIL
-The modules were not able to access the authentication information. This might be due to a network or hardware failure etc.
-.TP 3n
+.RS 4
+The modules were not able to access the authentication information\. This might be due to a network or hardware failure etc\.
+.RE
+.PP
PAM_SUCCESS
-The authentication token was successfully updated.
-.TP 3n
+.RS 4
+The authentication token was successfully updated\.
+.RE
+.PP
PAM_USER_UNKNOWN
-The supplied username is not known to the authentication service.
-.TP 3n
+.RS 4
+The supplied username is not known to the authentication service\.
+.RE
+.PP
PAM_MAXTRIES
-One or more of the authentication modules has reached its limit of tries authenticating the user. Do not try again.
+.RS 4
+One or more of the authentication modules has reached its limit of tries authenticating the user\. Do not try again\.
+.RE
.SH "SEE ALSO"
.PP