xref: /netbsd-src/external/bsd/openpam/dist/doc/man/pam_setcred.3 (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1.\"	$NetBSD: pam_setcred.3,v 1.4 2013/12/27 20:10:20 christos Exp $
2.\"
3.\" Generated from pam_setcred.c by gendoc.pl
4.\" Id: pam_setcred.c 648 2013-03-05 17:54:27Z des
5.Dd September 7, 2013
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 LIBRARY
12.Lb libpam
13.Sh SYNOPSIS
14.In sys/types.h
15.In security/pam_appl.h
16.Ft "int"
17.Fn pam_setcred "pam_handle_t *pamh" "int flags"
18.Sh DESCRIPTION
19The
20.Fn pam_setcred
21function manages the application's credentials.
22.Pp
23The
24.Fa flags
25argument is the binary or of zero or more of the following
26values:
27.Bl -tag -width 18n
28.It Dv PAM_SILENT
29Do not emit any messages.
30.It Dv PAM_ESTABLISH_CRED
31Establish the credentials of the target user.
32.It Dv PAM_DELETE_CRED
33Revoke all established credentials.
34.It Dv PAM_REINITIALIZE_CRED
35Fully reinitialise credentials.
36.It Dv PAM_REFRESH_CRED
37Refresh credentials.
38.El
39.Pp
40The latter four are mutually exclusive.
41.Pp
42If any other bits are set,
43.Fn pam_setcred
44will return
45.Dv PAM_SYMBOL_ERR .
46.Sh RETURN VALUES
47The
48.Fn pam_setcred
49function returns one of the following values:
50.Bl -tag -width 18n
51.It Bq Er PAM_ABORT
52General failure.
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_SYMBOL_ERR
68Invalid symbol.
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 des@des.no .
96