feat: pass custom ICE ufrag and pwd as local description init

Adds an optional second argument to `rtc::PeerConnection::setLocalDescription` that can contain an ICE ufrag and pwd that if passed will be used in place of the randomly generated versions. Refs: #1166 Refs: #1201 (comment) Co-authored-by: Paul-Louis Ageneau <[email protected]>
paullouisageneau · Jun 13, 2024 · 264585c · 264585c
1 parent a8bf0f9
commit 264585c
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/include/rtc/peerconnection.hpp b/include/rtc/peerconnection.hpp
@@ -35,6 +35,11 @@ struct RTC_CPP_EXPORT DataChannelInit {
 	string protocol = "";
 };
 
+struct RTC_CPP_EXPORT LocalDescriptionInit {
+    optional<string> iceUfrag;
+    optional<string> icePwd;
+};
+
 class RTC_CPP_EXPORT PeerConnection final : CheshireCat<impl::PeerConnection> {
 public:
 	enum class State : int {
@@ -90,7 +95,7 @@ class RTC_CPP_EXPORT PeerConnection final : CheshireCat<impl::PeerConnection> {
 	uint16_t maxDataChannelId() const;
 	bool getSelectedCandidatePair(Candidate *local, Candidate *remote);
 
-	void setLocalDescription(Description::Type type = Description::Type::Unspec);
+	void setLocalDescription(Description::Type type = Description::Type::Unspec, LocalDescriptionInit init = {});
 	void setRemoteDescription(Description description);
 	void addRemoteCandidate(Candidate candidate);
 	void gatherLocalCandidates(std::vector<IceServer> additionalIceServers = {});

diff --git a/src/impl/icetransport.cpp b/src/impl/icetransport.cpp
@@ -140,6 +140,12 @@ IceTransport::IceTransport(const Configuration &config, candidate_callback candi
 			addIceServer(server);
 }
 
+void IceTransport::setIceAttributes(string uFrag, string pwd) {
+	if (juice_set_local_ice_attributes(mAgent.get(), uFrag.c_str(), pwd.c_str()) < 0) {
+		throw std::invalid_argument("Invalid ICE attributes");
+	}
+}
+
 void IceTransport::addIceServer(IceServer server) {
 	if (server.hostname.empty())
 		return;
@@ -569,6 +575,10 @@ IceTransport::IceTransport(const Configuration &config, candidate_callback candi
 	                       RecvCallback, this);
 }
 
+void IceTransport::setIceAttributes(string, string) {
+	PLOG_WARNING << "Setting custom ICE attributes is not supported with libnice, please use libjuice";
+}
+
 void IceTransport::addIceServer(IceServer server) {
 	if (server.hostname.empty())
 		return;

diff --git a/src/impl/icetransport.hpp b/src/impl/icetransport.hpp
@@ -51,6 +51,7 @@ class IceTransport : public Transport {
 	void setRemoteDescription(const Description &description);
 	bool addRemoteCandidate(const Candidate &candidate);
 	void gatherLocalCandidates(string mid, std::vector<IceServer> additionalIceServers = {});
+	void setIceAttributes(string uFrag, string pwd);
 
 	optional<string> getLocalAddress() const;
 	optional<string> getRemoteAddress() const;

diff --git a/src/peerconnection.cpp b/src/peerconnection.cpp
@@ -76,7 +76,7 @@ bool PeerConnection::hasMedia() const {
 	return local && local->hasAudioOrVideo();
 }
 
-void PeerConnection::setLocalDescription(Description::Type type) {
+void PeerConnection::setLocalDescription(Description::Type type, LocalDescriptionInit init) {
 	std::unique_lock signalingLock(impl()->signalingMutex);
 	PLOG_VERBOSE << "Setting local description, type=" << Description::typeToString(type);
 
@@ -140,6 +140,11 @@ void PeerConnection::setLocalDescription(Description::Type type) {
 	if (!iceTransport)
 		return; // closed
 
+	if (init.iceUfrag && init.icePwd) {
+		PLOG_DEBUG << "Using custom ICE attributes, ufrag=\"" << init.iceUfrag.value() << "\", pwd=\"" << init.icePwd.value() << "\"";
+		iceTransport->setIceAttributes(init.iceUfrag.value(), init.icePwd.value());
+	}
+
 	Description local = iceTransport->getLocalDescription(type);
 	impl()->processLocalDescription(std::move(local));