getifs 0.5.0

Cross-platform enumeration of network interfaces and their MTU, gateway, multicast, and local/private/public IP addresses.
Documentation 
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

use std::{
  io,
  net::{IpAddr, Ipv4Addr, Ipv6Addr},
};

use iprfc::{FORWARDING_BLACKLIST, RFC6890};
use smallvec_wrapper::SmallVec;

use crate::{ipv4_filter_to_ip_filter, ipv6_filter_to_ip_filter};

use super::{os, IfNet, Ifv4Net, Ifv6Net};

/// Returns all IPv4 addresses that are part of [RFC
/// 6890] (regardless of whether or not there is a default route, unlike
/// [`public_ipv4_addrs`](super::public_ipv4_addrs)).
///
/// See also [`private_ipv4_addrs_by_filter`].
///
/// ## Example
///
/// ```rust
/// use getifs::private_ipv4_addrs;
///
/// let ipv4_addrs = private_ipv4_addrs().unwrap();
/// for addr in ipv4_addrs {
///   println!("{addr}");
/// }
/// ```
///
/// [RFC 6890]: https://tools.ietf.org/html/rfc6890
pub fn private_ipv4_addrs() -> io::Result<SmallVec<Ifv4Net>> {
  cfg_if::cfg_if! {
    if #[cfg(windows)] {
      os::interface_ipv4_addresses(None, private_ip_filter)
    } else {
      os::interface_ipv4_addresses(0, private_ip_filter)
    }
  }
}

/// Returns all IPv6 addresses that are part of [RFC
/// 6890] (regardless of whether or not there is a default route, unlike
/// [`public_ipv6_addrs`](super::public_ipv6_addrs)).
///
/// See also [`private_ipv6_addrs_by_filter`].
///
/// ## Example
///
/// ```rust
/// use getifs::private_ipv6_addrs;
///
/// let ipv6_addrs = private_ipv6_addrs().unwrap();
/// for addr in ipv6_addrs {
///   println!("{addr}");
/// }
/// ```
///
/// [RFC 6890]: https://tools.ietf.org/html/rfc6890
pub fn private_ipv6_addrs() -> io::Result<SmallVec<Ifv6Net>> {
  cfg_if::cfg_if! {
    if #[cfg(windows)] {
      os::interface_ipv6_addresses(None, private_ip_filter)
    } else {
      os::interface_ipv6_addresses(0, private_ip_filter)
    }
  }
}

/// Returns all IP addresses that are part of [RFC
/// 6890] (regardless of whether or not there is a default route, unlike
/// [`public_addrs`](super::public_addrs)).
///
/// See also [`private_addrs_by_filter`].
///
/// ## Example
///
/// ```rust
/// use getifs::private_addrs;
///
/// let all_addrs = private_addrs().unwrap();
/// for addr in all_addrs {
///   println!("{addr}");
/// }
/// ```
///
/// [RFC 6890]: https://tools.ietf.org/html/rfc6890
pub fn private_addrs() -> io::Result<SmallVec<IfNet>> {
  cfg_if::cfg_if! {
    if #[cfg(windows)] {
      os::interface_addresses(None, private_ip_filter)
    } else {
      os::interface_addresses(0, private_ip_filter)
    }
  }
}

/// Returns all IPv4 addresses that are part of [RFC
/// 6890] (regardless of whether or not there is a default route, unlike
/// [`public_ipv4_addrs_by_filter`](super::public_ipv4_addrs_by_filter)).
///
/// Use the provided filter to further refine the results.
///
/// ## Example
///
/// ```rust
/// use getifs::private_ipv4_addrs_by_filter;
///
/// let addrs = private_ipv4_addrs_by_filter(|addr| !addr.is_loopback()).unwrap();
/// for addr in addrs {
///   println!("{addr}");
/// }
/// ```
///
/// [RFC 6890]: https://tools.ietf.org/html/rfc6890
pub fn private_ipv4_addrs_by_filter<F>(mut f: F) -> io::Result<SmallVec<Ifv4Net>>
where
  F: FnMut(&Ipv4Addr) -> bool,
{
  cfg_if::cfg_if! {
    if #[cfg(windows)] {
      os::interface_ipv4_addresses(None, |ip| {
        private_ip_filter(ip) && ipv4_filter_to_ip_filter(&mut f)(ip)
      })
    } else {
      os::interface_ipv4_addresses(0, |ip| {
        private_ip_filter(ip) && ipv4_filter_to_ip_filter(&mut f)(ip)
      })
    }
  }
}

/// Returns all IPv6 addresses that are part of [RFC
/// 6890] (regardless of whether or not there is a default route, unlike
/// [`public_ipv6_addrs_by_filter`](super::public_ipv6_addrs_by_filter)).
///
/// Use the provided filter to further refine the results.
///
/// ## Example
///
/// ```rust
/// use getifs::private_ipv6_addrs_by_filter;
///
/// let addrs = private_ipv6_addrs_by_filter(|addr| !addr.is_loopback()).unwrap();
/// for addr in addrs {
///   println!("{addr}");
/// }
/// ```
///
/// [RFC 6890]: https://tools.ietf.org/html/rfc6890
pub fn private_ipv6_addrs_by_filter<F>(mut f: F) -> io::Result<SmallVec<Ifv6Net>>
where
  F: FnMut(&Ipv6Addr) -> bool,
{
  cfg_if::cfg_if! {
    if #[cfg(windows)] {
      os::interface_ipv6_addresses(None, |ip| {
        private_ip_filter(ip) && ipv6_filter_to_ip_filter(&mut f)(ip)
      })
    } else {
      os::interface_ipv6_addresses(0, |ip| {
        private_ip_filter(ip) && ipv6_filter_to_ip_filter(&mut f)(ip)
      })
    }
  }
}

/// Returns all IP addresses that are part of [RFC
/// 6890] (regardless of whether or not there is a default route, unlike
/// [`public_addrs_by_filter`](super::public_addrs_by_filter)).
///
/// Use the provided filter to further refine the results.
///
/// ## Example
///
/// ```rust
/// use getifs::private_addrs_by_filter;
///
///
/// let addrs = private_addrs_by_filter(|addr| !addr.is_loopback()).unwrap();
/// for addr in addrs {
///   println!("{addr}");
/// }
/// ```
///
/// [RFC 6890]: https://tools.ietf.org/html/rfc6890
pub fn private_addrs_by_filter<F>(mut f: F) -> io::Result<SmallVec<IfNet>>
where
  F: FnMut(&IpAddr) -> bool,
{
  cfg_if::cfg_if! {
    if #[cfg(windows)] {
      os::interface_addresses(None, |ip| private_ip_filter(ip) && f(ip))
    } else {
      os::interface_addresses(0, |ip| private_ip_filter(ip) && f(ip))
    }
  }
}

#[inline]
fn private_ip_filter(ip: &IpAddr) -> bool {
  RFC6890.contains(ip) && !FORWARDING_BLACKLIST.contains(ip)
}