lib/libpam/modules/pam_chroot/pam_chroot.8

   1 .\" $NetBSD$
   2 .\" Copyright (c) 2003 Networks Associates Technology, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" Portions of this software were developed for the FreeBSD Project by
   6 .\" ThinkSec AS and NAI Labs, the Security Research Division of Network
   7 .\" Associates, Inc. under DARPA/SPAWAR contract N66001-01-C-8035
   8 .\" ("CBOSS"), as part of the 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 .\" $FreeBSD: src/lib/libpam/modules/pam_chroot/pam_chroot.8,v 1.4 2004/07/02 23:52:16 ru Exp $
  35 .\"
  36 .Dd February 10, 2003
  37 .Dt PAM_CHROOT 8
  38 .Os
  39 .Sh NAME
  40 .Nm pam_chroot
  41 .Nd Chroot PAM module
  42 .Sh SYNOPSIS
  43 .Op Ar service-name
  44 .Ar module-type
  45 .Ar control-flag
  46 .Pa pam_chroot
  47 .Op Ar arguments
  48 .Sh DESCRIPTION
  49 The chroot service module for PAM chroots users into either a
  50 predetermined directory or one derived from their home directory.
  51 If a user's home directory as specified in the
  52 .Vt passwd
  53 structure returned by
  54 .Xr getpwnam 3
  55 contains the string
  56 .Dq Li /./ ,
  57 the portion of the directory name to the left of that string is used
  58 as the chroot directory, and the portion to the right will be the
  59 current working directory inside the chroot tree.
  60 Otherwise, the directories specified by the
  61 .Cm dir
  62 and
  63 .Cm cwd
  64 options (see below) are used.
  65 .Bl -tag -width ".Cm also_root"
  66 .It Cm also_root
  67 Do not hold user ID 0 exempt from the chroot requirement.
  68 .It Cm always
  69 Report a failure if a chroot directory could not be derived from the
  70 user's home directory, and the
  71 .Cm dir
  72 option was not specified.
  73 .It Cm cwd Ns = Ns Ar directory
  74 Specify the directory to
  75 .Xr chdir 2
  76 into after a successful
  77 .Xr chroot 2
  78 call.
  79 .It Cm dir Ns = Ns Ar directory
  80 Specify the chroot directory to use if one could not be derived from
  81 the user's home directory.
  82 .El
  83 .Sh SEE ALSO
  84 .Xr pam.conf 5 ,
  85 .Xr pam 8
  86 .Sh AUTHORS
  87 The
  88 .Nm
  89 module and this manual page were developed for the
  90 .Fx
  91 Project by
  92 ThinkSec AS and NAI Labs, the Security Research Division of Network
  93 Associates, Inc.\& under DARPA/SPAWAR contract N66001-01-C-8035
  94 .Pq Dq CBOSS ,
  95 as part of the DARPA CHATS research program.