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 February 23, 2021
  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_RESOLVE_BENEATH
 105 Only walk paths below the directory specified by the
 106 .Ar fd
 107 descriptor.
 108 See the description of the
 109 .Dv O_RESOLVE_BENEATH
 110 flag in the
 111 .Xr open 2
 112 manual page.
 113 .El
 114 .Pp
 115 If
 116 .Fn fchmodat
 117 is passed the special value
 118 .Dv AT_FDCWD
 119 in the
 120 .Fa fd
 121 parameter, the current working directory is used.
 122 If also
 123 .Fa flag
 124 is zero, the behavior is identical to a call to
 125 .Fn chmod .
 126 .Pp
 127 A mode is created from
 128 .Em or'd
 129 permission bit masks
 130 defined in
 131 .In sys/stat.h :
 132 .Pp
 133 .Bd -literal -offset indent -compact
 134 #define S_IRWXU 0000700    /* RWX mask for owner */
 135 #define S_IRUSR 0000400    /* R for owner */
 136 #define S_IWUSR 0000200    /* W for owner */
 137 #define S_IXUSR 0000100    /* X for owner */
 138
 139 #define S_IRWXG 0000070    /* RWX mask for group */
 140 #define S_IRGRP 0000040    /* R for group */
 141 #define S_IWGRP 0000020    /* W for group */
 142 #define S_IXGRP 0000010    /* X for group */
 143
 144 #define S_IRWXO 0000007    /* RWX mask for other */
 145 #define S_IROTH 0000004    /* R for other */
 146 #define S_IWOTH 0000002    /* W for other */
 147 #define S_IXOTH 0000001    /* X for other */
 148
 149 #define S_ISUID 0004000    /* set user id on execution */
 150 #define S_ISGID 0002000    /* set group id on execution */
 151 #define S_ISVTX 0001000    /* sticky bit */
 152 .Ed
 153 .Pp
 154 The non-standard
 155 .Dv S_ISTXT
 156 is a synonym for
 157 .Dv S_ISVTX .
 158 .Pp
 159 The
 160 .Fx
 161 VM system totally ignores the sticky bit
 162 .Pq Dv S_ISVTX
 163 for executables.
 164 On UFS-based file systems (FFS, LFS) the sticky
 165 bit may only be set upon directories.
 166 .Pp
 167 If mode
 168 .Dv S_ISVTX
 169 (the `sticky bit') is set on a directory,
 170 an unprivileged user may not delete or rename
 171 files of other users in that directory.
 172 The sticky bit may be
 173 set by any user on a directory which the user owns or has appropriate
 174 permissions.
 175 For more details of the properties of the sticky bit, see
 176 .Xr sticky 7 .
 177 .Pp
 178 If mode ISUID (set UID) is set on a directory,
 179 and the MNT_SUIDDIR option was used in the mount of the file system,
 180 then the owner of any new files and sub-directories
 181 created within this directory are set
 182 to be the same as the owner of that directory.
 183 If this function is enabled, new directories will inherit
 184 the bit from their parents.
 185 Execute bits are removed from
 186 the file, and it will not be given to root.
 187 This behavior does not change the
 188 requirements for the user to be allowed to write the file, but only the eventual
 189 owner after it has been created.
 190 Group inheritance is not affected.
 191 .Pp
 192 This feature is designed for use on fileservers serving PC users via
 193 ftp, SAMBA, or netatalk.
 194 It provides security holes for shell users and as
 195 such should not be used on shell machines, especially on home directories.
 196 This option requires the SUIDDIR
 197 option in the kernel to work.
 198 Only UFS file systems support this option.
 199 For more details of the suiddir mount option, see
 200 .Xr mount 8 .
 201 .Pp
 202 Writing or changing the owner of a file
 203 turns off the set-user-id and set-group-id bits
 204 unless the user is the super-user.
 205 This makes the system somewhat more secure
 206 by protecting set-user-id (set-group-id) files
 207 from remaining set-user-id (set-group-id) if they are modified,
 208 at the expense of a degree of compatibility.
 209 .Sh RETURN VALUES
 210 .Rv -std
 211 .Sh ERRORS
 212 The
 213 .Fn chmod
 214 system call
 215 will fail and the file mode will be unchanged if:
 216 .Bl -tag -width Er
 217 .It Bq Er ENOTDIR
 218 A component of the path prefix is not a directory.
 219 .It Bq Er ENAMETOOLONG
 220 A component of a pathname exceeded 255 characters,
 221 or an entire path name exceeded 1023 characters.
 222 .It Bq Er ENOENT
 223 The named file does not exist.
 224 .It Bq Er EACCES
 225 Search permission is denied for a component of the path prefix.
 226 .It Bq Er ELOOP
 227 Too many symbolic links were encountered in translating the pathname.
 228 .It Bq Er EPERM
 229 The effective user ID does not match the owner of the file and
 230 the effective user ID is not the super-user.
 231 .It Bq Er EPERM
 232 The effective user ID is not the super-user, the effective user ID do match the
 233 owner of the file, but the group ID of the file does not match the effective
 234 group ID nor one of the supplementary group IDs.
 235 .It Bq Er EPERM
 236 The named file has its immutable or append-only flag set, see the
 237 .Xr chflags 2
 238 manual page for more information.
 239 .It Bq Er EROFS
 240 The named file resides on a read-only file system.
 241 .It Bq Er EFAULT
 242 The
 243 .Fa path
 244 argument
 245 points outside the process's allocated address space.
 246 .It Bq Er EIO
 247 An I/O error occurred while reading from or writing to the file system.
 248 .It Bq Er EINTEGRITY
 249 Corrupted data was detected while reading from the file system.
 250 .It Bq Er EFTYPE
 251 The effective user ID is not the super-user, the mode includes the sticky bit
 252 .Dv ( S_ISVTX ) ,
 253 and path does not refer to a directory.
 254 .El
 255 .Pp
 256 The
 257 .Fn fchmod
 258 system call will fail if:
 259 .Bl -tag -width Er
 260 .It Bq Er EBADF
 261 The descriptor is not valid.
 262 .It Bq Er EINVAL
 263 The
 264 .Fa fd
 265 argument
 266 refers to a socket, not to a file.
 267 .It Bq Er EROFS
 268 The file resides on a read-only file system.
 269 .It Bq Er EIO
 270 An I/O error occurred while reading from or writing to the file system.
 271 .It Bq Er EINTEGRITY
 272 Corrupted data was detected while reading from the file system.
 273 .El
 274 .Pp
 275 In addition to the
 276 .Fn chmod
 277 errors,
 278 .Fn fchmodat
 279 fails if:
 280 .Bl -tag -width Er
 281 .It Bq Er EBADF
 282 The
 283 .Fa path
 284 argument does not specify an absolute path and the
 285 .Fa fd
 286 argument is neither
 287 .Fa AT_FDCWD
 288 nor a valid file descriptor open for searching.
 289 .It Bq Er EINVAL
 290 The value of the
 291 .Fa flag
 292 argument is not valid.
 293 .It Bq Er ENOTDIR
 294 The
 295 .Fa path
 296 argument is not an absolute path and
 297 .Fa fd
 298 is neither
 299 .Dv AT_FDCWD
 300 nor a file descriptor associated with a directory.
 301 .It Bq Er ENOTCAPABLE
 302 .Fa path
 303 is an absolute path,
 304 or contained a ".." component leading to a
 305 directory outside of the directory hierarchy specified by
 306 .Fa fd ,
 307 and the process is in capability mode or the
 308 .Dv AT_RESOLVE_BENEATH
 309 flag was specified.
 310 .El
 311 .Sh SEE ALSO
 312 .Xr chmod 1 ,
 313 .Xr chflags 2 ,
 314 .Xr chown 2 ,
 315 .Xr open 2 ,
 316 .Xr stat 2 ,
 317 .Xr sticky 7
 318 .Sh STANDARDS
 319 The
 320 .Fn chmod
 321 system call is expected to conform to
 322 .St -p1003.1-90 ,
 323 except for the return of
 324 .Er EFTYPE .
 325 The
 326 .Dv S_ISVTX
 327 bit on directories is expected to conform to
 328 .St -susv3 .
 329 The
 330 .Fn fchmodat
 331 system call is expected to conform to
 332 .St -p1003.1-2008 .
 333 .Sh HISTORY
 334 The
 335 .Fn chmod
 336 function appeared in
 337 .At v1 .
 338 The
 339 .Fn fchmod
 340 system call appeared in
 341 .Bx 4.2 .
 342 The
 343 .Fn lchmod
 344 system call appeared in
 345 .Fx 3.0 .
 346 The
 347 .Fn fchmodat
 348 system call appeared in
 349 .Fx 8.0 .