xref: /freebsd/contrib/openpam/doc/man/pam_setcred.3 (revision e3514747256465c52c3b2aedc9795f52c0d3efe9)
1.\" Generated from pam_setcred.c by gendoc.pl
2.\" $Id: pam_setcred.c 648 2013-03-05 17:54:27Z des $
3.Dd February 19, 2017
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_SYMBOL_ERR .
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_ABORT
48General failure.
49.It Bq Er PAM_BUF_ERR
50Memory buffer error.
51.It Bq Er PAM_CONV_ERR
52Conversation failure.
53.It Bq Er PAM_CRED_ERR
54Failed to set user credentials.
55.It Bq Er PAM_CRED_EXPIRED
56User credentials have expired.
57.It Bq Er PAM_CRED_UNAVAIL
58Failed to retrieve user credentials.
59.It Bq Er PAM_PERM_DENIED
60Permission denied.
61.It Bq Er PAM_SERVICE_ERR
62Error in service module.
63.It Bq Er PAM_SYMBOL_ERR
64Invalid symbol.
65.It Bq Er PAM_SYSTEM_ERR
66System error.
67.It Bq Er PAM_USER_UNKNOWN
68Unknown user.
69.El
70.Sh SEE ALSO
71.Xr pam 3 ,
72.Xr pam_strerror 3
73.Sh STANDARDS
74.Rs
75.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
76.%D "June 1997"
77.Re
78.Sh AUTHORS
79The
80.Fn pam_setcred
81function and this manual page were
82developed for the
83.Fx
84Project by ThinkSec AS and Network Associates Laboratories, the
85Security Research Division of Network Associates, Inc.\& under
86DARPA/SPAWAR contract N66001-01-C-8035
87.Pq Dq CBOSS ,
88as part of the DARPA CHATS research program.
89.Pp
90The OpenPAM library is maintained by
91.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
92