1.\"- 2.\" Copyright (c) 2001-2003 Networks Associates Technology, Inc. 3.\" Copyright (c) 2004-2011 Dag-Erling Smørgrav 4.\" All rights reserved. 5.\" 6.\" This software was developed for the FreeBSD Project by ThinkSec AS and 7.\" Network Associates Laboratories, the Security Research Division of 8.\" Network Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035 9.\" ("CBOSS"), as part of the DARPA CHATS research program. 10.\" 11.\" Redistribution and use in source and binary forms, with or without 12.\" modification, are permitted provided that the following conditions 13.\" are met: 14.\" 1. Redistributions of source code must retain the above copyright 15.\" notice, this list of conditions and the following disclaimer. 16.\" 2. Redistributions in binary form must reproduce the above copyright 17.\" notice, this list of conditions and the following disclaimer in the 18.\" documentation and/or other materials provided with the distribution. 19.\" 3. The name of the author may not be used to endorse or promote 20.\" products derived from this software without specific prior written 21.\" permission. 22.\" 23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 26.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33.\" SUCH DAMAGE. 34.\" 35.\" $Id$ 36.\" 37.Dd December 18, 2011 38.Dt PAM_AUTHENTICATE 3 39.Os 40.Sh NAME 41.Nm pam_authenticate 42.Nd perform authentication within the PAM framework 43.Sh LIBRARY 44.Lb libpam 45.Sh SYNOPSIS 46.In sys/types.h 47.In security/pam_appl.h 48.Ft "int" 49.Fn pam_authenticate "pam_handle_t *pamh" "int flags" 50.Sh DESCRIPTION 51The 52.Nm 53function attempts to authenticate the user 54associated with the pam context specified by the 55.Fa pamh 56argument. 57.Pp 58The application is free to call 59.Nm 60as many times as it 61wishes, but some modules may maintain an internal retry counter and 62return 63.Dv PAM_MAXTRIES 64when it exceeds some preset or hardcoded limit. 65.Pp 66The 67.Fa flags 68argument is the binary or of zero or more of the following 69values: 70.Bl -tag -width 18n 71.It Dv PAM_SILENT 72Do not emit any messages. 73.It Dv PAM_DISALLOW_NULL_AUTHTOK 74Fail if the user's authentication token is null. 75.El 76.Pp 77If any other bits are set, 78.Nm 79will return 80.Dv PAM_SYMBOL_ERR . 81.Sh RETURN VALUES 82The 83.Nm 84function returns one of the following values: 85.Bl -tag -width 18n 86.It Bq Er PAM_ABORT 87General failure. 88.It Bq Er PAM_AUTHINFO_UNAVAIL 89Authentication information is unavailable. 90.It Bq Er PAM_AUTH_ERR 91Authentication error. 92.It Bq Er PAM_BUF_ERR 93Memory buffer error. 94.It Bq Er PAM_CONV_ERR 95Conversation failure. 96.It Bq Er PAM_CRED_INSUFFICIENT 97Insufficient credentials. 98.It Bq Er PAM_MAXTRIES 99Maximum number of tries exceeded. 100.It Bq Er PAM_PERM_DENIED 101Permission denied. 102.It Bq Er PAM_SERVICE_ERR 103Error in service module. 104.It Bq Er PAM_SYMBOL_ERR 105Invalid symbol. 106.It Bq Er PAM_SYSTEM_ERR 107System error. 108.It Bq Er PAM_USER_UNKNOWN 109Unknown user. 110.El 111.Sh SEE ALSO 112.Xr pam 3 , 113.Xr pam_strerror 3 114.Sh STANDARDS 115.Rs 116.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 117.%D "June 1997" 118.Re 119.Sh AUTHORS 120The 121.Nm 122function and this manual page were developed for the 123.Fx 124Project by 125ThinkSec AS and Network Associates Laboratories, the 126Security Research Division of Network Associates, Inc.\& under 127DARPA/SPAWAR contract N66001-01-C-8035 128.Pq Dq CBOSS , 129as part of the DARPA CHATS research program. 130