]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - contrib/openpam/doc/man/pam_sm_authenticate.3
Upgrade to OpenSSH 7.3p1.
[FreeBSD/FreeBSD.git] / contrib / openpam / doc / man / pam_sm_authenticate.3
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 February 19, 2017
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_ABORT
28 General failure.
29 .It Bq Er PAM_AUTHINFO_UNAVAIL
30 Authentication information is unavailable.
31 .It Bq Er PAM_AUTH_ERR
32 Authentication error.
33 .It Bq Er PAM_BUF_ERR
34 Memory buffer error.
35 .It Bq Er PAM_CONV_ERR
36 Conversation failure.
37 .It Bq Er PAM_CRED_INSUFFICIENT
38 Insufficient credentials.
39 .It Bq Er PAM_IGNORE
40 Ignore this module.
41 .It Bq Er PAM_MAXTRIES
42 Maximum number of tries exceeded.
43 .It Bq Er PAM_PERM_DENIED
44 Permission denied.
45 .It Bq Er PAM_SERVICE_ERR
46 Error in service module.
47 .It Bq Er PAM_SYSTEM_ERR
48 System error.
49 .It Bq Er PAM_USER_UNKNOWN
50 Unknown user.
51 .El
52 .Sh SEE ALSO
53 .Xr pam 3 ,
54 .Xr pam_authenticate 3 ,
55 .Xr pam_strerror 3
56 .Sh STANDARDS
57 .Rs
58 .%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
59 .%D "June 1997"
60 .Re
61 .Sh AUTHORS
62 The
63 .Fn pam_sm_authenticate
64 function and this manual page were
65 developed for the
66 .Fx
67 Project by ThinkSec AS and Network Associates Laboratories, the
68 Security Research Division of Network Associates, Inc.\& under
69 DARPA/SPAWAR contract N66001-01-C-8035
70 .Pq Dq CBOSS ,
71 as part of the DARPA CHATS research program.
72 .Pp
73 The OpenPAM library is maintained by
74 .An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .