1.\" $NetBSD: pam_sm_setcred.3,v 1.3 2013/04/06 02:20:29 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 May 26, 2012 40.Dt PAM_SM_SETCRED 3 41.Os 42.Sh NAME 43.Nm pam_sm_setcred 44.Nd service module implementation for pam_setcred 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_setcred "pam_handle_t *pamh" "int flags" "int argc" "const char **argv" 53.Sh DESCRIPTION 54The 55.Fn pam_sm_setcred 56function is the service module's implementation of 57the 58.Xr pam_setcred 3 59API function. 60.Sh RETURN VALUES 61The 62.Fn pam_sm_setcred 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_BUF_ERR 68Memory buffer error. 69.It Bq Er PAM_CONV_ERR 70Conversation failure. 71.It Bq Er PAM_CRED_ERR 72Failed to set user credentials. 73.It Bq Er PAM_CRED_EXPIRED 74User credentials have expired. 75.It Bq Er PAM_CRED_UNAVAIL 76Failed to retrieve user credentials. 77.It Bq Er PAM_IGNORE 78Ignore this module. 79.It Bq Er PAM_PERM_DENIED 80Permission denied. 81.It Bq Er PAM_SERVICE_ERR 82Error in service module. 83.It Bq Er PAM_SYSTEM_ERR 84System error. 85.It Bq Er PAM_USER_UNKNOWN 86Unknown user. 87.El 88.Sh SEE ALSO 89.Xr pam 3 , 90.Xr pam_setcred 3 , 91.Xr pam_strerror 3 92.Sh STANDARDS 93.Rs 94.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 95.%D "June 1997" 96.Re 97.Sh AUTHORS 98The 99.Fn pam_sm_setcred 100function and this manual page were 101developed for the 102.Fx 103Project by ThinkSec AS and Network Associates Laboratories, the 104Security Research Division of Network Associates, Inc.\& under 105DARPA/SPAWAR contract N66001-01-C-8035 106.Pq Dq CBOSS , 107as part of the DARPA CHATS research program. 108