diff options
Diffstat (limited to 'Linux-PAM/doc/man/pam_authenticate.3')
| -rw-r--r-- | Linux-PAM/doc/man/pam_authenticate.3 | 76 |
1 files changed, 47 insertions, 29 deletions
diff --git a/Linux-PAM/doc/man/pam_authenticate.3 b/Linux-PAM/doc/man/pam_authenticate.3 index 576a7a2c..13c60f0a 100644 --- a/Linux-PAM/doc/man/pam_authenticate.3 +++ b/Linux-PAM/doc/man/pam_authenticate.3 @@ -1,22 +1,22 @@ .\" Title: pam_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_AUTHENTICATE" "3" "06/27/2006" "Linux\-PAM Manual" "Linux\-PAM Manual" +.TH "PAM_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_authenticate \- account authentication +pam_authenticate - account authentication .SH "SYNOPSIS" .sp .ft B .nf -#include <security/pam_appl.h> +#include <security/pam_appl\.h> .fi .ft .HP 21 @@ -25,47 +25,65 @@ pam_authenticate \- account authentication .PP The \fBpam_authenticate\fR -function is used to authenticate the user. The user is required to provide an authentication token depending upon the authentication service, usually this is a password, but could also be a finger print. +function is used to authenticate the user\. The user is required to provide an authentication token depending upon the authentication service, usually this is a password, but could also be a finger print\. .PP The PAM service module may request that the user enter their username vio the the conversation mechanism (see \fBpam_start\fR(3) and -\fBpam_conv\fR(3)). The name of the authenticated user will be present in the PAM item PAM_USER. This item may be recovered with a call to -\fBpam_get_item\fR(3). +\fBpam_conv\fR(3))\. The name of the authenticated user will be present in the PAM item PAM_USER\. This item may be recovered with a call to +\fBpam_get_item\fR(3)\. .PP The \fIpamh\fR -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: -.TP 3n +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: +.PP PAM_SILENT -Do not emit any messages. -.TP 3n +.RS 4 +Do not emit any messages\. +.RE +.PP PAM_DISALLOW_NULL_AUTHTOK -The PAM module service should return PAM_AUTH_ERR if the user does not have a registered authentication token. +.RS 4 +The PAM module service should return PAM_AUTH_ERR if the user does not have a registered authentication token\. +.RE .SH "RETURN VALUES" -.TP 3n +.PP PAM_ABORT +.RS 4 The application should exit immediately after calling \fBpam_end\fR(3) -first. -.TP 3n +first\. +.RE +.PP PAM_AUTH_ERR -The user was not authenticated. -.TP 3n +.RS 4 +The user was not authenticated\. +.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_UNVAIL -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_MAXTRIES -One or more of the authentication modules has reached its limit of tries authenticating the user. Do not try again. -.TP 3n +.RS 4 +One or more of the authentication modules has reached its limit of tries authenticating the user\. Do not try again\. +.RE +.PP PAM_SUCCESS -The user was successfully authenticated. -.TP 3n +.RS 4 +The user was successfully authenticated\. +.RE +.PP PAM_USER_UNKNOWN -User unknown to authentication service. +.RS 4 +User unknown to authentication service\. +.RE .SH "SEE ALSO" .PP |