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