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