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