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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)chmod.2     8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd November 11, 2018
  32 .Dt CHMOD 2
  33 .Os
  34 .Sh NAME
  35 .Nm chmod ,
  36 .Nm fchmod ,
  37 .Nm lchmod ,
  38 .Nm fchmodat
  39 .Nd change mode of file
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In sys/stat.h
  44 .Ft int
  45 .Fn chmod "const char *path" "mode_t mode"
  46 .Ft int
  47 .Fn fchmod "int fd" "mode_t mode"
  48 .Ft int
  49 .Fn lchmod "const char *path" "mode_t mode"
  50 .Ft int
  51 .Fn fchmodat "int fd" "const char *path" "mode_t mode" "int flag"
  52 .Sh DESCRIPTION
  53 The file permission bits of the file named specified by
  54 .Fa path
  55 or referenced by the file descriptor
  56 .Fa fd
  57 are changed to
  58 .Fa mode .
  59 The
  60 .Fn chmod
  61 system call verifies that the process owner (user) either owns
  62 the file specified by
  63 .Fa path
  64 (or
  65 .Fa fd ) ,
  66 or
  67 is the super-user.
  68 The
  69 .Fn chmod
  70 system call follows symbolic links to operate on the target of the link
  71 rather than the link itself.
  72 .Pp
  73 The
  74 .Fn lchmod
  75 system call is similar to
  76 .Fn chmod
  77 but does not follow symbolic links.
  78 .Pp
  79 The
  80 .Fn fchmodat
  81 is equivalent to either
  82 .Fn chmod
  83 or
  84 .Fn lchmod
  85 depending on the
  86 .Fa flag
  87 except in the case where
  88 .Fa path
  89 specifies a relative path.
  90 In this case the file to be changed is determined relative to the directory
  91 associated with the file descriptor
  92 .Fa fd
  93 instead of the current working directory.
  94 The values for the
  95 .Fa flag
  96 are constructed by a bitwise-inclusive OR of flags from the following list, defined
  97 in
  98 .In fcntl.h :
  99 .Bl -tag -width indent
 100 .It Dv AT_SYMLINK_NOFOLLOW
 101 If
 102 .Fa path
 103 names a symbolic link, then the mode of the symbolic link is changed.
 104 .It Dv AT_BENEATH
 105 Only allow to change permissions of a file which is beneath of
 106 the topping directory.
 107 See the description of the
 108 .Dv O_BENEATH
 109 flag in the
 110 .Xr open 2
 111 manual page.
 112 .El
 113 .Pp
 114 If
 115 .Fn fchmodat
 116 is passed the special value
 117 .Dv AT_FDCWD
 118 in the
 119 .Fa fd
 120 parameter, the current working directory is used.
 121 If also
 122 .Fa flag
 123 is zero, the behavior is identical to a call to
 124 .Fn chmod .
 125 .Pp
 126 A mode is created from
 127 .Em or'd
 128 permission bit masks
 129 defined in
 130 .In sys/stat.h :
 131 .Pp
 132 .Bd -literal -offset indent -compact
 133 #define S_IRWXU 0000700    /* RWX mask for owner */
 134 #define S_IRUSR 0000400    /* R for owner */
 135 #define S_IWUSR 0000200    /* W for owner */
 136 #define S_IXUSR 0000100    /* X for owner */
 137
 138 #define S_IRWXG 0000070    /* RWX mask for group */
 139 #define S_IRGRP 0000040    /* R for group */
 140 #define S_IWGRP 0000020    /* W for group */
 141 #define S_IXGRP 0000010    /* X for group */
 142
 143 #define S_IRWXO 0000007    /* RWX mask for other */
 144 #define S_IROTH 0000004    /* R for other */
 145 #define S_IWOTH 0000002    /* W for other */
 146 #define S_IXOTH 0000001    /* X for other */
 147
 148 #define S_ISUID 0004000    /* set user id on execution */
 149 #define S_ISGID 0002000    /* set group id on execution */
 150 #define S_ISVTX 0001000    /* sticky bit */
 151 .Ed
 152 .Pp
 153 The non-standard
 154 .Dv S_ISTXT
 155 is a synonym for
 156 .Dv S_ISVTX .
 157 .Pp
 158 The
 159 .Fx
 160 VM system totally ignores the sticky bit
 161 .Pq Dv S_ISVTX
 162 for executables.
 163 On UFS-based file systems (FFS, LFS) the sticky
 164 bit may only be set upon directories.
 165 .Pp
 166 If mode
 167 .Dv S_ISVTX
 168 (the `sticky bit') is set on a directory,
 169 an unprivileged user may not delete or rename
 170 files of other users in that directory.
 171 The sticky bit may be
 172 set by any user on a directory which the user owns or has appropriate
 173 permissions.
 174 For more details of the properties of the sticky bit, see
 175 .Xr sticky 7 .
 176 .Pp
 177 If mode ISUID (set UID) is set on a directory,
 178 and the MNT_SUIDDIR option was used in the mount of the file system,
 179 then the owner of any new files and sub-directories
 180 created within this directory are set
 181 to be the same as the owner of that directory.
 182 If this function is enabled, new directories will inherit
 183 the bit from their parents.
 184 Execute bits are removed from
 185 the file, and it will not be given to root.
 186 This behavior does not change the
 187 requirements for the user to be allowed to write the file, but only the eventual
 188 owner after it has been created.
 189 Group inheritance is not affected.
 190 .Pp
 191 This feature is designed for use on fileservers serving PC users via
 192 ftp, SAMBA, or netatalk.
 193 It provides security holes for shell users and as
 194 such should not be used on shell machines, especially on home directories.
 195 This option requires the SUIDDIR
 196 option in the kernel to work.
 197 Only UFS file systems support this option.
 198 For more details of the suiddir mount option, see
 199 .Xr mount 8 .
 200 .Pp
 201 Writing or changing the owner of a file
 202 turns off the set-user-id and set-group-id bits
 203 unless the user is the super-user.
 204 This makes the system somewhat more secure
 205 by protecting set-user-id (set-group-id) files
 206 from remaining set-user-id (set-group-id) if they are modified,
 207 at the expense of a degree of compatibility.
 208 .Sh RETURN VALUES
 209 .Rv -std
 210 .Sh ERRORS
 211 The
 212 .Fn chmod
 213 system call
 214 will fail and the file mode will be unchanged if:
 215 .Bl -tag -width Er
 216 .It Bq Er ENOTDIR
 217 A component of the path prefix is not a directory.
 218 .It Bq Er ENAMETOOLONG
 219 A component of a pathname exceeded 255 characters,
 220 or an entire path name exceeded 1023 characters.
 221 .It Bq Er ENOENT
 222 The named file does not exist.
 223 .It Bq Er EACCES
 224 Search permission is denied for a component of the path prefix.
 225 .It Bq Er ELOOP
 226 Too many symbolic links were encountered in translating the pathname.
 227 .It Bq Er EPERM
 228 The effective user ID does not match the owner of the file and
 229 the effective user ID is not the super-user.
 230 .It Bq Er EPERM
 231 The effective user ID is not the super-user, the effective user ID do match the
 232 owner of the file, but the group ID of the file does not match the effective
 233 group ID nor one of the supplementary group IDs.
 234 .It Bq Er EPERM
 235 The named file has its immutable or append-only flag set, see the
 236 .Xr chflags 2
 237 manual page for more information.
 238 .It Bq Er EROFS
 239 The named file resides on a read-only file system.
 240 .It Bq Er EFAULT
 241 The
 242 .Fa path
 243 argument
 244 points outside the process's allocated address space.
 245 .It Bq Er EIO
 246 An I/O error occurred while reading from or writing to the file system.
 247 .It Bq Er EFTYPE
 248 The effective user ID is not the super-user, the mode includes the sticky bit
 249 .Dv ( S_ISVTX ) ,
 250 and path does not refer to a directory.
 251 .El
 252 .Pp
 253 The
 254 .Fn fchmod
 255 system call will fail if:
 256 .Bl -tag -width Er
 257 .It Bq Er EBADF
 258 The descriptor is not valid.
 259 .It Bq Er EINVAL
 260 The
 261 .Fa fd
 262 argument
 263 refers to a socket, not to a file.
 264 .It Bq Er EROFS
 265 The file resides on a read-only file system.
 266 .It Bq Er EIO
 267 An I/O error occurred while reading from or writing to the file system.
 268 .El
 269 .Pp
 270 In addition to the
 271 .Fn chmod
 272 errors,
 273 .Fn fchmodat
 274 fails if:
 275 .Bl -tag -width Er
 276 .It Bq Er EBADF
 277 The
 278 .Fa path
 279 argument does not specify an absolute path and the
 280 .Fa fd
 281 argument is neither
 282 .Fa AT_FDCWD
 283 nor a valid file descriptor open for searching.
 284 .It Bq Er EINVAL
 285 The value of the
 286 .Fa flag
 287 argument is not valid.
 288 .It Bq Er ENOTDIR
 289 The
 290 .Fa path
 291 argument is not an absolute path and
 292 .Fa fd
 293 is neither
 294 .Dv AT_FDCWD
 295 nor a file descriptor associated with a directory.
 296 .It Bq Er ENOTCAPABLE
 297 .Fa path
 298 is an absolute path,
 299 or contained a ".." component leading to a
 300 directory outside of the directory hierarchy specified by
 301 .Fa fd ,
 302 and the process is in capability mode.
 303 .It Bq Er ENOTCAPABLE
 304 The
 305 .Dv AT_BENEATH
 306 flag was provided to
 307 .Fn fchmodat ,
 308 and the absolute
 309 .Fa path
 310 does not have its tail fully contained under the topping directory,
 311 or the relative
 312 .Fa path
 313 escapes it.
 314 .El
 315 .Sh SEE ALSO
 316 .Xr chmod 1 ,
 317 .Xr chflags 2 ,
 318 .Xr chown 2 ,
 319 .Xr open 2 ,
 320 .Xr stat 2 ,
 321 .Xr sticky 7
 322 .Sh STANDARDS
 323 The
 324 .Fn chmod
 325 system call is expected to conform to
 326 .St -p1003.1-90 ,
 327 except for the return of
 328 .Er EFTYPE .
 329 The
 330 .Dv S_ISVTX
 331 bit on directories is expected to conform to
 332 .St -susv3 .
 333 The
 334 .Fn fchmodat
 335 system call is expected to conform to
 336 .St -p1003.1-2008 .
 337 .Sh HISTORY
 338 The
 339 .Fn chmod
 340 function appeared in
 341 .At v1 .
 342 The
 343 .Fn fchmod
 344 system call appeared in
 345 .Bx 4.2 .
 346 The
 347 .Fn lchmod
 348 system call appeared in
 349 .Fx 3.0 .
 350 The
 351 .Fn fchmodat
 352 system call appeared in
 353 .Fx 8.0 .