xref: /dflybsd-src/contrib/openpam/doc/man/pam_setcred.3 (revision 4c84ab30f7dd59ef873b5a6d4e27bcea89d9f848)
110b5fe87SSascha Wildner.\" Generated from pam_setcred.c by gendoc.pl
210b5fe87SSascha Wildner.\" $OpenPAM: pam_setcred.c 938 2017-04-30 21:34:42Z des $
3*4c84ab30SSascha Wildner.Dd February 24, 2019
4ade90846SJoerg Sonnenberger.Dt PAM_SETCRED 3
5ade90846SJoerg Sonnenberger.Os
6ade90846SJoerg Sonnenberger.Sh NAME
7ade90846SJoerg Sonnenberger.Nm pam_setcred
8ade90846SJoerg Sonnenberger.Nd modify / delete user credentials for an authentication service
9ade90846SJoerg Sonnenberger.Sh SYNOPSIS
10ade90846SJoerg Sonnenberger.In sys/types.h
11ade90846SJoerg Sonnenberger.In security/pam_appl.h
12ade90846SJoerg Sonnenberger.Ft "int"
13ade90846SJoerg Sonnenberger.Fn pam_setcred "pam_handle_t *pamh" "int flags"
14ade90846SJoerg Sonnenberger.Sh DESCRIPTION
15ade90846SJoerg SonnenbergerThe
16577efdeeSPeter Avalos.Fn pam_setcred
17ade90846SJoerg Sonnenbergerfunction manages the application's credentials.
18ade90846SJoerg Sonnenberger.Pp
19ade90846SJoerg SonnenbergerThe
20ade90846SJoerg Sonnenberger.Fa flags
21ade90846SJoerg Sonnenbergerargument is the binary or of zero or more of the following
22ade90846SJoerg Sonnenbergervalues:
23ade90846SJoerg Sonnenberger.Bl -tag -width 18n
24ade90846SJoerg Sonnenberger.It Dv PAM_SILENT
25ade90846SJoerg SonnenbergerDo not emit any messages.
26ade90846SJoerg Sonnenberger.It Dv PAM_ESTABLISH_CRED
27ade90846SJoerg SonnenbergerEstablish the credentials of the target user.
28ade90846SJoerg Sonnenberger.It Dv PAM_DELETE_CRED
29ade90846SJoerg SonnenbergerRevoke all established credentials.
30ade90846SJoerg Sonnenberger.It Dv PAM_REINITIALIZE_CRED
31ade90846SJoerg SonnenbergerFully reinitialise credentials.
32ade90846SJoerg Sonnenberger.It Dv PAM_REFRESH_CRED
33ade90846SJoerg SonnenbergerRefresh credentials.
34ade90846SJoerg Sonnenberger.El
35ade90846SJoerg Sonnenberger.Pp
36ade90846SJoerg SonnenbergerThe latter four are mutually exclusive.
37ade90846SJoerg Sonnenberger.Pp
38ade90846SJoerg SonnenbergerIf any other bits are set,
39577efdeeSPeter Avalos.Fn pam_setcred
40ade90846SJoerg Sonnenbergerwill return
4110b5fe87SSascha Wildner.Dv PAM_BAD_CONSTANT .
42ade90846SJoerg Sonnenberger.Sh RETURN VALUES
43ade90846SJoerg SonnenbergerThe
44577efdeeSPeter Avalos.Fn pam_setcred
45ade90846SJoerg Sonnenbergerfunction returns one of the following values:
46ade90846SJoerg Sonnenberger.Bl -tag -width 18n
4710b5fe87SSascha Wildner.It Bq Er PAM_SUCCESS
4810b5fe87SSascha WildnerSuccess.
49ade90846SJoerg Sonnenberger.It Bq Er PAM_ABORT
50ade90846SJoerg SonnenbergerGeneral failure.
5110b5fe87SSascha Wildner.It Bq Er PAM_BAD_CONSTANT
5210b5fe87SSascha WildnerBad constant.
53ade90846SJoerg Sonnenberger.It Bq Er PAM_BUF_ERR
54ade90846SJoerg SonnenbergerMemory buffer error.
55ade90846SJoerg Sonnenberger.It Bq Er PAM_CONV_ERR
56ade90846SJoerg SonnenbergerConversation failure.
57ade90846SJoerg Sonnenberger.It Bq Er PAM_CRED_ERR
58ade90846SJoerg SonnenbergerFailed to set user credentials.
59ade90846SJoerg Sonnenberger.It Bq Er PAM_CRED_EXPIRED
60ade90846SJoerg SonnenbergerUser credentials have expired.
61ade90846SJoerg Sonnenberger.It Bq Er PAM_CRED_UNAVAIL
62ade90846SJoerg SonnenbergerFailed to retrieve user credentials.
63ade90846SJoerg Sonnenberger.It Bq Er PAM_PERM_DENIED
64ade90846SJoerg SonnenbergerPermission denied.
65ade90846SJoerg Sonnenberger.It Bq Er PAM_SERVICE_ERR
66ade90846SJoerg SonnenbergerError in service module.
67ade90846SJoerg Sonnenberger.It Bq Er PAM_SYSTEM_ERR
68ade90846SJoerg SonnenbergerSystem error.
69ade90846SJoerg Sonnenberger.It Bq Er PAM_USER_UNKNOWN
70ade90846SJoerg SonnenbergerUnknown user.
71ade90846SJoerg Sonnenberger.El
72ade90846SJoerg Sonnenberger.Sh SEE ALSO
73ade90846SJoerg Sonnenberger.Xr pam 3 ,
74ade90846SJoerg Sonnenberger.Xr pam_strerror 3
75ade90846SJoerg Sonnenberger.Sh STANDARDS
76ade90846SJoerg Sonnenberger.Rs
77ade90846SJoerg Sonnenberger.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
78ade90846SJoerg Sonnenberger.%D "June 1997"
79ade90846SJoerg Sonnenberger.Re
80ade90846SJoerg Sonnenberger.Sh AUTHORS
81ade90846SJoerg SonnenbergerThe
82577efdeeSPeter Avalos.Fn pam_setcred
83577efdeeSPeter Avalosfunction and this manual page were
84577efdeeSPeter Avalosdeveloped for the
85ade90846SJoerg Sonnenberger.Fx
86577efdeeSPeter AvalosProject by ThinkSec AS and Network Associates Laboratories, the
87f23594ceSHasso TepperSecurity Research Division of Network Associates, Inc.\& under
88ade90846SJoerg SonnenbergerDARPA/SPAWAR contract N66001-01-C-8035
89ade90846SJoerg Sonnenberger.Pq Dq CBOSS ,
90ade90846SJoerg Sonnenbergeras part of the DARPA CHATS research program.
9110b5fe87SSascha Wildner.Pp
9210b5fe87SSascha WildnerThe OpenPAM library is maintained by
9310b5fe87SSascha Wildner.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
94