xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_sm_authenticate.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.\"	$NetBSD: pam_sm_authenticate.3,v 1.8 2019/12/15 17:08:21 christos Exp $
2.\"
3.\" Generated from pam_sm_authenticate.c by gendoc.pl
4.\" $OpenPAM: pam_sm_authenticate.c 938 2017-04-30 21:34:42Z des $
5.Dd February 24, 2019
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 SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.In security/pam_modules.h
15.Ft "int"
16.Fn pam_sm_authenticate "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
17.Sh DESCRIPTION
18The
19.Fn pam_sm_authenticate
20function is the service module's
21implementation of the
22.Xr pam_authenticate 3
23API function.
24.Sh RETURN VALUES
25The
26.Fn pam_sm_authenticate
27function returns one of the following values:
28.Bl -tag -width 18n
29.It Bq Er PAM_SUCCESS
30Success.
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 Mt des@des.no .
79