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, 2020
  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_BENEATH
 122 Only allow to change ownership of a file which is beneath of
 123 the topping directory.
 124 See the description of the
 125 .Dv O_BENEATH
 126 flag in the
 127 .Xr open 2
 128 manual page.
 129 .El
 130 .Pp
 131 If
 132 .Fn fchownat
 133 is passed the special value
 134 .Dv AT_FDCWD
 135 in the
 136 .Fa fd
 137 parameter, the current working directory is used and the behavior is identical
 138 to a call to
 139 .Fn chown
 140 or
 141 .Fn lchown
 142 respectively, depending on whether or not the
 143 .Dv AT_SYMLINK_NOFOLLOW
 144 bit is set in the
 145 .Fa flag
 146 argument.
 147 .Pp
 148 One of the owner or group id's
 149 may be left unchanged by specifying it as -1.
 150 .Sh RETURN VALUES
 151 .Rv -std
 152 .Sh ERRORS
 153 The
 154 .Fn chown
 155 and
 156 .Fn lchown
 157 will fail and the file will be unchanged if:
 158 .Bl -tag -width Er
 159 .It Bq Er ENOTDIR
 160 A component of the path prefix is not a directory.
 161 .It Bq Er ENAMETOOLONG
 162 A component of a pathname exceeded 255 characters,
 163 or an entire path name exceeded 1023 characters.
 164 .It Bq Er ENOENT
 165 The named file does not exist.
 166 .It Bq Er EACCES
 167 Search permission is denied for a component of the path prefix.
 168 .It Bq Er ELOOP
 169 Too many symbolic links were encountered in translating the pathname.
 170 .It Bq Er EPERM
 171 The operation would change the ownership, but the effective user ID is not the
 172 super-user.
 173 .It Bq Er EPERM
 174 The named file has its immutable or append-only flag set, see the
 175 .Xr chflags 2
 176 manual page for more information.
 177 .It Bq Er EROFS
 178 The named file resides on a read-only file system.
 179 .It Bq Er EFAULT
 180 The
 181 .Fa path
 182 argument
 183 points outside the process's allocated address space.
 184 .It Bq Er EIO
 185 An I/O error occurred while reading from or writing to the file system.
 186 .It Bq Er EINTEGRITY
 187 Corrupted data was detected while reading from the file system.
 188 .El
 189 .Pp
 190 The
 191 .Fn fchown
 192 system call will fail if:
 193 .Bl -tag -width Er
 194 .It Bq Er EBADF
 195 The
 196 .Fa fd
 197 argument
 198 does not refer to a valid descriptor.
 199 .It Bq Er EINVAL
 200 The
 201 .Fa fd
 202 argument
 203 refers to a socket, not a file.
 204 .It Bq Er EPERM
 205 The effective user ID is not the super-user.
 206 .It Bq Er EROFS
 207 The named file resides on a read-only file system.
 208 .It Bq Er EIO
 209 An I/O error occurred while reading from or writing to the file system.
 210 .It Bq Er EINTEGRITY
 211 Corrupted data was detected while reading from the file system.
 212 .El
 213 .Pp
 214 In addition to the errors specified for
 215 .Fn chown
 216 and
 217 .Fn lchown ,
 218 the
 219 .Fn fchownat
 220 system call may fail if:
 221 .Bl -tag -width Er
 222 .It Bq Er EBADF
 223 The
 224 .Fa path
 225 argument does not specify an absolute path and the
 226 .Fa fd
 227 argument is neither
 228 .Dv AT_FDCWD
 229 nor a valid file descriptor open for searching.
 230 .It Bq Er EINVAL
 231 The value of the
 232 .Fa flag
 233 argument is not valid.
 234 .It Bq Er ENOTDIR
 235 The
 236 .Fa path
 237 argument is not an absolute path and
 238 .Fa fd
 239 is neither
 240 .Dv AT_FDCWD
 241 nor a file descriptor associated with a directory.
 242 .It Bq Er ENOTCAPABLE
 243 .Fa path
 244 is an absolute path,
 245 or contained a ".." component leading to a
 246 directory outside of the directory hierarchy specified by
 247 .Fa fd ,
 248 and the process is in capability mode.
 249 .It Bq Er ENOTCAPABLE
 250 The
 251 .Dv AT_BENEATH
 252 flag was provided to
 253 .Fn fchownat ,
 254 and the absolute
 255 .Fa path
 256 does not have its tail fully contained under the topping directory,
 257 or the relative
 258 .Fa path
 259 escapes it.
 260 .El
 261 .Sh SEE ALSO
 262 .Xr chgrp 1 ,
 263 .Xr chflags 2 ,
 264 .Xr chmod 2 ,
 265 .Xr flock 2 ,
 266 .Xr chown 8
 267 .Sh STANDARDS
 268 The
 269 .Fn chown
 270 system call is expected to conform to
 271 .St -p1003.1-90 .
 272 The
 273 .Fn fchownat
 274 system call follows The Open Group Extended API Set 2 specification.
 275 .Sh HISTORY
 276 The
 277 .Fn chown
 278 function appeared in
 279 .At v1 .
 280 The
 281 .Fn fchown
 282 system call appeared in
 283 .Bx 4.2 .
 284 .Pp
 285 The
 286 .Fn chown
 287 system call was changed to follow symbolic links in
 288 .Bx 4.4 .
 289 The
 290 .Fn lchown
 291 system call was added in
 292 .Fx 3.0
 293 to compensate for the loss of functionality.
 294 .Pp
 295 The
 296 .Fn fchownat
 297 system call appeared in
 298 .Fx 8.0 .