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