lib/libc/sys/chmod.2

   1 .\" Copyright (c) 1980, 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 .\"     @(#)chmod.2     8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd December 29, 2004
  36 .Dt CHMOD 2
  37 .Os
  38 .Sh NAME
  39 .Nm chmod ,
  40 .Nm fchmod ,
  41 .Nm lchmod
  42 .Nd change mode of file
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In sys/stat.h
  47 .Ft int
  48 .Fn chmod "const char *path" "mode_t mode"
  49 .Ft int
  50 .Fn fchmod "int fd" "mode_t mode"
  51 .Ft int
  52 .Fn lchmod "const char *path" "mode_t mode"
  53 .Sh DESCRIPTION
  54 The file permission bits of the file named specified by
  55 .Fa path
  56 or referenced by the file descriptor
  57 .Fa fd
  58 are changed to
  59 .Fa mode .
  60 The
  61 .Fn chmod
  62 system call verifies that the process owner (user) either owns
  63 the file specified by
  64 .Fa path
  65 (or
  66 .Fa fd ) ,
  67 or
  68 is the super-user.
  69 The
  70 .Fn chmod
  71 system call follows symbolic links to operate on the target of the link
  72 rather than the link itself.
  73 .Pp
  74 The
  75 .Fn lchmod
  76 system call is similar to
  77 .Fn chmod
  78 but does not follow symbolic links.
  79 .Pp
  80 A mode is created from
  81 .Em or'd
  82 permission bit masks
  83 defined in
  84 .In sys/stat.h :
  85 .Pp
  86 .Bd -literal -offset indent -compact
  87 #define S_IRWXU 0000700    /* RWX mask for owner */
  88 #define S_IRUSR 0000400    /* R for owner */
  89 #define S_IWUSR 0000200    /* W for owner */
  90 #define S_IXUSR 0000100    /* X for owner */
  91
  92 #define S_IRWXG 0000070    /* RWX mask for group */
  93 #define S_IRGRP 0000040    /* R for group */
  94 #define S_IWGRP 0000020    /* W for group */
  95 #define S_IXGRP 0000010    /* X for group */
  96
  97 #define S_IRWXO 0000007    /* RWX mask for other */
  98 #define S_IROTH 0000004    /* R for other */
  99 #define S_IWOTH 0000002    /* W for other */
 100 #define S_IXOTH 0000001    /* X for other */
 101
 102 #define S_ISUID 0004000    /* set user id on execution */
 103 #define S_ISGID 0002000    /* set group id on execution */
 104 #ifndef __BSD_VISIBLE
 105 #define S_ISTXT 0001000    /* sticky bit */
 106 #endif
 107 .Ed
 108 .Pp
 109 The
 110 .Fx
 111 VM system totally ignores the sticky bit
 112 .Pq Dv ISTXT
 113 for executables.
 114 On UFS-based file systems (FFS, LFS) the sticky
 115 bit may only be set upon directories.
 116 .Pp
 117 If mode
 118 .Dv ISTXT
 119 (the `sticky bit') is set on a directory,
 120 an unprivileged user may not delete or rename
 121 files of other users in that directory.
 122 The sticky bit may be
 123 set by any user on a directory which the user owns or has appropriate
 124 permissions.
 125 For more details of the properties of the sticky bit, see
 126 .Xr sticky 8 .
 127 .Pp
 128 If mode ISUID (set UID) is set on a directory,
 129 and the MNT_SUIDDIR option was used in the mount of the file system,
 130 then the owner of any new files and sub-directories
 131 created within this directory are set
 132 to be the same as the owner of that directory.
 133 If this function is enabled, new directories will inherit
 134 the bit from their parents.
 135 Execute bits are removed from
 136 the file, and it will not be given to root.
 137 This behavior does not change the
 138 requirements for the user to be allowed to write the file, but only the eventual
 139 owner after it has been created.
 140 Group inheritance is not affected.
 141 .Pp
 142 This feature is designed for use on fileservers serving PC users via
 143 ftp, SAMBA, or netatalk.
 144 It provides security holes for shell users and as
 145 such should not be used on shell machines, especially on home directories.
 146 This option requires the SUIDDIR
 147 option in the kernel to work.
 148 Only UFS file systems support this option.
 149 For more details of the suiddir mount option, see
 150 .Xr mount 8 .
 151 .Pp
 152 Writing or changing the owner of a file
 153 turns off the set-user-id and set-group-id bits
 154 unless the user is the super-user.
 155 This makes the system somewhat more secure
 156 by protecting set-user-id (set-group-id) files
 157 from remaining set-user-id (set-group-id) if they are modified,
 158 at the expense of a degree of compatibility.
 159 .Sh RETURN VALUES
 160 .Rv -std
 161 .Sh ERRORS
 162 The
 163 .Fn chmod
 164 system call
 165 will fail and the file mode will be unchanged if:
 166 .Bl -tag -width Er
 167 .It Bq Er ENOTDIR
 168 A component of the path prefix is not a directory.
 169 .It Bq Er ENAMETOOLONG
 170 A component of a pathname exceeded 255 characters,
 171 or an entire path name exceeded 1023 characters.
 172 .It Bq Er ENOENT
 173 The named file does not exist.
 174 .It Bq Er EACCES
 175 Search permission is denied for a component of the path prefix.
 176 .It Bq Er ELOOP
 177 Too many symbolic links were encountered in translating the pathname.
 178 .It Bq Er EPERM
 179 The effective user ID does not match the owner of the file and
 180 the effective user ID is not the super-user.
 181 .It Bq Er EROFS
 182 The named file resides on a read-only file system.
 183 .It Bq Er EFAULT
 184 The
 185 .Fa path
 186 argument
 187 points outside the process's allocated address space.
 188 .It Bq Er EIO
 189 An I/O error occurred while reading from or writing to the file system.
 190 .It Bq Er EFTYPE
 191 An attempt was made to set the sticky bit upon an executable.
 192 .El
 193 .Pp
 194 The
 195 .Fn fchmod
 196 system call will fail if:
 197 .Bl -tag -width Er
 198 .It Bq Er EBADF
 199 The descriptor is not valid.
 200 .It Bq Er EINVAL
 201 The
 202 .Fa fd
 203 argument
 204 refers to a socket, not to a file.
 205 .It Bq Er EROFS
 206 The file resides on a read-only file system.
 207 .It Bq Er EIO
 208 An I/O error occurred while reading from or writing to the file system.
 209 .El
 210 .Sh SEE ALSO
 211 .Xr chmod 1 ,
 212 .Xr chown 2 ,
 213 .Xr open 2 ,
 214 .Xr stat 2 ,
 215 .Xr sticky 8
 216 .Sh STANDARDS
 217 The
 218 .Fn chmod
 219 system call is expected to conform to
 220 .St -p1003.1-90 ,
 221 except for the return of
 222 .Er EFTYPE
 223 and the use of
 224 .Dv S_ISTXT .
 225 .Sh HISTORY
 226 The
 227 .Fn chmod
 228 function appeared in
 229 .At v7 .
 230 The
 231 .Fn fchmod
 232 system call appeared in
 233 .Bx 4.2 .
 234 The
 235 .Fn lchmod
 236 system call appeared in
 237 .Fx 3.0 .