6/lib/libc/sys/chroot.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)chroot.2    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt CHROOT 2
  37 .Os
  38 .Sh NAME
  39 .Nm chroot
  40 .Nd change root directory
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft int
  46 .Fn chroot "const char *dirname"
  47 .Sh DESCRIPTION
  48 The
  49 .Fa dirname
  50 argument
  51 is the address of the pathname of a directory, terminated by an ASCII NUL.
  52 The
  53 .Fn chroot
  54 system call causes
  55 .Fa dirname
  56 to become the root directory,
  57 that is, the starting point for path searches of pathnames
  58 beginning with
  59 .Ql / .
  60 .Pp
  61 In order for a directory to become the root directory
  62 a process must have execute (search) access for that directory.
  63 .Pp
  64 It should be noted that
  65 .Fn chroot
  66 has no effect on the process's current directory.
  67 .Pp
  68 This call is restricted to the super-user.
  69 .Pp
  70 Depending on the setting of the
  71 .Ql kern.chroot_allow_open_directories
  72 sysctl variable, open filedescriptors which reference directories
  73 will make the
  74 .Fn chroot
  75 fail as follows:
  76 .Pp
  77 If
  78 .Ql kern.chroot_allow_open_directories
  79 is set to zero,
  80 .Fn chroot
  81 will always fail with
  82 .Er EPERM
  83 if there are any directories open.
  84 .Pp
  85 If
  86 .Ql kern.chroot_allow_open_directories
  87 is set to one (the default),
  88 .Fn chroot
  89 will fail with
  90 .Er EPERM
  91 if there are any directories open and the
  92 process is already subject to the
  93 .Fn chroot
  94 system call.
  95 .Pp
  96 Any other value for
  97 .Ql kern.chroot_allow_open_directories
  98 will bypass the check for open directories
  99 .Pp
 100 Upon successful completion, a value of 0 is returned.
 101 Otherwise,
 102 a value of -1 is returned and
 103 .Va errno
 104 is set to indicate an error.
 105 .Sh ERRORS
 106 The
 107 .Fn chroot
 108 system call
 109 will fail and the root directory will be unchanged if:
 110 .Bl -tag -width Er
 111 .It Bq Er ENOTDIR
 112 A component of the path name is not a directory.
 113 .It Bq Er EPERM
 114 The effective user ID is not the super-user, or one or more
 115 filedescriptors are open directories.
 116 .It Bq Er ENAMETOOLONG
 117 A component of a pathname exceeded 255 characters,
 118 or an entire path name exceeded 1023 characters.
 119 .It Bq Er ENOENT
 120 The named directory does not exist.
 121 .It Bq Er EACCES
 122 Search permission is denied for any component of the path name.
 123 .It Bq Er ELOOP
 124 Too many symbolic links were encountered in translating the pathname.
 125 .It Bq Er EFAULT
 126 The
 127 .Fa dirname
 128 argument
 129 points outside the process's allocated address space.
 130 .It Bq Er EIO
 131 An I/O error occurred while reading from or writing to the file system.
 132 .El
 133 .Sh SEE ALSO
 134 .Xr chdir 2 ,
 135 .Xr jail 2
 136 .Sh HISTORY
 137 The
 138 .Fn chroot
 139 system call appeared in
 140 .Bx 4.2 .
 141 .Sh BUGS
 142 If the process is able to change its working directory to the target
 143 directory, but another access control check fails (such as a check for
 144 open directories, or a MAC check), it is possible that this system
 145 call may return an error, with the working directory of the process
 146 left changed.