path: root/doc/man/pam_authenticate.3
diff options
authorSteve Langasek <>2019-01-03 16:26:05 -0800
committerSteve Langasek <>2019-01-03 17:26:38 -0800
commit9c52e721044e7501c3d4567b36d222dc7326224a (patch)
tree9011790770130c60a712a6f125ad50d60e07cc74 /doc/man/pam_authenticate.3
parent9727ff2a3fa0e94a42b34a579027bacf4146d571 (diff)
parent186ff16e8d12ff15d518000c17f115ccab5275a4 (diff)
New upstream version 1.0.1
Diffstat (limited to 'doc/man/pam_authenticate.3')
1 files changed, 94 insertions, 0 deletions
diff --git a/doc/man/pam_authenticate.3 b/doc/man/pam_authenticate.3
new file mode 100644
index 00000000..49a540cc
--- /dev/null
+++ b/doc/man/pam_authenticate.3
@@ -0,0 +1,94 @@
+.\" Title: pam_authenticate
+.\" Author:
+.\" Generator: DocBook XSL Stylesheets v1.73.1 <>
+.\" Date: 04/16/2008
+.\" Manual: Linux-PAM Manual
+.\" Source: Linux-PAM Manual
+.TH "PAM_AUTHENTICATE" "3" "04/16/2008" "Linux-PAM Manual" "Linux-PAM Manual"
+.\" disable hyphenation
+.\" disable justification (adjust text to left margin only) l
+pam_authenticate - account authentication
+.ft B
+#include <security/pam_appl\.h>
+.HP 21
+.BI "int pam_authenticate(pam_handle_t\ *" "pamh" ", int\ " "flags" ");"
+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\.
+The PAM service module may request that the user enter their username vio the the conversation mechanism (see
+\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
+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:
+.RS 4
+Do not emit any messages\.
+.RS 4
+The PAM module service should return PAM_AUTH_ERR if the user does not have a registered authentication token\.
+.RS 4
+The application should exit immediately after calling
+.RS 4
+The user was not authenticated\.
+.RS 4
+For some reason the application does not have sufficient credentials to authenticate the user\.
+.RS 4
+The modules were not able to access the authentication information\. This might be due to a network or hardware failure etc\.
+.RS 4
+One or more of the authentication modules has reached its limit of tries authenticating the user\. Do not try again\.
+.RS 4
+The user was successfully authenticated\.
+.RS 4
+User unknown to authentication service\.