xref: /freebsd/sys/contrib/openzfs/include/zfs_deleg.h (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
1 // SPDX-License-Identifier: CDDL-1.0
2 /*
3  * CDDL HEADER START
4  *
5  * The contents of this file are subject to the terms of the
6  * Common Development and Distribution License (the "License").
7  * You may not use this file except in compliance with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or https://opensource.org/licenses/CDDL-1.0.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright 2010 Nexenta Systems, Inc. All rights reserved.
25  * Copyright (c) 2013, 2015 by Delphix. All rights reserved.
26  */
27 
28 #ifndef	_ZFS_DELEG_H
29 #define	_ZFS_DELEG_H extern __attribute__((visibility("default")))
30 
31 #include <sys/fs/zfs.h>
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 #define	ZFS_DELEG_SET_NAME_CHR		'@'		/* set name lead char */
38 #define	ZFS_DELEG_FIELD_SEP_CHR		'$'		/* field separator */
39 
40 /*
41  * Max name length for a delegation attribute
42  */
43 #define	ZFS_MAX_DELEG_NAME	128
44 
45 #define	ZFS_DELEG_LOCAL		'l'
46 #define	ZFS_DELEG_DESCENDENT	'd'
47 #define	ZFS_DELEG_NA		'-'
48 
49 typedef enum {
50 	ZFS_DELEG_NOTE_CREATE,
51 	ZFS_DELEG_NOTE_DESTROY,
52 	ZFS_DELEG_NOTE_SNAPSHOT,
53 	ZFS_DELEG_NOTE_ROLLBACK,
54 	ZFS_DELEG_NOTE_CLONE,
55 	ZFS_DELEG_NOTE_PROMOTE,
56 	ZFS_DELEG_NOTE_RENAME,
57 	ZFS_DELEG_NOTE_SEND,
58 	ZFS_DELEG_NOTE_RECEIVE,
59 	ZFS_DELEG_NOTE_ALLOW,
60 	ZFS_DELEG_NOTE_USERPROP,
61 	ZFS_DELEG_NOTE_MOUNT,
62 	ZFS_DELEG_NOTE_SHARE,
63 	ZFS_DELEG_NOTE_USERQUOTA,
64 	ZFS_DELEG_NOTE_GROUPQUOTA,
65 	ZFS_DELEG_NOTE_USERUSED,
66 	ZFS_DELEG_NOTE_GROUPUSED,
67 	ZFS_DELEG_NOTE_USEROBJQUOTA,
68 	ZFS_DELEG_NOTE_GROUPOBJQUOTA,
69 	ZFS_DELEG_NOTE_USEROBJUSED,
70 	ZFS_DELEG_NOTE_GROUPOBJUSED,
71 	ZFS_DELEG_NOTE_HOLD,
72 	ZFS_DELEG_NOTE_RELEASE,
73 	ZFS_DELEG_NOTE_DIFF,
74 	ZFS_DELEG_NOTE_BOOKMARK,
75 	ZFS_DELEG_NOTE_LOAD_KEY,
76 	ZFS_DELEG_NOTE_CHANGE_KEY,
77 	ZFS_DELEG_NOTE_PROJECTUSED,
78 	ZFS_DELEG_NOTE_PROJECTQUOTA,
79 	ZFS_DELEG_NOTE_PROJECTOBJUSED,
80 	ZFS_DELEG_NOTE_PROJECTOBJQUOTA,
81 	ZFS_DELEG_NOTE_NONE
82 } zfs_deleg_note_t;
83 
84 typedef struct zfs_deleg_perm_tab {
85 	const char *z_perm;
86 	zfs_deleg_note_t z_note;
87 } zfs_deleg_perm_tab_t;
88 
89 _ZFS_DELEG_H const zfs_deleg_perm_tab_t zfs_deleg_perm_tab[];
90 
91 _ZFS_DELEG_H int zfs_deleg_verify_nvlist(nvlist_t *nvlist);
92 _ZFS_DELEG_H void zfs_deleg_whokey(char *attr, zfs_deleg_who_type_t type,
93     char checkflag, void *data);
94 _ZFS_DELEG_H const char *zfs_deleg_canonicalize_perm(const char *perm);
95 
96 #ifdef	__cplusplus
97 }
98 #endif
99 
100 #endif	/* _ZFS_DELEG_H */
101