Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2014 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.net; |
| 18 | |
Remi NGUYEN VAN | 299a7cc | 2019-01-23 21:35:52 +0900 | [diff] [blame] | 19 | import android.annotation.SystemApi; |
| 20 | import android.annotation.TestApi; |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 21 | import android.os.Parcel; |
| 22 | import android.os.Parcelable; |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 23 | import android.util.Pair; |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 24 | |
Hugo Benichi | 1dfb6b6 | 2017-08-08 13:06:04 +0900 | [diff] [blame] | 25 | import java.net.Inet4Address; |
| 26 | import java.net.Inet6Address; |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 27 | import java.net.InetAddress; |
| 28 | import java.net.UnknownHostException; |
| 29 | import java.util.Arrays; |
Chalard Jean | adbf1d0 | 2018-02-26 11:52:46 +0900 | [diff] [blame] | 30 | import java.util.Comparator; |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 31 | |
| 32 | /** |
| 33 | * This class represents an IP prefix, i.e., a contiguous block of IP addresses aligned on a |
| 34 | * power of two boundary (also known as an "IP subnet"). A prefix is specified by two pieces of |
| 35 | * information: |
| 36 | * |
| 37 | * <ul> |
| 38 | * <li>A starting IP address (IPv4 or IPv6). This is the first IP address of the prefix. |
| 39 | * <li>A prefix length. This specifies the length of the prefix by specifing the number of bits |
| 40 | * in the IP address, starting from the most significant bit in network byte order, that |
| 41 | * are constant for all addresses in the prefix. |
| 42 | * </ul> |
| 43 | * |
| 44 | * For example, the prefix <code>192.0.2.0/24</code> covers the 256 IPv4 addresses from |
| 45 | * <code>192.0.2.0</code> to <code>192.0.2.255</code>, inclusive, and the prefix |
| 46 | * <code>2001:db8:1:2</code> covers the 2^64 IPv6 addresses from <code>2001:db8:1:2::</code> to |
| 47 | * <code>2001:db8:1:2:ffff:ffff:ffff:ffff</code>, inclusive. |
| 48 | * |
| 49 | * Objects of this class are immutable. |
| 50 | */ |
Robert Greenwalt | 0cbe94a | 2014-06-12 12:57:19 -0700 | [diff] [blame] | 51 | public final class IpPrefix implements Parcelable { |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 52 | private final byte[] address; // network byte order |
| 53 | private final int prefixLength; |
| 54 | |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 55 | private void checkAndMaskAddressAndPrefixLength() { |
| 56 | if (address.length != 4 && address.length != 16) { |
| 57 | throw new IllegalArgumentException( |
| 58 | "IpPrefix has " + address.length + " bytes which is neither 4 nor 16"); |
| 59 | } |
| 60 | NetworkUtils.maskRawAddress(address, prefixLength); |
| 61 | } |
| 62 | |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 63 | /** |
| 64 | * Constructs a new {@code IpPrefix} from a byte array containing an IPv4 or IPv6 address in |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 65 | * network byte order and a prefix length. Silently truncates the address to the prefix length, |
| 66 | * so for example {@code 192.0.2.1/24} is silently converted to {@code 192.0.2.0/24}. |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 67 | * |
| 68 | * @param address the IP address. Must be non-null and exactly 4 or 16 bytes long. |
| 69 | * @param prefixLength the prefix length. Must be >= 0 and <= (32 or 128) (IPv4 or IPv6). |
| 70 | * |
| 71 | * @hide |
| 72 | */ |
| 73 | public IpPrefix(byte[] address, int prefixLength) { |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 74 | this.address = address.clone(); |
| 75 | this.prefixLength = prefixLength; |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 76 | checkAndMaskAddressAndPrefixLength(); |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 77 | } |
| 78 | |
| 79 | /** |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 80 | * Constructs a new {@code IpPrefix} from an IPv4 or IPv6 address and a prefix length. Silently |
| 81 | * truncates the address to the prefix length, so for example {@code 192.0.2.1/24} is silently |
| 82 | * converted to {@code 192.0.2.0/24}. |
| 83 | * |
| 84 | * @param address the IP address. Must be non-null. |
| 85 | * @param prefixLength the prefix length. Must be >= 0 and <= (32 or 128) (IPv4 or IPv6). |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 86 | * @hide |
| 87 | */ |
Remi NGUYEN VAN | 299a7cc | 2019-01-23 21:35:52 +0900 | [diff] [blame] | 88 | @SystemApi |
| 89 | @TestApi |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 90 | public IpPrefix(InetAddress address, int prefixLength) { |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 91 | // We don't reuse the (byte[], int) constructor because it calls clone() on the byte array, |
| 92 | // which is unnecessary because getAddress() already returns a clone. |
| 93 | this.address = address.getAddress(); |
| 94 | this.prefixLength = prefixLength; |
| 95 | checkAndMaskAddressAndPrefixLength(); |
| 96 | } |
| 97 | |
| 98 | /** |
| 99 | * Constructs a new IpPrefix from a string such as "192.0.2.1/24" or "2001:db8::1/64". |
| 100 | * Silently truncates the address to the prefix length, so for example {@code 192.0.2.1/24} |
| 101 | * is silently converted to {@code 192.0.2.0/24}. |
| 102 | * |
| 103 | * @param prefix the prefix to parse |
| 104 | * |
| 105 | * @hide |
| 106 | */ |
Remi NGUYEN VAN | 5c5f1ba | 2019-01-29 12:08:43 +0900 | [diff] [blame] | 107 | @SystemApi |
| 108 | @TestApi |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 109 | public IpPrefix(String prefix) { |
| 110 | // We don't reuse the (InetAddress, int) constructor because "error: call to this must be |
| 111 | // first statement in constructor". We could factor out setting the member variables to an |
| 112 | // init() method, but if we did, then we'd have to make the members non-final, or "error: |
| 113 | // cannot assign a value to final variable address". So we just duplicate the code here. |
| 114 | Pair<InetAddress, Integer> ipAndMask = NetworkUtils.parseIpAndMask(prefix); |
| 115 | this.address = ipAndMask.first.getAddress(); |
| 116 | this.prefixLength = ipAndMask.second; |
| 117 | checkAndMaskAddressAndPrefixLength(); |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 118 | } |
| 119 | |
| 120 | /** |
| 121 | * Compares this {@code IpPrefix} object against the specified object in {@code obj}. Two |
| 122 | * objects are equal if they have the same startAddress and prefixLength. |
| 123 | * |
| 124 | * @param obj the object to be tested for equality. |
| 125 | * @return {@code true} if both objects are equal, {@code false} otherwise. |
| 126 | */ |
| 127 | @Override |
| 128 | public boolean equals(Object obj) { |
| 129 | if (!(obj instanceof IpPrefix)) { |
| 130 | return false; |
| 131 | } |
| 132 | IpPrefix that = (IpPrefix) obj; |
| 133 | return Arrays.equals(this.address, that.address) && this.prefixLength == that.prefixLength; |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Gets the hashcode of the represented IP prefix. |
| 138 | * |
| 139 | * @return the appropriate hashcode value. |
| 140 | */ |
| 141 | @Override |
| 142 | public int hashCode() { |
| 143 | return Arrays.hashCode(address) + 11 * prefixLength; |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * Returns a copy of the first IP address in the prefix. Modifying the returned object does not |
| 148 | * change this object's contents. |
| 149 | * |
| 150 | * @return the address in the form of a byte array. |
| 151 | */ |
| 152 | public InetAddress getAddress() { |
| 153 | try { |
| 154 | return InetAddress.getByAddress(address); |
| 155 | } catch (UnknownHostException e) { |
| 156 | // Cannot happen. InetAddress.getByAddress can only throw an exception if the byte |
| 157 | // array is the wrong length, but we check that in the constructor. |
| 158 | return null; |
| 159 | } |
| 160 | } |
| 161 | |
| 162 | /** |
| 163 | * Returns a copy of the IP address bytes in network order (the highest order byte is the zeroth |
| 164 | * element). Modifying the returned array does not change this object's contents. |
| 165 | * |
| 166 | * @return the address in the form of a byte array. |
| 167 | */ |
| 168 | public byte[] getRawAddress() { |
| 169 | return address.clone(); |
| 170 | } |
| 171 | |
| 172 | /** |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 173 | * Returns the prefix length of this {@code IpPrefix}. |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 174 | * |
| 175 | * @return the prefix length. |
| 176 | */ |
| 177 | public int getPrefixLength() { |
| 178 | return prefixLength; |
| 179 | } |
| 180 | |
| 181 | /** |
Erik Kline | acc8c09 | 2015-04-13 15:33:34 +0900 | [diff] [blame] | 182 | * Determines whether the prefix contains the specified address. |
| 183 | * |
| 184 | * @param address An {@link InetAddress} to test. |
| 185 | * @return {@code true} if the prefix covers the given address. |
| 186 | */ |
| 187 | public boolean contains(InetAddress address) { |
| 188 | byte[] addrBytes = (address == null) ? null : address.getAddress(); |
| 189 | if (addrBytes == null || addrBytes.length != this.address.length) { |
| 190 | return false; |
| 191 | } |
| 192 | NetworkUtils.maskRawAddress(addrBytes, prefixLength); |
| 193 | return Arrays.equals(this.address, addrBytes); |
| 194 | } |
| 195 | |
| 196 | /** |
Chalard Jean | adbf1d0 | 2018-02-26 11:52:46 +0900 | [diff] [blame] | 197 | * Returns whether the specified prefix is entirely contained in this prefix. |
| 198 | * |
| 199 | * Note this is mathematical inclusion, so a prefix is always contained within itself. |
| 200 | * @param otherPrefix the prefix to test |
| 201 | * @hide |
| 202 | */ |
| 203 | public boolean containsPrefix(IpPrefix otherPrefix) { |
| 204 | if (otherPrefix.getPrefixLength() < prefixLength) return false; |
| 205 | final byte[] otherAddress = otherPrefix.getRawAddress(); |
| 206 | NetworkUtils.maskRawAddress(otherAddress, prefixLength); |
| 207 | return Arrays.equals(otherAddress, address); |
| 208 | } |
| 209 | |
| 210 | /** |
Hugo Benichi | 1dfb6b6 | 2017-08-08 13:06:04 +0900 | [diff] [blame] | 211 | * @hide |
| 212 | */ |
| 213 | public boolean isIPv6() { |
| 214 | return getAddress() instanceof Inet6Address; |
| 215 | } |
| 216 | |
| 217 | /** |
| 218 | * @hide |
| 219 | */ |
| 220 | public boolean isIPv4() { |
| 221 | return getAddress() instanceof Inet4Address; |
| 222 | } |
| 223 | |
| 224 | /** |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 225 | * Returns a string representation of this {@code IpPrefix}. |
| 226 | * |
Lorenzo Colitti | 4b0f8e6 | 2014-09-19 01:49:05 +0900 | [diff] [blame] | 227 | * @return a string such as {@code "192.0.2.0/24"} or {@code "2001:db8:1:2::/64"}. |
Lorenzo Colitti | 8c6c2c3 | 2014-06-12 13:41:17 +0900 | [diff] [blame] | 228 | */ |
| 229 | public String toString() { |
| 230 | try { |
| 231 | return InetAddress.getByAddress(address).getHostAddress() + "/" + prefixLength; |
| 232 | } catch(UnknownHostException e) { |
| 233 | // Cosmic rays? |
| 234 | throw new IllegalStateException("IpPrefix with invalid address! Shouldn't happen.", e); |
| 235 | } |
| 236 | } |
| 237 | |
| 238 | /** |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 239 | * Implement the Parcelable interface. |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 240 | */ |
| 241 | public int describeContents() { |
| 242 | return 0; |
| 243 | } |
| 244 | |
| 245 | /** |
| 246 | * Implement the Parcelable interface. |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 247 | */ |
| 248 | public void writeToParcel(Parcel dest, int flags) { |
| 249 | dest.writeByteArray(address); |
| 250 | dest.writeInt(prefixLength); |
| 251 | } |
| 252 | |
| 253 | /** |
Chalard Jean | adbf1d0 | 2018-02-26 11:52:46 +0900 | [diff] [blame] | 254 | * Returns a comparator ordering IpPrefixes by length, shorter to longer. |
| 255 | * Contents of the address will break ties. |
| 256 | * @hide |
| 257 | */ |
| 258 | public static Comparator<IpPrefix> lengthComparator() { |
| 259 | return new Comparator<IpPrefix>() { |
| 260 | @Override |
| 261 | public int compare(IpPrefix prefix1, IpPrefix prefix2) { |
| 262 | if (prefix1.isIPv4()) { |
| 263 | if (prefix2.isIPv6()) return -1; |
| 264 | } else { |
| 265 | if (prefix2.isIPv4()) return 1; |
| 266 | } |
| 267 | final int p1len = prefix1.getPrefixLength(); |
| 268 | final int p2len = prefix2.getPrefixLength(); |
| 269 | if (p1len < p2len) return -1; |
| 270 | if (p2len < p1len) return 1; |
| 271 | final byte[] a1 = prefix1.address; |
| 272 | final byte[] a2 = prefix2.address; |
| 273 | final int len = a1.length < a2.length ? a1.length : a2.length; |
| 274 | for (int i = 0; i < len; ++i) { |
| 275 | if (a1[i] < a2[i]) return -1; |
| 276 | if (a1[i] > a2[i]) return 1; |
| 277 | } |
| 278 | if (a2.length < len) return 1; |
| 279 | if (a1.length < len) return -1; |
| 280 | return 0; |
| 281 | } |
| 282 | }; |
| 283 | } |
| 284 | |
| 285 | /** |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 286 | * Implement the Parcelable interface. |
Sreeram Ramachandran | cc91c7b | 2014-06-03 18:41:43 -0700 | [diff] [blame] | 287 | */ |
| 288 | public static final Creator<IpPrefix> CREATOR = |
| 289 | new Creator<IpPrefix>() { |
| 290 | public IpPrefix createFromParcel(Parcel in) { |
| 291 | byte[] address = in.createByteArray(); |
| 292 | int prefixLength = in.readInt(); |
| 293 | return new IpPrefix(address, prefixLength); |
| 294 | } |
| 295 | |
| 296 | public IpPrefix[] newArray(int size) { |
| 297 | return new IpPrefix[size]; |
| 298 | } |
| 299 | }; |
| 300 | } |