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