]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/openpam/doc/man/pam_sm_authenticate.3
MFV: r363292
[FreeBSD/FreeBSD.git] / contrib / openpam / doc / man / pam_sm_authenticate.3
1 .\" Generated from pam_sm_authenticate.c by gendoc.pl
2 .\" $OpenPAM: pam_sm_authenticate.c 938 2017-04-30 21:34:42Z des $
3 .Dd February 24, 2019
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 SYNOPSIS
10 .In sys/types.h
11 .In security/pam_appl.h
12 .In security/pam_modules.h
13 .Ft "int"
14 .Fn pam_sm_authenticate "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
15 .Sh DESCRIPTION
16 The
17 .Fn pam_sm_authenticate
18 function is the service module's
19 implementation of the
20 .Xr pam_authenticate 3
21 API function.
22 .Sh RETURN VALUES
23 The
24 .Fn pam_sm_authenticate
25 function returns one of the following values:
26 .Bl -tag -width 18n
27 .It Bq Er PAM_SUCCESS
28 Success.
29 .It Bq Er PAM_ABORT
30 General failure.
31 .It Bq Er PAM_AUTHINFO_UNAVAIL
32 Authentication information is unavailable.
33 .It Bq Er PAM_AUTH_ERR
34 Authentication error.
35 .It Bq Er PAM_BUF_ERR
36 Memory buffer error.
37 .It Bq Er PAM_CONV_ERR
38 Conversation failure.
39 .It Bq Er PAM_CRED_INSUFFICIENT
40 Insufficient credentials.
41 .It Bq Er PAM_IGNORE
42 Ignore this module.
43 .It Bq Er PAM_MAXTRIES
44 Maximum number of tries exceeded.
45 .It Bq Er PAM_PERM_DENIED
46 Permission denied.
47 .It Bq Er PAM_SERVICE_ERR
48 Error in service module.
49 .It Bq Er PAM_SYSTEM_ERR
50 System error.
51 .It Bq Er PAM_USER_UNKNOWN
52 Unknown 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
64 The
65 .Fn pam_sm_authenticate
66 function and this manual page were
67 developed for the
68 .Fx
69 Project by ThinkSec AS and Network Associates Laboratories, the
70 Security Research Division of Network Associates, Inc.\& under
71 DARPA/SPAWAR contract N66001-01-C-8035
72 .Pq Dq CBOSS ,
73 as part of the DARPA CHATS research program.
74 .Pp
75 The OpenPAM library is maintained by
76 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .