lib/libcr/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. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)access.2    8.2 (Berkeley) 4/1/94
  33 .\" $FreeBSD: src/lib/libc/sys/access.2,v 1.7.2.5 2002/10/12 22:02:53 rwatson Exp $
  34 .\"
  35 .Dd April 1, 1994
  36 .Dt ACCESS 2
  37 .Os
  38 .Sh NAME
  39 .Nm access
  40 .Nd check access permissions of a file or pathname
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft int
  46 .Fn access "const char *path" "int mode"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn access
  50 function checks the accessibility of the
  51 file named by
  52 .Fa path
  53 for the access permissions indicated by
  54 .Fa mode .
  55 The value of
  56 .Fa mode
  57 is the bitwise inclusive OR of the access permissions to be
  58 checked
  59 .Pf ( Dv R_OK
  60 for read permission,
  61 .Dv W_OK
  62 for write permission and
  63 .Dv X_OK
  64 for execute/search permission) or the existence test,
  65 .Dv F_OK .
  66 All components of the pathname
  67 .Fa path
  68 are checked for access permissions (including
  69 .Dv F_OK ) .
  70 .Pp
  71 The real user ID is used in place of the effective user ID
  72 and the real group access list
  73 (including the real group ID) are
  74 used in place of the effective ID for verifying permission.
  75 .Pp
  76 Even if a process has appropriate privileges and indicates success for
  77 .Dv X_OK ,
  78 the file may not actually have execute permission bits set.
  79 Likewise for
  80 .Dv R_OK
  81 and
  82 .Dv W_OK .
  83 .Sh RETURN VALUES
  84 If
  85 .Fa path
  86 cannot be found or if any of the desired access modes would
  87 not be granted, then a -1 value is returned; otherwise
  88 a 0 value is returned.
  89 .Sh ERRORS
  90 Access to the file is denied if:
  91 .Bl -tag -width Er
  92 .It Bq Er ENOTDIR
  93 A component of the path prefix is not a directory.
  94 .It Bq Er ENAMETOOLONG
  95 A component of a pathname exceeded 255 characters,
  96 or an entire path name exceeded 1023 characters.
  97 .It Bq Er ENOENT
  98 The named file does not exist.
  99 .It Bq Er ELOOP
 100 Too many symbolic links were encountered in translating the pathname.
 101 .It Bq Er EROFS
 102 Write access is requested for a file on a read-only file system.
 103 .It Bq Er ETXTBSY
 104 Write access is requested for a pure procedure (shared text)
 105 file presently being executed.
 106 .It Bq Er EACCES
 107 Permission bits of the file mode do not permit the requested
 108 access, or search permission is denied on a component of the
 109 path prefix.  The owner of a file has permission checked with
 110 respect to the ``owner'' read, write, and execute mode bits,
 111 members of the file's group other than the owner have permission
 112 checked with respect to the ``group'' mode bits, and all
 113 others have permissions checked with respect to the ``other''
 114 mode bits.
 115 .It Bq Er EFAULT
 116 .Fa Path
 117 points outside the process's allocated address space.
 118 .It Bq Er EIO
 119 An I/O error occurred while reading from or writing to the file system.
 120 .El
 121 .Sh SEE ALSO
 122 .Xr chmod 2 ,
 123 .Xr stat 2
 124 .Sh STANDARDS
 125 The
 126 .Fn access
 127 function call is expected to conform to
 128 .St -p1003.1-90 .
 129 .Sh CAVEAT
 130 .Fn Access
 131 is a potential security hole due to race conditions and
 132 should never be used.
 133 Setuid and setgid applications should restore the effective uid or gid
 134 and perform actions directly rather than use
 135 .Fn access
 136 to simulate access checks for the real user of group id.
 137 .Sh HISTORY
 138 An
 139 .Fn access
 140 function call appeared in
 141 .At v7 .