lib/libpam/modules/pam_chroot/pam_chroot.8

   1 .\" Copyright (c) 2003 Networks Associates Technology, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Portions of this software were developed for the FreeBSD Project by
   5 .\" ThinkSec AS and NAI Labs, the Security Research Division of Network
   6 .\" Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
   7 .\" ("CBOSS"), as part of the DARPA CHATS research program.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\" 3. The name of the author may not be used to endorse or promote
  18 .\"    products derived from this software without specific prior written
  19 .\"    permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\" $FreeBSD: src/lib/libpam/modules/pam_chroot/pam_chroot.8,v 1.4 2004/07/02 23:52:16 ru Exp $
  34 .\"
  35 .Dd February 10, 2003
  36 .Dt PAM_CHROOT 8
  37 .Os
  38 .Sh NAME
  39 .Nm pam_chroot
  40 .Nd Chroot PAM module
  41 .Sh SYNOPSIS
  42 .Op Ar service-name
  43 .Ar module-type
  44 .Ar control-flag
  45 .Pa pam_chroot
  46 .Op Ar arguments
  47 .Sh DESCRIPTION
  48 The chroot service module for PAM chroots users into either a
  49 predetermined directory or one derived from their home directory.
  50 If a user's home directory as specified in the
  51 .Vt passwd
  52 structure returned by
  53 .Xr getpwnam 3
  54 contains the string
  55 .Dq Li /./ ,
  56 the portion of the directory name to the left of that string is used
  57 as the chroot directory, and the portion to the right will be the
  58 current working directory inside the chroot tree.
  59 Otherwise, the directories specified by the
  60 .Cm dir
  61 and
  62 .Cm cwd
  63 options (see below) are used.
  64 .Bl -tag -width ".Cm also_root"
  65 .It Cm also_root
  66 Do not hold user ID 0 exempt from the chroot requirement.
  67 .It Cm always
  68 Report a failure if a chroot directory could not be derived from the
  69 user's home directory, and the
  70 .Cm dir
  71 option was not specified.
  72 .It Cm cwd Ns = Ns Ar directory
  73 Specify the directory to
  74 .Xr chdir 2
  75 into after a successful
  76 .Xr chroot 2
  77 call.
  78 .It Cm dir Ns = Ns Ar directory
  79 Specify the chroot directory to use if one could not be derived from
  80 the user's home directory.
  81 .El
  82 .Sh SEE ALSO
  83 .Xr pam 3 ,
  84 .Xr pam.conf 5
  85 .Sh AUTHORS
  86 The
  87 .Nm
  88 module and this manual page were developed for the
  89 .Fx
  90 Project by
  91 ThinkSec AS and NAI Labs, the Security Research Division of Network
  92 Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
  93 .Pq Dq CBOSS ,
  94 as part of the DARPA CHATS research program.