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 http://www.opensolaris.org/os/licensing.
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) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 */
24
25#ifndef	_SYS_FS_ZFS_ACL_H
26#define	_SYS_FS_ZFS_ACL_H
27
28#ifdef _KERNEL
29#include <sys/isa_defs.h>
30#include <sys/types32.h>
31#endif
32#include <sys/acl.h>
33#include <sys/dmu.h>
34#include <sys/zfs_fuid.h>
35#include <sys/sa.h>
36
37#ifdef	__cplusplus
38extern "C" {
39#endif
40
41struct znode_phys;
42
43#define	ACE_SLOT_CNT	6
44#define	ZFS_ACL_VERSION_INITIAL 0ULL
45#define	ZFS_ACL_VERSION_FUID	1ULL
46#define	ZFS_ACL_VERSION		ZFS_ACL_VERSION_FUID
47
48/*
49 * ZFS ACLs (Access Control Lists) are stored in various forms.
50 *
51 * Files created with ACL version ZFS_ACL_VERSION_INITIAL
52 * will all be created with fixed length ACEs of type
53 * zfs_oldace_t.
54 *
55 * Files with ACL version ZFS_ACL_VERSION_FUID will be created
56 * with various sized ACEs.  The abstraction entries will utilize
57 * zfs_ace_hdr_t, normal user/group entries will use zfs_ace_t
58 * and some specialized CIFS ACEs will use zfs_object_ace_t.
59 */
60
61/*
62 * All ACEs have a common hdr.  For
63 * owner@, group@, and everyone@ this is all
64 * thats needed.
65 */
66typedef struct zfs_ace_hdr {
67	uint16_t z_type;
68	uint16_t z_flags;
69	uint32_t z_access_mask;
70} zfs_ace_hdr_t;
71
72typedef zfs_ace_hdr_t zfs_ace_abstract_t;
73
74/*
75 * Standard ACE
76 */
77typedef struct zfs_ace {
78	zfs_ace_hdr_t	z_hdr;
79	uint64_t	z_fuid;
80} zfs_ace_t;
81
82/*
83 * The following type only applies to ACE_ACCESS_ALLOWED|DENIED_OBJECT_ACE_TYPE
84 * and will only be set/retrieved in a CIFS context.
85 */
86
87typedef struct zfs_object_ace {
88	zfs_ace_t	z_ace;
89	uint8_t		z_object_type[16]; /* object type */
90	uint8_t		z_inherit_type[16]; /* inherited object type */
91} zfs_object_ace_t;
92
93typedef struct zfs_oldace {
94	uint32_t	z_fuid;		/* "who" */
95	uint32_t	z_access_mask;  /* access mask */
96	uint16_t	z_flags;	/* flags, i.e inheritance */
97	uint16_t	z_type;		/* type of entry allow/deny */
98} zfs_oldace_t;
99
100typedef struct zfs_acl_phys_v0 {
101	uint64_t	z_acl_extern_obj;	/* ext acl pieces */
102	uint32_t	z_acl_count;		/* Number of ACEs */
103	uint16_t	z_acl_version;		/* acl version */
104	uint16_t	z_acl_pad;		/* pad */
105	zfs_oldace_t	z_ace_data[ACE_SLOT_CNT]; /* 6 standard ACEs */
106} zfs_acl_phys_v0_t;
107
108#define	ZFS_ACE_SPACE	(sizeof (zfs_oldace_t) * ACE_SLOT_CNT)
109
110/*
111 * Size of ACL count is always 2 bytes.
112 * Necessary to for dealing with both V0 ACL and V1 ACL layout
113 */
114#define	ZFS_ACL_COUNT_SIZE	(sizeof (uint16_t))
115
116typedef struct zfs_acl_phys {
117	uint64_t	z_acl_extern_obj;	  /* ext acl pieces */
118	uint32_t	z_acl_size;		  /* Number of bytes in ACL */
119	uint16_t	z_acl_version;		  /* acl version */
120	uint16_t	z_acl_count;		  /* ace count */
121	uint8_t	z_ace_data[ZFS_ACE_SPACE]; /* space for embedded ACEs */
122} zfs_acl_phys_t;
123
124typedef struct acl_ops {
125	uint32_t	(*ace_mask_get) (void *acep); /* get  access mask */
126	void 		(*ace_mask_set) (void *acep,
127			    uint32_t mask); /* set access mask */
128	uint16_t	(*ace_flags_get) (void *acep);	/* get flags */
129	void		(*ace_flags_set) (void *acep,
130			    uint16_t flags); /* set flags */
131	uint16_t	(*ace_type_get)(void *acep); /* get type */
132	void		(*ace_type_set)(void *acep,
133			    uint16_t type); /* set type */
134	uint64_t	(*ace_who_get)(void *acep); /* get who/fuid */
135	void		(*ace_who_set)(void *acep,
136			    uint64_t who); /* set who/fuid */
137	size_t		(*ace_size)(void *acep); /* how big is this ace */
138	size_t		(*ace_abstract_size)(void); /* sizeof abstract entry */
139	int		(*ace_mask_off)(void); /* off of access mask in ace */
140	/* ptr to data if any */
141	int		(*ace_data)(void *acep, void **datap);
142} acl_ops_t;
143
144/*
145 * A zfs_acl_t structure is composed of a list of zfs_acl_node_t's.
146 * Each node will have one or more ACEs associated with it.  You will
147 * only have multiple nodes during a chmod operation.   Normally only
148 * one node is required.
149 */
150typedef struct zfs_acl_node {
151	list_node_t	z_next;		/* Next chunk of ACEs */
152	void		*z_acldata;	/* pointer into actual ACE(s) */
153	void		*z_allocdata;	/* pointer to kmem allocated memory */
154	size_t		z_allocsize;	/* Size of blob in bytes */
155	size_t		z_size;		/* length of ACL data */
156	uint64_t	z_ace_count;	/* number of ACEs in this acl node */
157	int		z_ace_idx;	/* ace iterator positioned on */
158} zfs_acl_node_t;
159
160typedef struct zfs_acl {
161	uint64_t	z_acl_count;	/* Number of ACEs */
162	size_t		z_acl_bytes;	/* Number of bytes in ACL */
163	uint_t		z_version;	/* version of ACL */
164	void		*z_next_ace;	/* pointer to next ACE */
165	uint64_t	z_hints;	/* ACL hints (ZFS_INHERIT_ACE ...) */
166	zfs_acl_node_t	*z_curr_node;	/* current node iterator is handling */
167	list_t		z_acl;		/* chunks of ACE data */
168	acl_ops_t	z_ops;		/* ACL operations */
169} zfs_acl_t;
170
171typedef struct acl_locator_cb {
172	zfs_acl_t *cb_aclp;
173	zfs_acl_node_t *cb_acl_node;
174} zfs_acl_locator_cb_t;
175
176#define	ACL_DATA_ALLOCED	0x1
177#define	ZFS_ACL_SIZE(aclcnt)	(sizeof (ace_t) * (aclcnt))
178
179struct zfs_fuid_info;
180
181typedef struct zfs_acl_ids {
182	uint64_t		z_fuid;		/* file owner fuid */
183	uint64_t		z_fgid;		/* file group owner fuid */
184	uint64_t		z_mode;		/* mode to set on create */
185	zfs_acl_t		*z_aclp;	/* ACL to create with file */
186	struct zfs_fuid_info 	*z_fuidp;	/* for tracking fuids for log */
187} zfs_acl_ids_t;
188
189/*
190 * Property values for acl_mode and acl_inherit.
191 *
192 * acl_mode can take discard, noallow, groupmask and passthrough.
193 * whereas acl_inherit has secure instead of groupmask.
194 */
195
196#define	ZFS_ACL_DISCARD		0
197#define	ZFS_ACL_NOALLOW		1
198#define	ZFS_ACL_GROUPMASK	2
199#define	ZFS_ACL_PASSTHROUGH	3
200#define	ZFS_ACL_RESTRICTED	4
201#define	ZFS_ACL_PASSTHROUGH_X	5
202
203struct znode;
204struct zfsvfs;
205
206#ifdef _KERNEL
207int zfs_acl_ids_create(struct znode *, int, vattr_t *,
208    cred_t *, vsecattr_t *, zfs_acl_ids_t *);
209void zfs_acl_ids_free(zfs_acl_ids_t *);
210boolean_t zfs_acl_ids_overquota(struct zfsvfs *, zfs_acl_ids_t *, uint64_t);
211int zfs_getacl(struct znode *, vsecattr_t *, boolean_t, cred_t *);
212int zfs_setacl(struct znode *, vsecattr_t *, boolean_t, cred_t *);
213void zfs_acl_rele(void *);
214void zfs_oldace_byteswap(ace_t *, int);
215void zfs_ace_byteswap(void *, size_t, boolean_t);
216extern boolean_t zfs_has_access(struct znode *zp, cred_t *cr);
217extern int zfs_zaccess(struct znode *, int, int, boolean_t, cred_t *);
218int zfs_fastaccesschk_execute(struct znode *, cred_t *);
219extern int zfs_zaccess_rwx(struct znode *, mode_t, int, cred_t *);
220extern int zfs_zaccess_unix(struct znode *, mode_t, cred_t *);
221extern int zfs_acl_access(struct znode *, int, cred_t *);
222int zfs_acl_chmod_setattr(struct znode *, zfs_acl_t **, uint64_t);
223int zfs_zaccess_delete(struct znode *, struct znode *, cred_t *);
224int zfs_zaccess_rename(struct znode *, struct znode *,
225    struct znode *, struct znode *, cred_t *cr);
226void zfs_acl_free(zfs_acl_t *);
227int zfs_vsec_2_aclp(struct zfsvfs *, vtype_t, vsecattr_t *, cred_t *,
228    struct zfs_fuid_info **, zfs_acl_t **);
229int zfs_aclset_common(struct znode *, zfs_acl_t *, cred_t *, dmu_tx_t *);
230uint64_t zfs_external_acl(struct znode *);
231int zfs_znode_acl_version(struct znode *);
232int zfs_acl_size(struct znode *, int *);
233zfs_acl_t *zfs_acl_alloc(int);
234zfs_acl_node_t *zfs_acl_node_alloc(size_t);
235void zfs_acl_xform(struct znode *, zfs_acl_t *, cred_t *);
236void zfs_acl_data_locator(void **, uint32_t *, uint32_t, boolean_t, void *);
237uint64_t zfs_mode_compute(uint64_t, zfs_acl_t *,
238    uint64_t *, uint64_t, uint64_t);
239int zfs_acl_node_read(struct znode *, boolean_t, zfs_acl_t **, boolean_t);
240int zfs_acl_chown_setattr(struct znode *);
241
242#endif
243
244#ifdef	__cplusplus
245}
246#endif
247#endif	/* _SYS_FS_ZFS_ACL_H */
248