Merge pull request #452 from paullouisageneau/transport-policy

Add ICE transport policy option

DOC.md

@@ -72,6 +72,7 @@ typedef struct {
 	const char **iceServers;
 	int iceServersCount;
 	rtcCertificateType certificateType;
+	rtcTransportPolicy iceTransportPolicy;
 	bool enableIceTcp;
 	bool disableAutoNegotiation;
 	uint16_t portRangeBegin;
@@ -88,6 +89,7 @@ Arguments:
   - `iceServersCount` (optional): number of URLs in the array pointed by `iceServers` (0 if unused)
   - `bindAddress` (optional): if non-NULL, bind only to the given local address (ignored with libnice as ICE backend)
   - `certificateType` (optional): certificate type, either `RTC_CERTIFICATE_ECDSA` or `RTC_CERTIFICATE_RSA` (0 or `RTC_CERTIFICATE_DEFAULT` if default)
+  - `iceTransportPolicy` (optional): ICE transport policy, if set to `RTC_TRANSPORT_POLICY_RELAY`, the PeerConnection will emit only relayed candidates (0 or `RTC_TRANSPORT_POLICY_ALL` if default)
   - `enableIceTcp`: if true, generate TCP candidates for ICE (ignored with libjuice as ICE backend)
   - `disableAutoNegotiation`: if true, the user is responsible for calling `rtcSetLocalDescription` after creating a Data Channel and after setting the remote description
   - `portRangeBegin` (optional): first port (included) of the allowed local port range (0 if unused)

include/rtc/configuration.hpp

@@ -70,6 +70,11 @@ enum class CertificateType {
 	Rsa = RTC_CERTIFICATE_RSA
 };
 
+enum class TransportPolicy {
+	All = RTC_TRANSPORT_POLICY_ALL,
+	Relay = RTC_TRANSPORT_POLICY_RELAY
+};
+
 struct RTC_CPP_EXPORT Configuration {
 	// ICE settings
 	std::vector<IceServer> iceServers;
@@ -78,6 +83,7 @@ struct RTC_CPP_EXPORT Configuration {
 
 	// Options
 	CertificateType certificateType = CertificateType::Default;
+	TransportPolicy iceTransportPolicy = TransportPolicy::All;
 	bool enableIceTcp = false;
 	bool disableAutoNegotiation = false;
 

include/rtc/rtc.h

@@ -113,6 +113,11 @@ typedef enum {
 	RTC_DIRECTION_INACTIVE = 4
 } rtcDirection;
 
+typedef enum {
+	RTC_TRANSPORT_POLICY_ALL = 0,
+	RTC_TRANSPORT_POLICY_RELAY = 1
+} rtcTransportPolicy;
+
 #define RTC_ERR_SUCCESS 0
 #define RTC_ERR_INVALID -1   // invalid argument
 #define RTC_ERR_FAILURE -2   // runtime error
@@ -152,6 +157,7 @@ typedef struct {
 	int iceServersCount;
 	const char *bindAddress; // libjuice only, NULL means any
 	rtcCertificateType certificateType;
+	rtcTransportPolicy iceTransportPolicy;
 	bool enableIceTcp;
 	bool disableAutoNegotiation;
 	uint16_t portRangeBegin; // 0 means automatic

src/capi.cpp

@@ -343,6 +343,7 @@ int rtcCreatePeerConnection(const rtcConfiguration *config) {
 		}
 
 		c.certificateType = static_cast<CertificateType>(config->certificateType);
+		c.iceTransportPolicy = static_cast<TransportPolicy>(config->iceTransportPolicy);
 		c.enableIceTcp = config->enableIceTcp;
 		c.disableAutoNegotiation = config->disableAutoNegotiation;
 

src/impl/peerconnection.cpp

@@ -872,6 +872,8 @@ void PeerConnection::processLocalDescription(Description description) {
 	// Set local fingerprint (wait for certificate if necessary)
 	description.setFingerprint(mCertificate.get()->fingerprint());
 
+	PLOG_VERBOSE << "Issuing local description: " << description;
+
 	{
 		// Set as local description
 		std::lock_guard lock(mLocalDescriptionMutex);
@@ -886,7 +888,6 @@ void PeerConnection::processLocalDescription(Description description) {
 		mLocalDescription->addCandidates(std::move(existingCandidates));
 	}
 
-	PLOG_VERBOSE << "Issuing local description: " << description;
 	mProcessor->enqueue(localDescriptionCallback.wrap(), std::move(description));
 
 	// Reciprocated tracks might need to be open
@@ -900,10 +901,16 @@ void PeerConnection::processLocalCandidate(Candidate candidate) {
 	if (!mLocalDescription)
 		throw std::logic_error("Got a local candidate without local description");
 
+	if(config.iceTransportPolicy == TransportPolicy::Relay && candidate.type() != Candidate::Type::Relayed) {
+		PLOG_VERBOSE << "Not issuing local candidate because of transport policy: " << candidate;
+		return;
+	}
+
+	PLOG_VERBOSE << "Issuing local candidate: " << candidate;
+
 	candidate.resolve(Candidate::ResolveMode::Simple);
 	mLocalDescription->addCandidate(candidate);
 
-	PLOG_VERBOSE << "Issuing local candidate: " << candidate;
 	mProcessor->enqueue(localCandidateCallback.wrap(), std::move(candidate));
 }
 

test/turn_connectivity.cpp

@@ -33,6 +33,8 @@ void test_turn_connectivity() {
 	InitLogger(LogLevel::Debug);
 
 	Configuration config1;
+	config1.iceTransportPolicy = TransportPolicy::Relay; // force relay
+
 	// STUN server example (not necessary, just here for testing)
 	// Please do not use outside of libdatachannel tests
 	config1.iceServers.emplace_back("stun:stun.ageneau.net:3478");
@@ -43,6 +45,8 @@ void test_turn_connectivity() {
 	PeerConnection pc1(config1);
 
 	Configuration config2;
+	config2.iceTransportPolicy = TransportPolicy::Relay; // force relay
+
 	// STUN server example (not necessary, just here for testing)
 	// Please do not use outside of libdatachannel tests
 	config1.iceServers.emplace_back("stun:stun.ageneau.net:3478");
@@ -58,12 +62,8 @@ void test_turn_connectivity() {
 	});
 
 	pc1.onLocalCandidate([&pc2](Candidate candidate) {
-		// For this test, filter out non-relay candidates to force TURN
-		string str(candidate);
-		if (str.find("relay") != string::npos) {
-			cout << "Candidate 1: " << str << endl;
-			pc2.addRemoteCandidate(str);
-		}
+		cout << "Candidate 1: " << candidate << endl;
+		pc2.addRemoteCandidate(string(candidate));
 	});
 
 	pc1.onStateChange([](PeerConnection::State state) { cout << "State 1: " << state << endl; });
@@ -82,12 +82,8 @@ void test_turn_connectivity() {
 	});
 
 	pc2.onLocalCandidate([&pc1](Candidate candidate) {
-		// For this test, filter out non-relay candidates to force TURN
-		string str(candidate);
-		if (str.find("relay") != string::npos) {
-			cout << "Candidate 1: " << str << endl;
-			pc1.addRemoteCandidate(str);
-		}
+		cout << "Candidate 2: " << candidate << endl;
+		pc1.addRemoteCandidate(string(candidate));
 	});
 
 	pc2.onStateChange([](PeerConnection::State state) { cout << "State 2: " << state << endl; });
@@ -160,14 +156,23 @@ void test_turn_connectivity() {
 		cout << "Remote address 2: " << *addr << endl;
 
 	Candidate local, remote;
-	if (pc1.getSelectedCandidatePair(&local, &remote)) {
-		cout << "Local candidate 1:  " << local << endl;
-		cout << "Remote candidate 1: " << remote << endl;
-	}
-	if (pc2.getSelectedCandidatePair(&local, &remote)) {
-		cout << "Local candidate 2:  " << local << endl;
-		cout << "Remote candidate 2: " << remote << endl;
-	}
+	if (!pc1.getSelectedCandidatePair(&local, &remote))
+		throw runtime_error("getSelectedCabndidatePair failed");
+
+	cout << "Local candidate 1:  " << local << endl;
+	cout << "Remote candidate 1: " << remote << endl;
+
+	if(local.type() != Candidate::Type::Relayed || remote.type() != Candidate::Type::Relayed)
+		throw runtime_error("Connection is not relayed as expected");
+
+	if (!pc2.getSelectedCandidatePair(&local, &remote))
+		throw runtime_error("getSelectedCabndidatePair failed");
+
+	cout << "Local candidate 2:  " << local << endl;
+	cout << "Remote candidate 2: " << remote << endl;
+
+	if(local.type() != Candidate::Type::Relayed || remote.type() != Candidate::Type::Relayed)
+		throw runtime_error("Connection is not relayed as expected");
 
 	// Try to open a second data channel with another label
 	shared_ptr<DataChannel> second2;