interfaceiter.c 12.1 KB
Newer Older
Danny Mayer's avatar
Danny Mayer committed
1
/*
2
 * Copyright (C) 1999-2001, 2004, 2007-2009, 2013-2016  Internet Systems Consortium, Inc. ("ISC")
Danny Mayer's avatar
Danny Mayer committed
3
 *
4
5
6
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
Danny Mayer's avatar
Danny Mayer committed
7
8
 */

Automatic Updater's avatar
Automatic Updater committed
9
/* $Id: interfaceiter.c,v 1.15 2009/01/18 23:48:14 tbox Exp $ */
Danny Mayer's avatar
Danny Mayer committed
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

/*
 * Note that this code will need to be revisited to support IPv6 Interfaces.
 * For now we just iterate through IPv4 interfaces.
 */

#include <config.h>
#include <winsock2.h>
#include <ws2tcpip.h>
#include <sys/types.h>

#include <stdio.h>
#include <stdlib.h>
#include <errno.h>

#include <isc/interfaceiter.h>
#include <isc/mem.h>
27
#include <isc/print.h>
Danny Mayer's avatar
Danny Mayer committed
28
29
#include <isc/result.h>
#include <isc/string.h>
30
#include <isc/strerror.h>
Danny Mayer's avatar
Danny Mayer committed
31
32
33
#include <isc/types.h>
#include <isc/util.h>

34
35
void InitSockets(void);

Danny Mayer's avatar
Danny Mayer committed
36
37
38
39
40
/* Common utility functions */

/*
 * Extract the network address part from a "struct sockaddr".
 *
Francis Dupont's avatar
Francis Dupont committed
41
 * The address family is given explicitly
Danny Mayer's avatar
Danny Mayer committed
42
43
44
45
46
47
48
49
50
51
52
 * instead of using src->sa_family, because the latter does not work
 * for copying a network mask obtained by SIOCGIFNETMASK (it does
 * not have a valid address family).
 */


#define IFITER_MAGIC		0x49464954U	/* IFIT. */
#define VALID_IFITER(t)		((t) != NULL && (t)->magic == IFITER_MAGIC)

struct isc_interfaceiter {
	unsigned int		magic;		/* Magic number. */
Danny Mayer's avatar
Danny Mayer committed
53
	isc_mem_t		*mctx;
54
	SOCKET			socket;
Danny Mayer's avatar
Danny Mayer committed
55
	INTERFACE_INFO		IFData;		/* Current Interface Info */
Danny Mayer's avatar
Danny Mayer committed
56
	int			numIF;		/* Current Interface count */
57
58
59
60
61
62
63
	int			v4IF;		/* Number of IPv4 Interfaces */
	INTERFACE_INFO		*buf4;		/* Buffer for WSAIoctl data. */
	unsigned int		buf4size;	/* Bytes allocated. */
	INTERFACE_INFO		*pos4;		/* Current offset in IF List */
	SOCKET_ADDRESS_LIST	*buf6;
	unsigned int		buf6size;	/* Bytes allocated. */
	unsigned int		pos6;
Danny Mayer's avatar
Danny Mayer committed
64
65
66
67
68
69
70
71
72
73
	isc_interface_t		current;	/* Current interface data. */
	isc_result_t		result;		/* Last result code. */
};


/*
 * Size of buffer for SIO_GET_INTERFACE_LIST, in number of interfaces.
 * We assume no sane system will have more than than 1K of IP addresses on
 * all of its adapters.
 */
Danny Mayer's avatar
Danny Mayer committed
74
75
76
#define IFCONF_SIZE_INITIAL	  16
#define IFCONF_SIZE_INCREMENT	  64
#define IFCONF_SIZE_MAX		1040
Danny Mayer's avatar
Danny Mayer committed
77
78
79
80
81
82

static void
get_addr(unsigned int family, isc_netaddr_t *dst, struct sockaddr *src) {
	dst->family = family;
	switch (family) {
	case AF_INET:
83
84
85
		memmove(&dst->type.in,
			&((struct sockaddr_in *) src)->sin_addr,
			sizeof(struct in_addr));
Danny Mayer's avatar
Danny Mayer committed
86
87
		break;
	case	AF_INET6:
88
89
90
		memmove(&dst->type.in6,
			&((struct sockaddr_in6 *) src)->sin6_addr,
			sizeof(struct in6_addr));
91
		dst->zone = ((struct sockaddr_in6 *) src)->sin6_scope_id;
Danny Mayer's avatar
Danny Mayer committed
92
93
94
95
96
97
98
99
100
		break;
	default:
		INSIST(0);
		break;
	}
}

isc_result_t
isc_interfaceiter_create(isc_mem_t *mctx, isc_interfaceiter_t **iterp) {
Automatic Updater's avatar
Automatic Updater committed
101
	char strbuf[ISC_STRERRORSIZE];
Danny Mayer's avatar
Danny Mayer committed
102
103
104
105
106
107
108
109
110
111
112
113
114
	isc_interfaceiter_t *iter;
	isc_result_t result;
	int error;
	unsigned long bytesReturned = 0;

	REQUIRE(mctx != NULL);
	REQUIRE(iterp != NULL);
	REQUIRE(*iterp == NULL);

	iter = isc_mem_get(mctx, sizeof(*iter));
	if (iter == NULL)
		return (ISC_R_NOMEMORY);

115
116
	InitSockets();

Danny Mayer's avatar
Danny Mayer committed
117
	iter->mctx = mctx;
118
119
120
121
122
123
124
125
126
	iter->buf4 = NULL;
	iter->buf6 = NULL;
	iter->pos4 = NULL;
	iter->pos6 = 0;
	iter->buf6size = 0;
	iter->buf4size = 0;
	iter->result = ISC_R_FAILURE;
	iter->numIF = 0;
	iter->v4IF = 0;
Danny Mayer's avatar
Danny Mayer committed
127
128

	/*
Andreas Gustafsson's avatar
Andreas Gustafsson committed
129
130
	 * Create an unbound datagram socket to do the
	 * SIO_GET_INTERFACE_LIST WSAIoctl on.
Danny Mayer's avatar
Danny Mayer committed
131
	 */
132
133
	iter->socket = socket(AF_INET, SOCK_DGRAM, 0);
	if (iter->socket == INVALID_SOCKET) {
134
		error = WSAGetLastError();
135
136
		if (error == WSAEAFNOSUPPORT)
			goto inet6_only;
137
		isc__strerror(error, strbuf, sizeof(strbuf));
Danny Mayer's avatar
Danny Mayer committed
138
		UNEXPECTED_ERROR(__FILE__, __LINE__,
139
				"making interface scan socket: %s",
140
				strbuf);
Danny Mayer's avatar
Danny Mayer committed
141
142
143
144
145
146
147
148
		result = ISC_R_UNEXPECTED;
		goto socket_failure;
	}

	/*
	 * Get the interface configuration, allocating more memory if
	 * necessary.
	 */
149
	iter->buf4size = IFCONF_SIZE_INITIAL*sizeof(INTERFACE_INFO);
Danny Mayer's avatar
Danny Mayer committed
150
151

	for (;;) {
152
153
		iter->buf4 = isc_mem_get(mctx, iter->buf4size);
		if (iter->buf4 == NULL) {
Danny Mayer's avatar
Danny Mayer committed
154
155
156
157
			result = ISC_R_NOMEMORY;
			goto alloc_failure;
		}

Andreas Gustafsson's avatar
Andreas Gustafsson committed
158
		if (WSAIoctl(iter->socket, SIO_GET_INTERFACE_LIST,
159
			     0, 0, iter->buf4, iter->buf4size,
160
			     &bytesReturned, 0, 0) == SOCKET_ERROR)
Andreas Gustafsson's avatar
Andreas Gustafsson committed
161
		{
Danny Mayer's avatar
Danny Mayer committed
162
163
164
			error = WSAGetLastError();
			if (error != WSAEFAULT && error != WSAENOBUFS) {
				errno = error;
165
				isc__strerror(error, strbuf, sizeof(strbuf));
Danny Mayer's avatar
Danny Mayer committed
166
				UNEXPECTED_ERROR(__FILE__, __LINE__,
167
						"get interface configuration: %s",
168
						strbuf);
Danny Mayer's avatar
Danny Mayer committed
169
170
171
172
173
174
175
176
177
				result = ISC_R_UNEXPECTED;
				goto ioctl_failure;
			}
			/*
			 * EINVAL.  Retry with a bigger buffer.
			 */
		} else {
			/*
			 * The WSAIoctl succeeded.
Andreas Gustafsson's avatar
Andreas Gustafsson committed
178
179
180
			 * If the number of the returned bytes is the same
			 * as the buffer size, we will grow it just in
			 * case and retry.
Danny Mayer's avatar
Danny Mayer committed
181
			 */
Andreas Gustafsson's avatar
Andreas Gustafsson committed
182
			if (bytesReturned > 0 &&
183
			    (bytesReturned < iter->buf4size))
Danny Mayer's avatar
Danny Mayer committed
184
185
				break;
		}
186
		if (iter->buf4size >= IFCONF_SIZE_MAX*sizeof(INTERFACE_INFO)) {
Danny Mayer's avatar
Danny Mayer committed
187
188
189
190
191
192
			UNEXPECTED_ERROR(__FILE__, __LINE__,
					 "get interface configuration: "
					 "maximum buffer size exceeded");
			result = ISC_R_UNEXPECTED;
			goto ioctl_failure;
		}
193
		isc_mem_put(mctx, iter->buf4, iter->buf4size);
Danny Mayer's avatar
Danny Mayer committed
194

195
		iter->buf4size += IFCONF_SIZE_INCREMENT *
Andreas Gustafsson's avatar
Andreas Gustafsson committed
196
			sizeof(INTERFACE_INFO);
Danny Mayer's avatar
Danny Mayer committed
197
198
199
200
201
202
	}

	/*
	 * A newly created iterator has an undefined position
	 * until isc_interfaceiter_first() is called.
	 */
203
204
205
206
207
208
209
210
211
212
	iter->v4IF = bytesReturned/sizeof(INTERFACE_INFO);

	/* We don't need the socket any more, so close it */
	closesocket(iter->socket);

 inet6_only:
	/*
	 * Create an unbound datagram socket to do the
	 * SIO_ADDRESS_LIST_QUERY WSAIoctl on.
	 */
213
214
	iter->socket = socket(AF_INET6, SOCK_DGRAM, 0);
	if (iter->socket == INVALID_SOCKET) {
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
		error = WSAGetLastError();
		if (error == WSAEAFNOSUPPORT)
			goto inet_only;
		isc__strerror(error, strbuf, sizeof(strbuf));
		UNEXPECTED_ERROR(__FILE__, __LINE__,
				"making interface scan socket: %s",
				strbuf);
		result = ISC_R_UNEXPECTED;
		goto ioctl_failure;
	}

	/*
	 * Get the interface configuration, allocating more memory if
	 * necessary.
	 */
	iter->buf6size = sizeof(SOCKET_ADDRESS_LIST) +
			 IFCONF_SIZE_INITIAL*sizeof(SOCKET_ADDRESS);

	for (;;) {
		iter->buf6 = isc_mem_get(mctx, iter->buf6size);
		if (iter->buf6 == NULL) {
			result = ISC_R_NOMEMORY;
			goto ioctl_failure;
		}

		if (WSAIoctl(iter->socket, SIO_ADDRESS_LIST_QUERY,
			     0, 0, iter->buf6, iter->buf6size,
			     &bytesReturned, 0, 0) == SOCKET_ERROR)
		{
			error = WSAGetLastError();
			if (error != WSAEFAULT && error != WSAENOBUFS) {
				errno = error;
				isc__strerror(error, strbuf, sizeof(strbuf));
				UNEXPECTED_ERROR(__FILE__, __LINE__,
						 "sio address list query: %s",
						 strbuf);
				result = ISC_R_UNEXPECTED;
				goto ioctl6_failure;
			}
			/*
			 * EINVAL.  Retry with a bigger buffer.
			 */
		} else
			break;
Danny Mayer's avatar
Danny Mayer committed
259

260
261
262
263
264
265
266
267
		if (iter->buf6size >= IFCONF_SIZE_MAX*sizeof(SOCKET_ADDRESS)) {
			UNEXPECTED_ERROR(__FILE__, __LINE__,
					 "get interface configuration: "
					 "maximum buffer size exceeded");
			result = ISC_R_UNEXPECTED;
			goto ioctl6_failure;
		}
		isc_mem_put(mctx, iter->buf6, iter->buf6size);
Danny Mayer's avatar
Danny Mayer committed
268

269
270
271
272
273
274
275
		iter->buf6size += IFCONF_SIZE_INCREMENT *
			sizeof(SOCKET_ADDRESS);
	}

	closesocket(iter->socket);

 inet_only:
Danny Mayer's avatar
Danny Mayer committed
276
277
278
279
	iter->magic = IFITER_MAGIC;
	*iterp = iter;
	return (ISC_R_SUCCESS);

280
281
282
 ioctl6_failure:
	isc_mem_put(mctx, iter->buf6, iter->buf6size);

Danny Mayer's avatar
Danny Mayer committed
283
 ioctl_failure:
284
285
	if (iter->buf4 != NULL)
		isc_mem_put(mctx, iter->buf4, iter->buf4size);
Danny Mayer's avatar
Danny Mayer committed
286
287

 alloc_failure:
288
	if (iter->socket != INVALID_SOCKET)
289
		(void) closesocket(iter->socket);
Danny Mayer's avatar
Danny Mayer committed
290
291

 socket_failure:
Andreas Gustafsson's avatar
Andreas Gustafsson committed
292
	isc_mem_put(mctx, iter, sizeof(*iter));
Danny Mayer's avatar
Danny Mayer committed
293
294
295
296
297
298
299
300
301
302
303
304
	return (result);
}

/*
 * Get information about the current interface to iter->current.
 * If successful, return ISC_R_SUCCESS.
 * If the interface has an unsupported address family, or if
 * some operation on it fails, return ISC_R_IGNORE to make
 * the higher-level iterator code ignore it.
 */

static isc_result_t
305
internal_current(isc_interfaceiter_t *iter) {
Danny Mayer's avatar
Danny Mayer committed
306
307
	BOOL ifNamed = FALSE;
	unsigned long flags;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
308

Danny Mayer's avatar
Danny Mayer committed
309
310
311
312
	REQUIRE(VALID_IFITER(iter));
	REQUIRE(iter->numIF >= 0);

	memset(&iter->current, 0, sizeof(iter->current));
313
	iter->current.af = AF_INET;
Danny Mayer's avatar
Danny Mayer committed
314

315
	get_addr(AF_INET, &iter->current.address,
Danny Mayer's avatar
Danny Mayer committed
316
317
318
319
320
321
322
323
324
325
326
327
		 (struct sockaddr *)&(iter->IFData.iiAddress));

	/*
	 * Get interface flags.
	 */

	iter->current.flags = 0;
	flags = iter->IFData.iiFlags;

	if ((flags & IFF_UP) != 0)
		iter->current.flags |= INTERFACE_F_UP;

Andreas Gustafsson's avatar
Andreas Gustafsson committed
328
	if ((flags & IFF_POINTTOPOINT) != 0) {
Danny Mayer's avatar
Danny Mayer committed
329
330
331
332
333
		iter->current.flags |= INTERFACE_F_POINTTOPOINT;
		sprintf(iter->current.name, "PPP Interface %d", iter->numIF);
		ifNamed = TRUE;
	}

Andreas Gustafsson's avatar
Andreas Gustafsson committed
334
	if ((flags & IFF_LOOPBACK) != 0) {
Danny Mayer's avatar
Danny Mayer committed
335
		iter->current.flags |= INTERFACE_F_LOOPBACK;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
336
337
		sprintf(iter->current.name, "Loopback Interface %d",
			iter->numIF);
Danny Mayer's avatar
Danny Mayer committed
338
339
340
341
342
343
344
		ifNamed = TRUE;
	}

	/*
	 * If the interface is point-to-point, get the destination address.
	 */
	if ((iter->current.flags & INTERFACE_F_POINTTOPOINT) != 0) {
345
		get_addr(AF_INET, &iter->current.dstaddress,
Danny Mayer's avatar
Danny Mayer committed
346
		(struct sockaddr *)&(iter->IFData.iiBroadcastAddress));
Danny Mayer's avatar
Danny Mayer committed
347
348
	}

Danny Mayer's avatar
Danny Mayer committed
349
	if (ifNamed == FALSE)
Andreas Gustafsson's avatar
Andreas Gustafsson committed
350
351
352
		sprintf(iter->current.name,
			"TCP/IP Interface %d", iter->numIF);

Danny Mayer's avatar
Danny Mayer committed
353
354
355
	/*
	 * Get the network mask.
	 */
356
357
	get_addr(AF_INET, &iter->current.netmask,
		 (struct sockaddr *)&(iter->IFData.iiNetmask));
Danny Mayer's avatar
Danny Mayer committed
358
359
360
361

	return (ISC_R_SUCCESS);
}

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
static isc_result_t
internal_current6(isc_interfaceiter_t *iter) {
	BOOL ifNamed = FALSE;
	int i;

	REQUIRE(VALID_IFITER(iter));
	REQUIRE(iter->pos6 >= 0);
	REQUIRE(iter->buf6 != 0);

	memset(&iter->current, 0, sizeof(iter->current));
	iter->current.af = AF_INET6;

	get_addr(AF_INET6, &iter->current.address,
		 iter->buf6->Address[iter->pos6].lpSockaddr);

	/*
	 * Get interface flags.
	 */

	iter->current.flags = INTERFACE_F_UP;

	if (ifNamed == FALSE)
		sprintf(iter->current.name,
			"TCP/IPv6 Interface %d", iter->pos6 + 1);

Automatic Updater's avatar
Automatic Updater committed
387
	for (i = 0; i< 16; i++)
388
389
390
391
392
		iter->current.netmask.type.in6.s6_addr[i] = 0xff;
	iter->current.netmask.family = AF_INET6;
	return (ISC_R_SUCCESS);
}

Danny Mayer's avatar
Danny Mayer committed
393
394
395
396
397
398
399
400
401
/*
 * Step the iterator to the next interface.  Unlike
 * isc_interfaceiter_next(), this may leave the iterator
 * positioned on an interface that will ultimately
 * be ignored.  Return ISC_R_NOMORE if there are no more
 * interfaces, otherwise ISC_R_SUCCESS.
 */
static isc_result_t
internal_next(isc_interfaceiter_t *iter) {
402
	if (iter->numIF >= iter->v4IF)
Danny Mayer's avatar
Danny Mayer committed
403
404
405
406
407
408
409
410
		return (ISC_R_NOMORE);

	/*
	 * The first one needs to be set up to point to the last
	 * Element of the array.  Go to the end and back up
	 * Microsoft's implementation is peculiar for returning
	 * the list in reverse order
	 */
Automatic Updater's avatar
Automatic Updater committed
411

Danny Mayer's avatar
Danny Mayer committed
412
	if (iter->numIF == 0)
413
		iter->pos4 = (INTERFACE_INFO *)(iter->buf4 + (iter->v4IF));
Andreas Gustafsson's avatar
Andreas Gustafsson committed
414

415
416
	iter->pos4--;
	if (&(iter->pos4) < &(iter->buf4))
Danny Mayer's avatar
Danny Mayer committed
417
418
419
		return (ISC_R_NOMORE);

	memset(&(iter->IFData), 0, sizeof(INTERFACE_INFO));
420
	memmove(&(iter->IFData), iter->pos4, sizeof(INTERFACE_INFO));
Danny Mayer's avatar
Danny Mayer committed
421
422
423
424
425
	iter->numIF++;

	return (ISC_R_SUCCESS);
}

426
static isc_result_t
427
428
429
430
431
432
433
internal_next6(isc_interfaceiter_t *iter) {
	if (iter->pos6 == 0)
		return (ISC_R_NOMORE);
	iter->pos6--;
	return (ISC_R_SUCCESS);
}

Danny Mayer's avatar
Danny Mayer committed
434
435
isc_result_t
isc_interfaceiter_current(isc_interfaceiter_t *iter,
Danny Mayer's avatar
Danny Mayer committed
436
			  isc_interface_t *ifdata) {
Danny Mayer's avatar
Danny Mayer committed
437
	REQUIRE(iter->result == ISC_R_SUCCESS);
438
	memmove(ifdata, &iter->current, sizeof(*ifdata));
Danny Mayer's avatar
Danny Mayer committed
439
440
441
442
443
444
445
446
	return (ISC_R_SUCCESS);
}

isc_result_t
isc_interfaceiter_first(isc_interfaceiter_t *iter) {

	REQUIRE(VALID_IFITER(iter));

447
448
449
450
	if (iter->buf6 != NULL)
		iter->pos6 = iter->buf6->iAddressCount;
	iter->result = ISC_R_SUCCESS;
	return (isc_interfaceiter_next(iter));
Danny Mayer's avatar
Danny Mayer committed
451
452
453
454
455
456
457
458
459
460
461
}

isc_result_t
isc_interfaceiter_next(isc_interfaceiter_t *iter) {
	isc_result_t result;

	REQUIRE(VALID_IFITER(iter));
	REQUIRE(iter->result == ISC_R_SUCCESS);

	for (;;) {
		result = internal_next(iter);
462
463
464
465
466
467
468
469
		if (result == ISC_R_NOMORE) {
			result = internal_next6(iter);
			if (result != ISC_R_SUCCESS)
				break;
			result = internal_current6(iter);
			if (result != ISC_R_IGNORE)
				break;
		} else if (result != ISC_R_SUCCESS)
Danny Mayer's avatar
Danny Mayer committed
470
			break;
471
		result = internal_current(iter);
Danny Mayer's avatar
Danny Mayer committed
472
473
474
475
476
477
478
479
		if (result != ISC_R_IGNORE)
			break;
	}
	iter->result = result;
	return (result);
}

void
Andreas Gustafsson's avatar
Andreas Gustafsson committed
480
isc_interfaceiter_destroy(isc_interfaceiter_t **iterp) {
Danny Mayer's avatar
Danny Mayer committed
481
482
483
484
485
	isc_interfaceiter_t *iter;
	REQUIRE(iterp != NULL);
	iter = *iterp;
	REQUIRE(VALID_IFITER(iter));

486
487
488
489
	if (iter->buf4 != NULL)
		isc_mem_put(iter->mctx, iter->buf4, iter->buf4size);
	if (iter->buf6 != NULL)
		isc_mem_put(iter->mctx, iter->buf6, iter->buf6size);
Danny Mayer's avatar
Danny Mayer committed
490
491

	iter->magic = 0;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
492
	isc_mem_put(iter->mctx, iter, sizeof(*iter));
Danny Mayer's avatar
Danny Mayer committed
493
494
	*iterp = NULL;
}