interfaceiter.c 12.6 KB
Newer Older
Danny Mayer's avatar
Danny Mayer committed
1
/*
Automatic Updater's avatar
Automatic Updater committed
2
 * Copyright (C) 2004, 2007-2009  Internet Systems Consortium, Inc. ("ISC")
Andreas Gustafsson's avatar
Andreas Gustafsson committed
3
 * Copyright (C) 1999-2001  Internet Software Consortium.
Danny Mayer's avatar
Danny Mayer committed
4
 *
Automatic Updater's avatar
Automatic Updater committed
5
 * Permission to use, copy, modify, and/or distribute this software for any
Danny Mayer's avatar
Danny Mayer committed
6
7
8
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
Mark Andrews's avatar
Mark Andrews committed
9
10
11
12
13
14
15
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
Danny Mayer's avatar
Danny Mayer committed
16
17
 */

Automatic Updater's avatar
Automatic Updater committed
18
/* $Id: interfaceiter.c,v 1.15 2009/01/18 23:48:14 tbox Exp $ */
Danny Mayer's avatar
Danny Mayer committed
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

/*
 * 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>
#include <isc/result.h>
#include <isc/string.h>
38
#include <isc/strerror.h>
Danny Mayer's avatar
Danny Mayer committed
39
40
41
#include <isc/types.h>
#include <isc/util.h>

42
43
void InitSockets(void);

Danny Mayer's avatar
Danny Mayer committed
44
45
46
47
48
/* Common utility functions */

/*
 * Extract the network address part from a "struct sockaddr".
 *
Francis Dupont's avatar
Francis Dupont committed
49
 * The address family is given explicitly
Danny Mayer's avatar
Danny Mayer committed
50
51
52
53
54
55
56
57
58
59
60
 * 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
61
	isc_mem_t		*mctx;
62
	SOCKET			socket;
Danny Mayer's avatar
Danny Mayer committed
63
	INTERFACE_INFO		IFData;		/* Current Interface Info */
Danny Mayer's avatar
Danny Mayer committed
64
	int			numIF;		/* Current Interface count */
65
66
67
68
69
70
71
	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
72
73
74
75
76
77
78
79
80
81
	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
82
83
84
#define IFCONF_SIZE_INITIAL	  16
#define IFCONF_SIZE_INCREMENT	  64
#define IFCONF_SIZE_MAX		1040
Danny Mayer's avatar
Danny Mayer committed
85
86
87
88
89
90
91
92
93
94
95
96
97
98

static void
get_addr(unsigned int family, isc_netaddr_t *dst, struct sockaddr *src) {
	dst->family = family;
	switch (family) {
	case AF_INET:
		memcpy(&dst->type.in,
		       &((struct sockaddr_in *) src)->sin_addr,
		       sizeof(struct in_addr));
		break;
	case	AF_INET6:
		memcpy(&dst->type.in6,
		       &((struct sockaddr_in6 *) src)->sin6_addr,
		       sizeof(struct in6_addr));
99
		dst->zone = ((struct sockaddr_in6 *) src)->sin6_scope_id;
Danny Mayer's avatar
Danny Mayer committed
100
101
102
103
104
105
106
107
108
		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
109
	char strbuf[ISC_STRERRORSIZE];
Danny Mayer's avatar
Danny Mayer committed
110
111
112
113
114
115
116
117
118
119
120
121
122
	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);

123
124
	InitSockets();

Danny Mayer's avatar
Danny Mayer committed
125
	iter->mctx = mctx;
126
127
128
129
130
131
132
133
134
	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
135
136

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

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

	for (;;) {
160
161
		iter->buf4 = isc_mem_get(mctx, iter->buf4size);
		if (iter->buf4 == NULL) {
Danny Mayer's avatar
Danny Mayer committed
162
163
164
165
			result = ISC_R_NOMEMORY;
			goto alloc_failure;
		}

Andreas Gustafsson's avatar
Andreas Gustafsson committed
166
		if (WSAIoctl(iter->socket, SIO_GET_INTERFACE_LIST,
167
			     0, 0, iter->buf4, iter->buf4size,
168
			     &bytesReturned, 0, 0) == SOCKET_ERROR)
Andreas Gustafsson's avatar
Andreas Gustafsson committed
169
		{
Danny Mayer's avatar
Danny Mayer committed
170
171
172
			error = WSAGetLastError();
			if (error != WSAEFAULT && error != WSAENOBUFS) {
				errno = error;
173
				isc__strerror(error, strbuf, sizeof(strbuf));
Danny Mayer's avatar
Danny Mayer committed
174
				UNEXPECTED_ERROR(__FILE__, __LINE__,
175
						"get interface configuration: %s",
176
						strbuf);
Danny Mayer's avatar
Danny Mayer committed
177
178
179
180
181
182
183
184
185
				result = ISC_R_UNEXPECTED;
				goto ioctl_failure;
			}
			/*
			 * EINVAL.  Retry with a bigger buffer.
			 */
		} else {
			/*
			 * The WSAIoctl succeeded.
Andreas Gustafsson's avatar
Andreas Gustafsson committed
186
187
188
			 * 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
189
			 */
Andreas Gustafsson's avatar
Andreas Gustafsson committed
190
			if (bytesReturned > 0 &&
191
			    (bytesReturned < iter->buf4size))
Danny Mayer's avatar
Danny Mayer committed
192
193
				break;
		}
194
		if (iter->buf4size >= IFCONF_SIZE_MAX*sizeof(INTERFACE_INFO)) {
Danny Mayer's avatar
Danny Mayer committed
195
196
197
198
199
200
			UNEXPECTED_ERROR(__FILE__, __LINE__,
					 "get interface configuration: "
					 "maximum buffer size exceeded");
			result = ISC_R_UNEXPECTED;
			goto ioctl_failure;
		}
201
		isc_mem_put(mctx, iter->buf4, iter->buf4size);
Danny Mayer's avatar
Danny Mayer committed
202

203
		iter->buf4size += IFCONF_SIZE_INCREMENT *
Andreas Gustafsson's avatar
Andreas Gustafsson committed
204
			sizeof(INTERFACE_INFO);
Danny Mayer's avatar
Danny Mayer committed
205
206
207
208
209
210
	}

	/*
	 * A newly created iterator has an undefined position
	 * until isc_interfaceiter_first() is called.
	 */
211
212
213
214
215
216
217
218
219
220
	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.
	 */
221
222
	iter->socket = socket(AF_INET6, SOCK_DGRAM, 0);
	if (iter->socket == INVALID_SOCKET) {
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
		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
267

268
269
270
271
272
273
274
275
		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
276

277
278
279
280
281
282
283
		iter->buf6size += IFCONF_SIZE_INCREMENT *
			sizeof(SOCKET_ADDRESS);
	}

	closesocket(iter->socket);

 inet_only:
Danny Mayer's avatar
Danny Mayer committed
284
285
286
287
	iter->magic = IFITER_MAGIC;
	*iterp = iter;
	return (ISC_R_SUCCESS);

288
289
290
 ioctl6_failure:
	isc_mem_put(mctx, iter->buf6, iter->buf6size);

Danny Mayer's avatar
Danny Mayer committed
291
 ioctl_failure:
292
293
	if (iter->buf4 != NULL)
		isc_mem_put(mctx, iter->buf4, iter->buf4size);
Danny Mayer's avatar
Danny Mayer committed
294
295

 alloc_failure:
296
	if (iter->socket != INVALID_SOCKET)
297
		(void) closesocket(iter->socket);
Danny Mayer's avatar
Danny Mayer committed
298
299

 socket_failure:
Andreas Gustafsson's avatar
Andreas Gustafsson committed
300
	isc_mem_put(mctx, iter, sizeof(*iter));
Danny Mayer's avatar
Danny Mayer committed
301
302
303
304
305
306
307
308
309
310
311
312
	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
313
internal_current(isc_interfaceiter_t *iter) {
Danny Mayer's avatar
Danny Mayer committed
314
315
	BOOL ifNamed = FALSE;
	unsigned long flags;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
316

Danny Mayer's avatar
Danny Mayer committed
317
318
319
320
	REQUIRE(VALID_IFITER(iter));
	REQUIRE(iter->numIF >= 0);

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

323
	get_addr(AF_INET, &iter->current.address,
Danny Mayer's avatar
Danny Mayer committed
324
325
326
327
328
329
330
331
332
333
334
335
		 (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
336
	if ((flags & IFF_POINTTOPOINT) != 0) {
Danny Mayer's avatar
Danny Mayer committed
337
338
339
340
341
		iter->current.flags |= INTERFACE_F_POINTTOPOINT;
		sprintf(iter->current.name, "PPP Interface %d", iter->numIF);
		ifNamed = TRUE;
	}

Andreas Gustafsson's avatar
Andreas Gustafsson committed
342
	if ((flags & IFF_LOOPBACK) != 0) {
Danny Mayer's avatar
Danny Mayer committed
343
		iter->current.flags |= INTERFACE_F_LOOPBACK;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
344
345
		sprintf(iter->current.name, "Loopback Interface %d",
			iter->numIF);
Danny Mayer's avatar
Danny Mayer committed
346
347
348
349
350
351
352
		ifNamed = TRUE;
	}

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

Danny Mayer's avatar
Danny Mayer committed
357
	if (ifNamed == FALSE)
Andreas Gustafsson's avatar
Andreas Gustafsson committed
358
359
360
		sprintf(iter->current.name,
			"TCP/IP Interface %d", iter->numIF);

Danny Mayer's avatar
Danny Mayer committed
361
362
363
	/*
	 * Get the network mask.
	 */
364
365
	get_addr(AF_INET, &iter->current.netmask,
		 (struct sockaddr *)&(iter->IFData.iiNetmask));
Danny Mayer's avatar
Danny Mayer committed
366
367
368
369

	return (ISC_R_SUCCESS);
}

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
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
395
	for (i = 0; i< 16; i++)
396
397
398
399
400
		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
401
402
403
404
405
406
407
408
409
/*
 * 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) {
410
	if (iter->numIF >= iter->v4IF)
Danny Mayer's avatar
Danny Mayer committed
411
412
413
414
415
416
417
418
		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
419

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

423
424
	iter->pos4--;
	if (&(iter->pos4) < &(iter->buf4))
Danny Mayer's avatar
Danny Mayer committed
425
426
427
		return (ISC_R_NOMORE);

	memset(&(iter->IFData), 0, sizeof(INTERFACE_INFO));
428
	memcpy(&(iter->IFData), iter->pos4, sizeof(INTERFACE_INFO));
Danny Mayer's avatar
Danny Mayer committed
429
430
431
432
433
	iter->numIF++;

	return (ISC_R_SUCCESS);
}

434
static isc_result_t
435
436
437
438
439
440
441
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
442
443
isc_result_t
isc_interfaceiter_current(isc_interfaceiter_t *iter,
Danny Mayer's avatar
Danny Mayer committed
444
			  isc_interface_t *ifdata) {
Danny Mayer's avatar
Danny Mayer committed
445
446
447
448
449
450
451
452
453
454
	REQUIRE(iter->result == ISC_R_SUCCESS);
	memcpy(ifdata, &iter->current, sizeof(*ifdata));
	return (ISC_R_SUCCESS);
}

isc_result_t
isc_interfaceiter_first(isc_interfaceiter_t *iter) {

	REQUIRE(VALID_IFITER(iter));

455
456
457
458
	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
459
460
461
462
463
464
465
466
467
468
469
}

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);
470
471
472
473
474
475
476
477
		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
478
			break;
479
		result = internal_current(iter);
Danny Mayer's avatar
Danny Mayer committed
480
481
482
483
484
485
486
487
		if (result != ISC_R_IGNORE)
			break;
	}
	iter->result = result;
	return (result);
}

void
Andreas Gustafsson's avatar
Andreas Gustafsson committed
488
isc_interfaceiter_destroy(isc_interfaceiter_t **iterp) {
Danny Mayer's avatar
Danny Mayer committed
489
490
491
492
493
	isc_interfaceiter_t *iter;
	REQUIRE(iterp != NULL);
	iter = *iterp;
	REQUIRE(VALID_IFITER(iter));

494
495
496
497
	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
498
499

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