README.md
1[](https://travis-ci.org/krisprice/ipnet)
2
3This module provides types and useful methods for working with IPv4 and IPv6 network addresses, commonly called IP prefixes. The new `IpNet`, `Ipv4Net`, and `Ipv6Net` types build on the existing `IpAddr`, `Ipv4Addr`, and `Ipv6Addr` types already provided in Rust's standard library and align to their design to stay consistent.
4
5The module also provides the `IpSubnets`, `Ipv4Subnets`, and `Ipv6Subnets` types for iterating over the subnets contained in an IP address range. The `IpAddrRange`, `Ipv4AddrRange`, and `Ipv6AddrRange` types for iterating over IP addresses in a range. And traits that extend `Ipv4Addr` and `Ipv6Addr` with methods for addition, subtraction, bitwise-and, and bitwise-or operations that are missing in Rust's standard library.
6
7The module only uses stable features so it is guaranteed to compile using the stable toolchain. Tests aim for thorough coverage and can be found in both the test modules and doctests. Please file an [issue on GitHub] if you have any problems, requests, or suggested improvements.
8
9Read the [documentation] for the full details. And find it on [Crates.io].
10
11[documentation]: https://docs.rs/ipnet/
12[Crates.io]: https://crates.io/crates/ipnet
13[issue on GitHub]: https://github.com/krisprice/ipnet/issues
14
15## Release 2.0 requirements
16
17Release 2.0 requires Rust 1.26 or later. Release 1.0 used a custom emulated 128-bit integer type (`Emu128`) to fully support IPv6 addresses. This has been replaced with Rust's built-in 128-bit integer, which is now stable as of Rust 1.26. There are reports of issues using Rust's 128-bit integers on some targets (e.g. Emscripten). If you have issues on your chosen target, please continue to use the 1.0 release until that has been resolved.
18
19## Examples
20
21### Create a network address and print the hostmask and netmask
22
23```rust
24extern crate ipnet;
25use std::net::{Ipv4Addr, Ipv6Addr};
26use std::str::FromStr;
27use ipnet::{IpNet, Ipv4Net, Ipv6Net};
28
29fn main() {
30 // Create an Ipv4Net and Ipv6Net from their constructors.
31
32 let net4 = Ipv4Net::new(Ipv4Addr::new(10, 1, 1, 0), 24).unwrap();
33 let net6 = Ipv6Net::new(Ipv6Addr::new(0xfd, 0, 0, 0, 0, 0, 0, 0), 24).unwrap();
34
35 // They can also be created by a constructor that panics when the prefix length is invalid,
36
37 let net4 = Ipv4Net::new_assert(Ipv4Addr::new(10, 1, 1, 0), 24);
38 let net6 = Ipv6Net::new_assert(Ipv6Addr::new(0xfd, 0, 0, 0, 0, 0, 0, 0), 24);
39
40 // or does not compile when called from a const context.
41
42 const NET4: Ipv4Net = Ipv4Net::new_assert(Ipv4Addr::new(10, 1, 1, 0), 24);
43 const NET6: Ipv6Net = Ipv6Net::new_assert(Ipv6Addr::new(0xfd, 0, 0, 0, 0, 0, 0, 0), 24);
44
45 // They can also be created from string representations.
46
47 let net4 = Ipv4Net::from_str("10.1.1.0/24").unwrap();
48 let net6 = Ipv6Net::from_str("fd00::/24").unwrap();
49
50 // Or alternatively as follows.
51
52 let net4: Ipv4Net = "10.1.1.0/24".parse().unwrap();
53 let net6: Ipv6Net = "fd00::/24".parse().unwrap();
54
55 // IpNet can represent either an IPv4 or IPv6 network address.
56
57 let net = IpNet::from(net4);
58
59 // It can also be created from string representations.
60
61 let net = IpNet::from_str("10.1.1.0/24").unwrap();
62 let net: IpNet = "10.1.1.0/24".parse().unwrap();
63
64 // There are a number of methods that can be used. Read the
65 // documentation for the full details.
66
67 println!("{} hostmask = {}", net, net.hostmask());
68 println!("{} netmask = {}", net4, net4.netmask());
69}
70```
71
72### Subdivide an existing IP network into smaller subnets
73
74```rust
75extern crate ipnet;
76use ipnet::Ipv4Net;
77
78fn main() {
79 let net: Ipv4Net = "192.168.0.0/23".parse().unwrap();
80
81 println!("\n/25 subnets in {}:", net);
82
83 // Note: `subnets()` returns a `Result`. If the given prefix length
84 // is less than the existing prefix length the `Result` will contain
85 // an error.
86
87 let subnets = net.subnets(25)
88 .expect("PrefixLenError: new prefix length cannot be shorter than existing");
89
90 // Output:
91 // subnet 0 = 192.168.0.0/25
92 // subnet 1 = 192.168.0.128/25
93 // subnet 2 = 192.168.1.0/25
94 // subnet 3 = 192.168.1.128/25
95
96 for (i, n) in subnets.enumerate() {
97 println!("\tsubnet {} = {}", i, n);
98 }
99}
100```
101
102### Iterate over the valid subnets between two IPv4 addresses
103
104```rust
105extern crate ipnet;
106use std::net::Ipv4Addr;
107use ipnet::Ipv4Subnets;
108
109fn main() {
110 let start = Ipv4Addr::new(10, 0, 0, 0);
111 let end = Ipv4Addr::new(10, 0, 0, 239);
112
113 println!("\n/0 or greater subnets between {} and {}:", start, end);
114
115 // Output all subnets starting with the largest that will fit. This
116 // will give us the smallest possible set of valid subnets.
117 //
118 // Output:
119 // subnet 0 = 10.0.0.0/25
120 // subnet 1 = 10.0.0.128/26
121 // subnet 2 = 10.0.0.192/27
122 // subnet 3 = 10.0.0.224/28
123
124 let subnets = Ipv4Subnets::new(start, end, 0);
125
126 for (i, n) in subnets.enumerate() {
127 println!("\tsubnet {} = {}", i, n);
128 }
129
130 println!("\n/26 or greater subnets between {} and {}:", start, end);
131
132 // Output all subnets with prefix lengths less than or equal to 26.
133 // This results in more subnets, but limits them to a maximum size.
134 //
135 // Output:
136 // subnet 0 = 10.0.0.0/26
137 // subnet 1 = 10.0.0.64/26
138 // subnet 2 = 10.0.0.128/26
139 // subnet 3 = 10.0.0.192/27
140 // subnet 4 = 10.0.0.224/28
141
142 let subnets = Ipv4Subnets::new(start, end, 26);
143
144 for (i, n) in subnets.enumerate() {
145 println!("\tsubnet {} = {}", i, n);
146 }
147}
148```
149
150### Aggregate a list of IP prefixes
151
152```rust
153extern crate ipnet;
154use ipnet::IpNet;
155
156fn main() {
157 // Example input list of overlapping and adjacent prefixes.
158
159 let strings = vec![
160 "10.0.0.0/24", "10.0.1.0/24", "10.0.1.1/24", "10.0.1.2/24",
161 "10.0.2.0/24",
162 "10.1.0.0/24", "10.1.1.0/24",
163 "192.168.0.0/24", "192.168.1.0/24", "192.168.2.0/24", "192.168.3.0/24",
164 "fd00::/32", "fd00:1::/32",
165 ];
166
167 let nets: Vec<IpNet> = strings.iter().filter_map(|p| p.parse().ok()).collect();
168
169 println!("\nAggregated IP prefixes:");
170
171 // Output:
172 // 10.0.0.0/23
173 // 10.0.2.0/24
174 // 10.1.0.0/23
175 // 192.168.0.0/22
176 // fd00::/31
177
178 for n in IpNet::aggregate(&nets) {
179 println!("\t{}", n);
180 }
181}
182```
183
184## Future
185
186* Implementing `std::ops::{Add, Sub, BitAnd, BitOr}` for `Ipv4Addr` and `Ipv6Addr` would be useful as these are common operations on IP addresses. If done, the extension traits provided in this module would be removed and the major version incremented. Implementing these requires a change to the standard library. I've started a thread on this topic on the [Rust Internals](https://internals.rust-lang.org/t/pre-rfc-implementing-add-sub-bitand-bitor-for-ipaddr-ipv4addr-ipv6addr/) discussion board.
187* The results of `hosts()` and potentially `subnets()` should be represented as a `Range` rather than the custom `IpAddrRange` and `IpSubnets` types provided in this module. This requires the target types to have `Add` and `Step` implemented for them. Implementing `Add` for `IpAddr`, `Ipv4Addr`, and `Ipv6Addr` requires a change to the standard library (see above). And `Step` is still unstable so exploring this will also wait until it has stablized.
188
189## License
190
191Copyright (c) 2017, Juniper Networks, Inc. All rights reserved.
192
193This code is licensed to you under either the MIT License or Apache License, Version 2.0 at your choice (the "License"). You may not use this code except in compliance with the License. This code is not an official Juniper product. You can obtain a copy of the License at: https://opensource.org/licenses/MIT or http://www.apache.org/licenses/LICENSE-2.0
194