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