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 October 20, 2018
  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 starting directory.
 125 .El
 126 .Pp
 127 Even if a process's real or effective user has appropriate privileges
 128 and indicates success for
 129 .Dv X_OK ,
 130 the file may not actually have execute permission bits set.
 131 Likewise for
 132 .Dv R_OK
 133 and
 134 .Dv W_OK .
 135 .Sh RETURN VALUES
 136 .Rv -std
 137 .Sh ERRORS
 138 .Fn access ,
 139 .Fn eaccess ,
 140 or
 141 .Fn faccessat
 142 will fail if:
 143 .Bl -tag -width Er
 144 .It Bq Er EINVAL
 145 The value of the
 146 .Fa mode
 147 argument is invalid.
 148 .It Bq Er ENOTDIR
 149 A component of the path prefix is not a directory.
 150 .It Bq Er ENAMETOOLONG
 151 A component of a pathname exceeded 255 characters,
 152 or an entire path name exceeded 1023 characters.
 153 .It Bq Er ENOENT
 154 The named file does not exist.
 155 .It Bq Er ELOOP
 156 Too many symbolic links were encountered in translating the pathname.
 157 .It Bq Er EROFS
 158 Write access is requested for a file on a read-only file system.
 159 .It Bq Er ETXTBSY
 160 Write access is requested for a pure procedure (shared text)
 161 file presently being executed.
 162 .It Bq Er EACCES
 163 Permission bits of the file mode do not permit the requested
 164 access, or search permission is denied on a component of the
 165 path prefix.
 166 .It Bq Er EFAULT
 167 The
 168 .Fa path
 169 argument
 170 points outside the process's allocated address space.
 171 .It Bq Er EIO
 172 An I/O error occurred while reading from or writing to the file system.
 173 .El
 174 .Pp
 175 Also, the
 176 .Fn faccessat
 177 system call may fail if:
 178 .Bl -tag -width Er
 179 .It Bq Er EBADF
 180 The
 181 .Fa path
 182 argument does not specify an absolute path and the
 183 .Fa fd
 184 argument is
 185 neither
 186 .Dv AT_FDCWD
 187 nor a valid file descriptor.
 188 .It Bq Er EINVAL
 189 The value of the
 190 .Fa flag
 191 argument is not valid.
 192 .It Bq Er ENOTDIR
 193 The
 194 .Fa path
 195 argument is not an absolute path and
 196 .Fa fd
 197 is neither
 198 .Dv AT_FDCWD
 199 nor a file descriptor associated with a directory.
 200 .It Bq Er ENOTCAPABLE
 201 The
 202 .Dv AT_BENEATH
 203 flag was specified but
 204 .Fa path
 205 is not strictly relative to the starting directory.
 206 For example,
 207 .Fa path
 208 is absolute or includes a ".." component that escapes the starting directory.
 209 .El
 210 .Sh SEE ALSO
 211 .Xr chmod 2 ,
 212 .Xr intro 2 ,
 213 .Xr stat 2
 214 .Sh STANDARDS
 215 The
 216 .Fn access
 217 system call is expected to conform to
 218 .St -p1003.1-90 .
 219 The
 220 .Fn faccessat
 221 system call follows The Open Group Extended API Set 2 specification.
 222 .Sh HISTORY
 223 The
 224 .Fn access
 225 function appeared in
 226 .At v7 .
 227 The
 228 .Fn faccessat
 229 system call appeared in
 230 .Fx 8.0 .
 231 .Sh SECURITY CONSIDERATIONS
 232 The
 233 .Fn access
 234 system call
 235 is a potential security hole due to race conditions and
 236 should never be used.
 237 Set-user-ID and set-group-ID applications should restore the
 238 effective user or group ID,
 239 and perform actions directly rather than use
 240 .Fn access
 241 to simulate access checks for the real user or group ID.
 242 The
 243 .Fn eaccess
 244 system call
 245 likewise may be subject to races if used inappropriately.
 246 .Pp
 247 .Fn access
 248 remains useful for providing clues to users as to whether operations
 249 make sense for particular filesystem objects (e.g. 'delete' menu
 250 item only highlighted in a writable folder ... avoiding interpretation
 251 of the st_mode bits that the application might not understand --
 252 e.g. in the case of AFS).
 253 It also allows a cheaper file existence test than
 254 .Xr stat 2 .