lib/libc/sys/access.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 .\"     @(#)access.2    8.2 (Berkeley) 4/1/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd March 30, 2020
  32 .Dt ACCESS 2
  33 .Os
  34 .Sh NAME
  35 .Nm access ,
  36 .Nm eaccess ,
  37 .Nm faccessat
  38 .Nd check accessibility of a file
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In unistd.h
  43 .Ft int
  44 .Fn access "const char *path" "int mode"
  45 .Ft int
  46 .Fn eaccess "const char *path" "int mode"
  47 .Ft int
  48 .Fn faccessat "int fd" "const char *path" "int mode" "int flag"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn access
  52 and
  53 .Fn eaccess
  54 system calls check the accessibility of the
  55 file named by
  56 the
  57 .Fa path
  58 argument
  59 for the access permissions indicated by
  60 the
  61 .Fa mode
  62 argument.
  63 The value of
  64 .Fa mode
  65 is either the bitwise-inclusive OR of the access permissions to be
  66 checked
  67 .Dv ( R_OK
  68 for read permission,
  69 .Dv W_OK
  70 for write permission, and
  71 .Dv X_OK
  72 for execute/search permission),
  73 or the existence test
  74 .Pq Dv F_OK .
  75 .Pp
  76 For additional information, see the
  77 .Sx "File Access Permission"
  78 section of
  79 .Xr intro 2 .
  80 .Pp
  81 The
  82 .Fn eaccess
  83 system call uses
  84 the effective user ID and the group access list
  85 to authorize the request;
  86 the
  87 .Fn access
  88 system call uses
  89 the real user ID in place of the effective user ID,
  90 the real group ID in place of the effective group ID,
  91 and the rest of the group access list.
  92 .Pp
  93 The
  94 .Fn faccessat
  95 system call is equivalent to
  96 .Fn access
  97 except in the case where
  98 .Fa path
  99 specifies a relative path.
 100 In this case the file whose accessibility is to be determined is
 101 located relative to the directory associated with the file descriptor
 102 .Fa fd
 103 instead of the current working directory.
 104 If
 105 .Fn faccessat
 106 is passed the special value
 107 .Dv AT_FDCWD
 108 in the
 109 .Fa fd
 110 parameter, the current working directory is used and the behavior is
 111 identical to a call to
 112 .Fn access .
 113 Values for
 114 .Fa flag
 115 are constructed by a bitwise-inclusive OR of flags from the following
 116 list, defined in
 117 .In fcntl.h :
 118 .Bl -tag -width indent
 119 .It Dv AT_EACCESS
 120 The checks for accessibility are performed using the effective user and group
 121 IDs instead of the real user and group ID as required in a call to
 122 .Fn access .
 123 .It Dv AT_BENEATH
 124 Only operate on files and directories below the topping directory.
 125 See the description of the
 126 .Dv O_BENEATH
 127 flag in the
 128 .Xr open 2
 129 manual page.
 130 .El
 131 .Pp
 132 Even if a process's real or effective user has appropriate privileges
 133 and indicates success for
 134 .Dv X_OK ,
 135 the file may not actually have execute permission bits set.
 136 Likewise for
 137 .Dv R_OK
 138 and
 139 .Dv W_OK .
 140 .Sh RETURN VALUES
 141 .Rv -std
 142 .Sh ERRORS
 143 .Fn access ,
 144 .Fn eaccess ,
 145 or
 146 .Fn faccessat
 147 will fail if:
 148 .Bl -tag -width Er
 149 .It Bq Er EINVAL
 150 The value of the
 151 .Fa mode
 152 argument is invalid.
 153 .It Bq Er ENOTDIR
 154 A component of the path prefix is not a directory.
 155 .It Bq Er ENAMETOOLONG
 156 A component of a pathname exceeded 255 characters,
 157 or an entire path name exceeded 1023 characters.
 158 .It Bq Er ENOENT
 159 The named file does not exist.
 160 .It Bq Er ELOOP
 161 Too many symbolic links were encountered in translating the pathname.
 162 .It Bq Er EROFS
 163 Write access is requested for a file on a read-only file system.
 164 .It Bq Er ETXTBSY
 165 Write access is requested for a pure procedure (shared text)
 166 file presently being executed.
 167 .It Bq Er EACCES
 168 Permission bits of the file mode do not permit the requested
 169 access, or search permission is denied on a component of the
 170 path prefix.
 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 Also, the
 183 .Fn faccessat
 184 system call may fail if:
 185 .Bl -tag -width Er
 186 .It Bq Er EBADF
 187 The
 188 .Fa path
 189 argument does not specify an absolute path and the
 190 .Fa fd
 191 argument is
 192 neither
 193 .Dv AT_FDCWD
 194 nor a valid file descriptor.
 195 .It Bq Er EINVAL
 196 The value of the
 197 .Fa flag
 198 argument is not valid.
 199 .It Bq Er ENOTDIR
 200 The
 201 .Fa path
 202 argument is not an absolute path and
 203 .Fa fd
 204 is neither
 205 .Dv AT_FDCWD
 206 nor a file descriptor associated with a directory.
 207 .It Bq Er ENOTCAPABLE
 208 .Fa path
 209 is an absolute path,
 210 or contained a ".." component leading to a
 211 directory outside of the directory hierarchy specified by
 212 .Fa fd ,
 213 and the process is in capability mode.
 214 .It Bq Er ENOTCAPABLE
 215 The
 216 .Dv AT_BENEATH
 217 flag was provided to
 218 .Fn faccessat ,
 219 and the absolute
 220 .Fa path
 221 does not have its tail fully contained under the topping directory,
 222 or the relative
 223 .Fa path
 224 escapes it.
 225 .El
 226 .Sh SEE ALSO
 227 .Xr chmod 2 ,
 228 .Xr intro 2 ,
 229 .Xr stat 2
 230 .Sh STANDARDS
 231 The
 232 .Fn access
 233 system call is expected to conform to
 234 .St -p1003.1-90 .
 235 The
 236 .Fn faccessat
 237 system call follows The Open Group Extended API Set 2 specification.
 238 .Sh HISTORY
 239 The
 240 .Fn access
 241 function appeared in
 242 .At v7 .
 243 The
 244 .Fn faccessat
 245 system call appeared in
 246 .Fx 8.0 .
 247 .Sh SECURITY CONSIDERATIONS
 248 The
 249 .Fn access
 250 system call
 251 is a potential security hole due to race conditions and
 252 should never be used.
 253 Set-user-ID and set-group-ID applications should restore the
 254 effective user or group ID,
 255 and perform actions directly rather than use
 256 .Fn access
 257 to simulate access checks for the real user or group ID.
 258 The
 259 .Fn eaccess
 260 system call
 261 likewise may be subject to races if used inappropriately.
 262 .Pp
 263 .Fn access
 264 remains useful for providing clues to users as to whether operations
 265 make sense for particular filesystem objects (e.g. 'delete' menu
 266 item only highlighted in a writable folder ... avoiding interpretation
 267 of the st_mode bits that the application might not understand --
 268 e.g. in the case of AFS).
 269 It also allows a cheaper file existence test than
 270 .Xr stat 2 .