lib/libc/sys/chown.2

   1 .\" Copyright (c) 1980, 1991, 1993, 1994
   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 .\"     @(#)chown.2     8.4 (Berkeley) 4/19/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd March 30, 2021
  32 .Dt CHOWN 2
  33 .Os
  34 .Sh NAME
  35 .Nm chown ,
  36 .Nm fchown ,
  37 .Nm lchown ,
  38 .Nm fchownat
  39 .Nd change owner and group of a file
  40 .Sh LIBRARY
  41 .Lb libc
  42 .Sh SYNOPSIS
  43 .In unistd.h
  44 .Ft int
  45 .Fn chown "const char *path" "uid_t owner" "gid_t group"
  46 .Ft int
  47 .Fn fchown "int fd" "uid_t owner" "gid_t group"
  48 .Ft int
  49 .Fn lchown "const char *path" "uid_t owner" "gid_t group"
  50 .Ft int
  51 .Fn fchownat "int fd" "const char *path" "uid_t owner" "gid_t group" "int flag"
  52 .Sh DESCRIPTION
  53 The owner ID and group ID of the file
  54 named by
  55 .Fa path
  56 or referenced by
  57 .Fa fd
  58 is changed as specified by the arguments
  59 .Fa owner
  60 and
  61 .Fa group .
  62 The owner of a file may change the
  63 .Fa group
  64 to a group of which
  65 he or she is a member,
  66 but the change
  67 .Fa owner
  68 capability is restricted to the super-user.
  69 .Pp
  70 The
  71 .Fn chown
  72 system call
  73 clears the set-user-id and set-group-id bits
  74 on the file
  75 to prevent accidental or mischievous creation of
  76 set-user-id and set-group-id programs if not executed
  77 by the super-user.
  78 The
  79 .Fn chown
  80 system call
  81 follows symbolic links to operate on the target of the link
  82 rather than the link itself.
  83 .Pp
  84 The
  85 .Fn fchown
  86 system call
  87 is particularly useful when used in conjunction
  88 with the file locking primitives (see
  89 .Xr flock 2 ) .
  90 .Pp
  91 The
  92 .Fn lchown
  93 system call is similar to
  94 .Fn chown
  95 but does not follow symbolic links.
  96 .Pp
  97 The
  98 .Fn fchownat
  99 system call is equivalent to the
 100 .Fn chown
 101 and
 102 .Fn lchown
 103 except in the case where
 104 .Fa path
 105 specifies a relative path.
 106 In this case the file to be changed is determined relative to the directory
 107 associated with the file descriptor
 108 .Fa fd
 109 instead of the current working directory.
 110 .Pp
 111 Values for
 112 .Fa flag
 113 are constructed by a bitwise-inclusive OR of flags from the following
 114 list, defined in
 115 .In fcntl.h :
 116 .Bl -tag -width indent
 117 .It Dv AT_SYMLINK_NOFOLLOW
 118 If
 119 .Fa path
 120 names a symbolic link, ownership of the symbolic link is changed.
 121 .It Dv AT_RESOLVE_BENEATH
 122 Only walk paths below the directory specified by the
 123 .Ar fd
 124 descriptor.
 125 See the description of the
 126 .Dv O_RESOLVE_BENEATH
 127 flag in the
 128 .Xr open 2
 129 manual page.
 130 .It Dv AT_EMPTY_PATH
 131 If the
 132 .Fa path
 133 argument is an empty string, operate on the file or directory
 134 referenced by the descriptor
 135 .Fa fd .
 136 If
 137 .Fa fd
 138 is equal to
 139 .Dv AT_FDCWD ,
 140 operate on the current working directory.
 141 .El
 142 .Pp
 143 If
 144 .Fn fchownat
 145 is passed the special value
 146 .Dv AT_FDCWD
 147 in the
 148 .Fa fd
 149 parameter, the current working directory is used and the behavior is identical
 150 to a call to
 151 .Fn chown
 152 or
 153 .Fn lchown
 154 respectively, depending on whether or not the
 155 .Dv AT_SYMLINK_NOFOLLOW
 156 bit is set in the
 157 .Fa flag
 158 argument.
 159 .Pp
 160 One of the owner or group id's
 161 may be left unchanged by specifying it as -1.
 162 .Sh RETURN VALUES
 163 .Rv -std
 164 .Sh ERRORS
 165 The
 166 .Fn chown
 167 and
 168 .Fn lchown
 169 will fail and the file will be unchanged if:
 170 .Bl -tag -width Er
 171 .It Bq Er ENOTDIR
 172 A component of the path prefix is not a directory.
 173 .It Bq Er ENAMETOOLONG
 174 A component of a pathname exceeded 255 characters,
 175 or an entire path name exceeded 1023 characters.
 176 .It Bq Er ENOENT
 177 The named file does not exist.
 178 .It Bq Er EACCES
 179 Search permission is denied for a component of the path prefix.
 180 .It Bq Er ELOOP
 181 Too many symbolic links were encountered in translating the pathname.
 182 .It Bq Er EPERM
 183 The operation would change the ownership, but the effective user ID is not the
 184 super-user.
 185 .It Bq Er EPERM
 186 The named file has its immutable or append-only flag set, see the
 187 .Xr chflags 2
 188 manual page for more information.
 189 .It Bq Er EROFS
 190 The named file resides on a read-only file system.
 191 .It Bq Er EFAULT
 192 The
 193 .Fa path
 194 argument
 195 points outside the process's allocated address space.
 196 .It Bq Er EIO
 197 An I/O error occurred while reading from or writing to the file system.
 198 .It Bq Er EINTEGRITY
 199 Corrupted data was detected while reading from the file system.
 200 .El
 201 .Pp
 202 The
 203 .Fn fchown
 204 system call will fail if:
 205 .Bl -tag -width Er
 206 .It Bq Er EBADF
 207 The
 208 .Fa fd
 209 argument
 210 does not refer to a valid descriptor.
 211 .It Bq Er EINVAL
 212 The
 213 .Fa fd
 214 argument
 215 refers to a socket, not a file.
 216 .It Bq Er EPERM
 217 The effective user ID is not the super-user.
 218 .It Bq Er EROFS
 219 The named file resides on a read-only file system.
 220 .It Bq Er EIO
 221 An I/O error occurred while reading from or writing to the file system.
 222 .It Bq Er EINTEGRITY
 223 Corrupted data was detected while reading from the file system.
 224 .El
 225 .Pp
 226 In addition to the errors specified for
 227 .Fn chown
 228 and
 229 .Fn lchown ,
 230 the
 231 .Fn fchownat
 232 system call may fail if:
 233 .Bl -tag -width Er
 234 .It Bq Er EBADF
 235 The
 236 .Fa path
 237 argument does not specify an absolute path and the
 238 .Fa fd
 239 argument is neither
 240 .Dv AT_FDCWD
 241 nor a valid file descriptor open for searching.
 242 .It Bq Er EINVAL
 243 The value of the
 244 .Fa flag
 245 argument is not valid.
 246 .It Bq Er ENOTDIR
 247 The
 248 .Fa path
 249 argument is not an absolute path and
 250 .Fa fd
 251 is neither
 252 .Dv AT_FDCWD
 253 nor a file descriptor associated with a directory.
 254 .It Bq Er ENOTCAPABLE
 255 .Fa path
 256 is an absolute path,
 257 or contained a ".." component leading to a
 258 directory outside of the directory hierarchy specified by
 259 .Fa fd ,
 260 and the process is in capability mode or the
 261 .Dv AT_RESOLVE_BENEATH
 262 flag was specified.
 263 .El
 264 .Sh SEE ALSO
 265 .Xr chgrp 1 ,
 266 .Xr chflags 2 ,
 267 .Xr chmod 2 ,
 268 .Xr flock 2 ,
 269 .Xr chown 8
 270 .Sh STANDARDS
 271 The
 272 .Fn chown
 273 system call is expected to conform to
 274 .St -p1003.1-90 .
 275 The
 276 .Fn fchownat
 277 system call follows The Open Group Extended API Set 2 specification.
 278 .Sh HISTORY
 279 The
 280 .Fn chown
 281 function appeared in
 282 .At v1 .
 283 The
 284 .Fn fchown
 285 system call appeared in
 286 .Bx 4.2 .
 287 .Pp
 288 The
 289 .Fn chown
 290 system call was changed to follow symbolic links in
 291 .Bx 4.4 .
 292 The
 293 .Fn lchown
 294 system call was added in
 295 .Fx 3.0
 296 to compensate for the loss of functionality.
 297 .Pp
 298 The
 299 .Fn fchownat
 300 system call appeared in
 301 .Fx 8.0 .