original/man2/faccessat.2

   1 .\" This manpage is Copyright (C) 2006, Michael Kerrisk
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH FACCESSAT 2 2012-05-04 "Linux" "Linux Programmer's Manual"
  26 .SH NAME
  27 faccessat \- check user's permissions of a file relative to a \
  28 directory file descriptor
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <fcntl.h>           /* Definition of AT_* constants */
  32 .B #include <unistd.h>
  33 .sp
  34 .BI "int faccessat(int " dirfd ", const char *" pathname ", int " \
  35 mode ", int " flags );
  36 .fi
  37 .sp
  38 .in -4n
  39 Feature Test Macro Requirements for glibc (see
  40 .BR feature_test_macros (7)):
  41 .in
  42 .sp
  43 .BR faccessat ():
  44 .PD 0
  45 .ad l
  46 .RS 4
  47 .TP 4
  48 Since glibc 2.10:
  49 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  50 .TP
  51 Before glibc 2.10:
  52 _ATFILE_SOURCE
  53 .RE
  54 .ad
  55 .PD
  56 .SH DESCRIPTION
  57 The
  58 .BR faccessat ()
  59 system call operates in exactly the same way as
  60 .BR access (2),
  61 except for the differences described in this manual page.
  62
  63 If the pathname given in
  64 .I pathname
  65 is relative, then it is interpreted relative to the directory
  66 referred to by the file descriptor
  67 .I dirfd
  68 (rather than relative to the current working directory of
  69 the calling process, as is done by
  70 .BR access (2)
  71 for a relative pathname).
  72
  73 If
  74 .I pathname
  75 is relative and
  76 .I dirfd
  77 is the special value
  78 .BR AT_FDCWD ,
  79 then
  80 .I pathname
  81 is interpreted relative to the current working
  82 directory of the calling process (like
  83 .BR access (2)).
  84
  85 If
  86 .I pathname
  87 is absolute, then
  88 .I dirfd
  89 is ignored.
  90
  91 .I flags
  92 is constructed by ORing together zero or more of the following values:
  93 .TP
  94 .B AT_EACCESS
  95 Perform access checks using the effective user and group IDs.
  96 By default,
  97 .BR faccessat ()
  98 uses the real IDs (like
  99 .BR access (2)).
 100 .TP
 101 .B AT_SYMLINK_NOFOLLOW
 102 If
 103 .I pathname
 104 is a symbolic link, do not dereference it:
 105 instead return information about the link itself.
 106 .SH RETURN VALUE
 107 On success, (all requested permissions granted)
 108 .BR faccessat ()
 109 returns 0.
 110 On error, \-1 is returned and
 111 .I errno
 112 is set to indicate the error.
 113 .SH ERRORS
 114 The same errors that occur for
 115 .BR access (2)
 116 can also occur for
 117 .BR faccessat ().
 118 The following additional errors can occur for
 119 .BR faccessat ():
 120 .TP
 121 .B EBADF
 122 .I dirfd
 123 is not a valid file descriptor.
 124 .TP
 125 .B EINVAL
 126 Invalid flag specified in
 127 .IR flags .
 128 .TP
 129 .B ENOTDIR
 130 .I pathname
 131 is relative and
 132 .I dirfd
 133 is a file descriptor referring to a file other than a directory.
 134 .SH VERSIONS
 135 .BR faccessat ()
 136 was added to Linux in kernel 2.6.16;
 137 library support was added to glibc in version 2.4.
 138 .SH CONFORMING TO
 139 POSIX.1-2008.
 140 .SH NOTES
 141 See
 142 .BR openat (2)
 143 for an explanation of the need for
 144 .BR faccessat ().
 145
 146 .IR Warning :
 147 .BR faccessat ()
 148 is subject to the same kinds of races as
 149 .BR access (2)
 150 and
 151 .BR euidaccess (3).
 152 .SS Glibc notes
 153 The
 154 .B AT_EACCESS
 155 and
 156 .B AT_SYMLINK_NOFOLLOW
 157 flags are actually implemented within the glibc wrapper function for
 158 .BR faccessat ().
 159 If either of these flags are specified, then the wrapper function employs
 160 .BR fstatat (2)
 161 to determine access permissions.
 162 .SH SEE ALSO
 163 .BR access (2),
 164 .BR openat (2),
 165 .BR euidaccess (3),
 166 .BR credentials (7),
 167 .BR path_resolution (7),
 168 .BR symlink (7)