]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - lib/libc/sys/access.2
MFV r357608: Limit memory usage in xz(1) instead of in tuklib.
[FreeBSD/FreeBSD.git] / 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 November 11, 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 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 .El
179 .Pp
180 Also, the
181 .Fn faccessat
182 system call may fail if:
183 .Bl -tag -width Er
184 .It Bq Er EBADF
185 The
186 .Fa path
187 argument does not specify an absolute path and the
188 .Fa fd
189 argument is
190 neither
191 .Dv AT_FDCWD
192 nor a valid file descriptor.
193 .It Bq Er EINVAL
194 The value of the
195 .Fa flag
196 argument is not valid.
197 .It Bq Er ENOTDIR
198 The
199 .Fa path
200 argument is not an absolute path and
201 .Fa fd
202 is neither
203 .Dv AT_FDCWD
204 nor a file descriptor associated with a directory.
205 .It Bq Er ENOTCAPABLE
206 .Fa path
207 is an absolute path,
208 or contained a ".." component leading to a
209 directory outside of the directory hierarchy specified by
210 .Fa fd ,
211 and the process is in capability mode.
212 .It Bq Er ENOTCAPABLE
213 The
214 .Dv AT_BENEATH
215 flag was provided to
216 .Fn faccessat ,
217 and the absolute
218 .Fa path
219 does not have its tail fully contained under the topping directory,
220 or the relative
221 .Fa path
222 escapes it.
223 .El
224 .Sh SEE ALSO
225 .Xr chmod 2 ,
226 .Xr intro 2 ,
227 .Xr stat 2
228 .Sh STANDARDS
229 The
230 .Fn access
231 system call is expected to conform to
232 .St -p1003.1-90 .
233 The
234 .Fn faccessat
235 system call follows The Open Group Extended API Set 2 specification.
236 .Sh HISTORY
237 The
238 .Fn access
239 function appeared in
240 .At v7 .
241 The
242 .Fn faccessat
243 system call appeared in
244 .Fx 8.0 .
245 .Sh SECURITY CONSIDERATIONS
246 The
247 .Fn access
248 system call
249 is a potential security hole due to race conditions and
250 should never be used.
251 Set-user-ID and set-group-ID applications should restore the
252 effective user or group ID,
253 and perform actions directly rather than use
254 .Fn access
255 to simulate access checks for the real user or group ID.
256 The
257 .Fn eaccess
258 system call
259 likewise may be subject to races if used inappropriately.
260 .Pp
261 .Fn access
262 remains useful for providing clues to users as to whether operations
263 make sense for particular filesystem objects (e.g. 'delete' menu
264 item only highlighted in a writable folder ... avoiding interpretation
265 of the st_mode bits that the application might not understand --
266 e.g. in the case of AFS).
267 It also allows a cheaper file existence test than
268 .Xr stat 2 .