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