source/librpc/idl/security.idl

   1 #include "idl_types.h"
   2
   3 /*
   4   security IDL structures
   5 */
   6
   7 import "misc.idl";
   8
   9 /*
  10    use the same structure for dom_sid2 as dom_sid. A dom_sid2 is really
  11    just a dom sid, but with the sub_auths represented as a conformant
  12    array. As with all in-structure conformant arrays, the array length
  13    is placed before the start of the structure. That's what gives rise
  14    to the extra num_auths elemenent. We don't want the Samba code to
  15    have to bother with such esoteric NDR details, so its easier to just
  16    define it as a dom_sid and use pidl magic to make it all work. It
  17    just means you need to mark a sid as a "dom_sid2" in the IDL when you
  18    know it is of the conformant array variety
  19 */
  20 cpp_quote("#define dom_sid2 dom_sid")
  21
  22 /* same struct as dom_sid but inside a 28 bytes fixed buffer in NDR */
  23 cpp_quote("#define dom_sid28 dom_sid")
  24
  25 [
  26         pointer_default(unique)
  27 ]
  28 interface security
  29 {
  30         /*
  31           access masks are divided up like this:
  32                 0xabccdddd
  33                 where
  34                    a = generic rights bits        SEC_GENERIC_
  35                    b = flags                      SEC_FLAG_
  36                    c = standard rights bits       SEC_STD_
  37                    d = object type specific bits  SEC_{FILE,DIR,REG,xxx}_
  38
  39           common combinations of bits are prefixed with SEC_RIGHTS_
  40         */
  41         const int SEC_MASK_GENERIC         = 0xF0000000;
  42         const int SEC_MASK_FLAGS           = 0x0F000000;
  43         const int SEC_MASK_STANDARD        = 0x00FF0000;
  44         const int SEC_MASK_SPECIFIC        = 0x0000FFFF;
  45
  46         /* generic bits */
  47         const int SEC_GENERIC_ALL          = 0x10000000;
  48         const int SEC_GENERIC_EXECUTE      = 0x20000000;
  49         const int SEC_GENERIC_WRITE        = 0x40000000;
  50         const int SEC_GENERIC_READ         = 0x80000000;
  51
  52         /* flag bits */
  53         const int SEC_FLAG_SYSTEM_SECURITY = 0x01000000;
  54         const int SEC_FLAG_MAXIMUM_ALLOWED = 0x02000000;
  55
  56         /* standard bits */
  57         const int SEC_STD_DELETE           = 0x00010000;
  58         const int SEC_STD_READ_CONTROL     = 0x00020000;
  59         const int SEC_STD_WRITE_DAC        = 0x00040000;
  60         const int SEC_STD_WRITE_OWNER      = 0x00080000;
  61         const int SEC_STD_SYNCHRONIZE      = 0x00100000;
  62         const int SEC_STD_REQUIRED         = 0x000F0000;
  63         const int SEC_STD_ALL              = 0x001F0000;
  64
  65         /* file specific bits */
  66         const int SEC_FILE_READ_DATA       = 0x00000001;
  67         const int SEC_FILE_WRITE_DATA      = 0x00000002;
  68         const int SEC_FILE_APPEND_DATA     = 0x00000004;
  69         const int SEC_FILE_READ_EA         = 0x00000008;
  70         const int SEC_FILE_WRITE_EA        = 0x00000010;
  71         const int SEC_FILE_EXECUTE         = 0x00000020;
  72         const int SEC_FILE_READ_ATTRIBUTE  = 0x00000080;
  73         const int SEC_FILE_WRITE_ATTRIBUTE = 0x00000100;
  74         const int SEC_FILE_ALL             = 0x000001ff;
  75
  76         /* directory specific bits */
  77         const int SEC_DIR_LIST             = 0x00000001;
  78         const int SEC_DIR_ADD_FILE         = 0x00000002;
  79         const int SEC_DIR_ADD_SUBDIR       = 0x00000004;
  80         const int SEC_DIR_READ_EA          = 0x00000008;
  81         const int SEC_DIR_WRITE_EA         = 0x00000010;
  82         const int SEC_DIR_TRAVERSE         = 0x00000020;
  83         const int SEC_DIR_DELETE_CHILD     = 0x00000040;
  84         const int SEC_DIR_READ_ATTRIBUTE   = 0x00000080;
  85         const int SEC_DIR_WRITE_ATTRIBUTE  = 0x00000100;
  86
  87         /* registry entry specific bits */
  88         const int SEC_REG_QUERY_VALUE      = 0x00000001;
  89         const int SEC_REG_SET_VALUE        = 0x00000002;
  90         const int SEC_REG_CREATE_SUBKEY    = 0x00000004;
  91         const int SEC_REG_ENUM_SUBKEYS     = 0x00000008;
  92         const int SEC_REG_NOTIFY           = 0x00000010;
  93         const int SEC_REG_CREATE_LINK      = 0x00000020;
  94
  95         /* ldap specific access bits */
  96         const int SEC_ADS_CREATE_CHILD     = 0x00000001;
  97         const int SEC_ADS_DELETE_CHILD     = 0x00000002;
  98         const int SEC_ADS_LIST             = 0x00000004;
  99         const int SEC_ADS_SELF_WRITE       = 0x00000008;
 100         const int SEC_ADS_READ_PROP        = 0x00000010;
 101         const int SEC_ADS_WRITE_PROP       = 0x00000020;
 102         const int SEC_ADS_DELETE_TREE      = 0x00000040;
 103         const int SEC_ADS_LIST_OBJECT      = 0x00000080;
 104         const int SEC_ADS_CONTROL_ACCESS   = 0x00000100;
 105
 106         /* generic->specific mappings for files */
 107         const int SEC_RIGHTS_FILE_READ    = SEC_STD_READ_CONTROL |
 108                                             SEC_STD_SYNCHRONIZE |
 109                                             SEC_FILE_READ_DATA |
 110                                             SEC_FILE_READ_ATTRIBUTE |
 111                                             SEC_FILE_READ_EA;
 112
 113         const int SEC_RIGHTS_FILE_WRITE   = SEC_STD_READ_CONTROL |
 114                                             SEC_STD_SYNCHRONIZE |
 115                                             SEC_FILE_WRITE_DATA |
 116                                             SEC_FILE_WRITE_ATTRIBUTE |
 117                                             SEC_FILE_WRITE_EA |
 118                                             SEC_FILE_APPEND_DATA;
 119
 120         const int SEC_RIGHTS_FILE_EXECUTE = SEC_STD_SYNCHRONIZE |
 121                                             SEC_STD_READ_CONTROL |
 122                                             SEC_FILE_READ_ATTRIBUTE |
 123                                             SEC_FILE_EXECUTE;
 124
 125         const int SEC_RIGHTS_FILE_ALL     = SEC_STD_ALL | SEC_FILE_ALL;
 126
 127         /* generic->specific mappings for directories (same as files) */
 128         const int SEC_RIGHTS_DIR_READ     = SEC_RIGHTS_FILE_READ;
 129         const int SEC_RIGHTS_DIR_WRITE    = SEC_RIGHTS_FILE_WRITE;
 130         const int SEC_RIGHTS_DIR_EXECUTE  = SEC_RIGHTS_FILE_EXECUTE;
 131         const int SEC_RIGHTS_DIR_ALL      = SEC_RIGHTS_FILE_ALL;
 132
 133
 134         /***************************************************************/
 135         /* WELL KNOWN SIDS */
 136
 137         /* a NULL sid */
 138         const string SID_NULL = "S-1-0-0";
 139
 140         /* the world domain */
 141         const string NAME_WORLD       = "WORLD";
 142
 143         const string SID_WORLD_DOMAIN = "S-1-1";
 144         const string SID_WORLD        = "S-1-1-0";
 145
 146         /* SECURITY_CREATOR_SID_AUTHORITY */
 147         const string SID_CREATOR_OWNER_DOMAIN = "S-1-3";
 148         const string SID_CREATOR_OWNER        = "S-1-3-0";
 149         const string SID_CREATOR_GROUP        = "S-1-3-1";
 150
 151         /* SECURITY_NT_AUTHORITY */
 152         const string NAME_NT_AUTHORITY            = "NT AUTHORITY";
 153
 154         const string SID_NT_AUTHORITY             = "S-1-5";
 155         const string SID_NT_DIALUP                = "S-1-5-1";
 156         const string SID_NT_NETWORK               = "S-1-5-2";
 157         const string SID_NT_BATCH                 = "S-1-5-3";
 158         const string SID_NT_INTERACTIVE           = "S-1-5-4";
 159         const string SID_NT_SERVICE               = "S-1-5-6";
 160         const string SID_NT_ANONYMOUS             = "S-1-5-7";
 161         const string SID_NT_PROXY                 = "S-1-5-8";
 162         const string SID_NT_ENTERPRISE_DCS        = "S-1-5-9";
 163         const string SID_NT_SELF                  = "S-1-5-10";
 164         const string SID_NT_AUTHENTICATED_USERS   = "S-1-5-11";
 165         const string SID_NT_RESTRICTED            = "S-1-5-12";
 166         const string SID_NT_TERMINAL_SERVER_USERS = "S-1-5-13";
 167         const string SID_NT_REMOTE_INTERACTIVE    = "S-1-5-14";
 168         const string SID_NT_THIS_ORGANISATION     = "S-1-5-15";
 169         const string SID_NT_SYSTEM                = "S-1-5-18";
 170         const string SID_NT_LOCAL_SERVICE         = "S-1-5-19";
 171         const string SID_NT_NETWORK_SERVICE       = "S-1-5-20";
 172
 173         /* SECURITY_BUILTIN_DOMAIN_RID */
 174         const string NAME_BUILTIN                  = "BUILTIN";
 175
 176         const string SID_BUILTIN                   = "S-1-5-32";
 177         const string SID_BUILTIN_ADMINISTRATORS    = "S-1-5-32-544";
 178         const string SID_BUILTIN_USERS             = "S-1-5-32-545";
 179         const string SID_BUILTIN_GUESTS            = "S-1-5-32-546";
 180         const string SID_BUILTIN_POWER_USERS       = "S-1-5-32-547";
 181         const string SID_BUILTIN_ACCOUNT_OPERATORS = "S-1-5-32-548";
 182         const string SID_BUILTIN_SERVER_OPERATORS  = "S-1-5-32-549";
 183         const string SID_BUILTIN_PRINT_OPERATORS   = "S-1-5-32-550";
 184         const string SID_BUILTIN_BACKUP_OPERATORS  = "S-1-5-32-551";
 185         const string SID_BUILTIN_REPLICATOR        = "S-1-5-32-552";
 186         const string SID_BUILTIN_RAS_SERVERS       = "S-1-5-32-553";
 187         const string SID_BUILTIN_PREW2K            = "S-1-5-32-554";
 188
 189         /* well-known domain RIDs */
 190         const int DOMAIN_RID_LOGON                 = 9;
 191         const int DOMAIN_RID_ADMINISTRATOR         = 500;
 192         const int DOMAIN_RID_GUEST                 = 501;
 193         const int DOMAIN_RID_ADMINS                = 512;
 194         const int DOMAIN_RID_USERS                 = 513;
 195         const int DOMAIN_RID_DOMAIN_MEMBERS        = 515;
 196         const int DOMAIN_RID_DCS                   = 516;
 197         const int DOMAIN_RID_CERT_ADMINS           = 517;
 198         const int DOMAIN_RID_SCHEMA_ADMINS         = 518;
 199         const int DOMAIN_RID_ENTERPRISE_ADMINS     = 519;
 200
 201
 202         /*
 203           privilege IDs. Please keep the IDs below 64. If we get more
 204           than 64 then we need to change security_token
 205         */
 206         typedef enum {
 207                 SEC_PRIV_SECURITY                  = 1,
 208                 SEC_PRIV_BACKUP                    = 2,
 209                 SEC_PRIV_RESTORE                   = 3,
 210                 SEC_PRIV_SYSTEMTIME                = 4,
 211                 SEC_PRIV_SHUTDOWN                  = 5,
 212                 SEC_PRIV_REMOTE_SHUTDOWN           = 6,
 213                 SEC_PRIV_TAKE_OWNERSHIP            = 7,
 214                 SEC_PRIV_DEBUG                     = 8,
 215                 SEC_PRIV_SYSTEM_ENVIRONMENT        = 9,
 216                 SEC_PRIV_SYSTEM_PROFILE            = 10,
 217                 SEC_PRIV_PROFILE_SINGLE_PROCESS    = 11,
 218                 SEC_PRIV_INCREASE_BASE_PRIORITY    = 12,
 219                 SEC_PRIV_LOAD_DRIVER               = 13,
 220                 SEC_PRIV_CREATE_PAGEFILE           = 14,
 221                 SEC_PRIV_INCREASE_QUOTA            = 15,
 222                 SEC_PRIV_CHANGE_NOTIFY             = 16,
 223                 SEC_PRIV_UNDOCK                    = 17,
 224                 SEC_PRIV_MANAGE_VOLUME             = 18,
 225                 SEC_PRIV_IMPERSONATE               = 19,
 226                 SEC_PRIV_CREATE_GLOBAL             = 20,
 227                 SEC_PRIV_ENABLE_DELEGATION         = 21,
 228                 SEC_PRIV_INTERACTIVE_LOGON         = 22,
 229                 SEC_PRIV_NETWORK_LOGON             = 23,
 230                 SEC_PRIV_REMOTE_INTERACTIVE_LOGON  = 24
 231         } sec_privilege;
 232
 233
 234         /* a domain SID. Note that unlike Samba3 this contains a pointer,
 235            so you can't copy them using assignment */
 236         typedef [public,gensize,noprint,noejs,nosize] struct {
 237                 uint8  sid_rev_num;             /**< SID revision number */
 238                 [range(0,15)] int8  num_auths;  /**< Number of sub-authorities */
 239                 uint8  id_auth[6];              /**< Identifier Authority */
 240                 uint32 sub_auths[num_auths];
 241         } dom_sid;
 242
 243         typedef [bitmap8bit] bitmap {
 244                 SEC_ACE_FLAG_OBJECT_INHERIT             = 0x01,
 245                 SEC_ACE_FLAG_CONTAINER_INHERIT          = 0x02,
 246                 SEC_ACE_FLAG_NO_PROPAGATE_INHERIT       = 0x04,
 247                 SEC_ACE_FLAG_INHERIT_ONLY               = 0x08,
 248                 SEC_ACE_FLAG_INHERITED_ACE              = 0x10,
 249                 SEC_ACE_FLAG_VALID_INHERIT              = 0x0f,
 250                 SEC_ACE_FLAG_SUCCESSFUL_ACCESS          = 0x40,
 251                 SEC_ACE_FLAG_FAILED_ACCESS              = 0x80
 252         } security_ace_flags;
 253
 254         typedef [enum8bit] enum {
 255                 SEC_ACE_TYPE_ACCESS_ALLOWED             = 0,
 256                 SEC_ACE_TYPE_ACCESS_DENIED              = 1,
 257                 SEC_ACE_TYPE_SYSTEM_AUDIT               = 2,
 258                 SEC_ACE_TYPE_SYSTEM_ALARM               = 3,
 259                 SEC_ACE_TYPE_ALLOWED_COMPOUND           = 4,
 260                 SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT      = 5,
 261                 SEC_ACE_TYPE_ACCESS_DENIED_OBJECT       = 6,
 262                 SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT        = 7,
 263                 SEC_ACE_TYPE_SYSTEM_ALARM_OBJECT        = 8
 264         } security_ace_type;
 265
 266         typedef [bitmap32bit] bitmap {
 267                 SEC_ACE_OBJECT_TYPE_PRESENT             = 0x00000001,
 268                 SEC_ACE_INHERITED_OBJECT_TYPE_PRESENT   = 0x00000002
 269         } security_ace_object_flags;
 270
 271         typedef [nodiscriminant] union {
 272                 /* this is the 'schemaIDGUID' attribute of the attribute object in the schema naming context */
 273                 [case(SEC_ACE_OBJECT_TYPE_PRESENT)] GUID type;
 274                 [default];
 275         } security_ace_object_type;
 276
 277         typedef [nodiscriminant] union {
 278                 /* this is the 'schemaIDGUID' attribute of the objectclass object in the schema naming context
 279                  * (of the parent container)
 280                  */
 281                 [case(SEC_ACE_INHERITED_OBJECT_TYPE_PRESENT)] GUID inherited_type;
 282                 [default];
 283         } security_ace_object_inherited_type;
 284
 285         typedef struct {
 286                 security_ace_object_flags flags;
 287                 [switch_is(flags & SEC_ACE_OBJECT_TYPE_PRESENT)] security_ace_object_type type;
 288                 [switch_is(flags & SEC_ACE_INHERITED_OBJECT_TYPE_PRESENT)] security_ace_object_inherited_type inherited_type;
 289         } security_ace_object;
 290
 291         typedef [nodiscriminant] union {
 292                 [case(SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT)] security_ace_object object;
 293                 [case(SEC_ACE_TYPE_ACCESS_DENIED_OBJECT)] security_ace_object object;
 294                 [case(SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT)] security_ace_object object;
 295                 [case(SEC_ACE_TYPE_SYSTEM_ALARM_OBJECT)] security_ace_object object;
 296                 [default];
 297         } security_ace_object_ctr;
 298
 299         typedef [public,gensize,nosize] struct {
 300                 security_ace_type type;  /* SEC_ACE_TYPE_* */
 301                 security_ace_flags flags; /* SEC_ACE_FLAG_* */
 302                 [value(ndr_size_security_ace(r,ndr->flags))] uint16 size;
 303                 uint32 access_mask;
 304                 [switch_is(type)] security_ace_object_ctr object;
 305                 dom_sid trustee;
 306         } security_ace;
 307
 308         typedef enum {
 309                 SECURITY_ACL_REVISION_NT4       = 2,
 310                 SECURITY_ACL_REVISION_ADS       = 4
 311         } security_acl_revision;
 312
 313         const uint NT4_ACL_REVISION     = SECURITY_ACL_REVISION_NT4;
 314
 315         typedef [public,gensize,nosize] struct {
 316                 security_acl_revision revision;
 317                 [value(ndr_size_security_acl(r,ndr->flags))] uint16 size;
 318                 [range(0,1000)] uint32 num_aces;
 319                 security_ace aces[num_aces];
 320         } security_acl;
 321
 322         /* default revision for new ACLs */
 323         typedef [enum8bit] enum {
 324                 SECURITY_DESCRIPTOR_REVISION_1 = 1
 325         } security_descriptor_revision;
 326
 327         const int SD_REVISION                    = SECURITY_DESCRIPTOR_REVISION_1;
 328
 329         /* security_descriptor->type bits */
 330         typedef [bitmap16bit] bitmap {
 331                 SEC_DESC_OWNER_DEFAULTED        = 0x0001,
 332                 SEC_DESC_GROUP_DEFAULTED        = 0x0002,
 333                 SEC_DESC_DACL_PRESENT           = 0x0004,
 334                 SEC_DESC_DACL_DEFAULTED         = 0x0008,
 335                 SEC_DESC_SACL_PRESENT           = 0x0010,
 336                 SEC_DESC_SACL_DEFAULTED         = 0x0020,
 337                 SEC_DESC_DACL_TRUSTED           = 0x0040,
 338                 SEC_DESC_SERVER_SECURITY        = 0x0080,
 339                 SEC_DESC_DACL_AUTO_INHERIT_REQ  = 0x0100,
 340                 SEC_DESC_SACL_AUTO_INHERIT_REQ  = 0x0200,
 341                 SEC_DESC_DACL_AUTO_INHERITED    = 0x0400,
 342                 SEC_DESC_SACL_AUTO_INHERITED    = 0x0800,
 343                 SEC_DESC_DACL_PROTECTED         = 0x1000,
 344                 SEC_DESC_SACL_PROTECTED         = 0x2000,
 345                 SEC_DESC_RM_CONTROL_VALID       = 0x4000,
 346                 SEC_DESC_SELF_RELATIVE          = 0x8000
 347         } security_descriptor_type;
 348
 349         typedef [gensize,nosize,public,flag(NDR_LITTLE_ENDIAN)] struct {
 350                 security_descriptor_revision revision;
 351                 security_descriptor_type type;     /* SEC_DESC_xxxx flags */
 352                 [relative] dom_sid *owner_sid;
 353                 [relative] dom_sid *group_sid;
 354                 [relative] security_acl *sacl; /* system ACL */
 355                 [relative] security_acl *dacl; /* user (discretionary) ACL */
 356         } security_descriptor;
 357
 358         typedef [public] struct {
 359                 [range(0,0x40000),value(ndr_size_security_descriptor(sd,ndr->flags))] uint32 sd_size;
 360                 [subcontext(4)] security_descriptor *sd;
 361         } sec_desc_buf;
 362
 363         typedef [public] struct {
 364                 dom_sid *user_sid;
 365                 dom_sid *group_sid;
 366                 uint32 num_sids;
 367                 [size_is(num_sids)] dom_sid *sids[*];
 368                 udlong privilege_mask;
 369         } security_token;
 370
 371         /* bits that determine which parts of a security descriptor
 372            are being queried/set */
 373         typedef [public,bitmap32bit] bitmap {
 374                 SECINFO_OWNER                = 0x00000001,
 375                 SECINFO_GROUP                = 0x00000002,
 376                 SECINFO_DACL                 = 0x00000004,
 377                 SECINFO_SACL                 = 0x00000008,
 378                 SECINFO_UNPROTECTED_SACL     = 0x10000000,
 379                 SECINFO_UNPROTECTED_DACL     = 0x20000000,
 380                 SECINFO_PROTECTED_SACL       = 0x40000000,
 381                 SECINFO_PROTECTED_DACL       = 0x80000000
 382         } security_secinfo;
 383 }