lib/libc/posix1e/acl_set.3

   1 .\"-
   2 .\" Copyright (c) 2000, 2002 Robert N. M. Watson
   3 .\" All rights reserved.
   4 .\"
   5 .\" This software was developed by Robert Watson for the TrustedBSD Project.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd June 25, 2009
  31 .Dt ACL_SET 3
  32 .Os
  33 .Sh NAME
  34 .Nm acl_set_fd ,
  35 .Nm acl_set_fd_np ,
  36 .Nm acl_set_file ,
  37 .Nm acl_set_link_np
  38 .Nd set an ACL for a file
  39 .Sh LIBRARY
  40 .Lb libc
  41 .Sh SYNOPSIS
  42 .In sys/types.h
  43 .In sys/acl.h
  44 .Ft int
  45 .Fn acl_set_fd "int fd" "acl_t acl"
  46 .Ft int
  47 .Fn acl_set_fd_np "int fd" "acl_t acl" "acl_type_t type"
  48 .Ft int
  49 .Fn acl_set_file "const char *path_p" "acl_type_t type" "acl_t acl"
  50 .Ft int
  51 .Fn acl_set_link_np "const char *path_p" "acl_type_t type" "acl_t acl"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn acl_set_fd ,
  55 .Fn acl_set_fd_np ,
  56 .Fn acl_set_file ,
  57 and
  58 .Fn acl_set_link_np
  59 each associate an ACL with an object referred to by
  60 .Va fd
  61 or
  62 .Va path_p .
  63 The
  64 .Fn acl_set_fd_np
  65 and
  66 .Fn acl_set_link_np
  67 functions are not POSIX.1e calls.
  68 The
  69 .Fn acl_set_fd
  70 function allows only the setting of ACLs of type ACL_TYPE_ACCESS
  71 where as
  72 .Fn acl_set_fd_np
  73 allows the setting of ACLs of any type.
  74 The
  75 .Fn acl_set_link_np
  76 function acts on a symlink rather than its target, if the target of the
  77 path is a symlink.
  78 .Pp
  79 Valid values for the
  80 .Va type
  81 argument are:
  82 .Bl -column -offset 3n "ACL_TYPE_DEFAULT"
  83 .It ACL_TYPE_ACCESS     POSIX.1e access ACL
  84 .It ACL_TYPE_DEFAULT    POSIX.1e default ACL
  85 .It ACL_TYPE_NFS4       NFSv4 ACL
  86 .El
  87 .Pp
  88 Trying to set ACL_TYPE_NFS4 with
  89 .Va acl
  90 branded as POSIX.1e, or ACL_TYPE_ACCESS or ACL_TYPE_DEFAULT with ACL
  91 branded as NFSv4, will result in error.
  92 .Sh IMPLEMENTATION NOTES
  93 .Fx Ns 's
  94 support for POSIX.1e interfaces and features is still under
  95 development at this time.
  96 .Sh RETURN VALUES
  97 .Rv -std
  98 .Sh ERRORS
  99 If any of the following conditions occur, these functions shall return
 100 -1 and set
 101 .Va errno
 102 to the corresponding value:
 103 .Bl -tag -width Er
 104 .It Bq Er EACCES
 105 Search permission is denied for a component of the path prefix, or the
 106 object exists and the process does not have appropriate access rights.
 107 .It Bq Er EBADF
 108 The
 109 .Va fd
 110 argument is not a valid file descriptor.
 111 .It Bq Er EINVAL
 112 Argument
 113 .Va acl
 114 does not point to a valid ACL for this object, or the ACL type
 115 specified in
 116 .Va type
 117 is invalid for this object, or there is branding mismatch.
 118 .It Bq Er ENAMETOOLONG
 119 A component of a pathname exceeded 255 characters, or an
 120 entire path name exceeded 1023 characters.
 121 .It Bq Er ENOENT
 122 The named object does not exist, or the
 123 .Va path_p
 124 argument points to an empty string.
 125 .It Bq Er ENOMEM
 126 Insufficient memory available to fulfill request.
 127 .It Bq Er ENOSPC
 128 The directory or file system that would contain the new ACL cannot be
 129 extended, or the file system is out of file allocation resources.
 130 .It Bq Er EOPNOTSUPP
 131 The file system does not support ACL retrieval.
 132 .It Bq Er EROFS
 133 This function requires modification of a file system which is currently
 134 read-only.
 135 .El
 136 .Sh SEE ALSO
 137 .Xr acl 3 ,
 138 .Xr acl_delete 3 ,
 139 .Xr acl_get 3 ,
 140 .Xr acl_get_brand_np 3 ,
 141 .Xr acl_valid 3 ,
 142 .Xr posix1e 3
 143 .Sh STANDARDS
 144 POSIX.1e is described in IEEE POSIX.1e draft 17.
 145 Discussion
 146 of the draft continues on the cross-platform POSIX.1e implementation
 147 mailing list.
 148 To join this list, see the
 149 .Fx
 150 POSIX.1e implementation
 151 page for more information.
 152 .Sh HISTORY
 153 POSIX.1e support was introduced in
 154 .Fx 4.0 ,
 155 and development continues.
 156 .Sh AUTHORS
 157 .An Robert N M Watson