xref: /src/external/bsd/openpam/dist/doc/man/pam_setcred.3

<<<<<<< pam_setcred.3
.\"	$NetBSD: pam_setcred.3,v 1.5 2014/10/24 18:17:56 christos Exp $
.\"
=======
>>>>>>> 1.1.1.4
.\" Generated from pam_setcred.c by gendoc.pl
.\" Id: pam_setcred.c 648 2013-03-05 17:54:27Z des 
.Dd September 12, 2014
.Dt PAM_SETCRED 3
.Os
.Sh NAME
.Nm pam_setcred
.Nd modify / delete user credentials for an authentication service
.Sh LIBRARY
.Lb libpam
.Sh SYNOPSIS
.In sys/types.h
.In security/pam_appl.h
.Ft "int"
.Fn pam_setcred "pam_handle_t *pamh" "int flags"
.Sh DESCRIPTION
The
.Fn pam_setcred
function manages the application's credentials.
.Pp
The
.Fa flags
argument is the binary or of zero or more of the following
values:
.Bl -tag -width 18n
.It Dv PAM_SILENT
Do not emit any messages.
.It Dv PAM_ESTABLISH_CRED
Establish the credentials of the target user.
.It Dv PAM_DELETE_CRED
Revoke all established credentials.
.It Dv PAM_REINITIALIZE_CRED
Fully reinitialise credentials.
.It Dv PAM_REFRESH_CRED
Refresh credentials.
.El
.Pp
The latter four are mutually exclusive.
.Pp
If any other bits are set,
.Fn pam_setcred
will return
.Dv PAM_SYMBOL_ERR .
.Sh RETURN VALUES
The
.Fn pam_setcred
function returns one of the following values:
.Bl -tag -width 18n
.It Bq Er PAM_ABORT
General failure.
.It Bq Er PAM_BUF_ERR
Memory buffer error.
.It Bq Er PAM_CONV_ERR
Conversation failure.
.It Bq Er PAM_CRED_ERR
Failed to set user credentials.
.It Bq Er PAM_CRED_EXPIRED
User credentials have expired.
.It Bq Er PAM_CRED_UNAVAIL
Failed to retrieve user credentials.
.It Bq Er PAM_PERM_DENIED
Permission denied.
.It Bq Er PAM_SERVICE_ERR
Error in service module.
.It Bq Er PAM_SYMBOL_ERR
Invalid symbol.
.It Bq Er PAM_SYSTEM_ERR
System error.
.It Bq Er PAM_USER_UNKNOWN
Unknown user.
.El
.Sh SEE ALSO
.Xr pam 3 ,
.Xr pam_strerror 3
.Sh STANDARDS
.Rs
.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
.%D "June 1997"
.Re
.Sh AUTHORS
The
.Fn pam_setcred
function and this manual page were
developed for the
.Fx
Project by ThinkSec AS and Network Associates Laboratories, the
Security Research Division of Network Associates, Inc.\& under
DARPA/SPAWAR contract N66001-01-C-8035
.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.
.Pp
The OpenPAM library is maintained by
.An Dag-Erling Sm\(/orgrav Aq des (a] des.no .