?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
s3:smbXsrv.idl: remove smbXsrv_*0 defines
[Samba/gebeck_regimport.git] / source3 / librpc / idl / smbXsrv.idl
blobb3f2250313f641d35fb3dc28929e0d54f6778422
1 #include "idl_types.h"
2
3 import "server_id.idl";
4 import "security.idl";
5 import "auth.idl";
6
7 [
8 uuid("07408340-ae31-11e1-97dc-539f7fddc06f"),
9 version(0.0),
10 pointer_default(unique),
11 helpstring("smbXsrv structures")
12 ]
13 interface smbXsrv
14 {
15 /*
16 * smbXsrv_version* is designed to allow
17 * rolling code upgrades in future (within a cluster).
18 *
19 * This just adds the infrastructure,
20 * but we does not implement it yet!
21 *
22 * Currently it only prevents that
23 * nodes with a different version numbers
24 * cannot run at the same time.
25 *
26 * Each node checks at startup, if the version
27 * matches the version of all other nodes.
28 * And it exits if the version does not match
29 * to avoid corruption.
30 *
31 * While it would be possible to add versioning
32 * to each of our internal databases it is easier
33 * use a dedicated database "smbXsrv_version_global.tdb"
34 * to hold the global version information.
35 *
36 * This removes extra complexity from the individual
37 * databases and allows that we add/remove databases
38 * or use different indexing keys.
39 *
40 */
41 typedef [v1_enum] enum {
42 /*
43 * NOTE: Version 0 is designed to be unstable and the format
44 * may change during development.
45 */
46 SMBXSRV_VERSION_0 = 0x00000000
47 } smbXsrv_version_values;
48
49 const uint32 SMBXSRV_VERSION_CURRENT = SMBXSRV_VERSION_0;
50
51 typedef struct {
52 server_id server_id;
53 smbXsrv_version_values min_version;
54 smbXsrv_version_values max_version;
55 smbXsrv_version_values current_version;
56 } smbXsrv_version_node0;
57
58 typedef struct {
59 [ignore] db_record *db_rec;
60 [range(1, 1024)] uint32 num_nodes;
61 smbXsrv_version_node0 nodes[num_nodes];
62 } smbXsrv_version_global0;
63
64 typedef union {
65 [case(0)] smbXsrv_version_global0 *info0;
66 [default] hyper *dummy;
67 } smbXsrv_version_globalU;
68
69 typedef [public] struct {
70 smbXsrv_version_values version;
71 uint32 seqnum;
72 [switch_is(version)] smbXsrv_version_globalU info;
73 } smbXsrv_version_globalB;
74
75 void smbXsrv_version_global_decode(
76 [in] smbXsrv_version_globalB blob
77 );
78
79 /* sessions */
80
81 typedef struct {
82 server_id server_id;
83 [charset(UTF8),string] char local_address[];
84 [charset(UTF8),string] char remote_address[];
85 [charset(UTF8),string] char remote_name[];
86 [noprint] DATA_BLOB signing_key;
87 uint32 auth_session_info_seqnum;
88 } smbXsrv_channel_global0;
89
90 typedef struct {
91 [ignore] db_record *db_rec;
92 uint32 session_global_id;
93 hyper session_wire_id;
94 NTTIME creation_time;
95 NTTIME expiration_time;
96 /*
97 * auth_session is NULL until the
98 * session is valid for the first time.
99 */
100 uint32 auth_session_info_seqnum;
101 auth_session_info *auth_session_info;
102 uint16 connection_dialect;
103 boolean8 signing_required;
104 boolean8 encryption_required;
105 [noprint] DATA_BLOB signing_key;
106 [noprint] DATA_BLOB encryption_key;
107 [noprint] DATA_BLOB decryption_key;
108 [noprint] DATA_BLOB application_key;
109 [range(1, 1024)] uint32 num_channels;
110 smbXsrv_channel_global0 channels[num_channels];
111 } smbXsrv_session_global0;
112
113 typedef union {
114 [case(0)] smbXsrv_session_global0 *info0;
115 [default] hyper *dummy;
116 } smbXsrv_session_globalU;
117
118 typedef [public] struct {
119 smbXsrv_version_values version;
120 uint32 seqnum;
121 [switch_is(version)] smbXsrv_session_globalU info;
122 } smbXsrv_session_globalB;
123
124 void smbXsrv_session_global_decode(
125 [in] smbXsrv_session_globalB blob
126 );
127
128 /*
129 * The main server code should just work with
130 * 'struct smbXsrv_session' and never use
131 * smbXsrv_session0, smbXsrv_sessionU
132 * and smbXsrv_sessionB directly.
133 *
134 * If we need to change the smbXsrv_session,
135 * we can just rename smbXsrv_session
136 * to smbXsrv_session0 and add a new
137 * smbXsrv_session for version 1
138 * and could implement transparent mapping.
139 */
140 typedef struct {
141 [ignore] smbXsrv_session_table *table;
142 [ignore] db_record *db_rec;
143 [ignore] smbXsrv_connection *connection;
144 uint32 local_id;
145 [ref] smbXsrv_session_global0 *global;
146 NTSTATUS status;
147 NTTIME idle_time;
148 [ignore] gensec_security *gensec;
149 [ignore] user_struct *compat;
150 [ignore] smbXsrv_tcon_table *tcon_table;
151 } smbXsrv_session;
152
153 typedef union {
154 [case(0)] smbXsrv_session *info0;
155 [default] hyper *dummy;
156 } smbXsrv_sessionU;
157
158 typedef [public] struct {
159 smbXsrv_version_values version;
160 [value(0)] uint32 reserved;
161 [switch_is(version)] smbXsrv_sessionU info;
162 } smbXsrv_sessionB;
163
164 void smbXsrv_session_decode(
165 [in] smbXsrv_sessionB blob
166 );
167
168 /*
169 * smbXsrv_session_close is use in the MSG_SMBXSRV_SESSION_CLOSE
170 * message
171 */
172 typedef struct {
173 uint32 old_session_global_id;
174 hyper old_session_wire_id;
175 NTTIME old_creation_time;
176 hyper new_session_wire_id;
177 } smbXsrv_session_close0;
178
179 typedef union {
180 [case(0)] smbXsrv_session_close0 *info0;
181 [default] hyper *dummy;
182 } smbXsrv_session_closeU;
183
184 typedef [public] struct {
185 smbXsrv_version_values version;
186 [value(0)] uint32 reserved;
187 [switch_is(version)] smbXsrv_session_closeU info;
188 } smbXsrv_session_closeB;
189
190 void smbXsrv_session_close_decode(
191 [in] smbXsrv_session_closeB blob
192 );
193
194 /* tree connects */
195
196 typedef struct {
197 [ignore] db_record *db_rec;
198 uint32 tcon_global_id;
199 uint32 tcon_wire_id;
200 server_id server_id;
201 NTTIME creation_time;
202 [charset(UTF8),string] char share_name[];
203 boolean8 encryption_required;
204 } smbXsrv_tcon_global0;
205
206 typedef union {
207 [case(0)] smbXsrv_tcon_global0 *info0;
208 [default] hyper *dummy;
209 } smbXsrv_tcon_globalU;
210
211 typedef [public] struct {
212 smbXsrv_version_values version;
213 uint32 seqnum;
214 [switch_is(version)] smbXsrv_tcon_globalU info;
215 } smbXsrv_tcon_globalB;
216
217 void smbXsrv_tcon_global_decode(
218 [in] smbXsrv_tcon_globalB blob
219 );
220
221 /*
222 * The main server code should just work with
223 * 'struct smbXsrv_tcon' and never use
224 * smbXsrv_tcon0, smbXsrv_tconU
225 * and smbXsrv_tconB directly.
226 *
227 * If we need to change the smbXsrv_tcon,
228 * we can just rename smbXsrv_tcon
229 * to smbXsrv_tcon0 and add a new
230 * smbXsrv_tcon for version 1
231 * and could implement transparent mapping.
232 */
233 typedef struct {
234 [ignore] smbXsrv_tcon_table *table;
235 [ignore] db_record *db_rec;
236 uint32 local_id;
237 [ref] smbXsrv_tcon_global0 *global;
238 NTSTATUS status;
239 NTTIME idle_time;
240 [ignore] connection_struct *compat;
241 } smbXsrv_tcon;
242
243 typedef union {
244 [case(0)] smbXsrv_tcon *info0;
245 [default] hyper *dummy;
246 } smbXsrv_tconU;
247
248 typedef [public] struct {
249 smbXsrv_version_values version;
250 [value(0)] uint32 reserved;
251 [switch_is(version)] smbXsrv_tconU info;
252 } smbXsrv_tconB;
253
254 void smbXsrv_tcon_decode(
255 [in] smbXsrv_tconB blob
256 );
257
258 /* open files */
259
260 typedef struct {
261 [ignore] db_record *db_rec;
262 server_id server_id;
263 uint32 open_global_id;
264 hyper open_persistent_id;
265 hyper open_volatile_id;
266 dom_sid open_owner;
267 NTTIME open_time;
268 /*
269 * TODO: for durable/resilient/persistent handles we need more
270 * things here. See [MS-SMB2] 3.3.1.10 Per Open
271 *
272 * NOTE: this is still version 0, which is not a stable format!
273 */
274 } smbXsrv_open_global0;
275
276 typedef union {
277 [case(0)] smbXsrv_open_global0 *info0;
278 [default] hyper *dummy;
279 } smbXsrv_open_globalU;
280
281 typedef [public] struct {
282
283 smbXsrv_version_values version;
284 uint32 seqnum;
285 [switch_is(version)] smbXsrv_open_globalU info;
286 } smbXsrv_open_globalB;
287
288 void smbXsrv_open_global_decode(
289 [in] smbXsrv_open_globalB blob
290 );
291
292 /*
293 * The main server code should just work with
294 * 'struct smbXsrv_open' and never use
295 * smbXsrv_open0, smbXsrv_openU
296 * and smbXsrv_openB directly.
297 *
298 * If we need to change the smbXsrv_open,
299 * we can just rename smbXsrv_open
300 * to smbXsrv_open0 and add a new
301 * smbXsrv_open for version 1
302 * and could implement transparent mapping.
303 */
304 typedef struct {
305 [ignore] smbXsrv_open_table *table;
306 [ignore] db_record *db_rec;
307 uint32 local_id;
308 [ref] smbXsrv_open_global0 *global;
309 NTSTATUS status;
310 NTTIME idle_time;
311 [ignore] files_struct *compat;
312 } smbXsrv_open;
313
314 typedef union {
315 [case(0)] smbXsrv_open *info0;
316 [default] hyper *dummy;
317 } smbXsrv_openU;
318
319 typedef [public] struct {
320 smbXsrv_version_values version;
321 [value(0)] uint32 reserved;
322 [switch_is(version)] smbXsrv_openU info;
323 } smbXsrv_openB;
324
325 void smbXsrv_open_decode(
326 [in] smbXsrv_openB blob
327 );
328 }
reg import