4 IDL structures for xattr file attributes
6 this has nothing to do with RPC, we are just using our NDR/IDL
7 infrastructure as a convenient way to store linearised information
8 about a file in a architecture independent manner
11 import
"security.idl";
14 uuid("12345778-1234-abcd-0001-00000002"),
16 helper
("../librpc/ndr/ndr_xattr.h"),
17 pyhelper
("librpc/ndr/py_xattr.c"),
18 pointer_default(unique)
22 const char *XATTR_DOSATTRIB_NAME
= "user.DosAttrib";
23 const char *XATTR_DOSATTRIB_NAME_S3
= "user.DOSATTRIB";
24 const int XATTR_DOSATTRIB_ESTIMATED_SIZE
= 64;
26 /* we store basic dos attributes in a DosAttrib xattr. By
27 using a union we can cope with new version of this
28 structure more easily */
31 * the FFFF level is never really used,
32 * it's used to pass the information from
33 * the old hex string attrib information
34 * we have a handwritten parser which converts
35 * the hex string to the xattr_DosInfoFFFFCompat strucure
40 } xattr_DosInfoFFFFCompat
;
52 We use xattrDosInfo1 again when we store values.
53 Because the sticky write time is now stored in the opendb
54 and xattr_DosInfo2Old is only present to parse existing
57 const int XATTR_ATTRIB_FLAG_STICKY_WRITE_TIME = 0x1;
67 NTTIME write_time
; /* only used when sticky write time is set */
71 typedef [bitmap32bit
] bitmap
{
72 XATTR_DOSINFO_ATTRIB
= 0x00000001,
73 XATTR_DOSINFO_EA_SIZE
= 0x00000002,
74 XATTR_DOSINFO_SIZE
= 0x00000004,
75 XATTR_DOSINFO_ALLOC_SIZE
= 0x00000008,
76 XATTR_DOSINFO_CREATE_TIME
= 0x00000010,
77 XATTR_DOSINFO_CHANGE_TIME
= 0x00000020
78 } xattr_DosInfoValidFlags
;
81 xattr_DosInfoValidFlags valid_flags
;
90 typedef [public,switch_type(uint16
)] union {
91 [case(0xFFFF)] xattr_DosInfoFFFFCompat compatinfoFFFF
;
92 [case(1)] xattr_DosInfo1 info1
;
93 [case(2)] xattr_DosInfo2Old oldinfo2
;
94 [case(3)] xattr_DosInfo3 info3
;
97 typedef [public] struct {
99 [switch_is(version)] xattr_DosInfo info
;
102 typedef [public,nopush
,nopull
,noprint
] struct {
105 [switch_is(version)] xattr_DosInfo info
;
108 void xattr_parse_DOSATTRIB
(
109 [in] xattr_DOSATTRIB x
112 /* we store DOS style extended attributes in a DosEAs xattr */
113 const char *XATTR_DOSEAS_NAME
= "user.DosEAs";
120 typedef [public] struct {
122 [size_is(num_eas
)] xattr_EA
*eas
;
125 /* Slightly different version, used by the vfs_xattr_tdb module */
126 typedef [public] struct {
128 xattr_EA eas
[num_eas
];
131 /* we store stream information in this xattr structure. Then
132 the streams themselves are stored in
133 user.DosStream.STREAMNAME or in external files, according
135 const char *XATTR_DOSSTREAMS_NAME
= "user.DosStreams";
137 const int XATTR_STREAM_FLAG_INTERNAL
= 0x00000001;
139 /* stream data is stored in attributes with the given prefix */
140 const char *XATTR_DOSSTREAM_PREFIX
= "user.DosStream.";
142 const int XATTR_MAX_STREAM_SIZE
= 0x4000;
143 const int XATTR_MAX_STREAM_SIZE_TDB
= 0x100000;
152 typedef [public] struct {
154 [size_is(num_streams
)] xattr_DosStream
*streams
;
158 /* we store the NT ACL a NTACL xattr. It is versioned so we
159 can later add other acl attribs (such as posix acl mapping)
161 we put this xattr in the security namespace to ensure that
162 only trusted users can write to the ACL
164 stored in "security.NTACL"
166 Version 1. raw SD stored as Samba4 does it.
167 Version 2. raw SD + last changed hash so we
168 can discard if this doesn't match the underlying ACL hash.
171 const char *XATTR_NTACL_NAME
= "security.NTACL";
173 const int XATTR_SD_HASH_SIZE
= 64;
174 const int XATTR_SD_HASH_TYPE_NONE
= 0x0;
175 const int XATTR_SD_HASH_TYPE_SHA256
= 0x1;
177 typedef [public] struct {
178 security_descriptor
*sd
;
180 } security_descriptor_hash_v2
; /* Hash never used in this version. */
182 typedef [public] struct {
183 security_descriptor
*sd
;
185 uint8 hash
[64]; /* 64 bytes hash. */
186 } security_descriptor_hash_v3
;
188 typedef [public] struct {
189 security_descriptor
*sd
;
191 uint8 hash
[64]; /* 64 bytes hash. */
192 utf8string description
; /* description of what created
193 * this hash (to allow
194 * foresnics later, if we have
195 * a bug in one codepath */
197 uint8 sys_acl_hash
[64]; /* 64 bytes hash. */
198 } security_descriptor_hash_v4
;
200 typedef [switch_type(uint16
)] union {
201 [case(1)] security_descriptor
*sd
;
202 [case(2)] security_descriptor_hash_v2
*sd_hs2
;
203 [case(3)] security_descriptor_hash_v3
*sd_hs3
;
204 [case(4)] security_descriptor_hash_v4
*sd_hs4
;
207 typedef [public] struct {
209 [switch_is(version)] xattr_NTACL_Info info
;
213 * A wrapper of the common information required to be in the
214 * hash of the ACL, for the acl_xattr and acl_tdb modules.
216 [public] typedef struct {
217 DATA_BLOB acl_as_blob
;
221 } xattr_sys_acl_hash_wrapper
;