xref: /freebsd/contrib/openpam/doc/man/pam_sm_authenticate.3 (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
1.\" Generated from pam_sm_authenticate.c by gendoc.pl
2.\" $Id: pam_sm_authenticate.c 648 2013-03-05 17:54:27Z des $
3.Dd September 12, 2014
4.Dt PAM_SM_AUTHENTICATE 3
5.Os
6.Sh NAME
7.Nm pam_sm_authenticate
8.Nd service module implementation for pam_authenticate
9.Sh LIBRARY
10.Lb libpam
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_ABORT
30General failure.
31.It Bq Er PAM_AUTHINFO_UNAVAIL
32Authentication information is unavailable.
33.It Bq Er PAM_AUTH_ERR
34Authentication error.
35.It Bq Er PAM_BUF_ERR
36Memory buffer error.
37.It Bq Er PAM_CONV_ERR
38Conversation failure.
39.It Bq Er PAM_CRED_INSUFFICIENT
40Insufficient credentials.
41.It Bq Er PAM_IGNORE
42Ignore this module.
43.It Bq Er PAM_MAXTRIES
44Maximum number of tries exceeded.
45.It Bq Er PAM_PERM_DENIED
46Permission denied.
47.It Bq Er PAM_SERVICE_ERR
48Error in service module.
49.It Bq Er PAM_SYSTEM_ERR
50System error.
51.It Bq Er PAM_USER_UNKNOWN
52Unknown user.
53.El
54.Sh SEE ALSO
55.Xr pam 3 ,
56.Xr pam_authenticate 3 ,
57.Xr pam_strerror 3
58.Sh STANDARDS
59.Rs
60.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
61.%D "June 1997"
62.Re
63.Sh AUTHORS
64The
65.Fn pam_sm_authenticate
66function and this manual page were
67developed for the
68.Fx
69Project by ThinkSec AS and Network Associates Laboratories, the
70Security Research Division of Network Associates, Inc.\& under
71DARPA/SPAWAR contract N66001-01-C-8035
72.Pq Dq CBOSS ,
73as part of the DARPA CHATS research program.
74.Pp
75The OpenPAM library is maintained by
76.An Dag-Erling Sm\(/orgrav Aq des@des.no .
77