1.\"-
2.\" Copyright (c) 2002 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 December 12, 2002
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 security/pam_appl.h
46.Ft int
47.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
48.Sh DESCRIPTION
49The
50.Nm
51function attempts to authenticate the user
52associated with the pam context specified by the
53.Va pamh
54argument.
55.Pp
56The application is free to call
57.Nm
58as many times as it
59wishes, but some modules may maintain an internal retry counter and
60return
61.Dv PAM_MAXTRIES
62when it exceeds some preset or hardcoded limit.
63.Pp
64The
65.Va flags
66argument is the binary or of zero or more of the following
67values:
68.Bl -tag -width 18n
69.It Dv PAM_SILENT
70Do not emit any messages.
71.It Dv PAM_DISALLOW_NULL_AUTHTOK
72Fail if the user's authentication token is null.
73.El
74.Pp
75If any other bits are set,
76.Nm
77will return
78.Dv PAM_SYMBOL_ERR .
79.Sh RETURN VALUES
80The
81.Nm
82function returns one of the following values:
83.Bl -tag -width 18n
84.It Bq Er PAM_ABORT
85General failure.
86.It Bq Er PAM_AUTHINFO_UNAVAIL
87Authentication information is unavailable.
88.It Bq Er PAM_AUTH_ERR
89Authentication error.
90.It Bq Er PAM_BUF_ERR
91Memory buffer error.
92.It Bq Er PAM_CONV_ERR
93Conversation failure.
94.It Bq Er PAM_CRED_INSUFFICIENT
95Insufficient credentials.
96.It Bq Er PAM_MAXTRIES
97Maximum number of tries exceeded.
98.It Bq Er PAM_PERM_DENIED
99Permission denied.
100.It Bq Er PAM_SERVICE_ERR
101Error in service module.
102.It Bq Er PAM_SYMBOL_ERR
103Invalid symbol.
104.It Bq Er PAM_SYSTEM_ERR
105System error.
106.It Bq Er PAM_USER_UNKNOWN
107Unknown user.
108.El
109.Sh SEE ALSO
110.Xr pam 3 ,
111.Xr pam_strerror 3
112.Sh STANDARDS
113.Rs
114.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
115.%D "June 1997"
116.Re
117.Sh AUTHORS
118The
119.Nm
120function and this manual page were developed for the FreeBSD Project
121by ThinkSec AS and Network Associates Laboratories, the Security
122Research Division of Network Associates, Inc. under DARPA/SPAWAR
123contract N66001-01-C-8035
124.Pq Dq CBOSS ,
125as part of the DARPA CHATS research program.
2.\" Copyright (c) 2002 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 December 12, 2002
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 security/pam_appl.h
46.Ft int
47.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
48.Sh DESCRIPTION
49The
50.Nm
51function attempts to authenticate the user
52associated with the pam context specified by the
53.Va pamh
54argument.
55.Pp
56The application is free to call
57.Nm
58as many times as it
59wishes, but some modules may maintain an internal retry counter and
60return
61.Dv PAM_MAXTRIES
62when it exceeds some preset or hardcoded limit.
63.Pp
64The
65.Va flags
66argument is the binary or of zero or more of the following
67values:
68.Bl -tag -width 18n
69.It Dv PAM_SILENT
70Do not emit any messages.
71.It Dv PAM_DISALLOW_NULL_AUTHTOK
72Fail if the user's authentication token is null.
73.El
74.Pp
75If any other bits are set,
76.Nm
77will return
78.Dv PAM_SYMBOL_ERR .
79.Sh RETURN VALUES
80The
81.Nm
82function returns one of the following values:
83.Bl -tag -width 18n
84.It Bq Er PAM_ABORT
85General failure.
86.It Bq Er PAM_AUTHINFO_UNAVAIL
87Authentication information is unavailable.
88.It Bq Er PAM_AUTH_ERR
89Authentication error.
90.It Bq Er PAM_BUF_ERR
91Memory buffer error.
92.It Bq Er PAM_CONV_ERR
93Conversation failure.
94.It Bq Er PAM_CRED_INSUFFICIENT
95Insufficient credentials.
96.It Bq Er PAM_MAXTRIES
97Maximum number of tries exceeded.
98.It Bq Er PAM_PERM_DENIED
99Permission denied.
100.It Bq Er PAM_SERVICE_ERR
101Error in service module.
102.It Bq Er PAM_SYMBOL_ERR
103Invalid symbol.
104.It Bq Er PAM_SYSTEM_ERR
105System error.
106.It Bq Er PAM_USER_UNKNOWN
107Unknown user.
108.El
109.Sh SEE ALSO
110.Xr pam 3 ,
111.Xr pam_strerror 3
112.Sh STANDARDS
113.Rs
114.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
115.%D "June 1997"
116.Re
117.Sh AUTHORS
118The
119.Nm
120function and this manual page were developed for the FreeBSD Project
121by ThinkSec AS and Network Associates Laboratories, the Security
122Research Division of Network Associates, Inc. under DARPA/SPAWAR
123contract N66001-01-C-8035
124.Pq Dq CBOSS ,
125as part of the DARPA CHATS research program.