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