xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_setcred.3 (revision 82d56013d7b633d116a93943de88e08335357a7c)
1.\"	$NetBSD: pam_setcred.3,v 1.8 2019/12/15 17:08:21 christos Exp $
2.\"
3.\" Generated from pam_setcred.c by gendoc.pl
4.\" $OpenPAM: pam_setcred.c 938 2017-04-30 21:34:42Z des $
5.Dd February 24, 2019
6.Dt PAM_SETCRED 3
7.Os
8.Sh NAME
9.Nm pam_setcred
10.Nd modify / delete user credentials for an authentication service
11.Sh SYNOPSIS
12.In sys/types.h
13.In security/pam_appl.h
14.Ft "int"
15.Fn pam_setcred "pam_handle_t *pamh" "int flags"
16.Sh DESCRIPTION
17The
18.Fn pam_setcred
19function manages the application's credentials.
20.Pp
21The
22.Fa flags
23argument is the binary or of zero or more of the following
24values:
25.Bl -tag -width 18n
26.It Dv PAM_SILENT
27Do not emit any messages.
28.It Dv PAM_ESTABLISH_CRED
29Establish the credentials of the target user.
30.It Dv PAM_DELETE_CRED
31Revoke all established credentials.
32.It Dv PAM_REINITIALIZE_CRED
33Fully reinitialise credentials.
34.It Dv PAM_REFRESH_CRED
35Refresh credentials.
36.El
37.Pp
38The latter four are mutually exclusive.
39.Pp
40If any other bits are set,
41.Fn pam_setcred
42will return
43.Dv PAM_BAD_CONSTANT .
44.Sh RETURN VALUES
45The
46.Fn pam_setcred
47function returns one of the following values:
48.Bl -tag -width 18n
49.It Bq Er PAM_SUCCESS
50Success.
51.It Bq Er PAM_ABORT
52General failure.
53.It Bq Er PAM_BAD_CONSTANT
54Bad constant.
55.It Bq Er PAM_BUF_ERR
56Memory buffer error.
57.It Bq Er PAM_CONV_ERR
58Conversation failure.
59.It Bq Er PAM_CRED_ERR
60Failed to set user credentials.
61.It Bq Er PAM_CRED_EXPIRED
62User credentials have expired.
63.It Bq Er PAM_CRED_UNAVAIL
64Failed to retrieve user credentials.
65.It Bq Er PAM_PERM_DENIED
66Permission denied.
67.It Bq Er PAM_SERVICE_ERR
68Error in service module.
69.It Bq Er PAM_SYSTEM_ERR
70System error.
71.It Bq Er PAM_USER_UNKNOWN
72Unknown user.
73.El
74.Sh SEE ALSO
75.Xr pam 3 ,
76.Xr pam_strerror 3
77.Sh STANDARDS
78.Rs
79.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
80.%D "June 1997"
81.Re
82.Sh AUTHORS
83The
84.Fn pam_setcred
85function and this manual page were
86developed for the
87.Fx
88Project by ThinkSec AS and Network Associates Laboratories, the
89Security Research Division of Network Associates, Inc.\& under
90DARPA/SPAWAR contract N66001-01-C-8035
91.Pq Dq CBOSS ,
92as part of the DARPA CHATS research program.
93.Pp
94The OpenPAM library is maintained by
95.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
96