xref: /dflybsd-src/contrib/openpam/doc/man/pam_authenticate.3 (revision 4c84ab30f7dd59ef873b5a6d4e27bcea89d9f848)
110b5fe87SSascha Wildner.\" Generated from pam_authenticate.c by gendoc.pl
210b5fe87SSascha Wildner.\" $OpenPAM: pam_authenticate.c 938 2017-04-30 21:34:42Z des $
3*4c84ab30SSascha Wildner.Dd February 24, 2019
4ade90846SJoerg Sonnenberger.Dt PAM_AUTHENTICATE 3
5ade90846SJoerg Sonnenberger.Os
6ade90846SJoerg Sonnenberger.Sh NAME
7ade90846SJoerg Sonnenberger.Nm pam_authenticate
8ade90846SJoerg Sonnenberger.Nd perform authentication within the PAM framework
9ade90846SJoerg Sonnenberger.Sh SYNOPSIS
10ade90846SJoerg Sonnenberger.In sys/types.h
11ade90846SJoerg Sonnenberger.In security/pam_appl.h
12ade90846SJoerg Sonnenberger.Ft "int"
13ade90846SJoerg Sonnenberger.Fn pam_authenticate "pam_handle_t *pamh" "int flags"
14ade90846SJoerg Sonnenberger.Sh DESCRIPTION
15ade90846SJoerg SonnenbergerThe
16577efdeeSPeter Avalos.Fn pam_authenticate
17ade90846SJoerg Sonnenbergerfunction attempts to authenticate the user
18ade90846SJoerg Sonnenbergerassociated with the pam context specified by the
19ade90846SJoerg Sonnenberger.Fa pamh
20ade90846SJoerg Sonnenbergerargument.
21ade90846SJoerg Sonnenberger.Pp
22ade90846SJoerg SonnenbergerThe application is free to call
23577efdeeSPeter Avalos.Fn pam_authenticate
24ade90846SJoerg Sonnenbergeras many times as it
25ade90846SJoerg Sonnenbergerwishes, but some modules may maintain an internal retry counter and
26ade90846SJoerg Sonnenbergerreturn
27ade90846SJoerg Sonnenberger.Dv PAM_MAXTRIES
28ade90846SJoerg Sonnenbergerwhen it exceeds some preset or hardcoded limit.
29ade90846SJoerg Sonnenberger.Pp
30ade90846SJoerg SonnenbergerThe
31ade90846SJoerg Sonnenberger.Fa flags
32ade90846SJoerg Sonnenbergerargument is the binary or of zero or more of the following
33ade90846SJoerg Sonnenbergervalues:
34ade90846SJoerg Sonnenberger.Bl -tag -width 18n
35ade90846SJoerg Sonnenberger.It Dv PAM_SILENT
36ade90846SJoerg SonnenbergerDo not emit any messages.
37ade90846SJoerg Sonnenberger.It Dv PAM_DISALLOW_NULL_AUTHTOK
38ade90846SJoerg SonnenbergerFail if the user's authentication token is null.
39ade90846SJoerg Sonnenberger.El
40ade90846SJoerg Sonnenberger.Pp
41ade90846SJoerg SonnenbergerIf any other bits are set,
42577efdeeSPeter Avalos.Fn pam_authenticate
43ade90846SJoerg Sonnenbergerwill return
4410b5fe87SSascha Wildner.Dv PAM_BAD_CONSTANT .
45ade90846SJoerg Sonnenberger.Sh RETURN VALUES
46ade90846SJoerg SonnenbergerThe
47577efdeeSPeter Avalos.Fn pam_authenticate
48ade90846SJoerg Sonnenbergerfunction returns one of the following values:
49ade90846SJoerg Sonnenberger.Bl -tag -width 18n
5010b5fe87SSascha Wildner.It Bq Er PAM_SUCCESS
5110b5fe87SSascha WildnerSuccess.
52ade90846SJoerg Sonnenberger.It Bq Er PAM_ABORT
53ade90846SJoerg SonnenbergerGeneral failure.
54ade90846SJoerg Sonnenberger.It Bq Er PAM_AUTHINFO_UNAVAIL
55ade90846SJoerg SonnenbergerAuthentication information is unavailable.
56ade90846SJoerg Sonnenberger.It Bq Er PAM_AUTH_ERR
57ade90846SJoerg SonnenbergerAuthentication error.
5810b5fe87SSascha Wildner.It Bq Er PAM_BAD_CONSTANT
5910b5fe87SSascha WildnerBad constant.
60ade90846SJoerg Sonnenberger.It Bq Er PAM_BUF_ERR
61ade90846SJoerg SonnenbergerMemory buffer error.
62ade90846SJoerg Sonnenberger.It Bq Er PAM_CONV_ERR
63ade90846SJoerg SonnenbergerConversation failure.
64ade90846SJoerg Sonnenberger.It Bq Er PAM_CRED_INSUFFICIENT
65ade90846SJoerg SonnenbergerInsufficient credentials.
66ade90846SJoerg Sonnenberger.It Bq Er PAM_MAXTRIES
67ade90846SJoerg SonnenbergerMaximum number of tries exceeded.
68ade90846SJoerg Sonnenberger.It Bq Er PAM_PERM_DENIED
69ade90846SJoerg SonnenbergerPermission denied.
70ade90846SJoerg Sonnenberger.It Bq Er PAM_SERVICE_ERR
71ade90846SJoerg SonnenbergerError in service module.
72ade90846SJoerg Sonnenberger.It Bq Er PAM_SYSTEM_ERR
73ade90846SJoerg SonnenbergerSystem error.
74ade90846SJoerg Sonnenberger.It Bq Er PAM_USER_UNKNOWN
75ade90846SJoerg SonnenbergerUnknown user.
76ade90846SJoerg Sonnenberger.El
77ade90846SJoerg Sonnenberger.Sh SEE ALSO
78ade90846SJoerg Sonnenberger.Xr pam 3 ,
79ade90846SJoerg Sonnenberger.Xr pam_strerror 3
80ade90846SJoerg Sonnenberger.Sh STANDARDS
81ade90846SJoerg Sonnenberger.Rs
82ade90846SJoerg Sonnenberger.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
83ade90846SJoerg Sonnenberger.%D "June 1997"
84ade90846SJoerg Sonnenberger.Re
85ade90846SJoerg Sonnenberger.Sh AUTHORS
86ade90846SJoerg SonnenbergerThe
87577efdeeSPeter Avalos.Fn pam_authenticate
88577efdeeSPeter Avalosfunction and this manual page were
89577efdeeSPeter Avalosdeveloped for the
90ade90846SJoerg Sonnenberger.Fx
91577efdeeSPeter AvalosProject by ThinkSec AS and Network Associates Laboratories, the
92f23594ceSHasso TepperSecurity Research Division of Network Associates, Inc.\& under
93ade90846SJoerg SonnenbergerDARPA/SPAWAR contract N66001-01-C-8035
94ade90846SJoerg Sonnenberger.Pq Dq CBOSS ,
95ade90846SJoerg Sonnenbergeras part of the DARPA CHATS research program.
9610b5fe87SSascha Wildner.Pp
9710b5fe87SSascha WildnerThe OpenPAM library is maintained by
9810b5fe87SSascha Wildner.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
99