dist/openpam/doc/man/openpam_borrow_cred.3

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