xref: /freebsd/lib/libc/posix1e/acl_support_nfs4.c (revision 559a218c9b257775fb249b67945fe4a05b7a6b9f)
1aa015c8eSEdward Tomasz Napierala /*-
2*4d846d26SWarner Losh  * SPDX-License-Identifier: BSD-2-Clause
3d915a14eSPedro F. Giffuni  *
4aa015c8eSEdward Tomasz Napierala  * Copyright (c) 2008, 2009 Edward Tomasz Napierała <trasz@FreeBSD.org>
5aa015c8eSEdward Tomasz Napierala  *
6aa015c8eSEdward Tomasz Napierala  * Redistribution and use in source and binary forms, with or without
7aa015c8eSEdward Tomasz Napierala  * modification, are permitted provided that the following conditions
8aa015c8eSEdward Tomasz Napierala  * are met:
9aa015c8eSEdward Tomasz Napierala  * 1. Redistributions of source code must retain the above copyright
10aa015c8eSEdward Tomasz Napierala  *    notice, this list of conditions and the following disclaimer.
11aa015c8eSEdward Tomasz Napierala  * 2. Redistributions in binary form must reproduce the above copyright
12aa015c8eSEdward Tomasz Napierala  *    notice, this list of conditions and the following disclaimer in the
13aa015c8eSEdward Tomasz Napierala  *    documentation and/or other materials provided with the distribution.
14aa015c8eSEdward Tomasz Napierala  *
15aa015c8eSEdward Tomasz Napierala  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16aa015c8eSEdward Tomasz Napierala  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17aa015c8eSEdward Tomasz Napierala  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18aa015c8eSEdward Tomasz Napierala  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19aa015c8eSEdward Tomasz Napierala  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20aa015c8eSEdward Tomasz Napierala  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21aa015c8eSEdward Tomasz Napierala  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22aa015c8eSEdward Tomasz Napierala  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23aa015c8eSEdward Tomasz Napierala  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24aa015c8eSEdward Tomasz Napierala  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25aa015c8eSEdward Tomasz Napierala  * SUCH DAMAGE.
26aa015c8eSEdward Tomasz Napierala  */
27aa015c8eSEdward Tomasz Napierala 
28aa015c8eSEdward Tomasz Napierala #include <stdio.h>
29aa015c8eSEdward Tomasz Napierala #include <stdlib.h>
30aa015c8eSEdward Tomasz Napierala #include <string.h>
31aa015c8eSEdward Tomasz Napierala #include <assert.h>
32aa015c8eSEdward Tomasz Napierala #include <err.h>
33aa015c8eSEdward Tomasz Napierala #include <sys/acl.h>
34aa015c8eSEdward Tomasz Napierala #include "acl_support.h"
35aa015c8eSEdward Tomasz Napierala 
36aa015c8eSEdward Tomasz Napierala struct flagnames_struct {
37aa015c8eSEdward Tomasz Napierala 	uint32_t	flag;
38aa015c8eSEdward Tomasz Napierala 	const char	*name;
39aa015c8eSEdward Tomasz Napierala 	char		letter;
40aa015c8eSEdward Tomasz Napierala };
41aa015c8eSEdward Tomasz Napierala 
42aa015c8eSEdward Tomasz Napierala struct flagnames_struct a_flags[] =
43aa015c8eSEdward Tomasz Napierala     {{ ACL_ENTRY_FILE_INHERIT, "file_inherit", 'f'},
44aa015c8eSEdward Tomasz Napierala      { ACL_ENTRY_DIRECTORY_INHERIT, "dir_inherit", 'd'},
45aa015c8eSEdward Tomasz Napierala      { ACL_ENTRY_INHERIT_ONLY, "inherit_only", 'i'},
46aa015c8eSEdward Tomasz Napierala      { ACL_ENTRY_NO_PROPAGATE_INHERIT, "no_propagate", 'n'},
47aa015c8eSEdward Tomasz Napierala      { ACL_ENTRY_SUCCESSFUL_ACCESS, "successfull_access", 'S'},
48aa015c8eSEdward Tomasz Napierala      { ACL_ENTRY_FAILED_ACCESS, "failed_access", 'F'},
4928ffe927SXin LI      { ACL_ENTRY_INHERITED, "inherited", 'I' },
50aa015c8eSEdward Tomasz Napierala      /*
51aa015c8eSEdward Tomasz Napierala       * There is no ACE_IDENTIFIER_GROUP here - SunOS does not show it
52aa015c8eSEdward Tomasz Napierala       * in the "flags" field.  There is no ACE_OWNER, ACE_GROUP or
53aa015c8eSEdward Tomasz Napierala       * ACE_EVERYONE either, for obvious reasons.
54aa015c8eSEdward Tomasz Napierala       */
55aa015c8eSEdward Tomasz Napierala      { 0, 0, 0}};
56aa015c8eSEdward Tomasz Napierala 
57aa015c8eSEdward Tomasz Napierala struct flagnames_struct a_access_masks[] =
58aa015c8eSEdward Tomasz Napierala     {{ ACL_READ_DATA, "read_data", 'r'},
59aa015c8eSEdward Tomasz Napierala      { ACL_WRITE_DATA, "write_data", 'w'},
60aa015c8eSEdward Tomasz Napierala      { ACL_EXECUTE, "execute", 'x'},
61aa015c8eSEdward Tomasz Napierala      { ACL_APPEND_DATA, "append_data", 'p'},
62aa015c8eSEdward Tomasz Napierala      { ACL_DELETE_CHILD, "delete_child", 'D'},
63aa015c8eSEdward Tomasz Napierala      { ACL_DELETE, "delete", 'd'},
64aa015c8eSEdward Tomasz Napierala      { ACL_READ_ATTRIBUTES, "read_attributes", 'a'},
65aa015c8eSEdward Tomasz Napierala      { ACL_WRITE_ATTRIBUTES, "write_attributes", 'A'},
66aa015c8eSEdward Tomasz Napierala      { ACL_READ_NAMED_ATTRS, "read_xattr", 'R'},
67aa015c8eSEdward Tomasz Napierala      { ACL_WRITE_NAMED_ATTRS, "write_xattr", 'W'},
68aa015c8eSEdward Tomasz Napierala      { ACL_READ_ACL, "read_acl", 'c'},
69aa015c8eSEdward Tomasz Napierala      { ACL_WRITE_ACL, "write_acl", 'C'},
70aa015c8eSEdward Tomasz Napierala      { ACL_WRITE_OWNER, "write_owner", 'o'},
71aa015c8eSEdward Tomasz Napierala      { ACL_SYNCHRONIZE, "synchronize", 's'},
72181b4eebSEdward Tomasz Napierala      { ACL_FULL_SET, "full_set", '\0'},
73181b4eebSEdward Tomasz Napierala      { ACL_MODIFY_SET, "modify_set", '\0'},
74181b4eebSEdward Tomasz Napierala      { ACL_READ_SET, "read_set", '\0'},
75181b4eebSEdward Tomasz Napierala      { ACL_WRITE_SET, "write_set", '\0'},
76aa015c8eSEdward Tomasz Napierala      { 0, 0, 0}};
77aa015c8eSEdward Tomasz Napierala 
78aa015c8eSEdward Tomasz Napierala static const char *
format_flag(uint32_t * var,const struct flagnames_struct * flags)79aa015c8eSEdward Tomasz Napierala format_flag(uint32_t *var, const struct flagnames_struct *flags)
80aa015c8eSEdward Tomasz Napierala {
81aa015c8eSEdward Tomasz Napierala 
82513004a2SPedro F. Giffuni 	for (; flags->name != NULL; flags++) {
83aa015c8eSEdward Tomasz Napierala 		if ((flags->flag & *var) == 0)
84aa015c8eSEdward Tomasz Napierala 			continue;
85aa015c8eSEdward Tomasz Napierala 
86aa015c8eSEdward Tomasz Napierala 		*var &= ~flags->flag;
87aa015c8eSEdward Tomasz Napierala 		return (flags->name);
88aa015c8eSEdward Tomasz Napierala 	}
89aa015c8eSEdward Tomasz Napierala 
90aa015c8eSEdward Tomasz Napierala 	return (NULL);
91aa015c8eSEdward Tomasz Napierala }
92aa015c8eSEdward Tomasz Napierala 
93aa015c8eSEdward Tomasz Napierala static int
format_flags_verbose(char * str,size_t size,uint32_t var,const struct flagnames_struct * flags)94aa015c8eSEdward Tomasz Napierala format_flags_verbose(char *str, size_t size, uint32_t var,
95aa015c8eSEdward Tomasz Napierala     const struct flagnames_struct *flags)
96aa015c8eSEdward Tomasz Napierala {
97aa015c8eSEdward Tomasz Napierala 	size_t off = 0;
98aa015c8eSEdward Tomasz Napierala 	const char *tmp;
99aa015c8eSEdward Tomasz Napierala 
100aa015c8eSEdward Tomasz Napierala 	while ((tmp = format_flag(&var, flags)) != NULL) {
101aa015c8eSEdward Tomasz Napierala 		off += snprintf(str + off, size - off, "%s/", tmp);
102aa015c8eSEdward Tomasz Napierala 		assert (off < size);
103aa015c8eSEdward Tomasz Napierala 	}
104aa015c8eSEdward Tomasz Napierala 
105aa015c8eSEdward Tomasz Napierala 	/* If there were any flags added... */
106aa015c8eSEdward Tomasz Napierala 	if (off > 0) {
107aa015c8eSEdward Tomasz Napierala 		off--;
108aa015c8eSEdward Tomasz Napierala 		/* ... then remove the last slash. */
109aa015c8eSEdward Tomasz Napierala 		assert(str[off] == '/');
110aa015c8eSEdward Tomasz Napierala 	}
111aa015c8eSEdward Tomasz Napierala 
112aa015c8eSEdward Tomasz Napierala 	str[off] = '\0';
113aa015c8eSEdward Tomasz Napierala 
114aa015c8eSEdward Tomasz Napierala 	return (0);
115aa015c8eSEdward Tomasz Napierala }
116aa015c8eSEdward Tomasz Napierala 
117aa015c8eSEdward Tomasz Napierala static int
format_flags_compact(char * str,size_t size,uint32_t var,const struct flagnames_struct * flags)118aa015c8eSEdward Tomasz Napierala format_flags_compact(char *str, size_t size, uint32_t var,
119aa015c8eSEdward Tomasz Napierala     const struct flagnames_struct *flags)
120aa015c8eSEdward Tomasz Napierala {
121aa015c8eSEdward Tomasz Napierala 	size_t i;
122aa015c8eSEdward Tomasz Napierala 
123181b4eebSEdward Tomasz Napierala 	for (i = 0; flags[i].letter != '\0'; i++) {
124aa015c8eSEdward Tomasz Napierala 		assert(i < size);
125aa015c8eSEdward Tomasz Napierala 		if ((flags[i].flag & var) == 0)
126aa015c8eSEdward Tomasz Napierala 			str[i] = '-';
127aa015c8eSEdward Tomasz Napierala 		else
128aa015c8eSEdward Tomasz Napierala 			str[i] = flags[i].letter;
129aa015c8eSEdward Tomasz Napierala 	}
130aa015c8eSEdward Tomasz Napierala 
131aa015c8eSEdward Tomasz Napierala 	str[i] = '\0';
132aa015c8eSEdward Tomasz Napierala 
133aa015c8eSEdward Tomasz Napierala 	return (0);
134aa015c8eSEdward Tomasz Napierala }
135aa015c8eSEdward Tomasz Napierala 
136aa015c8eSEdward Tomasz Napierala static int
parse_flags_verbose(const char * strp,uint32_t * var,const struct flagnames_struct * flags,const char * flags_name,int * try_compact)137aa015c8eSEdward Tomasz Napierala parse_flags_verbose(const char *strp, uint32_t *var,
138aa015c8eSEdward Tomasz Napierala     const struct flagnames_struct *flags, const char *flags_name,
139aa015c8eSEdward Tomasz Napierala     int *try_compact)
140aa015c8eSEdward Tomasz Napierala {
141aa015c8eSEdward Tomasz Napierala 	int i, found, ever_found = 0;
142dd559118SAndrew Walker 	char *str, *flag, *to_free;
143aa015c8eSEdward Tomasz Napierala 
144aa015c8eSEdward Tomasz Napierala 	str = strdup(strp);
145dd559118SAndrew Walker 	to_free = str;
146aa015c8eSEdward Tomasz Napierala 	*try_compact = 0;
147aa015c8eSEdward Tomasz Napierala 	*var = 0;
148aa015c8eSEdward Tomasz Napierala 
149aa015c8eSEdward Tomasz Napierala 	while (str != NULL) {
150aa015c8eSEdward Tomasz Napierala 		flag = strsep(&str, "/:");
151aa015c8eSEdward Tomasz Napierala 
152aa015c8eSEdward Tomasz Napierala 		found = 0;
153aa015c8eSEdward Tomasz Napierala 		for (i = 0; flags[i].name != NULL; i++) {
154aa015c8eSEdward Tomasz Napierala 			if (strcmp(flags[i].name, flag) == 0) {
155aa015c8eSEdward Tomasz Napierala 				*var |= flags[i].flag;
156aa015c8eSEdward Tomasz Napierala 				found = 1;
157aa015c8eSEdward Tomasz Napierala 				ever_found = 1;
158aa015c8eSEdward Tomasz Napierala 			}
159aa015c8eSEdward Tomasz Napierala 		}
160aa015c8eSEdward Tomasz Napierala 
161aa015c8eSEdward Tomasz Napierala 		if (!found) {
162aa015c8eSEdward Tomasz Napierala 			if (ever_found)
163aa015c8eSEdward Tomasz Napierala 				warnx("malformed ACL: \"%s\" field contains "
164aa015c8eSEdward Tomasz Napierala 				    "invalid flag \"%s\"", flags_name, flag);
165aa015c8eSEdward Tomasz Napierala 			else
166aa015c8eSEdward Tomasz Napierala 				*try_compact = 1;
167dd559118SAndrew Walker 			free(to_free);
168aa015c8eSEdward Tomasz Napierala 			return (-1);
169aa015c8eSEdward Tomasz Napierala 		}
170aa015c8eSEdward Tomasz Napierala 	}
171aa015c8eSEdward Tomasz Napierala 
172dd559118SAndrew Walker 	free(to_free);
173aa015c8eSEdward Tomasz Napierala 	return (0);
174aa015c8eSEdward Tomasz Napierala }
175aa015c8eSEdward Tomasz Napierala 
176aa015c8eSEdward Tomasz Napierala static int
parse_flags_compact(const char * str,uint32_t * var,const struct flagnames_struct * flags,const char * flags_name)177aa015c8eSEdward Tomasz Napierala parse_flags_compact(const char *str, uint32_t *var,
178aa015c8eSEdward Tomasz Napierala     const struct flagnames_struct *flags, const char *flags_name)
179aa015c8eSEdward Tomasz Napierala {
180aa015c8eSEdward Tomasz Napierala 	int i, j, found;
181aa015c8eSEdward Tomasz Napierala 
182aa015c8eSEdward Tomasz Napierala 	*var = 0;
183aa015c8eSEdward Tomasz Napierala 
184aa015c8eSEdward Tomasz Napierala 	for (i = 0;; i++) {
185aa015c8eSEdward Tomasz Napierala 		if (str[i] == '\0')
186aa015c8eSEdward Tomasz Napierala 			return (0);
187aa015c8eSEdward Tomasz Napierala 
188aa015c8eSEdward Tomasz Napierala 		/* Ignore minus signs. */
189aa015c8eSEdward Tomasz Napierala 		if (str[i] == '-')
190aa015c8eSEdward Tomasz Napierala 			continue;
191aa015c8eSEdward Tomasz Napierala 
192aa015c8eSEdward Tomasz Napierala 		found = 0;
193aa015c8eSEdward Tomasz Napierala 
194aa015c8eSEdward Tomasz Napierala 		for (j = 0; flags[j].name != NULL; j++) {
195aa015c8eSEdward Tomasz Napierala 			if (flags[j].letter == str[i]) {
196aa015c8eSEdward Tomasz Napierala 				*var |= flags[j].flag;
197aa015c8eSEdward Tomasz Napierala 				found = 1;
198aa015c8eSEdward Tomasz Napierala 				break;
199aa015c8eSEdward Tomasz Napierala 			}
200aa015c8eSEdward Tomasz Napierala 		}
201aa015c8eSEdward Tomasz Napierala 
202aa015c8eSEdward Tomasz Napierala 		if (!found) {
203aa015c8eSEdward Tomasz Napierala 			warnx("malformed ACL: \"%s\" field contains "
204aa015c8eSEdward Tomasz Napierala 			    "invalid flag \"%c\"", flags_name, str[i]);
205aa015c8eSEdward Tomasz Napierala 			return (-1);
206aa015c8eSEdward Tomasz Napierala 		}
207aa015c8eSEdward Tomasz Napierala 	}
208aa015c8eSEdward Tomasz Napierala }
209aa015c8eSEdward Tomasz Napierala 
210aa015c8eSEdward Tomasz Napierala int
_nfs4_format_flags(char * str,size_t size,acl_flag_t var,int verbose)211aa015c8eSEdward Tomasz Napierala _nfs4_format_flags(char *str, size_t size, acl_flag_t var, int verbose)
212aa015c8eSEdward Tomasz Napierala {
213aa015c8eSEdward Tomasz Napierala 
214aa015c8eSEdward Tomasz Napierala 	if (verbose)
215aa015c8eSEdward Tomasz Napierala 		return (format_flags_verbose(str, size, var, a_flags));
216aa015c8eSEdward Tomasz Napierala 
217aa015c8eSEdward Tomasz Napierala 	return (format_flags_compact(str, size, var, a_flags));
218aa015c8eSEdward Tomasz Napierala }
219aa015c8eSEdward Tomasz Napierala 
220aa015c8eSEdward Tomasz Napierala int
_nfs4_format_access_mask(char * str,size_t size,acl_perm_t var,int verbose)221aa015c8eSEdward Tomasz Napierala _nfs4_format_access_mask(char *str, size_t size, acl_perm_t var, int verbose)
222aa015c8eSEdward Tomasz Napierala {
223aa015c8eSEdward Tomasz Napierala 
224aa015c8eSEdward Tomasz Napierala 	if (verbose)
225aa015c8eSEdward Tomasz Napierala 		return (format_flags_verbose(str, size, var, a_access_masks));
226aa015c8eSEdward Tomasz Napierala 
227aa015c8eSEdward Tomasz Napierala 	return (format_flags_compact(str, size, var, a_access_masks));
228aa015c8eSEdward Tomasz Napierala }
229aa015c8eSEdward Tomasz Napierala 
230aa015c8eSEdward Tomasz Napierala int
_nfs4_parse_flags(const char * str,acl_flag_t * flags)231aa015c8eSEdward Tomasz Napierala _nfs4_parse_flags(const char *str, acl_flag_t *flags)
232aa015c8eSEdward Tomasz Napierala {
233aa015c8eSEdward Tomasz Napierala 	int error, try_compact;
234aa015c8eSEdward Tomasz Napierala 	int tmpflags;
235aa015c8eSEdward Tomasz Napierala 
236aa015c8eSEdward Tomasz Napierala 	error = parse_flags_verbose(str, &tmpflags, a_flags, "flags", &try_compact);
237aa015c8eSEdward Tomasz Napierala 	if (error && try_compact)
238aa015c8eSEdward Tomasz Napierala 		error = parse_flags_compact(str, &tmpflags, a_flags, "flags");
239aa015c8eSEdward Tomasz Napierala 
240aa015c8eSEdward Tomasz Napierala 	*flags = tmpflags;
241aa015c8eSEdward Tomasz Napierala 
242aa015c8eSEdward Tomasz Napierala 	return (error);
243aa015c8eSEdward Tomasz Napierala }
244aa015c8eSEdward Tomasz Napierala 
245aa015c8eSEdward Tomasz Napierala int
_nfs4_parse_access_mask(const char * str,acl_perm_t * perms)246aa015c8eSEdward Tomasz Napierala _nfs4_parse_access_mask(const char *str, acl_perm_t *perms)
247aa015c8eSEdward Tomasz Napierala {
248aa015c8eSEdward Tomasz Napierala 	int error, try_compact;
249aa015c8eSEdward Tomasz Napierala 	int tmpperms;
250aa015c8eSEdward Tomasz Napierala 
251aa015c8eSEdward Tomasz Napierala 	error = parse_flags_verbose(str, &tmpperms, a_access_masks,
252aa015c8eSEdward Tomasz Napierala 	    "access permissions", &try_compact);
253aa015c8eSEdward Tomasz Napierala 	if (error && try_compact)
254aa015c8eSEdward Tomasz Napierala 		error = parse_flags_compact(str, &tmpperms,
255aa015c8eSEdward Tomasz Napierala 		    a_access_masks, "access permissions");
256aa015c8eSEdward Tomasz Napierala 
257aa015c8eSEdward Tomasz Napierala 	*perms = tmpperms;
258aa015c8eSEdward Tomasz Napierala 
259aa015c8eSEdward Tomasz Napierala 	return (error);
260aa015c8eSEdward Tomasz Napierala }
261