1PAM_AUTHENTICATE(3)            Linux-PAM Manual            PAM_AUTHENTICATE(3)
2
3
4

NAME

6       pam_authenticate - account authentication
7

SYNOPSIS

9       #include <security/pam_appl.h>
10
11       int pam_authenticate(pam_handle_t *pamh, int flags);
12

DESCRIPTION

14       The pam_authenticate function is used to authenticate the user. The
15       user is required to provide an authentication token depending upon the
16       authentication service, usually this is a password, but could also be a
17       finger print.
18
19       The PAM service module may request that the user enter their username
20       vio the the conversation mechanism (see pam_start(3) and pam_conv(3)).
21       The name of the authenticated user will be present in the PAM item
22       PAM_USER. This item may be recovered with a call to pam_get_item(3).
23
24       The pamh argument is an authentication handle obtained by a prior call
25       to pam_start(). The flags argument is the binary or of zero or more of
26       the following values:
27
28       PAM_SILENT
29           Do not emit any messages.
30
31       PAM_DISALLOW_NULL_AUTHTOK
32           The PAM module service should return PAM_AUTH_ERR if the user does
33           not have a registered authentication token.
34

RETURN VALUES

36       PAM_ABORT
37           The application should exit immediately after calling pam_end(3)
38           first.
39
40       PAM_AUTH_ERR
41           The user was not authenticated.
42
43       PAM_CRED_INSUFFICIENT
44           For some reason the application does not have sufficient
45           credentials to authenticate the user.
46
47       PAM_AUTHINFO_UNVAIL
48           The modules were not able to access the authentication information.
49           This might be due to a network or hardware failure etc.
50
51       PAM_MAXTRIES
52           One or more of the authentication modules has reached its limit of
53           tries authenticating the user. Do not try again.
54
55       PAM_SUCCESS
56           The user was successfully authenticated.
57
58       PAM_USER_UNKNOWN
59           User unknown to authentication service.
60

SEE ALSO

62       pam_start(3), pam_setcred(3), pam_chauthtok(3), pam_strerror(3), pam(8)
63
64
65
66Linux-PAM Manual                  09/19/2013               PAM_AUTHENTICATE(3)
Impressum