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