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