Add a colibri flag to use private addresses for ICE for jigasi/jibri. (…

…#1112) * Add a colibri flag to use private addresses for ICE for jigasi/jibri. * Make private addresses for jigasi/jibri configurable.
jitsi · Sep 13, 2023 · 4aceabd · 4aceabd
1 parent 42dd079
commit 4aceabd
Show file tree

Hide file tree

Showing 10 changed files with 32 additions and 2 deletions.
diff --git a/jicofo-selector/src/main/kotlin/org/jitsi/jicofo/bridge/colibri/ColibriSessionManager.kt b/jicofo-selector/src/main/kotlin/org/jitsi/jicofo/bridge/colibri/ColibriSessionManager.kt
@@ -96,5 +96,6 @@ data class ParticipantAllocationParameters(
     val forceMuteVideo: Boolean,
     val useSctp: Boolean,
     val visitor: Boolean,
+    val supportsPrivateAddresses: Boolean,
     val medias: Set<Media>
 )
diff --git a/jicofo-selector/src/main/kotlin/org/jitsi/jicofo/bridge/colibri/Extensions.kt b/jicofo-selector/src/main/kotlin/org/jitsi/jicofo/bridge/colibri/Extensions.kt
@@ -107,6 +107,9 @@ internal fun ParticipantInfo.toEndpoint(
         if (supportsSourceNames) {
             addCapability(Capability.CAP_SOURCE_NAME_SUPPORT)
         }
+        if (supportsPrivateAddresses) {
+            addCapability(Capability.CAP_PRIVATE_ADDRESS_CONNECTIVITY)
+        }
         if (useSsrcRewriting) {
             addCapability(Capability.CAP_SSRC_REWRITING_SUPPORT)
         }

diff --git a/jicofo-selector/src/main/kotlin/org/jitsi/jicofo/bridge/colibri/ParticipantInfo.kt b/jicofo-selector/src/main/kotlin/org/jitsi/jicofo/bridge/colibri/ParticipantInfo.kt
@@ -31,6 +31,7 @@ class ParticipantInfo(
     val useSctp = parameters.useSctp
     val medias = parameters.medias
     val supportsSourceNames = parameters.supportsSourceNames
+    val supportsPrivateAddresses = parameters.supportsPrivateAddresses
     val useSsrcRewriting = parameters.useSsrcRewriting
     val visitor = parameters.visitor
 
@@ -46,6 +47,7 @@ class ParticipantInfo(
         put("audio_muted", audioMuted)
         put("video_muted", videoMuted)
         put("source_names", supportsSourceNames)
+        put("private_addresses", supportsPrivateAddresses)
         put("ssrc_rewriting", useSsrcRewriting)
         put("visitor", visitor)
     }

diff --git a/jicofo-selector/src/main/resources/reference.conf b/jicofo-selector/src/main/resources/reference.conf
@@ -290,6 +290,9 @@ jicofo {
     // Note that if no separate Service connection has been configured, all services will automatically use the
     // Client connection.
     xmpp-connection-name = Client
+
+    // Enable use of private addresses for ICE for jibri
+    use-private-address-connectivity = true
   }
 
   jibri-sip {
@@ -306,6 +309,9 @@ jicofo {
     // Note that if no separate Service connection has been configured, all services will automatically use the
     // Client connection.
     xmpp-connection-name = Client
+
+    // Enable use of private addresses for ICE for jigasi
+    use-private-address-connectivity = true
   }
 
   // The region in which the machine is running.

diff --git a/jicofo/src/main/java/org/jitsi/jicofo/conference/ParticipantInviteRunnable.java b/jicofo/src/main/java/org/jitsi/jicofo/conference/ParticipantInviteRunnable.java
@@ -22,6 +22,8 @@
 import org.jitsi.jicofo.bridge.colibri.*;
 import org.jitsi.jicofo.codec.*;
 import org.jitsi.jicofo.conference.source.*;
+import org.jitsi.jicofo.jibri.*;
+import org.jitsi.jicofo.jigasi.*;
 import org.jitsi.jicofo.util.*;
 import org.jitsi.jicofo.xmpp.jingle.*;
 import org.jitsi.jicofo.xmpp.muc.*;
@@ -188,6 +190,12 @@ private void doRun()
                     logger.warn("Failed to convert ContentPacketExtension to Media: " + content.toXML());
                 }
             });
+            // This makes the bridge signal its private host candidates. We enable them for backend components, because
+            // they may be in the same network as the bridge, and disable them for endpoints to avoid checking
+            // unnecessary pairs (unless the endpoints explicitly signal the feature).
+            boolean privateAddresses =
+                (participant.getChatMember().isJigasi() && JigasiConfig.config.getPrivateAddressConnectivity()) ||
+                    (participant.getChatMember().isJibri() && JibriConfig.config.getPrivateAddressConnectivity());
             ParticipantAllocationParameters participantOptions = new ParticipantAllocationParameters(
                     participant.getEndpointId(),
                     participant.getStatId(),
@@ -199,6 +207,7 @@ private void doRun()
                     forceMuteVideo,
                     offer.getContents().stream().anyMatch(c -> c.getName() == "data"),
                     (participant.getChatMember().getRole() == MemberRole.VISITOR),
+                    privateAddresses,
                     medias);
             colibriAllocation = colibriSessionManager.allocate(participantOptions);
         }

diff --git a/jicofo/src/main/kotlin/org/jitsi/jicofo/conference/Participant.kt b/jicofo/src/main/kotlin/org/jitsi/jicofo/conference/Participant.kt
@@ -68,7 +68,7 @@ open class Participant @JvmOverloads constructor(
     private val jingleIqRequestHandler: JingleIqRequestHandler,
     parentLogger: Logger? = null,
     /** The list of XMPP features supported by this participant. */
-    private val supportedFeatures: Set<Features> = Features.defaultFeatures,
+    val supportedFeatures: Set<Features> = Features.defaultFeatures,
     /** The [Clock] used by this participant. */
     clock: Clock = Clock.systemUTC()
 ) {

diff --git a/jicofo/src/main/kotlin/org/jitsi/jicofo/jibri/JibriConfig.kt b/jicofo/src/main/kotlin/org/jitsi/jicofo/jibri/JibriConfig.kt
@@ -59,6 +59,10 @@ class JibriConfig private constructor() {
         "jicofo.jibri.xmpp-connection-name".from(newConfig)
     }
 
+    val privateAddressConnectivity: Boolean by config {
+        "jicofo.jibri.use-private-address-connectivity".from(newConfig)
+    }
+
     companion object {
         @JvmField
         val config = JibriConfig()

diff --git a/jicofo/src/main/kotlin/org/jitsi/jicofo/jigasi/JigasiConfig.kt b/jicofo/src/main/kotlin/org/jitsi/jicofo/jigasi/JigasiConfig.kt
@@ -39,6 +39,10 @@ class JigasiConfig private constructor() {
         "jicofo.jigasi.xmpp-connection-name".from(newConfig)
     }
 
+    val privateAddressConnectivity: Boolean by config {
+        "jicofo.jigasi.use-private-address-connectivity".from(newConfig)
+    }
+
     fun xmppConnectionName() = xmppConnectionName
 
     companion object {

diff --git a/jicofo/src/test/kotlin/org/jitsi/jicofo/conference/ParticipantInviteRunnableTest.kt b/jicofo/src/test/kotlin/org/jitsi/jicofo/conference/ParticipantInviteRunnableTest.kt
@@ -112,6 +112,7 @@ class ParticipantInviteRunnableTest : ShouldSpec({
                     every { statsId } returns "statsId"
                     every { region } returns "region"
                     every { isJibri } returns false
+                    every { isJigasi } returns false
                     every { isTranscriber } returns false
                 },
                 conference,

diff --git a/pom.xml b/pom.xml
@@ -177,7 +177,7 @@
       <dependency>
         <groupId>${project.groupId}</groupId>
         <artifactId>jitsi-xmpp-extensions</artifactId>
-        <version>1.0-72-gc9dde6c</version>
+        <version>1.0-74-gc88e006</version>
       </dependency>
       <dependency>
         <groupId>org.slf4j</groupId>