xref: /freebsd/lib/libc/posix1e/acl_set.3 (revision 09c817ba36db7c3a4ff5e25ac55816ca181a403d)
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
53The
54.Fn acl_set_fd ,
55.Fn acl_set_fd_np ,
56.Fn acl_set_file ,
57and
58.Fn acl_set_link_np
59each associate an ACL with an object referred to by
60.Va fd
61or
62.Va path_p .
63The
64.Fn acl_set_fd_np
65and
66.Fn acl_set_link_np
67functions are not POSIX.1e calls.
68The
69.Fn acl_set_fd
70function allows only the setting of ACLs of type ACL_TYPE_ACCESS
71where as
72.Fn acl_set_fd_np
73allows the setting of ACLs of any type.
74The
75.Fn acl_set_link_np
76function acts on a symlink rather than its target, if the target of the
77path is a symlink.
78.Pp
79Valid values for the
80.Va type
81argument are:
82.Pp
83.Bl -column -offset 3n "ACL_TYPE_DEFAULT"
84.It ACL_TYPE_ACCESS	POSIX.1e access ACL
85.It ACL_TYPE_DEFAULT	POSIX.1e default ACL
86.It ACL_TYPE_NFS4	NFSv4 ACL
87.El
88.Pp
89Trying to set ACL_TYPE_NFS4 with
90.Va acl
91branded as POSIX.1e, or ACL_TYPE_ACCESS or ACL_TYPE_DEFAULT with ACL
92branded as NFSv4, will result in error.
93.Sh IMPLEMENTATION NOTES
94.Fx Ns 's
95support for POSIX.1e interfaces and features is still under
96development at this time.
97.Sh RETURN VALUES
98.Rv -std
99.Sh ERRORS
100If any of the following conditions occur, these functions shall return
101-1 and set
102.Va errno
103to the corresponding value:
104.Bl -tag -width Er
105.It Bq Er EACCES
106Search permission is denied for a component of the path prefix, or the
107object exists and the process does not have appropriate access rights.
108.It Bq Er EBADF
109The
110.Va fd
111argument is not a valid file descriptor.
112.It Bq Er EINVAL
113Argument
114.Va acl
115does not point to a valid ACL for this object, or the ACL type
116specified in
117.Va type
118is invalid for this object, or there is branding mismatch.
119.It Bq Er ENAMETOOLONG
120A component of a pathname exceeded 255 characters, or an
121entire path name exceeded 1023 characters.
122.It Bq Er ENOENT
123The named object does not exist, or the
124.Va path_p
125argument points to an empty string.
126.It Bq Er ENOMEM
127Insufficient memory available to fulfill request.
128.It Bq Er ENOSPC
129The directory or file system that would contain the new ACL cannot be
130extended, or the file system is out of file allocation resources.
131.It Bq Er EOPNOTSUPP
132The file system does not support ACL retrieval.
133.It Bq Er EROFS
134This function requires modification of a file system which is currently
135read-only.
136.El
137.Sh SEE ALSO
138.Xr acl 3 ,
139.Xr acl_delete 3 ,
140.Xr acl_get 3 ,
141.Xr acl_get_brand_np 3 ,
142.Xr acl_valid 3 ,
143.Xr posix1e 3
144.Sh STANDARDS
145POSIX.1e is described in IEEE POSIX.1e draft 17.
146Discussion
147of the draft continues on the cross-platform POSIX.1e implementation
148mailing list.
149To join this list, see the
150.Fx
151POSIX.1e implementation
152page for more information.
153.Sh HISTORY
154POSIX.1e support was introduced in
155.Fx 4.0 ,
156and development continues.
157.Sh AUTHORS
158.An Robert N M Watson
159