original/man2/access.2

   1 .\" This manpage is Copyright (C) 1992 Drew Eckhardt;
   2 .\"             and Copyright (C) 1993 Michael Haardt, Ian Jackson.
   3 .\" and Copyright (C) 2004, 2006, 2007, 2014 Michael Kerrisk <mtk.manpages@gmail.com>
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .\"
  27 .\" Modified 1993-07-21 Rik Faith (faith@cs.unc.edu)
  28 .\" Modified 1994-08-21 by Michael Chastain (mec@shell.portal.com):
  29 .\"   Removed note about old kernel (pre-1.1.44) using wrong id on path.
  30 .\" Modified 1996-03-18 by Martin Schulze (joey@infodrom.north.de):
  31 .\"   Stated more clearly how it behaves with symbolic links.
  32 .\" Added correction due to Nick Duffek (nsd@bbc.com), aeb, 960426
  33 .\" Modified 1996-09-07 by Michael Haardt:
  34 .\"   Restrictions for NFS
  35 .\" Modified 1997-09-09 by Joseph S. Myers <jsm28@cam.ac.uk>
  36 .\" Modified 1998-01-13 by Michael Haardt:
  37 .\"   Using access is often insecure
  38 .\" Modified 2001-10-16 by aeb
  39 .\" Modified 2002-04-23 by Roger Luethi <rl@hellgate.ch>
  40 .\" Modified 2004-06-23 by Michael Kerrisk
  41 .\" 2007-06-10, mtk, various parts rewritten, and added BUGS section.
  42 .\"
  43 .TH ACCESS 2 2014-02-21 "Linux" "Linux Programmer's Manual"
  44 .SH NAME
  45 access, faccessat \- check user's permissions for a file
  46 .SH SYNOPSIS
  47 .nf
  48 .B #include <unistd.h>
  49 .sp
  50 .BI "int access(const char *" pathname ", int " mode );
  51
  52 .BR "#include <fcntl.h>           " "/* Definition of AT_* constants */"
  53 .B #include <unistd.h>
  54 .sp
  55 .BI "int faccessat(int " dirfd ", const char *" pathname ", int " \
  56 mode ", int " flags );
  57 .fi
  58 .sp
  59 .in -4n
  60 Feature Test Macro Requirements for glibc (see
  61 .BR feature_test_macros (7)):
  62 .in
  63 .sp
  64 .BR faccessat ():
  65 .PD 0
  66 .ad l
  67 .RS 4
  68 .TP 4
  69 Since glibc 2.10:
  70 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  71 .TP
  72 Before glibc 2.10:
  73 _ATFILE_SOURCE
  74 .RE
  75 .ad
  76 .PD
  77 .fi
  78 .SH DESCRIPTION
  79 .BR access ()
  80 checks whether the calling process can access the file
  81 .IR pathname .
  82 If
  83 .I pathname
  84 is a symbolic link, it is dereferenced.
  85
  86 The
  87 .I mode
  88 specifies the accessibility check(s) to be performed,
  89 and is either the value
  90 .BR F_OK ,
  91 .\" F_OK is defined as 0 on every system that I know of.
  92 or a mask consisting of the bitwise OR of one or more of
  93 .BR R_OK ", " W_OK ", and " X_OK .
  94 .B F_OK
  95 tests for the existence of the file.
  96 .BR R_OK ", " W_OK ", and " X_OK
  97 test whether the file exists and grants read, write, and
  98 execute permissions, respectively.
  99
 100 The check is done using the calling process's
 101 .I real
 102 UID and GID, rather than the effective IDs as is done when
 103 actually attempting an operation (e.g.,
 104 .BR open (2))
 105 on the file.
 106 This allows set-user-ID programs to
 107 easily determine the invoking user's authority.
 108
 109 If the calling process is privileged (i.e., its real UID is zero),
 110 then an
 111 .B X_OK
 112 check is successful for a regular file if execute permission
 113 is enabled for any of the file owner, group, or other.
 114 .SS faccessat()
 115 The
 116 .BR faccessat ()
 117 system call operates in exactly the same way as
 118 .BR access (),
 119 except for the differences described here.
 120
 121 If the pathname given in
 122 .I pathname
 123 is relative, then it is interpreted relative to the directory
 124 referred to by the file descriptor
 125 .I dirfd
 126 (rather than relative to the current working directory of
 127 the calling process, as is done by
 128 .BR access ()
 129 for a relative pathname).
 130
 131 If
 132 .I pathname
 133 is relative and
 134 .I dirfd
 135 is the special value
 136 .BR AT_FDCWD ,
 137 then
 138 .I pathname
 139 is interpreted relative to the current working
 140 directory of the calling process (like
 141 .BR access ()).
 142
 143 If
 144 .I pathname
 145 is absolute, then
 146 .I dirfd
 147 is ignored.
 148
 149 .I flags
 150 is constructed by ORing together zero or more of the following values:
 151 .TP
 152 .B AT_EACCESS
 153 Perform access checks using the effective user and group IDs.
 154 By default,
 155 .BR faccessat ()
 156 uses the real IDs (like
 157 .BR access ()).
 158 .TP
 159 .B AT_SYMLINK_NOFOLLOW
 160 If
 161 .I pathname
 162 is a symbolic link, do not dereference it:
 163 instead return information about the link itself.
 164 .PP
 165 See
 166 .BR openat (2)
 167 for an explanation of the need for
 168 .BR faccessat ().
 169 .SH "RETURN VALUE"
 170 On success (all requested permissions granted, or
 171 .I mode
 172 is
 173 .B F_OK
 174 and the file exists), zero is returned.
 175 On error (at least one bit in
 176 .I mode
 177 asked for a permission that is denied, or
 178 .I mode
 179 is
 180 .B F_OK
 181 and the file does not exist, or some other error occurred),
 182 \-1 is returned, and
 183 .I errno
 184 is set appropriately.
 185 .SH ERRORS
 186 .BR access ()
 187 and
 188 .BR faccessat ()
 189 shall fail if:
 190 .TP
 191 .B EACCES
 192 The requested access would be denied to the file, or search permission
 193 is denied for one of the directories in the path prefix of
 194 .IR pathname .
 195 (See also
 196 .BR path_resolution (7).)
 197 .TP
 198 .B ELOOP
 199 Too many symbolic links were encountered in resolving
 200 .IR pathname .
 201 .TP
 202 .B ENAMETOOLONG
 203 .I pathname
 204 is too long.
 205 .TP
 206 .B ENOENT
 207 A component of
 208 .I pathname
 209 does not exist or is a dangling symbolic link.
 210 .TP
 211 .B ENOTDIR
 212 A component used as a directory in
 213 .I pathname
 214 is not, in fact, a directory.
 215 .TP
 216 .B EROFS
 217 Write permission was requested for a file on a read-only filesystem.
 218 .PP
 219 .BR access ()
 220 and
 221 .BR faccessat ()
 222 may fail if:
 223 .TP
 224 .B EFAULT
 225 .I pathname
 226 points outside your accessible address space.
 227 .TP
 228 .B EINVAL
 229 .I mode
 230 was incorrectly specified.
 231 .TP
 232 .B EIO
 233 An I/O error occurred.
 234 .TP
 235 .B ENOMEM
 236 Insufficient kernel memory was available.
 237 .TP
 238 .B ETXTBSY
 239 Write access was requested to an executable which is being
 240 executed.
 241 .PP
 242 The following additional errors can occur for
 243 .BR faccessat ():
 244 .TP
 245 .B EBADF
 246 .I dirfd
 247 is not a valid file descriptor.
 248 .TP
 249 .B EINVAL
 250 Invalid flag specified in
 251 .IR flags .
 252 .TP
 253 .B ENOTDIR
 254 .I pathname
 255 is relative and
 256 .I dirfd
 257 is a file descriptor referring to a file other than a directory.
 258 .SH VERSIONS
 259 .BR faccessat ()
 260 was added to Linux in kernel 2.6.16;
 261 library support was added to glibc in version 2.4.
 262 .SH "CONFORMING TO"
 263 .BR access ():
 264 SVr4, 4.3BSD, POSIX.1-2001, POSIX.1-2008.
 265
 266 .BR faccessat ():
 267 POSIX.1-2008.
 268 .SH NOTES
 269 .PP
 270 .BR Warning :
 271 Using these calls to check if a user is authorized to, for example,
 272 open a file before actually doing so using
 273 .BR open (2)
 274 creates a security hole, because the user might exploit the short time
 275 interval between checking and opening the file to manipulate it.
 276 .BR "For this reason, the use of this system call should be avoided" .
 277 (In the example just described,
 278 a safer alternative would be to temporarily switch the process's
 279 effective user ID to the real ID and then call
 280 .BR open (2).)
 281 .PP
 282 .BR access ()
 283 always dereferences symbolic links.
 284 If you need to check the permissions on a symbolic link, use
 285 .BR faccessat (2)
 286 with the flag
 287 .BR AT_SYMLINK_NOFOLLOW .
 288 .PP
 289 These calls return an error if any of the access types in
 290 .I mode
 291 is denied, even if some of the other access types in
 292 .I mode
 293 are permitted.
 294 .PP
 295 If the calling process has appropriate privileges (i.e., is superuser),
 296 POSIX.1-2001 permits an implementation to indicate success for an
 297 .B X_OK
 298 check even if none of the execute file permission bits are set.
 299 .\" HPU-UX 11 and Tru64 5.1 do this.
 300 Linux does not do this.
 301 .PP
 302 A file is accessible only if the permissions on each of the
 303 directories in the path prefix of
 304 .I pathname
 305 grant search (i.e., execute) access.
 306 If any directory is inaccessible, then the
 307 .BR access ()
 308 call will fail, regardless of the permissions on the file itself.
 309 .PP
 310 Only access bits are checked, not the file type or contents.
 311 Therefore, if a directory is found to be writable,
 312 it probably means that files can be created in the directory,
 313 and not that the directory can be written as a file.
 314 Similarly, a DOS file may be found to be "executable," but the
 315 .BR execve (2)
 316 call will still fail.
 317 .PP
 318 These calls
 319 may not work correctly on NFSv2 filesystems with UID mapping enabled,
 320 because UID mapping is done on the server and hidden from the client,
 321 which checks permissions.  (NFS versions 3 and higher perform the check on
 322 the server.)
 323 Similar problems can occur to FUSE mounts.
 324 .\"
 325 .\"
 326 .SS faccessat ()
 327 The raw
 328 .BR faccessat ()
 329 system call takes only the first three arguments.
 330 The
 331 .B AT_EACCESS
 332 and
 333 .B AT_SYMLINK_NOFOLLOW
 334 flags are actually implemented within the glibc wrapper function for
 335 .BR faccessat ().
 336 If either of these flags is specified, then the wrapper function employs
 337 .BR fstatat (2)
 338 to determine access permissions.
 339 .SH BUGS
 340 In kernel 2.4 (and earlier) there is some strangeness in the handling of
 341 .B X_OK
 342 tests for superuser.
 343 If all categories of execute permission are disabled
 344 for a nondirectory file, then the only
 345 .BR access ()
 346 test that returns \-1 is when
 347 .I mode
 348 is specified as just
 349 .BR X_OK ;
 350 if
 351 .B R_OK
 352 or
 353 .B W_OK
 354 is also specified in
 355 .IR mode ,
 356 then
 357 .BR access ()
 358 returns 0 for such files.
 359 .\" This behavior appears to have been an implementation accident.
 360 Early 2.6 kernels (up to and including 2.6.3)
 361 also behaved in the same way as kernel 2.4.
 362
 363 In kernels before 2.6.20,
 364 these calls ignored the effect of the
 365 .B MS_NOEXEC
 366 flag if it was used to
 367 .BR mount (2)
 368 the underlying filesystem.
 369 Since kernel 2.6.20, the
 370 .B MS_NOEXEC
 371 is honored
 372 .SH "SEE ALSO"
 373 .BR chmod (2),
 374 .BR chown (2),
 375 .BR open (2),
 376 .BR setgid (2),
 377 .BR setuid (2),
 378 .BR stat (2),
 379 .BR euidaccess (3),
 380 .BR credentials (7),
 381 .BR path_resolution (7),
 382 .BR symlink (7)
 383 .SH COLOPHON
 384 This page is part of release 3.67 of the Linux
 385 .I man-pages
 386 project.
 387 A description of the project,
 388 information about reporting bugs,
 389 and the latest version of this page,
 390 can be found at
 391 \%http://www.kernel.org/doc/man\-pages/.