From 1d13bc71750af56f21719442c368d8fa75d65813 Mon Sep 17 00:00:00 2001 From: Boris Grozev Date: Wed, 16 Nov 2016 16:29:39 -0600 Subject: [PATCH] feat: Adds MappingCandidateHarvesters. Moves the HarvesterConfiguration class from jitsi-videobridge to ice4j (now named MappingCandidateHarvesters), and re-implements the STUN candidate harvester's discovery in a way which allows us to detect failures. --- .../ice/harvest/AwsCandidateHarvester.java | 2 +- .../harvest/MappingCandidateHarvester.java | 13 +- .../harvest/MappingCandidateHarvesters.java | 371 ++++++++++++++++++ .../StunMappingCandidateHarvester.java | 143 ++----- 4 files changed, 418 insertions(+), 111 deletions(-) create mode 100644 src/main/java/org/ice4j/ice/harvest/MappingCandidateHarvesters.java diff --git a/src/main/java/org/ice4j/ice/harvest/AwsCandidateHarvester.java b/src/main/java/org/ice4j/ice/harvest/AwsCandidateHarvester.java index 4f25851..74c7b71 100644 --- a/src/main/java/org/ice4j/ice/harvest/AwsCandidateHarvester.java +++ b/src/main/java/org/ice4j/ice/harvest/AwsCandidateHarvester.java @@ -83,7 +83,7 @@ public class AwsCandidateHarvester */ public AwsCandidateHarvester() { - super(null, null); + super(); } /** diff --git a/src/main/java/org/ice4j/ice/harvest/MappingCandidateHarvester.java b/src/main/java/org/ice4j/ice/harvest/MappingCandidateHarvester.java index bc6bd22..e39a016 100644 --- a/src/main/java/org/ice4j/ice/harvest/MappingCandidateHarvester.java +++ b/src/main/java/org/ice4j/ice/harvest/MappingCandidateHarvester.java @@ -70,8 +70,17 @@ public class MappingCandidateHarvester public MappingCandidateHarvester(TransportAddress mask, TransportAddress face) { - this.mask = mask; - this.face = face; + this.mask = Objects.requireNonNull(mask); + this.face = Objects.requireNonNull(face); + } + + /** + * Initializes a {@link MappingCandidateHarvester} instance without + * specified addresses (only useful in subclasses which override + * {@link #getMask()} and {@link #getFace()}). + */ + protected MappingCandidateHarvester() + { } /** diff --git a/src/main/java/org/ice4j/ice/harvest/MappingCandidateHarvesters.java b/src/main/java/org/ice4j/ice/harvest/MappingCandidateHarvesters.java new file mode 100644 index 0000000..0d06b0b --- /dev/null +++ b/src/main/java/org/ice4j/ice/harvest/MappingCandidateHarvesters.java @@ -0,0 +1,371 @@ +/* + * Copyright @ 2015-2016 Atlassian Pty Ltd + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.ice4j.ice.harvest; + +import org.ice4j.*; + +import java.net.*; +import java.util.*; +import java.util.concurrent.*; +import java.util.logging.*; + +/** + * Manages a static list of {@link MappingCandidateHarvester} instances, created + * according to configuration provided as system properties. + * + * The instances in the set are safe to use by any {@code Agent}s. + * + * @author Damian Minkov + * @author Boris Grozev + */ +public class MappingCandidateHarvesters +{ + /** + * The {@link Logger} used by the {@link MappingCandidateHarvesters} + * class for logging output. + */ + private static final Logger logger + = Logger.getLogger(MappingCandidateHarvesters.class.getName()); + + /** + * The name of the property that specifies the local address, if any, for + * the pre-configured NAT harvester. + */ + public static final String NAT_HARVESTER_LOCAL_ADDRESS_PNAME + = "org.ice4j.ice.harvest.NAT_HARVESTER_LOCAL_ADDRESS"; + + /** + * The name of the property that specifies the public address, if any, for + * the pre-configured NAT harvester. + */ + public static final String NAT_HARVESTER_PUBLIC_ADDRESS_PNAME + = "org.ice4j.ice.harvest.NAT_HARVESTER_PUBLIC_ADDRESS"; + + /** + * The name of the property used to disable the AWS harvester. + */ + public static final String DISABLE_AWS_HARVESTER_PNAME + = "org.ice4j.ice.harvest.DISABLE_AWS_HARVESTER"; + + /** + * The name of the property which forces the use of the AWS harvester. + */ + public static final String FORCE_AWS_HARVESTER_PNAME + = "org.ice4j.ice.harvest.FORCE_AWS_HARVESTER"; + + /** + * The name of the property which contains the addresses of the STUN servers + * to use for the STUN mapping harvester. The property should contain a + * comma-separated list of addresses (pairs of IP address and port, + * separated by a colon). Example: + * {@code stun1.example.com:12345,stun2.example.com:23456} + */ + public static final String STUN_MAPPING_HARVESTER_ADDRESSES_PNAME + = "org.ice4j.ice.harvest.STUN_MAPPING_HARVESTER_ADDRESSES"; + + /** + * Whether {@link #harvesters} has been initialized. + */ + private static boolean initialized = false; + + /** + * The list of already configured harvesters. + */ + private static MappingCandidateHarvester[] harvesters; + + /** + * Whether the discovery of a public address via STUN has failed. + * It is considered failed if the configuration included at least one STUN + * server, but we failed to receive at least one valid response. + * Note that this defaults to false and is only raised after we are certain + * we failed (i.e. after our STUN transactions timeout). + */ + public static boolean stunDiscoveryFailed = false; + + /** + * @return the list of configured harvesters. + */ + public static MappingCandidateHarvester[] getHarvesters() + { + initialize(); + return harvesters; + } + + /** + * Initializes {@link #harvesters}. + * First it reads the configuration and instantiates harvesters accordingly, + * waiting for their initialization (which may include network communication + * and thus take a long time). Then it removes harvesters which failed to + * initialize properly and remove any harvesters with duplicate addresses. + * + * Three types of mapping harvesters are supported: NAT (with + * pre-configured addresses), AWS and STUN. + */ + public static synchronized void initialize() + { + if (initialized) + return; + initialized = true; + + long start = System.currentTimeMillis(); + List harvesterList = new LinkedList<>(); + + + // Pre-configured NAT harvester. + String localAddressStr + = StackProperties.getString(NAT_HARVESTER_LOCAL_ADDRESS_PNAME); + String publicAddressStr + = StackProperties.getString(NAT_HARVESTER_PUBLIC_ADDRESS_PNAME); + + if (localAddressStr != null && publicAddressStr != null) + { + // the port number is unused, 9 is for "discard" + TransportAddress localAddress + = new TransportAddress(localAddressStr, 9, Transport.UDP); + TransportAddress publicAddress + = new TransportAddress(publicAddressStr, 9, Transport.UDP); + + harvesterList.add( + new MappingCandidateHarvester(publicAddress, localAddress)); + } + + // AWS harvester + boolean disableAwsHarvester + = StackProperties.getBoolean(DISABLE_AWS_HARVESTER_PNAME, false); + boolean forceAwsHarvester + = StackProperties.getBoolean(FORCE_AWS_HARVESTER_PNAME, false); + + if (logger.isLoggable(Level.FINE)) + { + logger.fine("AWS configuration: disable=" + disableAwsHarvester + + "; force=" + forceAwsHarvester); + } + + if (!disableAwsHarvester && + (forceAwsHarvester || AwsCandidateHarvester.smellsLikeAnEC2())) + { + harvesterList.add(new AwsCandidateHarvester()); + } + + // STUN harvesters + String stunServers + = StackProperties.getString(STUN_MAPPING_HARVESTER_ADDRESSES_PNAME); + if (stunServers != null && !stunServers.isEmpty()) + { + // Create STUN harvesters (and wait for all of their discovery to + // finish). + List stunHarvesters + = createStunHarvesters(stunServers.split(",")); + + // We have STUN servers configured, so flag the failure if none of + // them were able to discover an address. + stunDiscoveryFailed = stunHarvesters.isEmpty(); + + harvesterList.addAll(stunHarvesters); + } + + harvesterList = prune(harvesterList); + harvesters + = harvesterList.toArray( + new MappingCandidateHarvester[harvesterList.size()]); + + for (MappingCandidateHarvester harvester : harvesters) + { + logger.info("Using " + harvester); + } + logger.info("Initialized mapping harvesters (delay=" + + (System.currentTimeMillis() - start) + "ms)."); + } + + /** + * Prunes a list of mapping harvesters, removing the ones without valid + * addresses and those with duplicate addresses. + * @param harvesters the list of harvesters. + * @return the pruned list. + */ + private static List prune( + List harvesters) + { + List pruned = new LinkedList<>(); + for (MappingCandidateHarvester harvester : harvesters) + { + maybeAdd(harvester, pruned); + } + return pruned; + } + + /** + * Adds {@code harvester} to {@code harvesters}, if it has valid addresses + * and {@code harvesters} doesn't already contain a harvester with the same + * addresses. + * @param harvester the harvester to add. + * @param harvesters the list to add to. + */ + private static void maybeAdd( + MappingCandidateHarvester harvester, + List harvesters) + { + TransportAddress face = harvester.getFace(); + TransportAddress mask = harvester.getMask(); + if (face == null || mask == null || face.equals(mask)) + { + logger.info("Discarding a mapping harvester: " + harvester); + return; + } + + for (MappingCandidateHarvester h : harvesters) + { + if (face.getAddress().equals(h.getFace().getAddress()) && mask.getAddress().equals(h.getMask().getAddress())) + { + logger.info("Discarding a mapping harvester with duplicate " + + "addresses: " + harvester + ". Kept: " + h); + return; + } + } + + harvesters.add(harvester); + } + + /** + * Creates STUN mapping harvesters for each of the given STUN servers, and + * waits for address discovery to finish for all of them. + * @param stunServers an array of STUN server addresses (ip_address:port + * pairs). + * @return the list of those who were successful in discovering an address. + */ + private static List createStunHarvesters( + String[] stunServers) + { + List stunHarvesters = new LinkedList<>(); + + if (stunServers == null || stunServers.length == 0) + { + logger.severe("No STUN servers configured."); + return stunHarvesters; + } + + List> tasks = new LinkedList<>(); + + // Create a StunMappingCandidateHarvester for each local:remote address + // pair. + List localAddresses + = HostCandidateHarvester.getAllAllowedAddresses(); + for (String stunServer : stunServers) + { + String[] addressAndPort = stunServer.split(":"); + if (addressAndPort.length < 2) + { + logger.severe("Failed to parse STUN server address: " + + stunServer); + continue; + } + int port; + try + { + port = Integer.parseInt(addressAndPort[1]); + } + catch (NumberFormatException nfe) + { + logger.severe("Invalid STUN server port: " + addressAndPort[1]); + continue; + } + + TransportAddress remoteAddress + = new TransportAddress( + addressAndPort[0], + port, + Transport.UDP); + + for (InetAddress localInetAddress : localAddresses) + { + if (localInetAddress instanceof Inet6Address) + { + // This is disabled, because it is broken for an unknown + // reason and it is not currently needed. + continue; + } + + TransportAddress localAddress + = new TransportAddress(localInetAddress, 0, Transport.UDP); + + final StunMappingCandidateHarvester stunHarvester + = new StunMappingCandidateHarvester( + localAddress, + remoteAddress); + + Callable task + = new Callable() + { + @Override + public StunMappingCandidateHarvester call() + throws Exception + { + stunHarvester.discover(); + return stunHarvester; + } + }; + tasks.add(task); + } + } + + // Now run discover() on all created harvesters in parallel and pick + // the ones which succeeded. + ExecutorService es = Executors.newFixedThreadPool(tasks.size()); + + List> futures; + try + { + futures = es.invokeAll(tasks); + } + catch (InterruptedException ie) + { + Thread.currentThread().interrupt(); + return stunHarvesters; + } + + for (Future future : futures) + { + try + { + StunMappingCandidateHarvester harvester = future.get(); + + // The STUN server replied successfully. + if (harvester.getMask() != null) + { + stunHarvesters.add(harvester); + } + } + catch (ExecutionException ee) + { + // The harvester failed for some reason, discard it. + } + catch(InterruptedException ie) + { + Thread.currentThread().interrupt(); + throw new RuntimeException(ie); + } + } + + return stunHarvesters; + } + + /** + * Prevent instance creation. + */ + private MappingCandidateHarvesters() + { + } +} diff --git a/src/main/java/org/ice4j/ice/harvest/StunMappingCandidateHarvester.java b/src/main/java/org/ice4j/ice/harvest/StunMappingCandidateHarvester.java index f030ba1..fd8032b 100644 --- a/src/main/java/org/ice4j/ice/harvest/StunMappingCandidateHarvester.java +++ b/src/main/java/org/ice4j/ice/harvest/StunMappingCandidateHarvester.java @@ -18,15 +18,18 @@ package org.ice4j.ice.harvest; import org.ice4j.*; -import org.ice4j.ice.*; +import org.ice4j.socket.*; +import org.ice4j.stunclient.*; +import java.net.*; import java.util.logging.*; /** - * A MappingCandidateHarvester which use a list of pre-configured stun servers - * to discover its public ip address. + * A {@link MappingCandidateHarvester} which uses a STUN servers to discover + * its public IP address. * * @author Damian Minkov + * @author Boris Grozev */ public class StunMappingCandidateHarvester extends MappingCandidateHarvester @@ -38,132 +41,56 @@ public class StunMappingCandidateHarvester private static final Logger logger = Logger.getLogger(StunMappingCandidateHarvester.class.getName()); - /** - * The addresses that we will use as a mask - */ - private static TransportAddress mask; - - /** - * The addresses that we will be masking - */ - private static TransportAddress face; - - /** - * Whether we have already checked and found the mapping addresses. - */ - private static boolean addressChecked = false; - /** * The list of servers we will use to discover our public address. */ - private static String[] stunServers; + private TransportAddress stunServerAddress; /** - * Creates a mapping harvester with the specified mask - * @param servers list of stun servers in the form address:port + * Initializes a new {@link StunMappingCandidateHarvester} instance with + * a given local address and a STUN server address. Note that the actual + * discovery of the public address needs to be initiated to a separate call + * to {@link #discover()}. + * @param localAddress The local address. + * @param stunServerAddress The address of the STUN server. */ - public StunMappingCandidateHarvester(String[] servers) + public StunMappingCandidateHarvester( + TransportAddress localAddress, + TransportAddress stunServerAddress) { - super(null, null); - - StunMappingCandidateHarvester.stunServers = servers; - - // we have the list of addresses lets, try discovering - obtainAddresses(); + face = localAddress; + this.stunServerAddress = stunServerAddress; } /** - * Creates a mapping harvester with the specified mask + * Attempts to discover the the public address (mask) via the STUN server. + * Note that this will block until we either receive a response from the + * STUN server, or a timeout occurs. */ - public StunMappingCandidateHarvester() + public void discover() { - super(null, null); - } - - /** - * Uses the pre-configured list of stun servers to discover our public - * address. Uses the first successful one and ignore the rest. - * Learn the private (face) and public (mask) addresses of this instance. - */ - private static synchronized void obtainAddresses() - { - if (addressChecked) - return; - addressChecked = true; - try { - for (String server : stunServers) + SimpleAddressDetector sad + = new SimpleAddressDetector(stunServerAddress); + sad.start(); + + IceSocketWrapper localSocket + = new IceUdpSocketWrapper(new DatagramSocket(face)); + + mask = sad.getMappingFor(localSocket); + if (mask != null) { - String[] addressAndPort = server.split(":"); - - StunCandidateHarvester stunHarv = new StunCandidateHarvester( - new TransportAddress( - addressAndPort[0], - Integer.parseInt(addressAndPort[1]), - Transport.UDP)); - - Agent agent = new Agent(); - agent.setTrickling(false); - agent.addCandidateHarvester(stunHarv); - - IceMediaStream stream = agent.createMediaStream("audio"); - // local ports does not matter, just to be something - // out of the default used range - agent.createComponent( - stream, Transport.UDP, 32020, 32020, 32020 + 100); - - IceMediaStream iceMediaStream = agent.getStreams().get(0); - TransportAddress addr = iceMediaStream - .getComponent(Component.RTP).getDefaultCandidate() - .getTransportAddress(); - mask = addr; - - Candidate candidate = - iceMediaStream.getComponents().get(0).getDefaultCandidate(); - face = candidate.getHostAddress(); - - agent.free(); - - if (mask != null && face != null) - break; + logger.info("Discovered public address " + mask + + " from STUN server " + stunServerAddress + + " using local address " + face); } - - logger.info("Detected through stun local IP: " + face); - logger.info("Detected through stun public IP: " + mask); - } catch (Exception exc) { - //whatever happens, we just log and fail + //whatever happens, we just log logger.log(Level.INFO, "We failed to obtain addresses " + "for the following reason: ", exc); } } - - /** - * Returns the public (mask) address, or null. - * @return the public (mask) address, or null. - */ - public TransportAddress getMask() - { - if (mask == null) - { - obtainAddresses(); - } - return mask; - } - - /** - * Returns the local (face) address, or null. - * @return the local (face) address, or null. - */ - public TransportAddress getFace() - { - if (face == null) - { - obtainAddresses(); - } - return face; - } }