share/man/man3sec/acl_trivial.3sec

   1 '\" te
   2 .\" Copyright 2014 Nexenta Systems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH ACL_TRIVIAL 3SEC "Nov 24, 2014"
   8 .SH NAME
   9 acl_trivial \- determine whether a file has a trivial ACL
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lsec\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <sys/acl.h>
  15
  16 \fBint\fR \fBacl_trivial\fR(\fBchar *\fR\fIpath\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .LP
  21 The \fBacl_trivial()\fR function is used to determine whether a file has a
  22 trivial ACL. Whether an ACL is trivial depends on the type of the ACL. A POSIX
  23 draft ACL is trivial if it does not have more than \fBMIN_ACL_ENTRIES\fR
  24 entries. An NFSv4/ZFS-style ACL is trivial if it does not have entries other
  25 than \fBowner@\fR, \fBgroup@\fR, and \fBeveryone@\fR, does not have inheritance
  26 flags set, and is ordered in a manner that meets POSIX access control
  27 requirements.
  28 .SH RETURN VALUES
  29 .LP
  30 Upon successful completion, \fBacl_trivial()\fR returns 0 if the file's ACL is
  31 trivial and 1 if the file's ACL is not trivial. If it could not be determined
  32 whether a file's ACL is trivial, -1 is returned and \fBerrno\fR is set to
  33 indicate the error.
  34 .SH ERRORS
  35 .LP
  36 The \fBacl_trivial()\fR function will fail if:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBEACCES\fR\fR
  41 .ad
  42 .RS 10n
  43 A file's ACL could not be read.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBENOENT\fR\fR
  50 .ad
  51 .RS 10n
  52 A component of \fIpath\fR does not name an existing file or \fIpath\fR is an
  53 empty string.
  54 .RE
  55
  56 .SH ATTRIBUTES
  57 .LP
  58 See \fBattributes\fR(5) for descriptions of the following attributes:
  59 .sp
  60
  61 .sp
  62 .TS
  63 box;
  64 c | c
  65 l | l .
  66 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  67 _
  68 Interface Stability     Evolving
  69 _
  70 MT-Level        MT-Safe
  71 .TE
  72
  73 .SH SEE ALSO
  74 .LP
  75 \fBacl\fR(5), \fBattributes\fR(5)