share/man/man3sec/aclcheck.3sec

   1 '\" te
   2 .\" Copyright (c) 2001, Sun Microsystems, Inc.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH ACLCHECK 3SEC "Dec 10, 2001"
   7 .SH NAME
   8 aclcheck \- check the validity of an ACL
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lsec\fR [ \fIlibrary\fR... ]
  13 #include <sys/acl.h>
  14
  15 \fBint\fR \fBaclcheck\fR(\fBaclent_t *\fR\fIaclbufp\fR, \fBint\fR \fInentries\fR, \fBint *\fR\fIwhich\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBaclcheck()\fR function checks the validity of an \fBACL\fR pointed to by
  22 \fIaclbufp.\fR The \fInentries\fR argument is the number of entries contained
  23 in the buffer. The \fIwhich\fR parameter returns the index of the first entry
  24 that is invalid.
  25 .sp
  26 .LP
  27 The function verifies that an \fBACL\fR pointed to by \fIaclbufp\fR is valid
  28 according to the following rules:
  29 .RS +4
  30 .TP
  31 .ie t \(bu
  32 .el o
  33 There must be exactly one \fBGROUP_OBJ\fR \fBACL\fR entry.
  34 .RE
  35 .RS +4
  36 .TP
  37 .ie t \(bu
  38 .el o
  39 There must be exactly one \fBUSER_OBJ\fR \fBACL\fR entry.
  40 .RE
  41 .RS +4
  42 .TP
  43 .ie t \(bu
  44 .el o
  45 There must be exactly one \fBOTHER_OBJ\fR \fBACL\fR entry.
  46 .RE
  47 .RS +4
  48 .TP
  49 .ie t \(bu
  50 .el o
  51 If there are any \fBGROUP\fR \fBACL\fR entries, then the group \fBID\fR in each
  52 group \fBACL\fR entry must be unique.
  53 .RE
  54 .RS +4
  55 .TP
  56 .ie t \(bu
  57 .el o
  58 If there are any \fBUSER\fR \fBACL\fR entries, then the user \fBID\fR in each
  59 user \fBACL\fR entry must be unique.
  60 .RE
  61 .RS +4
  62 .TP
  63 .ie t \(bu
  64 .el o
  65 If there are any \fBGROUP\fR or \fBUSER\fR \fBACL\fR entries, then there must
  66 be exactly one \fBCLASS_OBJ\fR (\fBACL\fR mask) entry.
  67 .RE
  68 .RS +4
  69 .TP
  70 .ie t \(bu
  71 .el o
  72 If there are any default \fBACL\fR entries, then the following apply:
  73 .RS +4
  74 .TP
  75 .ie t \(bu
  76 .el o
  77 There must be exactly one default \fBGROUP_OBJ\fR \fBACL\fR entry.
  78 .RE
  79 .RS +4
  80 .TP
  81 .ie t \(bu
  82 .el o
  83 There must be exactly one default \fBOTHER_OBJ\fR \fBACL\fR entry.
  84 .RE
  85 .RS +4
  86 .TP
  87 .ie t \(bu
  88 .el o
  89 There must be exactly one default \fBUSER_OBJ\fR \fBACL\fR entry.
  90 .RE
  91 .RS +4
  92 .TP
  93 .ie t \(bu
  94 .el o
  95 If there are any \fBDEF_GROUP\fR entries, then the group \fBID\fR in each
  96 \fBDEF_GROUP\fR \fBACL\fR entry must be unique.
  97 .RE
  98 .RS +4
  99 .TP
 100 .ie t \(bu
 101 .el o
 102 If there are any \fBDEF_USER\fR entries, then the user \fBID\fR in each
 103 \fBDEF_USER\fR \fBACL\fR entry must be unique.
 104 .RE
 105 .RS +4
 106 .TP
 107 .ie t \(bu
 108 .el o
 109 If there are any \fBDEF_GROUP\fR or \fBDEF_USER\fR entries, then there must be
 110 exactly one \fBDEF_CLASS_OBJ\fR (default \fBACL\fR mask) entry.
 111 .RE
 112 .RE
 113 .RS +4
 114 .TP
 115 .ie t \(bu
 116 .el o
 117 If any of the above rules are violated, then the function fails with
 118 \fBerrno\fR set to  \fBEINVAL\fR.
 119 .RE
 120 .SH RETURN VALUES
 121 .sp
 122 .LP
 123 If the \fBACL\fR is valid, \fBalcheck()\fR will return \fB0\fR. Otherwise
 124 \fBerrno\fR is set to \fBEINVAL\fR and return code is set to one of the
 125 following:
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fBGRP_ERROR\fR\fR
 130 .ad
 131 .RS 19n
 132 There is more than one \fBGROUP_OBJ\fR or \fBDEF_GROUP_OBJ\fR \fBACL\fR entry.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBUSER_ERROR\fR\fR
 139 .ad
 140 .RS 19n
 141 There is more than one \fBUSER_OBJ\fR or \fBDEF_USER_OBJ\fR \fBACL\fR entry.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBCLASS_ERROR\fR\fR
 148 .ad
 149 .RS 19n
 150 There is more than one \fBCLASS_OBJ\fR (\fBACL\fR mask) or \fBDEF_CLASS_OBJ\fR
 151 (default \fBACL\fR mask) entry.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fBOTHER_ERROR\fR\fR
 158 .ad
 159 .RS 19n
 160 There is more than one \fBOTHER_OBJ\fR or \fBDEF_OTHER_OBJ\fR \fBACL\fR entry.
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fBDUPLICATE_ERROR\fR\fR
 167 .ad
 168 .RS 19n
 169 Duplicate entries of \fBUSER\fR, \fBGROUP\fR, \fBDEF_USER\fR, or
 170 \fBDEF_GROUP\fR.
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fBENTRY_ERROR\fR\fR
 177 .ad
 178 .RS 19n
 179 The entry type is invalid.
 180 .RE
 181
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fBMISS_ERROR\fR\fR
 186 .ad
 187 .RS 19n
 188 Missing an entry. The \fIwhich\fR parameter returns \fB\(mi1\fR in this case.
 189 .RE
 190
 191 .sp
 192 .ne 2
 193 .na
 194 \fB\fBMEM_ERROR\fR\fR
 195 .ad
 196 .RS 19n
 197 The system cannot allocate any memory. The \fBwhich\fR parameter returns
 198 \fB\(mi1\fR in this case.
 199 .RE
 200
 201 .SH ATTRIBUTES
 202 .sp
 203 .LP
 204 See \fBattributes\fR(5) for descriptions of the following attributes:
 205 .sp
 206
 207 .sp
 208 .TS
 209 box;
 210 c | c
 211 l | l .
 212 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 213 _
 214 Interface Stability     Evolving
 215 _
 216 MT-Level        Unsafe
 217 .TE
 218
 219 .SH SEE ALSO
 220 .sp
 221 .LP
 222 \fBacl\fR(2), \fBaclsort\fR(3SEC), \fBattributes\fR(5)