4.Dt PAM_AUTHENTICATE 3
5.Os
6.Sh NAME
7.Nm pam_authenticate
8.Nd perform authentication within the PAM framework
9.Sh LIBRARY
10.Lb libpam
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.Ft "int"
15.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
16.Sh DESCRIPTION
17The
18.Fn pam_authenticate
19function attempts to authenticate the user
20associated with the pam context specified by the
21.Fa pamh
22argument.
23.Pp
24The application is free to call
25.Fn pam_authenticate
26as many times as it
27wishes, but some modules may maintain an internal retry counter and
28return
29.Dv PAM_MAXTRIES
30when it exceeds some preset or hardcoded limit.
31.Pp
32The
33.Fa flags
34argument is the binary or of zero or more of the following
35values:
36.Bl -tag -width 18n
37.It Dv PAM_SILENT
38Do not emit any messages.
39.It Dv PAM_DISALLOW_NULL_AUTHTOK
40Fail if the user's authentication token is null.
41.El
42.Pp
43If any other bits are set,
44.Fn pam_authenticate
45will return
46.Dv PAM_SYMBOL_ERR .
47.Sh RETURN VALUES
48The
49.Fn pam_authenticate
50function returns one of the following values:
51.Bl -tag -width 18n
52.It Bq Er PAM_ABORT
53General failure.
54.It Bq Er PAM_AUTHINFO_UNAVAIL
55Authentication information is unavailable.
56.It Bq Er PAM_AUTH_ERR
57Authentication error.
58.It Bq Er PAM_BUF_ERR
59Memory buffer error.
60.It Bq Er PAM_CONV_ERR
61Conversation failure.
62.It Bq Er PAM_CRED_INSUFFICIENT
63Insufficient credentials.
64.It Bq Er PAM_MAXTRIES
65Maximum number of tries exceeded.
66.It Bq Er PAM_PERM_DENIED
67Permission denied.
68.It Bq Er PAM_SERVICE_ERR
69Error in service module.
70.It Bq Er PAM_SYMBOL_ERR
71Invalid symbol.
72.It Bq Er PAM_SYSTEM_ERR
73System error.
74.It Bq Er PAM_USER_UNKNOWN
75Unknown user.
76.El
77.Sh SEE ALSO
78.Xr pam 3 ,
79.Xr pam_strerror 3
80.Sh STANDARDS
81.Rs
82.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
83.%D "June 1997"
84.Re
85.Sh AUTHORS
86The
87.Fn pam_authenticate
88function and this manual page were
89developed for the
90.Fx
91Project by ThinkSec AS and Network Associates Laboratories, the
92Security Research Division of Network Associates, Inc.\& under
93DARPA/SPAWAR contract N66001-01-C-8035
94.Pq Dq CBOSS ,
95as part of the DARPA CHATS research program.
96.Pp
97The OpenPAM library is maintained by
98.An Dag-Erling Sm\(/orgrav Aq des@des.no .
| 4.Dt PAM_AUTHENTICATE 3
5.Os
6.Sh NAME
7.Nm pam_authenticate
8.Nd perform authentication within the PAM framework
9.Sh LIBRARY
10.Lb libpam
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.Ft "int"
15.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
16.Sh DESCRIPTION
17The
18.Fn pam_authenticate
19function attempts to authenticate the user
20associated with the pam context specified by the
21.Fa pamh
22argument.
23.Pp
24The application is free to call
25.Fn pam_authenticate
26as many times as it
27wishes, but some modules may maintain an internal retry counter and
28return
29.Dv PAM_MAXTRIES
30when it exceeds some preset or hardcoded limit.
31.Pp
32The
33.Fa flags
34argument is the binary or of zero or more of the following
35values:
36.Bl -tag -width 18n
37.It Dv PAM_SILENT
38Do not emit any messages.
39.It Dv PAM_DISALLOW_NULL_AUTHTOK
40Fail if the user's authentication token is null.
41.El
42.Pp
43If any other bits are set,
44.Fn pam_authenticate
45will return
46.Dv PAM_SYMBOL_ERR .
47.Sh RETURN VALUES
48The
49.Fn pam_authenticate
50function returns one of the following values:
51.Bl -tag -width 18n
52.It Bq Er PAM_ABORT
53General failure.
54.It Bq Er PAM_AUTHINFO_UNAVAIL
55Authentication information is unavailable.
56.It Bq Er PAM_AUTH_ERR
57Authentication error.
58.It Bq Er PAM_BUF_ERR
59Memory buffer error.
60.It Bq Er PAM_CONV_ERR
61Conversation failure.
62.It Bq Er PAM_CRED_INSUFFICIENT
63Insufficient credentials.
64.It Bq Er PAM_MAXTRIES
65Maximum number of tries exceeded.
66.It Bq Er PAM_PERM_DENIED
67Permission denied.
68.It Bq Er PAM_SERVICE_ERR
69Error in service module.
70.It Bq Er PAM_SYMBOL_ERR
71Invalid symbol.
72.It Bq Er PAM_SYSTEM_ERR
73System error.
74.It Bq Er PAM_USER_UNKNOWN
75Unknown user.
76.El
77.Sh SEE ALSO
78.Xr pam 3 ,
79.Xr pam_strerror 3
80.Sh STANDARDS
81.Rs
82.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
83.%D "June 1997"
84.Re
85.Sh AUTHORS
86The
87.Fn pam_authenticate
88function and this manual page were
89developed for the
90.Fx
91Project by ThinkSec AS and Network Associates Laboratories, the
92Security Research Division of Network Associates, Inc.\& under
93DARPA/SPAWAR contract N66001-01-C-8035
94.Pq Dq CBOSS ,
95as part of the DARPA CHATS research program.
96.Pp
97The OpenPAM library is maintained by
98.An Dag-Erling Sm\(/orgrav Aq des@des.no .
|