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.\" 35.Dd August 1, 2010 36.Dt CHROOT 2 37.Os 38.Sh NAME 39.Nm chroot , 40.Nm chroot_kernel 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.Ft int 49.Fn chroot_kernel "const char *dirname" 50.Sh DESCRIPTION 51.Fa Dirname 52is the address of the pathname of a directory, terminated by an ASCII NUL. 53.Fn Chroot 54causes 55.Fa dirname 56to become the root directory, 57that is, the starting point for path searches of pathnames 58beginning with 59.Ql / . 60.Pp 61In order for a directory to become the root directory 62a process must have execute (search) access for that directory. 63.Pp 64It should be noted that 65.Fn chroot 66has no effect on the process's current directory. 67.Pp 68This call is restricted to the super-user. 69.Pp 70Depending on the setting of the 71.Va kern.chroot_allow_open_directories 72sysctl variable, open filedescriptors which reference directories 73will make the 74.Fn chroot 75fail as follows: 76.Pp 77If 78.Va kern.chroot_allow_open_directories 79is set to zero, 80.Fn chroot 81will always fail with 82.Er EPERM 83if there are any directories open. 84.Pp 85If 86.Va kern.chroot_allow_open_directories 87is set to one (the default), 88.Fn chroot 89will fail with 90.Er EPERM 91if there are any directories open and the 92process is already subject to a 93.Fn chroot 94call. 95.Pp 96Any other value for 97.Va kern.chroot_allow_open_directories 98will bypass the check for open directories 99.Pp 100Upon successful completion, a value of 0 is returned. Otherwise, 101a value of -1 is returned and 102.Va errno 103is set to indicate an error. 104.Pp 105The 106.Fn chroot_kernel 107system call adjusts the kernel's internal namecache and root vnode 108references to 109.Fa dirname . 110If used in conjunction with 111.Fn chroot 112during early boot, it allows for changing the root mount to any 113mount point available at that time. 114.Sh ERRORS 115.Fn Chroot 116will fail and the root directory will be unchanged if: 117.Bl -tag -width Er 118.It Bq Er ENOTDIR 119A component of the path name is not a directory. 120.It Bq Er EPERM 121The effective user ID is not the super-user, or one or more 122filedescriptors are open directories. 123.It Bq Er ENAMETOOLONG 124A component of a pathname exceeded 255 characters, 125or an entire path name exceeded 1023 characters. 126.It Bq Er ENOENT 127The named directory does not exist. 128.It Bq Er EACCES 129Search permission is denied for any component of the path name. 130.It Bq Er ELOOP 131Too many symbolic links were encountered in translating the pathname. 132.It Bq Er EFAULT 133.Fa dirname 134points outside the process's allocated address space. 135.It Bq Er EIO 136An I/O error occurred while reading from or writing to the file system. 137.El 138.Sh SEE ALSO 139.Xr chdir 2 , 140.Xr jail 2 141.Sh HISTORY 142The 143.Fn chroot 144function call appeared in 145.Bx 4.2 . 146