xref: /freebsd/contrib/openpam/doc/man/openpam_borrow_cred.3 (revision b18a4ccab954b694b9ed6dcc83773f615c430d33)
1.\" Generated from openpam_borrow_cred.c by gendoc.pl
2.\" $OpenPAM: openpam_borrow_cred.c 938 2017-04-30 21:34:42Z des $
3.Dd February 24, 2019
4.Dt OPENPAM_BORROW_CRED 3
5.Os
6.Sh NAME
7.Nm openpam_borrow_cred
8.Nd temporarily borrow user credentials
9.Sh SYNOPSIS
10.In sys/types.h
11.In security/pam_appl.h
12.In security/openpam.h
13.Ft "int"
14.Fn openpam_borrow_cred "pam_handle_t *pamh" "const struct passwd *pwd"
15.Sh DESCRIPTION
16The
17.Fn openpam_borrow_cred
18function saves the current credentials and
19switches to those of the user specified by its
20.Fa pwd
21argument.
22The affected credentials are the effective UID, the effective GID, and
23the group access list.
24The original credentials can be restored using
25.Xr openpam_restore_cred 3 .
26.Pp
27.Sh RETURN VALUES
28The
29.Fn openpam_borrow_cred
30function returns one of the following values:
31.Bl -tag -width 18n
32.It Bq Er PAM_SUCCESS
33Success.
34.It Bq Er PAM_BUF_ERR
35Memory buffer error.
36.It Bq Er PAM_PERM_DENIED
37Permission denied.
38.It Bq Er PAM_SYSTEM_ERR
39System error.
40.El
41.Sh SEE ALSO
42.Xr setegid 2 ,
43.Xr seteuid 2 ,
44.Xr setgroups 2 ,
45.Xr openpam_restore_cred 3 ,
46.Xr pam 3 ,
47.Xr pam_strerror 3
48.Sh STANDARDS
49The
50.Fn openpam_borrow_cred
51function is an OpenPAM extension.
52.Sh AUTHORS
53The
54.Fn openpam_borrow_cred
55function and this manual page were
56developed for the
57.Fx
58Project by ThinkSec AS and Network Associates Laboratories, the
59Security Research Division of Network Associates, Inc.\& under
60DARPA/SPAWAR contract N66001-01-C-8035
61.Pq Dq CBOSS ,
62as part of the DARPA CHATS research program.
63.Pp
64The OpenPAM library is maintained by
65.An Dag-Erling Sm\(/orgrav Aq Mt des@des.no .
66