DragonFlyBSD Kernel Audit
DF-0661 / ng_device_ported.c
← back to finding ↓ download raw
  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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
/*
 * Ported copy of sys/netgraph/ng_device.c for KLD module build & PoC.
 *
 * The original ng_device.c uses the long-removed 'struct cdevsw' API and
 * old-style d_*_t signatures (cdev_t dev, ...).  Modern DragonFly uses
 * 'struct dev_ops' with *_args structures.  This file is a faithful port:
 * the device-registration boilerplate is adapted to dev_ops, but the
 * read/write data paths -- including the VLA bug under test (DF-0661) --
 * are preserved VERBATIM from sys/netgraph/ng_device.c lines 505-600.
 *
 * The vulnerable lines are:
 *   ngdread:  char buffer[uio->uio_resid+1];   (orig :509)
 *   ngdwrite: char buffer[uio->uio_resid];      (orig :562)
 * with uio_resid being a user-controlled size_t (sys/sys/_uio.h:69).
 */

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/mbuf.h>
#include <sys/uio.h>
#include <sys/queue.h>
#include <sys/malloc.h>
#include <sys/conf.h>
#include <sys/poll.h>
#include <sys/device.h>
#include <sys/devfs.h>
#include <sys/socket.h>
#include <sys/thread2.h>

#include <netgraph/ng_message.h>
#include <netgraph/netgraph.h>

#include "ng_device.h"

/* turn this on for verbose messages */
#define NGD_DEBUG

/* Netgraph methods */
static ng_constructor_t	ng_device_cons;
static ng_rcvmsg_t	ng_device_rcvmsg;
static ng_newhook_t	ng_device_newhook;
static ng_connect_t 	ng_device_connect;
static ng_rcvdata_t	ng_device_rcvdata;
static ng_disconnect_t	ng_device_disconnect;
static int              ng_device_mod_event(module_t mod, int event, void *data);

static int ng_device_init(void);
static int get_free_unit(void);

/* Netgraph type */
static struct ng_type typestruct = {
	NG_VERSION,			/* version */
	NG_DEVICE_NODE_TYPE,		/* name */
	ng_device_mod_event,		/* modevent */
	ng_device_cons, 		/* constructor */
	ng_device_rcvmsg, 		/* receive msg */
	NULL, 				/* shutdown */
	ng_device_newhook, 		/* newhook */
	NULL,				/* findhook */
	ng_device_connect, 		/* connect */
	ng_device_rcvdata, 		/* receive data */
	ng_device_rcvdata, 		/* receive queued data */
	ng_device_disconnect, 		/* disconnect */
	NULL
};
NETGRAPH_INIT(device, &typestruct);

/* per hook data */
struct ngd_connection {
	SLIST_ENTRY(ngd_connection) links;

	cdev_t 	ngddev;
	struct 	ng_hook *active_hook;
	char	*readq;
	int 	loc;
	int 	unit;
};

/* global data */
struct ngd_softc {
	SLIST_HEAD(, ngd_connection) head;

	node_p node;
	char nodename[NG_NODESIZ];
} ngd_softc;

/* the per connection receiving queue maximum */
#define NGD_QUEUE_SIZE (1024*10)

/* Maximum number of NGD devices */
#define MAX_NGD	25 		/* should be more than enough for now */

/* ---- device operations (ported from cdevsw to dev_ops) ---- */
static d_open_t		ngdopen;
static d_close_t	ngdclose;
static d_read_t		ngdread;
static d_write_t	ngdwrite;
static d_ioctl_t	ngdioctl;

#define NGD_CDEV_MAJOR 20
static struct dev_ops ngd_ops = {
	{ "ngd", NGD_CDEV_MAJOR, 0 },
	.d_open =	ngdopen,
	.d_close =	ngdclose,
	.d_read =	ngdread,
	.d_write =	ngdwrite,
	.d_ioctl =	ngdioctl,
};

/*
 * this holds all the stuff that should be done at load time
 */
static int
ng_device_mod_event(module_t mod, int event, void *data)
{
	int error = 0;

#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */

	switch (event) {
		case MOD_LOAD:
			ng_device_init();
			break;

		case MOD_UNLOAD:
			dev_ops_remove_all(&ngd_ops);
			error = EBUSY; /* no unload! */
			break;

		
		default:
			error = EOPNOTSUPP;
			break;
	}

	return(error);
}


static int
ng_device_init(void)
{
        struct ngd_softc *sc = &ngd_softc;
	
#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */ 

	SLIST_INIT(&sc->head);

        if (ng_make_node_common(&typestruct, &sc->node) != 0) {
                kprintf("%s(): ng_make_node_common failed\n", __func__);
                return(ENXIO);
        }
        ksprintf(sc->nodename, "%s", NG_DEVICE_NODE_TYPE);
        if (ng_name_node(sc->node, sc->nodename)) {
                NG_NODE_UNREF(sc->node); /* make it go away again */
                kprintf("%s(): ng_name_node failed\n", __func__);
                return(ENXIO);
        }
        NG_NODE_SET_PRIVATE(sc->node, sc);

	return(0);
}

/* don't allow to be created, only the device can do that */
static int
ng_device_cons(node_p *node)
{
#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */
	return(EINVAL);
}

/* Receive control message. We just free it. */
static int
ng_device_rcvmsg(node_p node, 
	struct ng_mesg *msg, const char *retaddr, struct ng_mesg **rptr)
{
	kfree(msg, M_NETGRAPH);
	return(ENOTTY);
}

static int
get_free_unit(void)
{
	struct ngd_connection *tmp = NULL;
	struct ngd_softc *sc = &ngd_softc;
	int n = 0;
	int unit = -1;

#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */

	if (SLIST_EMPTY(&sc->head)) {
		unit = 0;
		return(unit);
	}

	for(n = 0;n<MAX_NGD && unit == -1;n++) {
		SLIST_FOREACH(tmp, &sc->head, links) {
			if(tmp->unit == n) {
				unit = -1;
				break;
			}
			unit = n;
		}
	}

	return(unit);
}

/*
 * incoming hook
 */
static int
ng_device_newhook(node_p node, hook_p hook, const char *name)
{
	struct ngd_softc *sc = &ngd_softc;
	struct ngd_connection * new_connection = NULL;

#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */

	new_connection = kmalloc(sizeof(struct ngd_connection), M_DEVBUF, M_NOWAIT);
	if(new_connection == NULL) {
		kprintf("%s(): ERROR: new_connection == NULL\n", __func__);
		return(-1);
	}

	new_connection->unit = get_free_unit();
	if(new_connection->unit<0) {
		kprintf("%s: No free unit found by get_free_unit(), "
				"increas MAX_NGD\n", __func__);
		kfree(new_connection, M_DEVBUF);
		return(-1);
	}
	new_connection->ngddev = make_dev(&ngd_ops,
	    new_connection->unit, 0, 0, 0600, "ngd%d", new_connection->unit);
	if(new_connection->ngddev == NULL) {
		kprintf("%s(): make_dev failed\n", __func__);
		SLIST_REMOVE(&sc->head, new_connection, ngd_connection, links);
		kfree(new_connection, M_DEVBUF);
		return(-1);
	}

	new_connection->readq =
	    kmalloc(sizeof(char)*NGD_QUEUE_SIZE, M_DEVBUF, M_NOWAIT | M_ZERO);
	if(new_connection->readq == NULL) {
		kprintf("%s(): readq malloc failed\n", __func__);
		destroy_dev(new_connection->ngddev);
		SLIST_REMOVE(&sc->head, new_connection, ngd_connection, links);
		kfree(new_connection, M_DEVBUF);
		return(-1);
	}

	new_connection->loc = 0;
	new_connection->active_hook = hook;

	SLIST_INSERT_HEAD(&sc->head, new_connection, links);

	return(0);
}

static int
ng_device_connect(hook_p hook)
{
#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */
	return(0);
}

/* Receive data from hook */
static int
ng_device_rcvdata(hook_p hook, struct mbuf *m, meta_p meta)
{
	struct ngd_softc *sc = &ngd_softc;
	struct ngd_connection * connection = NULL;
	struct ngd_connection * tmp;
	char *buffer;

#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */

	SLIST_FOREACH(tmp, &sc->head, links) {
		if(tmp->active_hook == hook) {
			connection = tmp;
		}
	}
	if(connection == NULL) {
		kprintf("%s(): connection still NULL, no hook found\n", __func__);
		return(-1);
	}

	NG_FREE_META(meta);

	m = m_pullup(m, m->m_len);
	if(m == NULL) {
		kprintf("%s(): ERROR: m_pullup failed\n", __func__);
		return(-1);
	}

	buffer = kmalloc(sizeof(char)*m->m_len, M_DEVBUF, M_NOWAIT | M_ZERO);
	if(buffer == NULL) {
		kprintf("%s(): ERROR: buffer malloc failed\n", __func__);
		return(-1);
	}

	buffer = mtod(m, char *);

	if( (connection->loc+m->m_len) < NGD_QUEUE_SIZE) {
	        memcpy(connection->readq+connection->loc, buffer, m->m_len);
		connection->loc += m->m_len;
	} else
		kprintf("%s(): queue full, first read out a bit\n", __func__);

	kfree(buffer, M_DEVBUF);

	return(0);
}

/* Removal of the last link destroys the node */
static int
ng_device_disconnect(hook_p hook)
{
	struct ngd_softc *sc = &ngd_softc;
	struct ngd_connection * connection = NULL;
	struct ngd_connection * tmp;

#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */

	SLIST_FOREACH(tmp, &sc->head, links) {
		if(tmp->active_hook == hook) {
			connection = tmp;
		}
	}
	if(connection == NULL) {
		kprintf("%s(): connection still NULL, no hook found\n",
		    __func__);
		return(-1);
	}

        kfree(connection->readq, M_DEVBUF);

	destroy_dev(connection->ngddev);

	SLIST_REMOVE(&sc->head, connection, ngd_connection, links);

	return(0);
}

/* the device is opened */
static int
ngdopen(struct dev_open_args *ap)
{
#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */
	return(0);
}

/* the device is closed */
static int
ngdclose(struct dev_close_args *ap)
{
#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif
	return(0);
}

/* process ioctl */
static int
ngdioctl(struct dev_ioctl_args *ap)
{
	cdev_t dev = ap->a_head.a_dev;
	struct ngd_softc *sc = &ngd_softc;
	struct ngd_connection * connection = NULL;
	struct ngd_connection * tmp;
	int error = 0;
	struct ng_mesg *msg;
        struct ngd_param_s * datap;

#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */

	SLIST_FOREACH(tmp, &sc->head, links) {
		if(tmp->ngddev == dev) {
			connection = tmp;
		}
	}
	if(connection == NULL) {
		kprintf("%s(): connection still NULL, no dev found\n",
		    __func__);
		return(-1);
	}

	NG_MKMESSAGE(msg, NGM_DEVICE_COOKIE, ap->a_cmd, sizeof(struct ngd_param_s), 
			M_NOWAIT);
	if (msg == NULL) {
		kprintf("%s(): msg == NULL\n", __func__);
		goto nomsg;
	}

	datap = (struct ngd_param_s *)msg->data;
        datap->p = ap->a_data;

	error = ng_send_msg(sc->node, msg,
	    NG_HOOK_NAME(connection->active_hook), NULL);
	if(error)
		kprintf("%s(): ng_send_msg() error: %d\n", __func__, error);

nomsg:

	return(0);
}


/*
 * This function is called when a read(2) is done to our device.
 *
 * *** DF-0661 VULNERABLE FUNCTION (faithful port of orig lines 505-547) ***
 * The VLA `char buffer[uio->uio_resid+1]` is materialized on the kernel
 * stack with uio_resid being a user-controlled size_t, with NO upper-bound
 * check.  A huge read count overflows the kernel stack.
 */
static int
ngdread(struct dev_read_args *ap)
{
	cdev_t dev = ap->a_head.a_dev;
	struct uio *uio = ap->a_uio;
	int ret = 0, amnt;
	char buffer[uio->uio_resid+1];
	struct ngd_softc *sc = &ngd_softc;
	struct ngd_connection * connection = NULL;
	struct ngd_connection * tmp;

#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */

	SLIST_FOREACH(tmp, &sc->head, links) {
		if(tmp->ngddev == dev) {
			connection = tmp;
		}
	}
	if(connection == NULL) {
		kprintf("%s(): connection still NULL, no dev found\n", __func__);
		return(-1);
	}

	while ( ( uio->uio_resid > 0 ) && ( connection->loc > 0 ) ) {
		amnt = MIN(uio->uio_resid, connection->loc);

		memcpy(buffer, connection->readq, amnt);
		memcpy(connection->readq, connection->readq+amnt,
				connection->loc-amnt);
		connection->loc -= amnt;

		ret = uiomove((caddr_t)buffer, amnt, uio);
		if(ret != 0)
			goto error;

	}
	return(0);

error:
	kprintf("%s(): uiomove returns error %d\n", __func__, ret);
	return(ret);
}


/* 
 * This function is called when our device is written to.
 *
 * *** DF-0661 VULNERABLE FUNCTION (faithful port of orig lines 556-600) ***
 * The VLA `char buffer[uio->uio_resid]` is materialized on the kernel
 * stack with uio_resid being a user-controlled size_t, with NO upper-bound
 * check.  A huge write count overflows the kernel stack.
 */
static int
ngdwrite(struct dev_write_args *ap)
{
	cdev_t dev = ap->a_head.a_dev;
	struct uio *uio = ap->a_uio;
	int ret;
	int error = 0;
	struct mbuf *m;
	char buffer[uio->uio_resid];
	int len = uio->uio_resid;
	struct ngd_softc *sc =& ngd_softc;
	struct ngd_connection * connection = NULL;
	struct ngd_connection * tmp;

#ifdef NGD_DEBUG
	kprintf("%s()\n", __func__);
#endif /* NGD_DEBUG */

	SLIST_FOREACH(tmp, &sc->head, links) {
		if(tmp->ngddev == dev) {
			connection = tmp;
		}
	}

	if(connection == NULL) {
		kprintf("%s(): connection still NULL, no dev found\n", __func__);
		return(-1);
	}

	if (len > 0) {
		if ((ret = uiomove((caddr_t)buffer, len, uio)) != 0)
			goto error;
	} else
		kprintf("%s(): len <= 0 : supposed to happen?!\n", __func__);

	m = m_devget(buffer, len, 0, NULL);

	NG_SEND_DATA_ONLY(error, connection->active_hook, m);

	return(0);

error:
	kprintf("%s(): uiomove returned err: %d\n", __func__, ret);

	return(ret);
}