xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_setcred.3 (revision 0d9d0fd8a30be9a1924e715bbcf67a4a83efd262)
1*0d9d0fd8Schristos.\"	$NetBSD: pam_setcred.3,v 1.9 2023/06/30 21:46:20 christos Exp $
244269bb5Schristos.\"
38fa0fefeSchristos.\" Generated from pam_setcred.c by gendoc.pl
4*0d9d0fd8Schristos.Dd June 27, 2023
544269bb5Schristos.Dt PAM_SETCRED 3
644269bb5Schristos.Os
744269bb5Schristos.Sh NAME
844269bb5Schristos.Nm pam_setcred
944269bb5Schristos.Nd modify / delete user credentials for an authentication service
1044269bb5Schristos.Sh SYNOPSIS
1144269bb5Schristos.In sys/types.h
1244269bb5Schristos.In security/pam_appl.h
1344269bb5Schristos.Ft "int"
1444269bb5Schristos.Fn pam_setcred "pam_handle_t *pamh" "int flags"
1544269bb5Schristos.Sh DESCRIPTION
1644269bb5SchristosThe
17e1b25b17Schristos.Fn pam_setcred
1844269bb5Schristosfunction manages the application's credentials.
1944269bb5Schristos.Pp
2044269bb5SchristosThe
2144269bb5Schristos.Fa flags
2244269bb5Schristosargument is the binary or of zero or more of the following
2344269bb5Schristosvalues:
2444269bb5Schristos.Bl -tag -width 18n
2544269bb5Schristos.It Dv PAM_SILENT
2644269bb5SchristosDo not emit any messages.
2744269bb5Schristos.It Dv PAM_ESTABLISH_CRED
2844269bb5SchristosEstablish the credentials of the target user.
2944269bb5Schristos.It Dv PAM_DELETE_CRED
3044269bb5SchristosRevoke all established credentials.
3144269bb5Schristos.It Dv PAM_REINITIALIZE_CRED
3244269bb5SchristosFully reinitialise credentials.
3344269bb5Schristos.It Dv PAM_REFRESH_CRED
3444269bb5SchristosRefresh credentials.
3544269bb5Schristos.El
3644269bb5Schristos.Pp
3744269bb5SchristosThe latter four are mutually exclusive.
3844269bb5Schristos.Pp
3944269bb5SchristosIf any other bits are set,
40e1b25b17Schristos.Fn pam_setcred
4144269bb5Schristoswill return
424cb4af11Schristos.Dv PAM_BAD_CONSTANT .
4344269bb5Schristos.Sh RETURN VALUES
4444269bb5SchristosThe
45e1b25b17Schristos.Fn pam_setcred
4644269bb5Schristosfunction returns one of the following values:
4744269bb5Schristos.Bl -tag -width 18n
484cb4af11Schristos.It Bq Er PAM_SUCCESS
494cb4af11SchristosSuccess.
5044269bb5Schristos.It Bq Er PAM_ABORT
5144269bb5SchristosGeneral failure.
524cb4af11Schristos.It Bq Er PAM_BAD_CONSTANT
534cb4af11SchristosBad constant.
5444269bb5Schristos.It Bq Er PAM_BUF_ERR
5544269bb5SchristosMemory buffer error.
5644269bb5Schristos.It Bq Er PAM_CONV_ERR
5744269bb5SchristosConversation failure.
5844269bb5Schristos.It Bq Er PAM_CRED_ERR
5944269bb5SchristosFailed to set user credentials.
6044269bb5Schristos.It Bq Er PAM_CRED_EXPIRED
6144269bb5SchristosUser credentials have expired.
6244269bb5Schristos.It Bq Er PAM_CRED_UNAVAIL
6344269bb5SchristosFailed to retrieve user credentials.
6444269bb5Schristos.It Bq Er PAM_PERM_DENIED
6544269bb5SchristosPermission denied.
6644269bb5Schristos.It Bq Er PAM_SERVICE_ERR
6744269bb5SchristosError in service module.
6844269bb5Schristos.It Bq Er PAM_SYSTEM_ERR
6944269bb5SchristosSystem error.
7044269bb5Schristos.It Bq Er PAM_USER_UNKNOWN
7144269bb5SchristosUnknown user.
7244269bb5Schristos.El
7344269bb5Schristos.Sh SEE ALSO
7444269bb5Schristos.Xr pam 3 ,
7544269bb5Schristos.Xr pam_strerror 3
7644269bb5Schristos.Sh STANDARDS
7744269bb5Schristos.Rs
7844269bb5Schristos.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
7944269bb5Schristos.%D "June 1997"
8044269bb5Schristos.Re
8144269bb5Schristos.Sh AUTHORS
8244269bb5SchristosThe
83e1b25b17Schristos.Fn pam_setcred
84e1b25b17Schristosfunction and this manual page were
85e1b25b17Schristosdeveloped for the
8644269bb5Schristos.Fx
87e1b25b17SchristosProject by ThinkSec AS and Network Associates Laboratories, the
8844269bb5SchristosSecurity Research Division of Network Associates, Inc.\& under
8944269bb5SchristosDARPA/SPAWAR contract N66001-01-C-8035
9044269bb5Schristos.Pq Dq CBOSS ,
9144269bb5Schristosas part of the DARPA CHATS research program.
928fa0fefeSchristos.Pp
938fa0fefeSchristosThe OpenPAM library is maintained by
944cb4af11Schristos.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
95