summaryrefslogtreecommitdiff
path: root/source4/librpc/idl/epmapper.idl
blob: 042c55f2a9df555d8fa07c0d1bc5ea69af390f65 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
#include "idl_types.h"

/*
  endpoint mapper interface
  Related links:
	http://www.opengroup.org/onlinepubs/9629399/apdxl.htm : Details on towers
http://www.opengroup.org/onlinepubs/9629399/chap6.htm#tagcjh_11_02_03_01: binding strings

*/

[
 uuid(e1af8308-5d1f-11c9-91a4-08002b14a0fa), 
 version(3.0), 
 endpoints(epmapper, TCP-135),
 pointer_default(unique)
]
interface epmapper
{

	/*
	  note that the following IDL won't work in MIDL, and in fact
	  that the full towers/floors representation of epm cannot be
	  represented in MIDL at all. I decided to represent it using
	  the extended IDL syntax in pidl to make it easier to work
	  with.
	*/

	const int EPMAPPER_STATUS_NO_MORE_ENTRIES = 0x16c9a0d6;
	const int EPMAPPER_STATUS_NO_MEMORY = 0x16C9A012;
	const int EPMAPPER_STATUS_OK = 0;


	/* this guid indicates NDR encoding in a protocol tower */
	const string NDR_GUID = "8a885d04-1ceb-11c9-9fe8-08002b104860";
	const string NDR_GUID_VERSION = 2;

	const uint32 EPMAPPER_PORT = 135;

	typedef struct {
		GUID uuid;
		uint16 version;
	} epm_prot_uuid;

	typedef enum {
		
		/* Level 4 and higher */
		EPM_PROTOCOL_DNET_NSP		= 0x04,
		EPM_PROTOCOL_OSI_TP4  		= 0x05,
		EPM_PROTOCOL_OSI_CLNS 		= 0x06,
		EPM_PROTOCOL_TCP     		= 0x07,
		EPM_PROTOCOL_UDP     		= 0x08,
		EPM_PROTOCOL_IP      		= 0x09,

		/* These 4 are protocol identifiers, always at level 3 or lower */
		EPM_PROTOCOL_NCADG 			= 0x0a, /* Connectionless RPC */
		EPM_PROTOCOL_NCACN 			= 0x0b,
		EPM_PROTOCOL_NCALRPC 		= 0x0c, /* Local RPC */
		EPM_PROTOCOL_UUID 			= 0x0d,

		EPM_PROTOCOL_IPX  			= 0x0e,
		EPM_PROTOCOL_SMB     		= 0x0f,
		EPM_PROTOCOL_PIPE    		= 0x10,
		EPM_PROTOCOL_NETBIOS 		= 0x11,
		EPM_PROTOCOL_NB_NB   		= 0x12, /* NetBIOS over NetBEUI */
		EPM_PROTOCOL_SPX     		= 0x13,
		EPM_PROTOCOL_NB_IPX  		= 0x14, /* NetBIOS over IPX */
		EPM_PROTOCOL_HTTP    		= 0x1f,
		EPM_PROTOCOL_UNIX_DS  		= 0x20,  /* Unix domain socket */
		EPM_PROTOCOL_NULL			= 0x21
	} epm_protocols;

	typedef [nodiscriminant] union {
		[case(EPM_PROTOCOL_UUID)] epm_prot_uuid uuid;
		[default]  [flag(NDR_REMAINING)] DATA_BLOB lhs_data;
	} epm_protocol_info;

	typedef struct {
		//FIXME	
	} epm_rhs_dnet_nsp;

	typedef struct {
		//FIXME
	} epm_rhs_osi_tp4;

	typedef struct {
		//FIXME
	} epm_rhs_osi_clns;
	
	typedef struct {
		uint16 port;
	} epm_rhs_udp;

	typedef struct {
		uint16 port;
	} epm_rhs_tcp;

	typedef struct {
		uint32 address;
	} epm_rhs_ip;

	typedef struct {
		uint16 minor_version;
	} epm_rhs_ncadg;

	typedef struct {
		uint16 minor_version;
	} epm_rhs_ncacn;

	typedef struct {
		uint16 unknown;
	} epm_rhs_uuid;

	typedef struct {
		//FIXME	
	} epm_rhs_ipx;

	typedef struct {
		astring unc;
	} epm_rhs_smb;

	typedef struct {
		astring path;	
	} epm_rhs_pipe;

	typedef struct {
		astring name;
	} epm_rhs_netbios;

	typedef struct {
	} epm_rhs_nb_nb;

	typedef struct {
	} epm_rhs_spx;

	typedef struct {
	} epm_rhs_nb_ipx;

	typedef struct {
		uint16 port;
	} epm_rhs_http;

	typedef struct {
		astring path;
	} epm_rhs_unix_ds;

	typedef struct {
	} epm_rhs_null;

	typedef struct {
	} epm_rhs_ncalrpc;

	typedef [nodiscriminant] union {
		[case(EPM_PROTOCOL_DNET_NSP)] epm_rhs_dnet_nsp dnet_nsp;
		[case(EPM_PROTOCOL_OSI_TP4)] epm_rhs_osi_tp4 osi_tp4;
		[case(EPM_PROTOCOL_OSI_CLNS)] epm_rhs_osi_clns osi_clns;
		[case(EPM_PROTOCOL_TCP)] epm_rhs_tcp tcp;
		[case(EPM_PROTOCOL_UDP)] epm_rhs_udp udp;
		[case(EPM_PROTOCOL_IP)] epm_rhs_ip ip;
		[case(EPM_PROTOCOL_NCADG)] epm_rhs_ncadg ncadg;
		[case(EPM_PROTOCOL_NCACN)] epm_rhs_ncacn ncacn;
		[case(EPM_PROTOCOL_NCALRPC)] epm_rhs_ncalrpc ncalrpc;
		[case(EPM_PROTOCOL_UUID)] epm_rhs_uuid uuid;
		[case(EPM_PROTOCOL_IPX)] epm_rhs_ipx ipx;
		[case(EPM_PROTOCOL_SMB)] epm_rhs_smb smb;
		[case(EPM_PROTOCOL_PIPE)] epm_rhs_pipe pipe;
		[case(EPM_PROTOCOL_NETBIOS)] epm_rhs_netbios netbios;
		[case(EPM_PROTOCOL_NB_NB)] epm_rhs_nb_nb nb_nb;
		[case(EPM_PROTOCOL_SPX)] epm_rhs_spx spx;
		[case(EPM_PROTOCOL_NB_IPX)] epm_rhs_nb_ipx nb_ipx;
		[case(EPM_PROTOCOL_HTTP)] epm_rhs_http http;
		[case(EPM_PROTOCOL_UNIX_DS)] epm_rhs_unix_ds unix_ds;
		[case(EPM_PROTOCOL_NULL)] epm_rhs_null null;
		[default]  [flag(NDR_REMAINING)] DATA_BLOB unknown;
	} epm_rhs;

	typedef struct {
		uint8  protocol;
		[switch_is(protocol)] epm_protocol_info info;
	} epm_lhs;

	typedef struct {
		[subcontext(2)] epm_lhs lhs;
		[subcontext(2),switch_is(lhs.protocol)] epm_rhs rhs;
	} epm_floor;

	/* note that the NDR_NOALIGN flag is inherited by all nested
	   structures. All of the towers/floors stuff is
	   non-aligned. I wonder what sort of wicked substance these
	   guys were smoking?
	*/
	typedef [flag(NDR_NOALIGN|NDR_LITTLE_ENDIAN)] struct {
		uint16 num_floors;
		epm_floor floors[num_floors];
	} epm_towers;

	typedef struct {
		uint32 tower_length;
		[subcontext(4)] epm_towers towers;
	} epm_twr_t;

	typedef struct {
		GUID        object;
		epm_twr_t   *tower;
		ascstr2     annotation;
	} epm_entry_t;

	typedef struct {
		GUID                uuid;
		uint16              vers_major;
		uint16              vers_minor;
	} rpc_if_id_t;
    
	/**********************/
	/* Function 0x0       */
	error_status_t epm_Insert(
		[in]    uint32          num_ents,
		[in,size_is(num_ents)]  epm_entry_t         entries[],
		[in]    uint32    replace
		);
    
	/**********************/
	/* Function 0x1       */
	error_status_t epm_Delete(
		[in]     uint32          num_ents,
		[in, size_is(num_ents)]  epm_entry_t entries[]
		);
    
	/**********************/
	/* Function 0x02      */
	error_status_t epm_Lookup(
		[in]            uint32          inquiry_type,
		[in]            GUID            *object,
		[in]            rpc_if_id_t     *interface_id,
		[in]            uint32          vers_option,
		[in,out,ref]    policy_handle   *entry_handle,
		[in]            uint32          max_ents,
		[out]           uint32          num_ents,
		[out, length_is(num_ents), size_is(max_ents)]  epm_entry_t entries[]
		);


	/**********************/
	/* Function 0x03      */

	typedef struct {
		epm_twr_t *twr;
	} epm_twr_p_t;

	error_status_t epm_Map(
		[in]            GUID            *object,
		[in]            epm_twr_t       *map_tower,
		[in,out,ref]    policy_handle   *entry_handle,
		[in]            uint32          max_towers,
		[out]           uint32          num_towers,
		[out, length_is(num_towers), size_is(max_towers)]  epm_twr_p_t towers[]
		);
    

	/**********************/
	/* Function 0x04      */
	error_status_t epm_LookupHandleFree(
		[in,out,ref]    policy_handle *entry_handle
		);
    
	/**********************/
	/* Function 0x05      */
	error_status_t epm_InqObject(
		[out]           GUID        *epm_object
		);
    

	/**********************/
	/* Function 0x06      */
	error_status_t epm_MgmtDelete(
		[in]            uint32   object_speced,
		[in]            GUID     *object,
		[in]            epm_twr_t    *tower
		);

	/**********************/
	/* Function 0x07      */
	error_status_t epm_MapAuth();
}