lib/libcr/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: src/lib/libc/sys/chroot.2,v 1.7.2.8 2002/12/11 14:06:37 ru Exp $
  34 .\" $DragonFly: src/lib/libcr/sys/Attic/chroot.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt CHROOT 2
  38 .Os
  39 .Sh NAME
  40 .Nm chroot
  41 .Nd change root directory
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In unistd.h
  46 .Ft int
  47 .Fn chroot "const char *dirname"
  48 .Sh DESCRIPTION
  49 .Fa Dirname
  50 is the address of the pathname of a directory, terminated by an ASCII NUL.
  51 .Fn Chroot
  52 causes
  53 .Fa dirname
  54 to become the root directory,
  55 that is, the starting point for path searches of pathnames
  56 beginning with
  57 .Ql / .
  58 .Pp
  59 In order for a directory to become the root directory
  60 a process must have execute (search) access for that directory.
  61 .Pp
  62 It should be noted that
  63 .Fn chroot
  64 has no effect on the process's current directory.
  65 .Pp
  66 This call is restricted to the super-user.
  67 .Pp
  68 Depending on the setting of the
  69 .Ql kern.chroot_allow_open_directories
  70 sysctl variable, open filedescriptors which reference directories
  71 will make the
  72 .Fn chroot
  73 fail as follows:
  74 .Pp
  75 If
  76 .Ql kern.chroot_allow_open_directories
  77 is set to zero,
  78 .Fn chroot
  79 will always fail with
  80 .Er EPERM
  81 if there are any directories open.
  82 .Pp
  83 If
  84 .Ql kern.chroot_allow_open_directories
  85 is set to one (the default),
  86 .Fn chroot
  87 will fail with
  88 .Er EPERM
  89 if there are any directories open and the
  90 process is already subject to a
  91 .Fn chroot
  92 call.
  93 .Pp
  94 Any other value for
  95 .Ql kern.chroot_allow_open_directories
  96 will bypass the check for open directories
  97 .Pp
  98 Upon successful completion, a value of 0 is returned.  Otherwise,
  99 a value of -1 is returned and
 100 .Va errno
 101 is set to indicate an error.
 102 .Sh ERRORS
 103 .Fn Chroot
 104 will fail and the root directory will be unchanged if:
 105 .Bl -tag -width Er
 106 .It Bq Er ENOTDIR
 107 A component of the path name is not a directory.
 108 .It Bq Er EPERM
 109 The effective user ID is not the super-user, or one or more
 110 filedescriptors are open directories.
 111 .It Bq Er ENAMETOOLONG
 112 A component of a pathname exceeded 255 characters,
 113 or an entire path name exceeded 1023 characters.
 114 .It Bq Er ENOENT
 115 The named directory does not exist.
 116 .It Bq Er EACCES
 117 Search permission is denied for any component of the path name.
 118 .It Bq Er ELOOP
 119 Too many symbolic links were encountered in translating the pathname.
 120 .It Bq Er EFAULT
 121 .Fa dirname
 122 points outside the process's allocated address space.
 123 .It Bq Er EIO
 124 An I/O error occurred while reading from or writing to the file system.
 125 .El
 126 .Sh SEE ALSO
 127 .Xr chdir 2 ,
 128 .Xr jail 2
 129 .Sh HISTORY
 130 The
 131 .Fn chroot
 132 function call appeared in
 133 .Bx 4.2 .