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