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