1.\"-
2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" Network Associates Laboratories, the Security Research Division of
7.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
8.\" ("CBOSS"), as part of the DARPA CHATS research program.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. The name of the author may not be used to endorse or promote
19.\"    products derived from this software without specific prior written
20.\"    permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $P4$
35.\"
36.Dd June 16, 2005
37.Dt PAM_AUTHENTICATE 3
38.Os
39.Sh NAME
40.Nm pam_authenticate
41.Nd perform authentication within the PAM framework
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In sys/types.h
46.In security/pam_appl.h
47.Ft "int"
48.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
49.Sh DESCRIPTION
50The
51.Nm
52function attempts to authenticate the user
53associated with the pam context specified by the
54.Fa pamh
55argument.
56.Pp
57The application is free to call
58.Nm
59as many times as it
60wishes, but some modules may maintain an internal retry counter and
61return
62.Dv PAM_MAXTRIES
63when it exceeds some preset or hardcoded limit.
64.Pp
65The
66.Fa flags
67argument is the binary or of zero or more of the following
68values:
69.Bl -tag -width 18n
70.It Dv PAM_SILENT
71Do not emit any messages.
72.It Dv PAM_DISALLOW_NULL_AUTHTOK
73Fail if the user's authentication token is null.
74.El
75.Pp
76If any other bits are set,
77.Nm
78will return
79.Dv PAM_SYMBOL_ERR .
80.Sh RETURN VALUES
81The
82.Nm
83function returns one of the following values:
84.Bl -tag -width 18n
85.It Bq Er PAM_ABORT
86General failure.
87.It Bq Er PAM_AUTHINFO_UNAVAIL
88Authentication information is unavailable.
89.It Bq Er PAM_AUTH_ERR
90Authentication error.
91.It Bq Er PAM_BUF_ERR
92Memory buffer error.
93.It Bq Er PAM_CONV_ERR
94Conversation failure.
95.It Bq Er PAM_CRED_INSUFFICIENT
96Insufficient credentials.
97.It Bq Er PAM_MAXTRIES
98Maximum number of tries exceeded.
99.It Bq Er PAM_PERM_DENIED
100Permission denied.
101.It Bq Er PAM_SERVICE_ERR
102Error in service module.
103.It Bq Er PAM_SYMBOL_ERR
104Invalid symbol.
105.It Bq Er PAM_SYSTEM_ERR
106System error.
107.It Bq Er PAM_USER_UNKNOWN
108Unknown user.
109.El
110.Sh SEE ALSO
111.Xr pam 3 ,
112.Xr pam_strerror 3
113.Sh STANDARDS
114.Rs
115.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
116.%D "June 1997"
117.Re
118.Sh AUTHORS
119The
120.Nm
121function and this manual page were developed for the
122.Fx
123Project by ThinkSec AS and Network Associates Laboratories, the
124Security Research Division of Network Associates, Inc.& under
125DARPA/SPAWAR contract N66001-01-C-8035
126.Pq Dq CBOSS ,
127as part of the DARPA CHATS research program.
128