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
|
/*
* Copyright Internet Systems Consortium, Inc. ("ISC")
* Copyright Internet Software Consortium.
* Copyright the NTPsec project contributors
* SPDX-License-Identifier: ISC
*/
#ifndef GUARD_ISC_INTERFACEITER_H
#define GUARD_ISC_INTERFACEITER_H 1
/*****
***** Module Info
*****/
/* isc_interfaceiter.h
* Iterates over the list of network interfaces.
*
* Interfaces whose address family is not supported are ignored and never
* returned by the iterator. Interfaces whose netmask, interface flags,
* or similar cannot be obtained are also ignored, and the failure is logged.
*
* Standards:
* The API for scanning varies greatly among operating systems.
* This module attempts to hide the differences.
*/
/***
*** Imports
***/
#include "isc_result.h"
typedef struct isc_interfaceiter isc_interfaceiter_t; /* Interface Iterator */
typedef struct isc_mem isc_mem_t; /* Memory */
/* Net Address */
typedef struct isc_netaddr {
unsigned int family;
union {
struct in_addr in;
struct in6_addr in6;
} type;
uint32_t zone;
} isc_netaddr_t;
/*!
* \brief Public structure describing a network interface.
*/
typedef struct isc_interface {
char name[32]; /* Interface name, null-terminated. */
unsigned int af; /* Address family. */
isc_netaddr_t address; /* Local address. */
isc_netaddr_t netmask; /* Network mask. */
isc_netaddr_t broadcast; /* Broadcast address. */
isc_netaddr_t dstaddress; /* Destination address (point-to-point only). */
uint32_t flags; /* Flags; see INTERFACE flags. */
unsigned int ifindex; /* Interface index for IP(V6)_MULTICAST_IF. */
} isc_interface_t;
/*@{*/
/*! Interface flags. */
#define INTERFACE_F_UP 0x00000001U
#define INTERFACE_F_POINTTOPOINT 0x00000002U
#define INTERFACE_F_LOOPBACK 0x00000004U
#define INTERFACE_F_BROADCAST 0x00000008U
#define INTERFACE_F_MULTICAST 0x00000010U
#define INTERFACE_F_PRIVACY 0x00000020U /* RFC 4941 */
/*@}*/
/***
*** Functions
***/
bool
isc_interfaceiter_create_bool(isc_mem_t *mctx, isc_interfaceiter_t **iterp);
isc_result_t
isc_interfaceiter_create(isc_mem_t *mctx, isc_interfaceiter_t **iterp);
/*!<
* \brief Create an iterator for traversing the operating system's list
* of network interfaces.
*
* Returns:
*\li #ISC_R_SUCCESS
* \li #ISC_R_NOMEMORY
*\li Various network-related errors
*/
bool
isc_interfaceiter_first_bool(isc_interfaceiter_t *iter);
isc_result_t
isc_interfaceiter_first(isc_interfaceiter_t *iter);
/*!<
* \brief Position the iterator on the first interface.
*
* Returns:
*\li #ISC_R_SUCCESS Success.
*\li #ISC_R_NOMORE There are no interfaces.
*/
bool
isc_interfaceiter_current_bool(isc_interfaceiter_t *iter,
isc_interface_t *ifdata);
isc_result_t
isc_interfaceiter_current(isc_interfaceiter_t *iter,
isc_interface_t *ifdata);
/*!<
* \brief Get information about the interface the iterator is currently
* positioned at and store it at *ifdata.
*
* Requires:
*\li The iterator has been successfully positioned using
* isc_interface_iter_first() / isc_interface_iter_next().
*
* Returns:
*\li #ISC_R_SUCCESS Success.
*/
bool
isc_interfaceiter_next_bool(isc_interfaceiter_t *iter);
isc_result_t
isc_interfaceiter_next(isc_interfaceiter_t *iter);
/*!<
* \brief Position the iterator on the next interface.
*
* Requires:
* \li The iterator has been successfully positioned using
* isc_interface_iter_first() / isc_interface_iter_next().
*
* Returns:
*\li #ISC_R_SUCCESS Success.
*\li #ISC_R_NOMORE There are no more interfaces.
*/
void
isc_interfaceiter_destroy(isc_interfaceiter_t **iterp);
/*!<
* \brief Destroy the iterator.
*/
#endif /* GUARD_ISC_INTERFACEITER_H */
|
