xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_sm_authenticate.3 (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1.\"	$NetBSD: pam_sm_authenticate.3,v 1.4 2013/12/27 20:10:20 christos Exp $
2.\"
3.\" Generated from pam_sm_authenticate.c by gendoc.pl
4.\" Id: pam_sm_authenticate.c 648 2013-03-05 17:54:27Z des
5.Dd September 7, 2013
6.Dt PAM_SM_AUTHENTICATE 3
7.Os
8.Sh NAME
9.Nm pam_sm_authenticate
10.Nd service module implementation for pam_authenticate
11.Sh LIBRARY
12.Lb libpam
13.Sh SYNOPSIS
14.In sys/types.h
15.In security/pam_appl.h
16.In security/pam_modules.h
17.Ft "int"
18.Fn pam_sm_authenticate "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
19.Sh DESCRIPTION
20The
21.Fn pam_sm_authenticate
22function is the service module's
23implementation of the
24.Xr pam_authenticate 3
25API function.
26.Sh RETURN VALUES
27The
28.Fn pam_sm_authenticate
29function returns one of the following values:
30.Bl -tag -width 18n
31.It Bq Er PAM_ABORT
32General failure.
33.It Bq Er PAM_AUTHINFO_UNAVAIL
34Authentication information is unavailable.
35.It Bq Er PAM_AUTH_ERR
36Authentication error.
37.It Bq Er PAM_BUF_ERR
38Memory buffer error.
39.It Bq Er PAM_CONV_ERR
40Conversation failure.
41.It Bq Er PAM_CRED_INSUFFICIENT
42Insufficient credentials.
43.It Bq Er PAM_IGNORE
44Ignore this module.
45.It Bq Er PAM_MAXTRIES
46Maximum number of tries exceeded.
47.It Bq Er PAM_PERM_DENIED
48Permission denied.
49.It Bq Er PAM_SERVICE_ERR
50Error in service module.
51.It Bq Er PAM_SYSTEM_ERR
52System error.
53.It Bq Er PAM_USER_UNKNOWN
54Unknown user.
55.El
56.Sh SEE ALSO
57.Xr pam 3 ,
58.Xr pam_authenticate 3 ,
59.Xr pam_strerror 3
60.Sh STANDARDS
61.Rs
62.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
63.%D "June 1997"
64.Re
65.Sh AUTHORS
66The
67.Fn pam_sm_authenticate
68function and this manual page were
69developed for the
70.Fx
71Project by ThinkSec AS and Network Associates Laboratories, the
72Security Research Division of Network Associates, Inc.\& under
73DARPA/SPAWAR contract N66001-01-C-8035
74.Pq Dq CBOSS ,
75as part of the DARPA CHATS research program.
76.Pp
77The OpenPAM library is maintained by
78.An Dag-Erling Sm\(/orgrav Aq des@des.no .
79