1.\" $NetBSD: pam_authenticate.3,v 1.6 2014/10/24 18:25:14 christos Exp $ 2.\" 3.\" Generated from pam_authenticate.c by gendoc.pl 4.\" Id: pam_authenticate.c 648 2013-03-05 17:54:27Z des 5.Dd September 12, 2014 6.Dt PAM_AUTHENTICATE 3 7.Os 8.Sh NAME 9.Nm pam_authenticate 10.Nd perform authentication within the PAM framework 11.Sh LIBRARY 12.Lb libpam 13.Sh SYNOPSIS 14.In sys/types.h 15.In security/pam_appl.h 16.Ft "int" 17.Fn pam_authenticate "pam_handle_t *pamh" "int flags" 18.Sh DESCRIPTION 19The 20.Fn pam_authenticate 21function attempts to authenticate the user 22associated with the pam context specified by the 23.Fa pamh 24argument. 25.Pp 26The application is free to call 27.Fn pam_authenticate 28as many times as it 29wishes, but some modules may maintain an internal retry counter and 30return 31.Dv PAM_MAXTRIES 32when it exceeds some preset or hardcoded limit. 33.Pp 34The 35.Fa flags 36argument is the binary or of zero or more of the following 37values: 38.Bl -tag -width 18n 39.It Dv PAM_SILENT 40Do not emit any messages. 41.It Dv PAM_DISALLOW_NULL_AUTHTOK 42Fail if the user's authentication token is null. 43.El 44.Pp 45If any other bits are set, 46.Fn pam_authenticate 47will return 48.Dv PAM_SYMBOL_ERR . 49.Sh RETURN VALUES 50The 51.Fn pam_authenticate 52function returns one of the following values: 53.Bl -tag -width 18n 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_BUF_ERR 61Memory buffer error. 62.It Bq Er PAM_CONV_ERR 63Conversation failure. 64.It Bq Er PAM_CRED_INSUFFICIENT 65Insufficient credentials. 66.It Bq Er PAM_MAXTRIES 67Maximum number of tries exceeded. 68.It Bq Er PAM_PERM_DENIED 69Permission denied. 70.It Bq Er PAM_SERVICE_ERR 71Error in service module. 72.It Bq Er PAM_SYMBOL_ERR 73Invalid symbol. 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 des@des.no . 101