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