source4/librpc/idl/security.idl

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