source: openpam/trunk/doc/man/openpam_borrow_cred.3 @ 107

Last change on this file since 107 was 107, checked in by Dag-Erling Smørgrav, 18 years ago

Regenerate.

File size: 3.1 KB
Line 
1.\"-
2.\" Copyright (c) 2002 Networks Associates Technology, Inc.
3.\" All rights reserved.
4.\"
5.\" This software was developed for the FreeBSD Project by ThinkSec AS and
6.\" NAI Labs, the Security Research Division of Network Associates, Inc.
7.\" under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
8.\" DARPA CHATS research program.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. The name of the author may not be used to endorse or promote
19.\"    products derived from this software without specific prior written
20.\"    permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $P4: //depot/projects/openpam/doc/man/openpam_borrow_cred.3#1 $
35.\"
36.Dd April 8, 2002
37.Dt OPENPAM_BORROW_CRED 3
38.Os
39.Sh NAME
40.Nm openpam_borrow_cred
41.Nd temporarily borrow user credentials
42.Sh LIBRARY
43.Lb libpam
44.Sh SYNOPSIS
45.In security/pam_appl.h
46.Ft int
47.Fn openpam_borrow_cred "pam_handle_t *pamh" "const struct passwd *pwd"
48.Sh DESCRIPTION
49The
50.Nm
51function saves the current credentials and
52switches to those of the user specified by its
53.Va pwd
54argument.  The
55affected credentials are the effective UID, the effective GID, and the
56group access list.  The original credentials can be restored using
57.Xr openpam_restore_cred 3 .
58.Pp
59.Sh RETURN VALUES
60The
61.Nm
62function returns one of the following values:
63.Bl -tag -width 18n
64.It Bq Er PAM_BUF_ERR
65Memory buffer error.
66.It Bq Er PAM_PERM_DENIED
67Permission denied.
68.It Bq Er PAM_SYSTEM_ERR
69System error.
70.El
71.Sh SEE ALSO
72.Xr openpam_restore_cred 3 ,
73.Xr pam 3 ,
74.Xr pam_strerror 3 ,
75.Xr setegid 3 ,
76.Xr seteuid 3 ,
77.Xr setgroups 3
78.Sh STANDARDS
79The
80.Nm
81function is an OpenPAM extension.
82.Sh AUTHORS
83The
84.Nm
85function and this manual page were developed for the FreeBSD Project
86by ThinkSec AS and NAI Labs, the Security Research Division of Network
87Associates, Inc.  under DARPA/SPAWAR contract N66001-01-C-8035
88.Pq Dq CBOSS ,
89as part of the DARPA CHATS research program.
Note: See TracBrowser for help on using the repository browser.