usr/src/man/man3sec/acl_strip.3sec

   1 '\" te
   2 .\" Copyright (c) 2005, Sun Microsystems, Inc. All Rights Reserved.
   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 ACL_STRIP 3SEC "Oct 6, 2005"
   7 .SH NAME
   8 acl_strip \- remove all ACLs from a file
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lsec\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <sys/acl.h>
  14
  15 \fBint\fR \fBacl_strip\fR(\fBconst char *\fR\fIpath\fR, \fBuid_t\fR \fIuid\fR, \fBgid_t\fR \fIgid\fR, \fBmode_t\fR \fImode\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBacl_strip()\fR function removes all ACLs from a file and replaces them
  22 with a trivial ACL based on the \fImode\fR argument. After replacing the ACL,
  23 the owner and group of the file are set to the values specified by the
  24 \fIuid\fR and \fIgid\fR arguments.
  25 .SH RETURN VALUES
  26 .sp
  27 .LP
  28 Upon successful completion, \fBacl_strip()\fR returns 0. Otherwise it returns
  29 -1 and sets \fBerrno\fR to indicate the error.
  30 .SH ERRORS
  31 .sp
  32 .LP
  33 The \fBacl_strip()\fR function will fail if:
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fBEACCES\fR\fR
  38 .ad
  39 .RS 16n
  40 Search permission is denied on a component of the path prefix of \fIpath\fR.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBEFAULT\fR\fR
  47 .ad
  48 .RS 16n
  49 The \fIpath\fR argument points to an illegal address.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fBEINVAL\fR\fR
  56 .ad
  57 .RS 16n
  58 The \fIuid\fR or \fIgid\fR argument is out of range.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBEIO\fR\fR
  65 .ad
  66 .RS 16n
  67 A disk I/O error has occurred while storing or retrieving the ACL.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBELOOP\fR\fR
  74 .ad
  75 .RS 16n
  76 A loop exists in symbolic links encountered during the resolution of the
  77 \fIpath\fR argument.
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fBENAMETOOLONG\fR\fR
  84 .ad
  85 .RS 16n
  86 The length of  the \fIpath\fR argument  exceeds {\fBPATH_MAX\fR},  or the
  87 length of a path component exceeds {\fBNAME_MAX\fR} while \fB_POSIX_NO_TRUNC\fR
  88 is in effect.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBENOENT\fR\fR
  95 .ad
  96 .RS 16n
  97 A component of \fIpath\fR does not exist.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBENOTDIR\fR\fR
 104 .ad
 105 .RS 16n
 106 A component of the prefix of \fIpath\fR is not a directory.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBEPERM\fR\fR
 113 .ad
 114 .RS 16n
 115 The effective user ID does not match the owner of the file and the process does
 116 not have appropriate privileges.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBEROFS\fR\fR
 123 .ad
 124 .RS 16n
 125 The file system is mounted read-only.
 126 .RE
 127
 128 .SH ATTRIBUTES
 129 .sp
 130 .LP
 131 See \fBattributes\fR(5) for descriptions of the following attributes:
 132 .sp
 133
 134 .sp
 135 .TS
 136 box;
 137 c | c
 138 l | l .
 139 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 140 _
 141 Interface Stability     Evolving
 142 _
 143 MT-Level        MT-Safe
 144 .TE
 145
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBacl_get\fR(3SEC), \fBacl_trivial\fR(3SEC), \fBacl\fR(5), \fBattributes\fR(5)