-
Notifications
You must be signed in to change notification settings - Fork 887
Add SubnetAddressTranslator #2013
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 4.x
Are you sure you want to change the base?
Changes from all commits
bc5514c
d4fae06
b6bc879
05f38bf
eb4b576
addc6be
7f7fdf5
844287e
85d5931
4698204
bce2289
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,14 +19,11 @@ | |
|
||
import com.datastax.oss.driver.api.core.metadata.EndPoint; | ||
import com.datastax.oss.driver.internal.core.metadata.DefaultEndPoint; | ||
import com.datastax.oss.driver.internal.core.util.AddressUtils; | ||
import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableSet; | ||
import com.datastax.oss.driver.shaded.guava.common.collect.Sets; | ||
import java.net.InetAddress; | ||
import java.net.InetSocketAddress; | ||
import java.net.UnknownHostException; | ||
import java.util.Arrays; | ||
import java.util.Collections; | ||
import java.util.HashSet; | ||
import java.util.List; | ||
import java.util.Set; | ||
import org.slf4j.Logger; | ||
|
@@ -41,7 +38,22 @@ public static Set<EndPoint> merge( | |
|
||
Set<EndPoint> result = Sets.newHashSet(programmaticContactPoints); | ||
for (String spec : configContactPoints) { | ||
for (InetSocketAddress address : extract(spec, resolve)) { | ||
|
||
Set<InetSocketAddress> addresses = Collections.emptySet(); | ||
try { | ||
addresses = AddressUtils.extract(spec, resolve); | ||
} catch (RuntimeException e) { | ||
LOG.warn("Ignoring invalid contact point {} ({})", spec, e.getMessage(), e); | ||
} | ||
|
||
if (addresses.size() > 1) { | ||
LOG.info( | ||
"Contact point {} resolves to multiple addresses, will use them all ({})", | ||
spec, | ||
addresses); | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Does this log message offer us much useful information? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same as above, it was there so I kept it as is. |
||
|
||
for (InetSocketAddress address : addresses) { | ||
DefaultEndPoint endPoint = new DefaultEndPoint(address); | ||
boolean wasNew = result.add(endPoint); | ||
if (!wasNew) { | ||
|
@@ -51,43 +63,4 @@ public static Set<EndPoint> merge( | |
} | ||
return ImmutableSet.copyOf(result); | ||
} | ||
|
||
private static Set<InetSocketAddress> extract(String spec, boolean resolve) { | ||
int separator = spec.lastIndexOf(':'); | ||
if (separator < 0) { | ||
LOG.warn("Ignoring invalid contact point {} (expecting host:port)", spec); | ||
return Collections.emptySet(); | ||
} | ||
|
||
String host = spec.substring(0, separator); | ||
String portSpec = spec.substring(separator + 1); | ||
int port; | ||
try { | ||
port = Integer.parseInt(portSpec); | ||
} catch (NumberFormatException e) { | ||
LOG.warn("Ignoring invalid contact point {} (expecting a number, got {})", spec, portSpec); | ||
return Collections.emptySet(); | ||
} | ||
if (!resolve) { | ||
return ImmutableSet.of(InetSocketAddress.createUnresolved(host, port)); | ||
} else { | ||
try { | ||
InetAddress[] inetAddresses = InetAddress.getAllByName(host); | ||
if (inetAddresses.length > 1) { | ||
LOG.info( | ||
"Contact point {} resolves to multiple addresses, will use them all ({})", | ||
spec, | ||
Arrays.deepToString(inetAddresses)); | ||
} | ||
Set<InetSocketAddress> result = new HashSet<>(); | ||
for (InetAddress inetAddress : inetAddresses) { | ||
result.add(new InetSocketAddress(inetAddress, port)); | ||
} | ||
return result; | ||
} catch (UnknownHostException e) { | ||
LOG.warn("Ignoring invalid contact point {} (unknown host {})", spec, host); | ||
return Collections.emptySet(); | ||
} | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,157 @@ | ||
package com.datastax.oss.driver.internal.core.addresstranslation; | ||
|
||
import com.datastax.oss.driver.shaded.guava.common.annotations.VisibleForTesting; | ||
import java.net.InetAddress; | ||
import java.net.UnknownHostException; | ||
import java.util.Arrays; | ||
|
||
class Subnet { | ||
private final byte[] subnet; | ||
private final byte[] networkMask; | ||
private final byte[] upper; | ||
private final byte[] lower; | ||
|
||
private Subnet(byte[] subnet, byte[] networkMask) { | ||
this.subnet = subnet; | ||
this.networkMask = networkMask; | ||
|
||
byte[] upper = new byte[subnet.length]; | ||
byte[] lower = new byte[subnet.length]; | ||
for (int i = 0; i < subnet.length; i++) { | ||
upper[i] = (byte) (subnet[i] | ~networkMask[i]); | ||
lower[i] = (byte) (subnet[i] & networkMask[i]); | ||
} | ||
this.upper = upper; | ||
this.lower = lower; | ||
} | ||
|
||
static Subnet parse(String subnetCIDR) throws UnknownHostException { | ||
String[] parts = subnetCIDR.split("/"); | ||
if (parts.length != 2) { | ||
throw new IllegalArgumentException("Invalid subnet: " + subnetCIDR); | ||
} | ||
|
||
boolean isIPv6 = parts[0].contains(":"); | ||
byte[] subnet = InetAddress.getByName(parts[0]).getAddress(); | ||
if (isIPv4(subnet) && isIPv6) { | ||
subnet = toIPv6(subnet); | ||
} | ||
int prefixLength = Integer.parseInt(parts[1]); | ||
validatePrefixLength(subnet, prefixLength); | ||
|
||
byte[] networkMask = toNetworkMask(subnet, prefixLength); | ||
validateSubnetIsPrefixBlock(subnet, networkMask, subnetCIDR); | ||
return new Subnet(subnet, networkMask); | ||
} | ||
|
||
private static byte[] toNetworkMask(byte[] subnet, int prefixLength) { | ||
int fullBytes = prefixLength / 8; | ||
int remainingBits = prefixLength % 8; | ||
byte[] mask = new byte[subnet.length]; | ||
Arrays.fill(mask, 0, fullBytes, (byte) 0xFF); | ||
if (remainingBits > 0) { | ||
mask[fullBytes] = (byte) (0xFF << (8 - remainingBits)); | ||
} | ||
return mask; | ||
} | ||
|
||
private static void validatePrefixLength(byte[] subnet, int prefixLength) { | ||
int max_prefix_length = subnet.length * 8; | ||
if (prefixLength < 0 || max_prefix_length < prefixLength) { | ||
throw new IllegalArgumentException( | ||
String.format( | ||
"Prefix length %s must be within [0; %s]", prefixLength, max_prefix_length)); | ||
} | ||
} | ||
|
||
private static void validateSubnetIsPrefixBlock( | ||
byte[] subnet, byte[] networkMask, String subnetCIDR) { | ||
byte[] prefixBlock = toPrefixBlock(subnet, networkMask); | ||
if (!Arrays.equals(subnet, prefixBlock)) { | ||
throw new IllegalArgumentException( | ||
String.format("Subnet %s must be represented as a network prefix block", subnetCIDR)); | ||
} | ||
} | ||
|
||
private static byte[] toPrefixBlock(byte[] subnet, byte[] networkMask) { | ||
byte[] prefixBlock = new byte[subnet.length]; | ||
for (int i = 0; i < subnet.length; i++) { | ||
prefixBlock[i] = (byte) (subnet[i] & networkMask[i]); | ||
} | ||
return prefixBlock; | ||
} | ||
|
||
@VisibleForTesting | ||
byte[] getSubnet() { | ||
return Arrays.copyOf(subnet, subnet.length); | ||
} | ||
|
||
@VisibleForTesting | ||
byte[] getNetworkMask() { | ||
return Arrays.copyOf(networkMask, networkMask.length); | ||
} | ||
|
||
byte[] getUpper() { | ||
return Arrays.copyOf(upper, upper.length); | ||
} | ||
|
||
byte[] getLower() { | ||
return Arrays.copyOf(lower, lower.length); | ||
} | ||
|
||
boolean isIPv4() { | ||
return isIPv4(subnet); | ||
} | ||
|
||
boolean isIPv6() { | ||
return isIPv6(subnet); | ||
} | ||
|
||
boolean contains(byte[] ip) { | ||
if (isIPv4() && !isIPv4(ip)) { | ||
return false; | ||
} | ||
if (isIPv6() && isIPv4(ip)) { | ||
ip = toIPv6(ip); | ||
} | ||
if (subnet.length != ip.length) { | ||
throw new IllegalArgumentException( | ||
"IP version is unknown: " + Arrays.toString(toZeroBasedByteArray(ip))); | ||
} | ||
for (int i = 0; i < subnet.length; i++) { | ||
if (subnet[i] != (byte) (ip[i] & networkMask[i])) { | ||
return false; | ||
} | ||
} | ||
return true; | ||
} | ||
|
||
private static boolean isIPv4(byte[] ip) { | ||
return ip.length == 4; | ||
} | ||
|
||
private static boolean isIPv6(byte[] ip) { | ||
return ip.length == 16; | ||
} | ||
|
||
private static byte[] toIPv6(byte[] ipv4) { | ||
byte[] ipv6 = new byte[16]; | ||
ipv6[10] = (byte) 0xFF; | ||
ipv6[11] = (byte) 0xFF; | ||
System.arraycopy(ipv4, 0, ipv6, 12, 4); | ||
return ipv6; | ||
} | ||
|
||
@Override | ||
public String toString() { | ||
return Arrays.toString(toZeroBasedByteArray(subnet)); | ||
} | ||
|
||
private static int[] toZeroBasedByteArray(byte[] bytes) { | ||
int[] res = new int[bytes.length]; | ||
for (int i = 0; i < bytes.length; i++) { | ||
res[i] = bytes[i] & 0xFF; | ||
} | ||
return res; | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
package com.datastax.oss.driver.internal.core.addresstranslation; | ||
|
||
import java.net.InetSocketAddress; | ||
import java.net.UnknownHostException; | ||
|
||
class SubnetAddress { | ||
private final Subnet subnet; | ||
private final InetSocketAddress address; | ||
|
||
SubnetAddress(String subnetCIDR, InetSocketAddress address) { | ||
try { | ||
this.subnet = Subnet.parse(subnetCIDR); | ||
} catch (UnknownHostException e) { | ||
throw new RuntimeException(e); | ||
} | ||
this.address = address; | ||
} | ||
|
||
InetSocketAddress getAddress() { | ||
return this.address; | ||
} | ||
|
||
boolean isOverlapping(SubnetAddress other) { | ||
Subnet thisSubnet = this.subnet; | ||
Subnet otherSubnet = other.subnet; | ||
return thisSubnet.contains(otherSubnet.getLower()) | ||
|| thisSubnet.contains(otherSubnet.getUpper()) | ||
|| otherSubnet.contains(thisSubnet.getLower()) | ||
|| otherSubnet.contains(thisSubnet.getUpper()); | ||
} | ||
|
||
boolean contains(InetSocketAddress address) { | ||
return subnet.contains(address.getAddress().getAddress()); | ||
} | ||
|
||
boolean isIPv4() { | ||
return subnet.isIPv4(); | ||
} | ||
|
||
boolean isIPv6() { | ||
return subnet.isIPv6(); | ||
} | ||
|
||
@Override | ||
public String toString() { | ||
return "SubnetAddress[subnet=" + subnet + ", address=" + address + "]"; | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could just continue here to next iteration of the outer for loop. You know addresses is the empty set at this point so there's no point iterating over it below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I look at this now it feels like we had to make this a bit more complicated because AddressUtils.extract() now throws exceptions in most cases rather than just logging errors and returning an empty set. Was there a particular reason for this change? It's not immediately clear the exceptions buy you much here.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Previously,
#extract
code was used only in this class and we logged errors together with reasons of these errors. Now the info about reasons is moved to util method, which is called from multiple places. In this class, I aimed to keep logging (as well as other functionality) as close to the origin as seemed possible to avoid opinionated refactoring, so I needed a way to get reasons of errors from the utility#extract
to log them together with the context logs.Happy to agree on the way it should look like and change accordingly.