xref: /freebsd/contrib/openpam/doc/man/pam_sm_setcred.3 (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1.\" Generated from pam_sm_setcred.c by gendoc.pl
2.Dd June 27, 2023
3.Dt PAM_SM_SETCRED 3
4.Os
5.Sh NAME
6.Nm pam_sm_setcred
7.Nd service module implementation for pam_setcred
8.Sh SYNOPSIS
9.In sys/types.h
10.In security/pam_appl.h
11.In security/pam_modules.h
12.Ft "int"
13.Fn pam_sm_setcred "pam_handle_t *pamh" "int flags" "int argc" "const char **argv"
14.Sh DESCRIPTION
15The
16.Fn pam_sm_setcred
17function is the service module's implementation of
18the
19.Xr pam_setcred 3
20API function.
21.Sh RETURN VALUES
22The
23.Fn pam_sm_setcred
24function returns one of the following values:
25.Bl -tag -width 18n
26.It Bq Er PAM_SUCCESS
27Success.
28.It Bq Er PAM_ABORT
29General failure.
30.It Bq Er PAM_BUF_ERR
31Memory buffer error.
32.It Bq Er PAM_CONV_ERR
33Conversation failure.
34.It Bq Er PAM_CRED_ERR
35Failed to set user credentials.
36.It Bq Er PAM_CRED_EXPIRED
37User credentials have expired.
38.It Bq Er PAM_CRED_UNAVAIL
39Failed to retrieve user credentials.
40.It Bq Er PAM_IGNORE
41Ignore this module.
42.It Bq Er PAM_PERM_DENIED
43Permission denied.
44.It Bq Er PAM_SERVICE_ERR
45Error in service module.
46.It Bq Er PAM_SYSTEM_ERR
47System error.
48.It Bq Er PAM_USER_UNKNOWN
49Unknown user.
50.El
51.Sh SEE ALSO
52.Xr pam 3 ,
53.Xr pam_setcred 3 ,
54.Xr pam_strerror 3
55.Sh STANDARDS
56.Rs
57.%T "X/Open Single Sign-On Service (XSSO) - Pluggable Authentication Modules"
58.%D "June 1997"
59.Re
60.Sh AUTHORS
61The
62.Fn pam_sm_setcred
63function and this manual page were
64developed for the
65.Fx
66Project by ThinkSec AS and Network Associates Laboratories, the
67Security Research Division of Network Associates, Inc.\& under
68DARPA/SPAWAR contract N66001-01-C-8035
69.Pq Dq CBOSS ,
70as part of the DARPA CHATS research program.
71.Pp
72The OpenPAM library is maintained by
73.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
74