aboutsummaryrefslogtreecommitdiffstats
path: root/packet-dcerpc-mapi.c
blob: 611cf09254dd968bfc2589f92fb93db25a21b6e6 (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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
/* packet-dcerpc-mapi.c
 * Routines for MS Exchange MAPI
 * Copyright 2002, Ronnie Sahlberg
 *
 * $Id: packet-dcerpc-mapi.c,v 1.26 2004/01/19 20:10:33 jmayer Exp $
 *
 * Ethereal - Network traffic analyzer
 * By Gerald Combs <gerald@ethereal.com>
 * Copyright 1998 Gerald Combs
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <glib.h>
#include <epan/packet.h>
#include "packet-dcerpc.h"
#include "packet-dcerpc-nt.h"
#include "packet-dcerpc-mapi.h"
#include "smb.h"	/* for "NT_errors[]" */
#include "prefs.h"

static int proto_dcerpc_mapi = -1;
static int hf_mapi_opnum = -1;
static int hf_mapi_unknown_string = -1;
static int hf_mapi_unknown_short = -1;
static int hf_mapi_unknown_long = -1;
static int hf_mapi_hnd = -1;
static int hf_mapi_rc = -1;
static int hf_mapi_encap_datalen = -1;
static int hf_mapi_encrypted_data = -1;
static int hf_mapi_decrypted_data_maxlen = -1;
static int hf_mapi_decrypted_data_offset = -1;
static int hf_mapi_decrypted_data_len = -1;
static int hf_mapi_decrypted_data = -1;
static int hf_mapi_pdu_len = -1;
static int hf_mapi_pdu_trailer = -1;
static int hf_mapi_pdu_extra_trailer = -1;

static gint ett_dcerpc_mapi = -1;
static gint ett_mapi_decrypted_pdu = -1;

static e_uuid_t uuid_dcerpc_mapi = {
        0xa4f1db00, 0xca47, 0x1067,
        { 0xb3, 0x1f, 0x00, 0xdd, 0x01, 0x06, 0x62, 0xda }
};

static guint16 ver_dcerpc_mapi = 0;

#define DISSECT_UNKNOWN(len) \
	{\
	proto_tree_add_text(tree, tvb, offset, len,\
		"unknown data (%d byte%s)", len,\
		plurality(len, "", "s"));\
	offset += len;\
	}

/* decryption */
static gboolean mapi_decrypt = FALSE;
static GMemChunk *mapi_decrypted_data_chunk = NULL;
static int mapi_decrypted_data_init_count = 200;
static GHashTable *mapi_decrypted_table = NULL;
typedef struct {
	guint32 frame;
	guint32 callid;
	tvbuff_t *tvb;
	unsigned char *data;
} mapi_decrypted_data_t;

static gboolean
free_all_decrypted(gpointer key_arg, gpointer value _U_, gpointer user_data _U_)
{
	mapi_decrypted_data_t *mdd=(mapi_decrypted_data_t *)key_arg;

	if(mdd->tvb){
		tvb_free(mdd->tvb);
		mdd->tvb=NULL;
	}
	if(mdd->data){
		g_free(mdd->data);
		mdd->data=NULL;
	}
	return TRUE;
}
static guint
mapi_decrypt_hash(gconstpointer k)
{
	const mapi_decrypted_data_t *mdd=(const mapi_decrypted_data_t *)k;
	return mdd->frame;
}
static gint
mapi_decrypt_equal(gconstpointer k1, gconstpointer k2)
{
	const mapi_decrypted_data_t *mdd1=(const mapi_decrypted_data_t *)k1;
	const mapi_decrypted_data_t *mdd2=(const mapi_decrypted_data_t *)k2;

	return	( (mdd1->frame==mdd2->frame)
		&&(mdd1->callid==mdd2->callid) );
}
static void
mapi_decrypt_init(void)
{
	if(mapi_decrypted_table){
		g_hash_table_foreach_remove(mapi_decrypted_table,
			free_all_decrypted, NULL);
	} else {
		mapi_decrypted_table=g_hash_table_new(mapi_decrypt_hash,
			mapi_decrypt_equal);
	}

	if(mapi_decrypted_data_chunk){
		g_mem_chunk_destroy(mapi_decrypted_data_chunk);
		mapi_decrypted_data_chunk=NULL;
	}

	if(mapi_decrypt){
		mapi_decrypted_data_chunk=g_mem_chunk_new("mapi_decrypt_chunk",
			sizeof(mapi_decrypted_data_t),
			mapi_decrypted_data_init_count*sizeof(mapi_decrypted_data_t),
			G_ALLOC_ONLY);
	}
}


static int
mapi_decrypt_pdu(tvbuff_t *tvb, int offset,
	packet_info *pinfo, proto_tree *tree, guint8 *drep)
{
	dcerpc_info *di;
	mapi_decrypted_data_t *mmd=NULL;
	guint32 len;
	const unsigned char *ptr;
	guint32 i;
	guint16 pdu_len;
	proto_item *it = NULL;
	proto_tree *tr = NULL;

	di=pinfo->private_data;
	if(di->conformant_run){
		return offset;
	}

	offset=dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, hf_mapi_decrypted_data_maxlen, NULL);
	offset=dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, hf_mapi_decrypted_data_offset, NULL);
	offset=dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, hf_mapi_decrypted_data_len, &len);

	if(len>(guint32)tvb_length_remaining(tvb, offset)){
		len=tvb_length_remaining(tvb, offset);
	}

	if(!pinfo->fd->flags.visited){
		mmd=g_mem_chunk_alloc(mapi_decrypted_data_chunk);
		mmd->callid=di->call_id;
		mmd->frame=pinfo->fd->num;
		mmd->data=g_malloc(len);
		ptr=(const unsigned char *)tvb_get_ptr(tvb, offset, len);
		for(i=0;i<len;i++){
			mmd->data[i]=ptr[i]^0xa5;
		}
		mmd->tvb=tvb_new_real_data(mmd->data, len, len);
		g_hash_table_insert(mapi_decrypted_table, mmd, mmd);
	}

	if(!mmd){
		mapi_decrypted_data_t mmd_key;
		mmd_key.callid=di->call_id;
		mmd_key.frame=pinfo->fd->num;
		mmd=g_hash_table_lookup(mapi_decrypted_table, &mmd_key);
	}

	add_new_data_source(pinfo, mmd->tvb, "Decrypted MAPI");

	/* decrypted PDU */
	/* All from 10 minutes eyeballing. This may be wrong.
	   The PDU is NOT NDR encoded. So this completely new marshalling
	   used by MAPI needs to be figured out.

	   It seems that ASCII text strings always are NULL terminated,
	   also no obvious string-length-byte can be seen so it seems the
	   length of strings are determined by searching the terminating null
	   byte.

	   The first two bytes of the PDU is the length of the PDU including
	   the two length bytes.
	   The third byte may be a subcommand byte ?

	   After the PDU comes, in requests a 4 byte thing. Which is either
	   (not very often) 0xffffffff or something else. If it is
	   'something else' these four bytes are repeated for the matching
	   response packet.
	   In some repsonse packets, this 4 byte trailer are sometimes followed
	   by some other data. Unclear if this is just random padding or actual
	   data. Seems a bit non-random for padding though.

	   Some response packets have a PDU of 2 bytes only, ie only the
	   2 byte length field followed by the 4 byte trailer.
	   strange.
	   perhaps the 4 byte trailers, and the extra trailers have some
	   special meaning?
	   More work needs to be done in this area.
	*/
	it=proto_tree_add_text(tree, mmd->tvb, 0, len, "Decrypted MAPI PDU");
	tr=proto_item_add_subtree(it, ett_mapi_decrypted_pdu);

	pdu_len=tvb_get_letohs(mmd->tvb, 0);
	proto_tree_add_uint(tr, hf_mapi_pdu_len, mmd->tvb, 0, 2, pdu_len);

	/*XXX call dissector here */
	proto_tree_add_item(tr, hf_mapi_decrypted_data, mmd->tvb, 2, pdu_len-2, FALSE);

	proto_tree_add_item(tr, hf_mapi_pdu_trailer, mmd->tvb, pdu_len, 4, FALSE);
	if(len>((guint32)pdu_len+4)){
		proto_tree_add_item(tr, hf_mapi_pdu_extra_trailer, mmd->tvb, pdu_len+4, len-(pdu_len+4), FALSE);
	}


	offset+=len;

	return offset;
}

static int
mapi_logon_rqst(tvbuff_t *tvb, int offset,
	packet_info *pinfo, proto_tree *tree, guint8 *drep)
{
        offset = dissect_ndr_cvstring(tvb, offset, pinfo, tree, drep,
			sizeof(guint8), hf_mapi_unknown_string, TRUE, NULL);

        DISSECT_UNKNOWN(tvb_length_remaining(tvb, offset));

	return offset;
}

/* The strings in this function are decoded properly on seen captures.
There might be offsets/padding mismatched due to potential pointer expansions
or padding bytes. Captures where this code breaks will tell us about that */
static int
mapi_logon_reply(tvbuff_t *tvb, int offset,
	packet_info *pinfo, proto_tree *tree, guint8 *drep)
{
	offset = dissect_nt_policy_hnd(tvb, offset, pinfo, tree, drep,
				       hf_mapi_hnd, NULL, NULL, FALSE, FALSE);

        DISSECT_UNKNOWN(20); /* this is 20 bytes, unless there are pointers */

        offset = dissect_ndr_cvstring(tvb, offset, pinfo, tree, drep,
			sizeof(guint8), hf_mapi_unknown_string, TRUE, NULL);

        /* Was DISSECT_UNKNOWN(6), but the 1 or 2 bytes the comment that
           was here referred to probably were padding, if they were seen;
           in another capture, there are 5 bytes there - it's probably a
           4-byte quantity, always aligned on a 4-byte boundary. */
        offset = dissect_ndr_uint32 (tvb, offset, pinfo, tree, drep,
			hf_mapi_unknown_long, NULL);

        offset = dissect_ndr_cvstring(tvb, offset, pinfo, tree, drep,
			sizeof(guint8), hf_mapi_unknown_string, TRUE, NULL);

        DISSECT_UNKNOWN( tvb_length_remaining(tvb, offset)-4 );

	offset = dissect_ntstatus(tvb, offset, pinfo, tree, drep,
			hf_mapi_rc, NULL);

	return offset;
}

static int
mapi_ec_do_rpc_request(tvbuff_t *tvb, int offset,
	packet_info *pinfo, proto_tree *tree, guint8 *drep)
{
	offset = dissect_nt_policy_hnd(tvb, offset, pinfo, tree, drep,
				       hf_mapi_hnd, NULL, NULL, FALSE, FALSE);

	if(!mapi_decrypt){
		/* this is a unidimensional varying and conformant array of
		   encrypted data */
       		offset = dissect_ndr_pointer(tvb, offset, pinfo, tree, drep,
				dissect_ndr_byte_array, NDR_POINTER_REF,
				"Encrypted data", hf_mapi_encrypted_data);
	} else {
		offset = mapi_decrypt_pdu(tvb, offset, pinfo, tree, drep);
	}

	/* length of encrypted data. */
	offset = dissect_ndr_uint16 (tvb, offset, pinfo, tree, drep,
			hf_mapi_encap_datalen, NULL);

	offset = dissect_ndr_uint16 (tvb, offset, pinfo, tree, drep,
			hf_mapi_unknown_short, NULL);

	return offset;
}
static int
mapi_ec_do_rpc_reply(tvbuff_t *tvb, int offset,
	packet_info *pinfo, proto_tree *tree, guint8 *drep)
{
	offset = dissect_nt_policy_hnd(tvb, offset, pinfo, tree, drep,
				       hf_mapi_hnd, NULL, NULL, FALSE, FALSE);

	if(!mapi_decrypt){
		/* this is a unidimensional varying and conformant array of
		   encrypted data */
       		offset = dissect_ndr_pointer(tvb, offset, pinfo, tree, drep,
				dissect_ndr_byte_array, NDR_POINTER_REF,
				"Encrypted data", hf_mapi_encrypted_data);
	} else {
		offset = mapi_decrypt_pdu(tvb, offset, pinfo, tree, drep);
	}

	/* length of encrypted data */
	offset = dissect_ndr_uint16 (tvb, offset, pinfo, tree, drep,
			hf_mapi_encap_datalen, NULL);

	offset = dissect_ntstatus(tvb, offset, pinfo, tree, drep,
			hf_mapi_rc, NULL);

	return offset;
}

static int
mapi_logoff_rqst(tvbuff_t *tvb, int offset,
	packet_info *pinfo, proto_tree *tree, guint8 *drep)
{
	offset = dissect_nt_policy_hnd(tvb, offset, pinfo, tree, drep,
				       hf_mapi_hnd, NULL, NULL, FALSE, FALSE);

	return offset;
}

static int
mapi_logoff_reply(tvbuff_t *tvb, int offset,
	packet_info *pinfo, proto_tree *tree, guint8 *drep)
{
	offset = dissect_nt_policy_hnd(tvb, offset, pinfo, tree, drep,
				       hf_mapi_hnd, NULL, NULL, FALSE, FALSE);

	offset = dissect_ntstatus(tvb, offset, pinfo, tree, drep,
			hf_mapi_rc, NULL);

	return offset;
}


static dcerpc_sub_dissector dcerpc_mapi_dissectors[] = {
        { MAPI_EC_DO_CONNECT,	"EcDoConnect",
		mapi_logon_rqst,
		mapi_logon_reply },
        { MAPI_EC_DO_DISCONNECT,"EcDoDisconnect",
		mapi_logoff_rqst,
		mapi_logoff_reply },
        { MAPI_EC_DO_RPC,	"EcDoRpc",
		mapi_ec_do_rpc_request,
		mapi_ec_do_rpc_reply },
	{ MAPI_EC_GET_MORE_RPC, "EcGetMoreRpc", NULL, NULL },
	{ MAPI_EC_REGISTER_PUSH_NOTIFICATION, "EcRRegisterPushNotification",
		NULL, NULL },
	{ MAPI_EC_UNREGISTER_PUSH_NOTIFICATION, "EcRUnregisterPushNotification",
		NULL, NULL },
	{ MAPI_EC_DUMMY_RPC, "EcDummyRpc", NULL, NULL },
	{ MAPI_EC_GET_DC_NAME, "EcRGetDCName", NULL, NULL },
 	{ MAPI_EC_NET_GET_DC_NAME, "EcRNetGetDCName", NULL, NULL },
	{ MAPI_EC_DO_RPC_EXT, "EcDoRpcExt", NULL, NULL },
        {0, NULL, NULL,  NULL }
};

void
proto_register_dcerpc_mapi(void)
{

static hf_register_info hf[] = {
	{ &hf_mapi_opnum,
	        { "Operation", "mapi.opnum", FT_UINT16, BASE_DEC,
		  NULL, 0x0, "", HFILL }},

	{ &hf_mapi_hnd,
		{ "Context Handle", "mapi.hnd", FT_BYTES, BASE_NONE,
		NULL, 0x0, "", HFILL }},

	{ &hf_mapi_rc,
		{ "Return code", "mapi.rc", FT_UINT32, BASE_HEX,
		VALS (NT_errors), 0x0, "", HFILL }},

	{ &hf_mapi_unknown_string,
		{ "Unknown string", "mapi.unknown_string", FT_STRING, BASE_NONE,
		NULL, 0, "Unknown string. If you know what this is, contact ethereal developers.", HFILL }},

	{ &hf_mapi_unknown_short,
		{ "Unknown short", "mapi.unknown_short", FT_UINT16, BASE_HEX,
		NULL, 0, "Unknown short. If you know what this is, contact ethereal developers.", HFILL }},

	{ &hf_mapi_unknown_long,
		{ "Unknown long", "mapi.unknown_long", FT_UINT32, BASE_HEX,
		NULL, 0, "Unknown long. If you know what this is, contact ethereal developers.", HFILL }},

	{ &hf_mapi_encap_datalen,
		{ "Length", "mapi.encap_len", FT_UINT16, BASE_DEC,
		NULL, 0x0, "Length of encapsulated/encrypted data", HFILL }},

	{ &hf_mapi_encrypted_data,
		{ "Encrypted data", "mapi.encrypted_data", FT_BYTES, BASE_HEX,
		NULL, 0, "Encrypted data", HFILL }},

	{ &hf_mapi_decrypted_data_maxlen,
		{ "Max Length", "mapi.decrypted.data.maxlen", FT_UINT32, BASE_DEC,
		NULL, 0x0, "Maximum size of buffer for decrypted data", HFILL }},

	{ &hf_mapi_decrypted_data_offset,
		{ "Offset", "mapi.decrypted.data.offset", FT_UINT32, BASE_DEC,
		NULL, 0x0, "Offset into buffer for decrypted data", HFILL }},

	{ &hf_mapi_decrypted_data_len,
		{ "Length", "mapi.decrypted.data.len", FT_UINT32, BASE_DEC,
		NULL, 0x0, "Used size of buffer for decrypted data", HFILL }},

	{ &hf_mapi_decrypted_data,
		{ "Decrypted data", "mapi.decrypted.data", FT_BYTES, BASE_HEX,
		NULL, 0x0, "Decrypted data", HFILL }},

	{ &hf_mapi_pdu_len,
		{ "Length", "mapi.pdu.len", FT_UINT16, BASE_DEC,
		NULL, 0x0, "Size of the command PDU", HFILL }},

	{ &hf_mapi_pdu_trailer,
		{ "Trailer", "mapi.pdu.trailer", FT_UINT32, BASE_HEX,
		NULL, 0x0, "If you know what this is, contact ethereal developers", HFILL }},

	{ &hf_mapi_pdu_extra_trailer,
		{ "unknown", "mapi.pdu.extra_trailer", FT_BYTES, BASE_HEX,
		NULL, 0x0, "If you know what this is, contact ethereal developers", HFILL }}
	};


        static gint *ett[] = {
                &ett_dcerpc_mapi,
                &ett_mapi_decrypted_pdu
        };
	module_t *mapi_module;

        proto_dcerpc_mapi = proto_register_protocol(
                "Microsoft Exchange MAPI", "MAPI", "mapi");

        proto_register_field_array(proto_dcerpc_mapi, hf,
				   array_length(hf));
        proto_register_subtree_array(ett, array_length(ett));
	mapi_module = prefs_register_protocol(proto_dcerpc_mapi, NULL);
	prefs_register_bool_preference(mapi_module, "decrypt",
		"Decrypt MAPI PDUs",
		"Whether the dissector should decrypt MAPI PDUs",
		&mapi_decrypt);
	register_init_routine(mapi_decrypt_init);
}

void
proto_reg_handoff_dcerpc_mapi(void)
{
        /* Register protocol as dcerpc */

        dcerpc_init_uuid(proto_dcerpc_mapi, ett_dcerpc_mapi,
                         &uuid_dcerpc_mapi, ver_dcerpc_mapi,
                         dcerpc_mapi_dissectors, hf_mapi_opnum);
}