Debian Codegraph @

upstream/debian-unstable/man3/pam_authenticate.3

raw
1 '\" t
2 .\" Title: pam_authenticate
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 06/29/2025
6 .\" Manual: Linux-PAM Manual
7 .\" Source: Linux-PAM
8 .\" Language: English
9 .\"
10 .TH "PAM_AUTHENTICATE" "3" "06/29/2025" "Linux\-PAM" "Linux\-PAM Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 pam_authenticate \- account authentication
32 .SH "SYNOPSIS"
33 .sp
34 .ft B
35 .nf
36 #include <security/pam_appl\&.h>
37 .fi
38 .ft
39 .HP \w'int\ pam_authenticate('u
40 .BI "int pam_authenticate(pam_handle_t\ *" "pamh" ", int\ " "flags" ");"
41 .SH "DESCRIPTION"
42 .PP
43 The
44 \fBpam_authenticate\fR
45 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\&.
46 .PP
47 The PAM service module may request that the user enter their username via the conversation mechanism (see
48 \fBpam_start\fR(3)
49 and
50 \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
51 \fBpam_get_item\fR(3)\&.
52 .PP
53 The
54 \fIpamh\fR
55 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:
56 .PP
57 PAM_SILENT
58 .RS 4
59 Do not emit any messages\&.
60 .RE
61 .PP
62 PAM_DISALLOW_NULL_AUTHTOK
63 .RS 4
64 The PAM module service should return PAM_AUTH_ERR if the user does not have a registered authentication token\&.
65 .RE
66 .SH "RETURN VALUES"
67 .PP
68 PAM_ABORT
69 .RS 4
70 The application should exit immediately after calling
71 \fBpam_end\fR(3)
72 first\&.
73 .RE
74 .PP
75 PAM_AUTH_ERR
76 .RS 4
77 The user was not authenticated\&.
78 .RE
79 .PP
80 PAM_CRED_INSUFFICIENT
81 .RS 4
82 For some reason the application does not have sufficient credentials to authenticate the user\&.
83 .RE
84 .PP
85 PAM_AUTHINFO_UNAVAIL
86 .RS 4
87 The modules were not able to access the authentication information\&. This might be due to a network or hardware failure etc\&.
88 .RE
89 .PP
90 PAM_MAXTRIES
91 .RS 4
92 One or more of the authentication modules has reached its limit of tries authenticating the user\&. Do not try again\&.
93 .RE
94 .PP
95 PAM_SUCCESS
96 .RS 4
97 The user was successfully authenticated\&.
98 .RE
99 .PP
100 PAM_USER_UNKNOWN
101 .RS 4
102 User unknown to authentication service\&.
103 .RE
104 .SH "SEE ALSO"
105 .PP
106 \fBpam_start\fR(3),
107 \fBpam_setcred\fR(3),
108 \fBpam_chauthtok\fR(3),
109 \fBpam_strerror\fR(3),
110 \fBpam\fR(7)