1*0d9d0fd8Schristos.\" $NetBSD: pam_authenticate.3,v 1.9 2023/06/30 21:46:20 christos Exp $ 244269bb5Schristos.\" 38fa0fefeSchristos.\" Generated from pam_authenticate.c by gendoc.pl 4*0d9d0fd8Schristos.Dd June 27, 2023 544269bb5Schristos.Dt PAM_AUTHENTICATE 3 644269bb5Schristos.Os 744269bb5Schristos.Sh NAME 844269bb5Schristos.Nm pam_authenticate 944269bb5Schristos.Nd perform authentication within the PAM framework 1044269bb5Schristos.Sh SYNOPSIS 1144269bb5Schristos.In sys/types.h 1244269bb5Schristos.In security/pam_appl.h 1344269bb5Schristos.Ft "int" 1444269bb5Schristos.Fn pam_authenticate "pam_handle_t *pamh" "int flags" 1544269bb5Schristos.Sh DESCRIPTION 1644269bb5SchristosThe 17e1b25b17Schristos.Fn pam_authenticate 1844269bb5Schristosfunction attempts to authenticate the user 1944269bb5Schristosassociated with the pam context specified by the 2044269bb5Schristos.Fa pamh 2144269bb5Schristosargument. 2244269bb5Schristos.Pp 2344269bb5SchristosThe application is free to call 24e1b25b17Schristos.Fn pam_authenticate 2544269bb5Schristosas many times as it 2644269bb5Schristoswishes, but some modules may maintain an internal retry counter and 2744269bb5Schristosreturn 2844269bb5Schristos.Dv PAM_MAXTRIES 2944269bb5Schristoswhen it exceeds some preset or hardcoded limit. 3044269bb5Schristos.Pp 3144269bb5SchristosThe 3244269bb5Schristos.Fa flags 3344269bb5Schristosargument is the binary or of zero or more of the following 3444269bb5Schristosvalues: 3544269bb5Schristos.Bl -tag -width 18n 3644269bb5Schristos.It Dv PAM_SILENT 3744269bb5SchristosDo not emit any messages. 3844269bb5Schristos.It Dv PAM_DISALLOW_NULL_AUTHTOK 3944269bb5SchristosFail if the user's authentication token is null. 4044269bb5Schristos.El 4144269bb5Schristos.Pp 4244269bb5SchristosIf any other bits are set, 43e1b25b17Schristos.Fn pam_authenticate 4444269bb5Schristoswill return 454cb4af11Schristos.Dv PAM_BAD_CONSTANT . 4644269bb5Schristos.Sh RETURN VALUES 4744269bb5SchristosThe 48e1b25b17Schristos.Fn pam_authenticate 4944269bb5Schristosfunction returns one of the following values: 5044269bb5Schristos.Bl -tag -width 18n 514cb4af11Schristos.It Bq Er PAM_SUCCESS 524cb4af11SchristosSuccess. 5344269bb5Schristos.It Bq Er PAM_ABORT 5444269bb5SchristosGeneral failure. 5544269bb5Schristos.It Bq Er PAM_AUTHINFO_UNAVAIL 5644269bb5SchristosAuthentication information is unavailable. 5744269bb5Schristos.It Bq Er PAM_AUTH_ERR 5844269bb5SchristosAuthentication error. 594cb4af11Schristos.It Bq Er PAM_BAD_CONSTANT 604cb4af11SchristosBad constant. 6144269bb5Schristos.It Bq Er PAM_BUF_ERR 6244269bb5SchristosMemory buffer error. 6344269bb5Schristos.It Bq Er PAM_CONV_ERR 6444269bb5SchristosConversation failure. 6544269bb5Schristos.It Bq Er PAM_CRED_INSUFFICIENT 6644269bb5SchristosInsufficient credentials. 6744269bb5Schristos.It Bq Er PAM_MAXTRIES 6844269bb5SchristosMaximum number of tries exceeded. 6944269bb5Schristos.It Bq Er PAM_PERM_DENIED 7044269bb5SchristosPermission denied. 7144269bb5Schristos.It Bq Er PAM_SERVICE_ERR 7244269bb5SchristosError in service module. 7344269bb5Schristos.It Bq Er PAM_SYSTEM_ERR 7444269bb5SchristosSystem error. 7544269bb5Schristos.It Bq Er PAM_USER_UNKNOWN 7644269bb5SchristosUnknown user. 7744269bb5Schristos.El 7844269bb5Schristos.Sh SEE ALSO 7944269bb5Schristos.Xr pam 3 , 8044269bb5Schristos.Xr pam_strerror 3 8144269bb5Schristos.Sh STANDARDS 8244269bb5Schristos.Rs 8344269bb5Schristos.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 8444269bb5Schristos.%D "June 1997" 8544269bb5Schristos.Re 8644269bb5Schristos.Sh AUTHORS 8744269bb5SchristosThe 88e1b25b17Schristos.Fn pam_authenticate 89e1b25b17Schristosfunction and this manual page were 90e1b25b17Schristosdeveloped for the 9144269bb5Schristos.Fx 92e1b25b17SchristosProject by ThinkSec AS and Network Associates Laboratories, the 9344269bb5SchristosSecurity Research Division of Network Associates, Inc.\& under 9444269bb5SchristosDARPA/SPAWAR contract N66001-01-C-8035 9544269bb5Schristos.Pq Dq CBOSS , 9644269bb5Schristosas part of the DARPA CHATS research program. 978fa0fefeSchristos.Pp 988fa0fefeSchristosThe OpenPAM library is maintained by 994cb4af11Schristos.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no . 100