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 May 26, 2012 38.Dt PAM_SETCRED 3 39.Os 40.Sh NAME 41.Nm pam_setcred 42.Nd modify / delete user credentials for an authentication service 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_setcred "pam_handle_t *pamh" "int flags" 50.Sh DESCRIPTION 51The 52.Fn pam_setcred 53function manages the application's credentials. 54.Pp 55The 56.Fa flags 57argument is the binary or of zero or more of the following 58values: 59.Bl -tag -width 18n 60.It Dv PAM_SILENT 61Do not emit any messages. 62.It Dv PAM_ESTABLISH_CRED 63Establish the credentials of the target user. 64.It Dv PAM_DELETE_CRED 65Revoke all established credentials. 66.It Dv PAM_REINITIALIZE_CRED 67Fully reinitialise credentials. 68.It Dv PAM_REFRESH_CRED 69Refresh credentials. 70.El 71.Pp 72The latter four are mutually exclusive. 73.Pp 74If any other bits are set, 75.Fn pam_setcred 76will return 77.Dv PAM_SYMBOL_ERR . 78.Sh RETURN VALUES 79The 80.Fn pam_setcred 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_BUF_ERR 86Memory buffer error. 87.It Bq Er PAM_CONV_ERR 88Conversation failure. 89.It Bq Er PAM_CRED_ERR 90Failed to set user credentials. 91.It Bq Er PAM_CRED_EXPIRED 92User credentials have expired. 93.It Bq Er PAM_CRED_UNAVAIL 94Failed to retrieve user credentials. 95.It Bq Er PAM_PERM_DENIED 96Permission denied. 97.It Bq Er PAM_SERVICE_ERR 98Error in service module. 99.It Bq Er PAM_SYMBOL_ERR 100Invalid symbol. 101.It Bq Er PAM_SYSTEM_ERR 102System error. 103.It Bq Er PAM_USER_UNKNOWN 104Unknown user. 105.El 106.Sh SEE ALSO 107.Xr pam 3 , 108.Xr pam_strerror 3 109.Sh STANDARDS 110.Rs 111.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules" 112.%D "June 1997" 113.Re 114.Sh AUTHORS 115The 116.Fn pam_setcred 117function and this manual page were 118developed for the 119.Fx 120Project by ThinkSec AS and Network Associates Laboratories, the 121Security Research Division of Network Associates, Inc.\& under 122DARPA/SPAWAR contract N66001-01-C-8035 123.Pq Dq CBOSS , 124as part of the DARPA CHATS research program. 125