xref: /titanic_52/usr/src/man/man3sec/acl_check.3sec (revision 6a1af1a67532df169a657cce07140be64bdea084) 
 te
 Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
 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.
 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.
 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]
 acl_check 3SEC "22 Apr 2008" "SunOS 5.11" "File Access Control Library Functions"
 NAME
acl_check - check the validity of an ACL

 SYNOPSIS


cc [ flag.\|.\|. ] file.\|.\|. -lsec [ library.\|.\|. ] 
#include <sys/acl.h>

int acl_check(acl_t *aclp, int isdir);




 DESCRIPTION

The acl_check() function checks the validity of an ACL pointed to by
aclp. The isdir argument checks the validity of an ACL that will be
applied to a directory. The ACL can be either a POSIX draft ACL as supported by
UFS or NFSv4 ACL as supported by ZFS or NFSV4.


When the function verifies a POSIX draft ACL, the rules followed are described
in aclcheck(3SEC). For NFSv4 ACL, the ACL is verified against the
following rules:




The inheritance flags are valid.






The ACL must have at least one ACL entry and no more than
{MAX_ACL_ENTRIES}.






The permission field contains only supported permissions.






The entry type is valid.






The flag fields contain only valid flags as supported by NFSv4/ZFS.




If any of the above rules are violated, the function fails with errno set
to EINVAL.

 RETURN VALUES

If the ACL is valid, acl_check() returns 0. Otherwise errno is set
to EINVAL and the return value is set to one of the following:


EACL_INHERIT_ERROR


There are invalid inheritance flags specified.





EACL_FLAGS_ERROR


There are invalid flags specified on the ACL that don't map to supported flags
in NFSV4/ZFS ACL model.





EACL_ENTRY_ERROR


The ACL contains an unknown value in the type field.





EACL_MEM_ERROR


The system cannot allocate any memory.





EACL_INHERIT_NOTDIR


Inheritance flags are only allowed for ACLs on directories.




 ATTRIBUTES

See attributes(5) for descriptions of the following attributes:







ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityCommitted
MT-LevelMT-Safe



 SEE ALSO

acl(2), aclcheck(3SEC), aclsort(3SEC), acl(5),
attributes(5)