perf tools: Fix a build error on arm64 with clang
[linux-2.6-microblaze.git] / fs / cifs / cifsacl.h
1 /*
2  *   fs/cifs/cifsacl.h
3  *
4  *   Copyright (c) International Business Machines  Corp., 2007
5  *   Author(s): Steve French (sfrench@us.ibm.com)
6  *
7  *   This library is free software; you can redistribute it and/or modify
8  *   it under the terms of the GNU Lesser General Public License as published
9  *   by the Free Software Foundation; either version 2.1 of the License, or
10  *   (at your option) any later version.
11  *
12  *   This library is distributed in the hope that it will be useful,
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
15  *   the GNU Lesser General Public License for more details.
16  *
17  *   You should have received a copy of the GNU Lesser General Public License
18  *   along with this library; if not, write to the Free Software
19  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  */
21
22 #ifndef _CIFSACL_H
23 #define _CIFSACL_H
24
25
26 #define NUM_AUTHS (6)   /* number of authority fields */
27 #define SID_MAX_SUB_AUTHORITIES (15) /* max number of sub authority fields */
28
29 #define READ_BIT        0x4
30 #define WRITE_BIT       0x2
31 #define EXEC_BIT        0x1
32
33 #define ACL_OWNER_MASK 0700
34 #define ACL_GROUP_MASK 0070
35 #define ACL_EVERYONE_MASK 0007
36
37 #define UBITSHIFT       6
38 #define GBITSHIFT       3
39
40 #define ACCESS_ALLOWED  0
41 #define ACCESS_DENIED   1
42
43 #define SIDOWNER 1
44 #define SIDGROUP 2
45
46 /*
47  * Security Descriptor length containing DACL with 3 ACEs (one each for
48  * owner, group and world).
49  */
50 #define DEFAULT_SEC_DESC_LEN (sizeof(struct cifs_ntsd) + \
51                               sizeof(struct cifs_acl) + \
52                               (sizeof(struct cifs_ace) * 4))
53
54 /*
55  * Maximum size of a string representation of a SID:
56  *
57  * The fields are unsigned values in decimal. So:
58  *
59  * u8:  max 3 bytes in decimal
60  * u32: max 10 bytes in decimal
61  *
62  * "S-" + 3 bytes for version field + 15 for authority field + NULL terminator
63  *
64  * For authority field, max is when all 6 values are non-zero and it must be
65  * represented in hex. So "-0x" + 12 hex digits.
66  *
67  * Add 11 bytes for each subauthority field (10 bytes each + 1 for '-')
68  */
69 #define SID_STRING_BASE_SIZE (2 + 3 + 15 + 1)
70 #define SID_STRING_SUBAUTH_SIZE (11) /* size of a single subauth string */
71
72 struct cifs_ntsd {
73         __le16 revision; /* revision level */
74         __le16 type;
75         __le32 osidoffset;
76         __le32 gsidoffset;
77         __le32 sacloffset;
78         __le32 dacloffset;
79 } __attribute__((packed));
80
81 struct cifs_sid {
82         __u8 revision; /* revision level */
83         __u8 num_subauth;
84         __u8 authority[NUM_AUTHS];
85         __le32 sub_auth[SID_MAX_SUB_AUTHORITIES]; /* sub_auth[num_subauth] */
86 } __attribute__((packed));
87
88 /* size of a struct cifs_sid, sans sub_auth array */
89 #define CIFS_SID_BASE_SIZE (1 + 1 + NUM_AUTHS)
90
91 struct cifs_acl {
92         __le16 revision; /* revision level */
93         __le16 size;
94         __le32 num_aces;
95 } __attribute__((packed));
96
97 /* ACE types - see MS-DTYP 2.4.4.1 */
98 #define ACCESS_ALLOWED_ACE_TYPE 0x00
99 #define ACCESS_DENIED_ACE_TYPE  0x01
100 #define SYSTEM_AUDIT_ACE_TYPE   0x02
101 #define SYSTEM_ALARM_ACE_TYPE   0x03
102 #define ACCESS_ALLOWED_COMPOUND_ACE_TYPE 0x04
103 #define ACCESS_ALLOWED_OBJECT_ACE_TYPE  0x05
104 #define ACCESS_DENIED_OBJECT_ACE_TYPE   0x06
105 #define SYSTEM_AUDIT_OBJECT_ACE_TYPE    0x07
106 #define SYSTEM_ALARM_OBJECT_ACE_TYPE    0x08
107 #define ACCESS_ALLOWED_CALLBACK_ACE_TYPE 0x09
108 #define ACCESS_DENIED_CALLBACK_ACE_TYPE 0x0A
109 #define ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE 0x0B
110 #define ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE  0x0C
111 #define SYSTEM_AUDIT_CALLBACK_ACE_TYPE  0x0D
112 #define SYSTEM_ALARM_CALLBACK_ACE_TYPE  0x0E /* Reserved */
113 #define SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE 0x0F
114 #define SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE 0x10 /* reserved */
115 #define SYSTEM_MANDATORY_LABEL_ACE_TYPE 0x11
116 #define SYSTEM_RESOURCE_ATTRIBUTE_ACE_TYPE 0x12
117 #define SYSTEM_SCOPED_POLICY_ID_ACE_TYPE 0x13
118
119 /* ACE flags */
120 #define OBJECT_INHERIT_ACE      0x01
121 #define CONTAINER_INHERIT_ACE   0x02
122 #define NO_PROPAGATE_INHERIT_ACE 0x04
123 #define INHERIT_ONLY_ACE        0x08
124 #define INHERITED_ACE           0x10
125 #define SUCCESSFUL_ACCESS_ACE_FLAG 0x40
126 #define FAILED_ACCESS_ACE_FLAG  0x80
127
128 struct cifs_ace {
129         __u8 type; /* see above and MS-DTYP 2.4.4.1 */
130         __u8 flags;
131         __le16 size;
132         __le32 access_req;
133         struct cifs_sid sid; /* ie UUID of user or group who gets these perms */
134 } __attribute__((packed));
135
136 /*
137  * The current SMB3 form of security descriptor is similar to what was used for
138  * cifs (see above) but some fields are split, and fields in the struct below
139  * matches names of fields to the spec, MS-DTYP (see sections 2.4.5 and
140  * 2.4.6). Note that "CamelCase" fields are used in this struct in order to
141  * match the MS-DTYP and MS-SMB2 specs which define the wire format.
142  */
143 struct smb3_sd {
144         __u8 Revision; /* revision level, MUST be one */
145         __u8 Sbz1; /* only meaningful if 'RM' flag set below */
146         __le16 Control;
147         __le32 OffsetOwner;
148         __le32 OffsetGroup;
149         __le32 OffsetSacl;
150         __le32 OffsetDacl;
151 } __packed;
152
153 /* Meaning of 'Control' field flags */
154 #define ACL_CONTROL_SR  0x8000  /* Self relative */
155 #define ACL_CONTROL_RM  0x4000  /* Resource manager control bits */
156 #define ACL_CONTROL_PS  0x2000  /* SACL protected from inherits */
157 #define ACL_CONTROL_PD  0x1000  /* DACL protected from inherits */
158 #define ACL_CONTROL_SI  0x0800  /* SACL Auto-Inherited */
159 #define ACL_CONTROL_DI  0x0400  /* DACL Auto-Inherited */
160 #define ACL_CONTROL_SC  0x0200  /* SACL computed through inheritance */
161 #define ACL_CONTROL_DC  0x0100  /* DACL computed through inheritence */
162 #define ACL_CONTROL_SS  0x0080  /* Create server ACL */
163 #define ACL_CONTROL_DT  0x0040  /* DACL provided by trusted source */
164 #define ACL_CONTROL_SD  0x0020  /* SACL defaulted */
165 #define ACL_CONTROL_SP  0x0010  /* SACL is present on object */
166 #define ACL_CONTROL_DD  0x0008  /* DACL defaulted */
167 #define ACL_CONTROL_DP  0x0004  /* DACL is present on object */
168 #define ACL_CONTROL_GD  0x0002  /* Group was defaulted */
169 #define ACL_CONTROL_OD  0x0001  /* User was defaulted */
170
171 /* Meaning of AclRevision flags */
172 #define ACL_REVISION    0x02 /* See section 2.4.4.1 of MS-DTYP */
173 #define ACL_REVISION_DS 0x04 /* Additional AceTypes allowed */
174
175 struct smb3_acl {
176         u8 AclRevision; /* revision level */
177         u8 Sbz1; /* MBZ */
178         __le16 AclSize;
179         __le16 AceCount;
180         __le16 Sbz2; /* MBZ */
181 } __packed;
182
183 /*
184  * Used to store the special 'NFS SIDs' used to persist the POSIX uid and gid
185  * See http://technet.microsoft.com/en-us/library/hh509017(v=ws.10).aspx
186  */
187 struct owner_sid {
188         u8 Revision;
189         u8 NumAuth;
190         u8 Authority[6];
191         __le32 SubAuthorities[3];
192 } __packed;
193
194 struct owner_group_sids {
195         struct owner_sid owner;
196         struct owner_sid group;
197 } __packed;
198
199 /*
200  * Minimum security identifier can be one for system defined Users
201  * and Groups such as NULL SID and World or Built-in accounts such
202  * as Administrator and Guest and consists of
203  * Revision + Num (Sub)Auths + Authority + Domain (one Subauthority)
204  */
205 #define MIN_SID_LEN  (1 + 1 + 6 + 4) /* in bytes */
206
207 /*
208  * Minimum security descriptor can be one without any SACL and DACL and can
209  * consist of revision, type, and two sids of minimum size for owner and group
210  */
211 #define MIN_SEC_DESC_LEN  (sizeof(struct cifs_ntsd) + (2 * MIN_SID_LEN))
212
213 #endif /* _CIFSACL_H */