librpc/idl/xattr.idl

   1 #include "idl_types.h"
   2
   3 /*
   4    IDL structures for xattr file attributes
   5
   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
   9 */
  10
  11 import "security.idl";
  12
  13 [
  14   version(0.0),
  15   helper("../librpc/ndr/ndr_xattr.h"),
  16   pyhelper("librpc/ndr/py_xattr.c"),
  17   pointer_default(unique)
  18 ]
  19 interface xattr
  20 {
  21         const char *XATTR_DOSATTRIB_NAME = "user.DosAttrib";
  22         const char *XATTR_DOSATTRIB_NAME_S3 = "user.DOSATTRIB";
  23         const int XATTR_DOSATTRIB_ESTIMATED_SIZE = 64;
  24
  25         /* we store basic dos attributes in a DosAttrib xattr. By
  26            using a union we can cope with new version of this
  27            structure more easily */
  28
  29         /*
  30          * the FFFF level is never really used,
  31          * it's used to pass the information from
  32          * the old hex string attrib information
  33          * we have a handwritten parser which converts
  34          * the hex string to the xattr_DosInfoFFFFCompat strucure
  35          */
  36
  37         typedef struct {
  38                 uint32 attrib;
  39         } xattr_DosInfoFFFFCompat;
  40
  41         typedef struct {
  42                 uint32 attrib;
  43                 uint32 ea_size;
  44                 udlong size;
  45                 udlong alloc_size;
  46                 NTTIME create_time;
  47                 NTTIME change_time;
  48         } xattr_DosInfo1;
  49
  50 /*
  51         We use xattrDosInfo1 again when we store values.
  52         Because the sticky write time is now stored in the opendb
  53         and xattr_DosInfo2Old is only present to parse existing
  54         values from disk.
  55
  56         const int XATTR_ATTRIB_FLAG_STICKY_WRITE_TIME = 0x1;
  57 */
  58         typedef struct {
  59                 uint32     flags;
  60                 uint32     attrib;
  61                 uint32     ea_size;
  62                 udlong     size;
  63                 udlong     alloc_size;
  64                 NTTIME     create_time;
  65                 NTTIME     change_time;
  66                 NTTIME     write_time; /* only used when sticky write time is set */
  67                 utf8string name;
  68         } xattr_DosInfo2Old;
  69
  70         typedef [bitmap32bit] bitmap {
  71                 XATTR_DOSINFO_ATTRIB            = 0x00000001,
  72                 XATTR_DOSINFO_EA_SIZE           = 0x00000002,
  73                 XATTR_DOSINFO_SIZE              = 0x00000004,
  74                 XATTR_DOSINFO_ALLOC_SIZE        = 0x00000008,
  75                 XATTR_DOSINFO_CREATE_TIME       = 0x00000010,
  76                 XATTR_DOSINFO_CHANGE_TIME       = 0x00000020,
  77                 XATTR_DOSINFO_ITIME             = 0x00000040
  78         } xattr_DosInfoValidFlags;
  79
  80         typedef struct {
  81                 xattr_DosInfoValidFlags valid_flags;
  82                 uint32 attrib;
  83                 uint32 ea_size;
  84                 udlong size;
  85                 udlong alloc_size;
  86                 NTTIME create_time;
  87                 NTTIME change_time;
  88         } xattr_DosInfo3;
  89
  90         typedef struct {
  91                 xattr_DosInfoValidFlags valid_flags;
  92                 uint32 attrib;
  93                 NTTIME itime;
  94                 NTTIME create_time;
  95         } xattr_DosInfo4;
  96
  97         typedef [public,switch_type(uint16)] union {
  98                 [case(0xFFFF)] xattr_DosInfoFFFFCompat compatinfoFFFF;
  99                 [case(1)] xattr_DosInfo1 info1;
 100                 [case(2)] xattr_DosInfo2Old oldinfo2;
 101                 [case(3)] xattr_DosInfo3 info3;
 102                 [case(4)] xattr_DosInfo4 info4;
 103         } xattr_DosInfo;
 104
 105         typedef [public] struct {
 106                 uint16 version;
 107                 [switch_is(version)] xattr_DosInfo info;
 108         } xattr_DosAttrib;
 109
 110         typedef [public,nopush,nopull,noprint] struct {
 111                 astring attrib_hex;
 112                 uint16 version;
 113                 [switch_is(version)] xattr_DosInfo info;
 114         } xattr_DOSATTRIB;
 115
 116         /* we store DOS style extended attributes in a DosEAs xattr */
 117         const char *XATTR_DOSEAS_NAME = "user.DosEAs";
 118
 119         typedef struct {
 120                 utf8string name;
 121                 DATA_BLOB value;
 122         } xattr_EA;
 123
 124         typedef [public] struct {
 125                 uint16 num_eas;
 126                 [size_is(num_eas)] xattr_EA *eas;
 127         } xattr_DosEAs;
 128
 129         /* Slightly different version, used by the vfs_xattr_tdb module */
 130         typedef [public] struct {
 131                 uint32 num_eas;
 132                 xattr_EA eas[num_eas];
 133         } tdb_xattrs;
 134
 135         /* we store stream information in this xattr structure. Then
 136            the streams themselves are stored in
 137            user.DosStream.STREAMNAME or in external files, according
 138            to the flags */
 139         const char *XATTR_DOSSTREAMS_NAME = "user.DosStreams";
 140
 141         const int XATTR_STREAM_FLAG_INTERNAL = 0x00000001;
 142
 143         /* stream data is stored in attributes with the given prefix */
 144         const char *XATTR_DOSSTREAM_PREFIX = "user.DosStream.";
 145
 146         const int XATTR_MAX_STREAM_SIZE     = 0x4000;
 147         const int XATTR_MAX_STREAM_SIZE_TDB = 0x100000;
 148
 149         typedef struct {
 150                 uint32     flags;
 151                 udlong     size;
 152                 udlong     alloc_size;
 153                 utf8string name;
 154         } xattr_DosStream;
 155
 156         typedef [public] struct {
 157                 uint32 num_streams;
 158                 [size_is(num_streams)] xattr_DosStream *streams;
 159         } xattr_DosStreams;
 160
 161
 162         /* we store the NT ACL a NTACL xattr. It is versioned so we
 163            can later add other acl attribs (such as posix acl mapping)
 164
 165            we put this xattr in the security namespace to ensure that
 166            only trusted users can write to the ACL
 167
 168            stored in "security.NTACL"
 169
 170            Version 1. raw SD stored as Samba4 does it.
 171            Version 2. raw SD + last changed hash so we
 172                       can discard if this doesn't match the underlying ACL hash.
 173         */
 174
 175         const char *XATTR_NTACL_NAME = "security.NTACL";
 176
 177         const int XATTR_SD_HASH_SIZE = 64;
 178         const int XATTR_SD_HASH_TYPE_NONE = 0x0;
 179         const int XATTR_SD_HASH_TYPE_SHA256 = 0x1;
 180
 181         typedef [public] struct {
 182                 security_descriptor *sd;
 183                 uint8 hash[16];
 184         } security_descriptor_hash_v2; /* Hash never used in this version. */
 185
 186         typedef [public] struct {
 187                 security_descriptor *sd;
 188                 uint16 hash_type;
 189                 uint8 hash[64]; /* 64 bytes hash. */
 190         } security_descriptor_hash_v3;
 191
 192         typedef [public] struct {
 193                 security_descriptor *sd;
 194                 uint16 hash_type;
 195                 uint8 hash[64]; /* 64 bytes hash. */
 196                 utf8string description; /* description of what created
 197                                          * this hash (to allow
 198                                          * forensics later, if we have
 199                                          * a bug in one codepath */
 200                 NTTIME time;
 201                 uint8 sys_acl_hash[64]; /* 64 bytes hash. */
 202         } security_descriptor_hash_v4;
 203
 204         typedef [switch_type(uint16)] union {
 205                 [case(1)] security_descriptor *sd;
 206                 [case(2)] security_descriptor_hash_v2 *sd_hs2;
 207                 [case(3)] security_descriptor_hash_v3 *sd_hs3;
 208                 [case(4)] security_descriptor_hash_v4 *sd_hs4;
 209         } xattr_NTACL_Info;
 210
 211         typedef [public] struct {
 212                 uint16 version;
 213                 [switch_is(version)] xattr_NTACL_Info info;
 214         } xattr_NTACL;
 215
 216         /*
 217          * A wrapper of the common information required to be in the
 218          * hash of the ACL, for the acl_xattr and acl_tdb modules.
 219          */
 220         [public] typedef struct {
 221                 DATA_BLOB acl_as_blob;
 222                 uid_t owner;
 223                 gid_t group;
 224                 mode_t mode;
 225         } xattr_sys_acl_hash_wrapper;
 226
 227 }