source: openpam/trunk/doc/man/pam_sm_authenticate.3 @ 107

Last change on this file since 107 was 107, checked in by Dag-Erling Smørgrav, 18 years ago

Regenerate.

File size: 3.4 KB
Line 
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.\" NAI Labs, the Security Research Division of Network Associates, Inc.
7.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8.\" 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: //depot/projects/openpam/doc/man/pam_sm_authenticate.3#6 $
35.\"
36.Dd April 8, 2002
37.Dt PAM_SM_AUTHENTICATE 3
38.Os
39.Sh NAME
40.Nm pam_sm_authenticate
41.Nd service module implementation for pam_authenticate
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In security/pam_appl.h
46.In security/pam_modules.h
47.Ft int
48.Fn pam_sm_authenticate "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
49.Sh DESCRIPTION
50The
51.Nm
52function is the service module's
53implementation of the
54.Xr pam_authenticate 3
55API function.
56.Sh RETURN VALUES
57The
58.Nm
59function returns one of the following values:
60.Bl -tag -width 18n
61.It Bq Er PAM_ABORT
62General failure.
63.It Bq Er PAM_AUTHINFO_UNAVAIL
64Authentication information is unavailable.
65.It Bq Er PAM_AUTH_ERR
66Authentication error.
67.It Bq Er PAM_BUF_ERR
68Memory buffer error.
69.It Bq Er PAM_CONV_ERR
70Conversation failure.
71.It Bq Er PAM_CRED_INSUFFICIENT
72Insufficient credentials.
73.It Bq Er PAM_IGNORE
74Ignore this module.
75.It Bq Er PAM_MAXTRIES
76Maximum number of tries exceeded.
77.It Bq Er PAM_PERM_DENIED
78Permission denied.
79.It Bq Er PAM_SERVICE_ERR
80Error in service module.
81.It Bq Er PAM_SYSTEM_ERR
82System error.
83.It Bq Er PAM_USER_UNKNOWN
84Unknown user.
85.El
86.Sh SEE ALSO
87.Xr pam 3 ,
88.Xr pam_authenticate 3 ,
89.Xr pam_strerror 3
90.Sh STANDARDS
91.Rs
92.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
93.%D "June 1997"
94.Re
95.Sh AUTHORS
96The
97.Nm
98function and this manual page were developed for the FreeBSD Project
99by ThinkSec AS and NAI Labs, the Security Research Division of Network
100Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
101.Pq Dq CBOSS ,
102as part of the DARPA CHATS research program.
Note: See TracBrowser for help on using the repository browser.