1.\" $NetBSD: pam_authenticate.3,v 1.7 2017/05/06 19:50:09 christos Exp $ 2.\" 3.\" Generated from pam_authenticate.c by gendoc.pl 4.\" $OpenPAM: pam_authenticate.c 938 2017-04-30 21:34:42Z des $ 5.Dd April 30, 2017 6.Dt PAM_AUTHENTICATE 3 7.Os 8.Sh NAME 9.Nm pam_authenticate 10.Nd perform authentication within the PAM framework 11.Sh SYNOPSIS 12.In sys/types.h 13.In security/pam_appl.h 14.Ft "int" 15.Fn pam_authenticate "pam_handle_t *pamh" "int flags" 16.Sh DESCRIPTION 17The 18.Fn pam_authenticate 19function attempts to authenticate the user 20associated with the pam context specified by the 21.Fa pamh 22argument. 23.Pp 24The application is free to call 25.Fn pam_authenticate 26as many times as it 27wishes, but some modules may maintain an internal retry counter and 28return 29.Dv PAM_MAXTRIES 30when it exceeds some preset or hardcoded limit. 31.Pp 32The 33.Fa flags 34argument is the binary or of zero or more of the following 35values: 36.Bl -tag -width 18n 37.It Dv PAM_SILENT 38Do not emit any messages. 39.It Dv PAM_DISALLOW_NULL_AUTHTOK 40Fail if the user's authentication token is null. 41.El 42.Pp 43If any other bits are set, 44.Fn pam_authenticate 45will return 46.Dv PAM_BAD_CONSTANT . 47.Sh RETURN VALUES 48The 49.Fn pam_authenticate 50function returns one of the following values: 51.Bl -tag -width 18n 52.It Bq Er PAM_SUCCESS 53Success. 54.It Bq Er PAM_ABORT 55General failure. 56.It Bq Er PAM_AUTHINFO_UNAVAIL 57Authentication information is unavailable. 58.It Bq Er PAM_AUTH_ERR 59Authentication error. 60.It Bq Er PAM_BAD_CONSTANT 61Bad constant. 62.It Bq Er PAM_BUF_ERR 63Memory buffer error. 64.It Bq Er PAM_CONV_ERR 65Conversation failure. 66.It Bq Er PAM_CRED_INSUFFICIENT 67Insufficient credentials. 68.It Bq Er PAM_MAXTRIES 69Maximum number of tries exceeded. 70.It Bq Er PAM_PERM_DENIED 71Permission denied. 72.It Bq Er PAM_SERVICE_ERR 73Error in service module. 74.It Bq Er PAM_SYSTEM_ERR 75System error. 76.It Bq Er PAM_USER_UNKNOWN 77Unknown user. 78.El 79.Sh SEE ALSO 80.Xr pam 3 , 81.Xr pam_strerror 3 82.Sh STANDARDS 83.Rs 84.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 85.%D "June 1997" 86.Re 87.Sh AUTHORS 88The 89.Fn pam_authenticate 90function and this manual page were 91developed for the 92.Fx 93Project by ThinkSec AS and Network Associates Laboratories, the 94Security Research Division of Network Associates, Inc.\& under 95DARPA/SPAWAR contract N66001-01-C-8035 96.Pq Dq CBOSS , 97as part of the DARPA CHATS research program. 98.Pp 99The OpenPAM library is maintained by 100.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no . 101