Capture SCTP traffic in pcaps

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/RtpReceiver.kt

@@ -20,6 +20,7 @@ import org.jitsi.nlj.srtp.SrtpTransformers
 import org.jitsi.nlj.stats.EndpointConnectionStats
 import org.jitsi.nlj.stats.RtpReceiverStats
 import org.jitsi.nlj.transform.NodeStatsProducer
+import org.jitsi.nlj.transform.node.Node
 import org.jitsi.nlj.util.Bandwidth
 
 abstract class RtpReceiver :
@@ -63,6 +64,8 @@ abstract class RtpReceiver :
     abstract fun forceMuteAudio(shouldMute: Boolean)
 
     abstract fun forceMuteVideo(shouldMute: Boolean)
+
+    abstract fun getPcapNode(): Node
 }
 
 interface RtpReceiverEventHandler {

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/RtpReceiverImpl.kt

@@ -139,7 +139,7 @@ class RtpReceiverImpl @JvmOverloads constructor(
             }
         })
     }
-    private val toggleablePcapWriter = ToggleablePcapWriter(logger, "$id-rx")
+    private val toggleablePcapWriter = ToggleablePcapWriter(logger, "$id-rx", outgoing = false)
     private val videoBitrateCalculator = VideoBitrateCalculator(parentLogger)
     private val audioBitrateCalculator = BitrateCalculator("Audio bitrate calculator")
 
@@ -151,6 +151,8 @@ class RtpReceiverImpl @JvmOverloads constructor(
         tccGenerator.addLossListener(lossListener)
     }
 
+    override fun getPcapNode() = toggleablePcapWriter.newObserverNode()
+
     companion object {
         val queueErrorCounter = CountingErrorHandler()
 

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/RtpSender.kt

@@ -22,6 +22,7 @@ import org.jitsi.nlj.srtp.SrtpTransformers
 import org.jitsi.nlj.stats.EndpointConnectionStats
 import org.jitsi.nlj.stats.PacketStreamStats
 import org.jitsi.nlj.transform.NodeStatsProducer
+import org.jitsi.nlj.transform.node.Node
 import org.jitsi.nlj.transform.node.outgoing.OutgoingStatisticsSnapshot
 
 /**
@@ -46,6 +47,7 @@ abstract class RtpSender :
     abstract fun addLossListener(lossListener: LossListener)
     abstract fun setFeature(feature: Features, enabled: Boolean)
     abstract fun isFeatureEnabled(feature: Features): Boolean
+    abstract fun getPcapNode(): Node
     abstract fun tearDown()
 
     abstract val bandwidthEstimator: BandwidthEstimator

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/RtpSenderImpl.kt

@@ -107,7 +107,7 @@ class RtpSenderImpl(
 
     private val srtpEncryptWrapper = SrtpEncryptNode()
     private val srtcpEncryptWrapper = SrtcpEncryptNode()
-    private val toggleablePcapWriter = ToggleablePcapWriter(logger, "$id-tx")
+    private val toggleablePcapWriter = ToggleablePcapWriter(logger, "$id-tx", outgoing = true)
     private val outgoingPacketCache = PacketCacher()
     private val absSendTime = AbsSendTime(streamInformationStore)
     private val statsTracker = OutgoingStatisticsTracker()
@@ -312,6 +312,8 @@ class RtpSenderImpl(
         addJson("Bandwidth Estimation", bandwidthEstimator.getStats().toJson())
     }
 
+    override fun getPcapNode(): Node = toggleablePcapWriter.newObserverNode()
+
     override fun stop() {
         running = false
     }

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/Transceiver.kt

@@ -320,6 +320,10 @@ class Transceiver(
         rtpReceiver.forceMuteVideo(shouldMute)
     }
 
+    fun getReceiverPcapNode() = rtpReceiver.getPcapNode()
+
+    fun getSenderPcapNode() = rtpSender.getPcapNode()
+
     /**
      * Get stats about this transceiver's pipeline nodes
      */

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/rtp/codec/vp8/Vp8Packet.kt

@@ -79,7 +79,7 @@ class Vp8Packet private constructor(
 
     val hasTL0PICIDX = DePacketizer.VP8PayloadDescriptor.hasTL0PICIDX(buffer, payloadOffset, payloadLength)
 
-    @field:Suppress("ktlint:standard:property-naming")
+    @field:Suppress("ktlint:standard:property-naming", "ktlint:standard:backing-property-naming")
     private var _TL0PICIDX = TL0PICIDX
         ?: DePacketizer.VP8PayloadDescriptor.getTL0PICIDX(buffer, payloadOffset, payloadLength)
 

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/rtp/codec/vp9/Vp9Packet.kt

@@ -99,7 +99,7 @@ class Vp9Packet private constructor(
     val isInterPicturePredicted =
         DePacketizer.VP9PayloadDescriptor.isInterPicturePredicted(buffer, payloadOffset, payloadLength)
 
-    @field:Suppress("ktlint:standard:property-naming")
+    @field:Suppress("ktlint:standard:property-naming", "ktlint:standard:backing-property-naming")
     private var _TL0PICIDX =
         TL0PICIDX ?: DePacketizer.VP9PayloadDescriptor.getTL0PICIDX(buffer, payloadOffset, payloadLength)
 

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/transform/node/PcapWriter.kt

@@ -41,9 +41,11 @@ import kotlin.io.path.Path
 
 class PcapWriter(
     parentLogger: Logger,
-    filePath: Path = Path(directory, "${Random().nextLong()}.pcap")
+    filePath: Path = Path(directory, "${Random().nextLong()}.pcap"),
+    private val outgoing: Boolean
 ) : ObserverNode("PCAP writer") {
-    constructor(parentLogger: Logger, filePath: String) : this(parentLogger, Path(filePath))
+    constructor(parentLogger: Logger, filePath: String, outgoing: Boolean) :
+        this(parentLogger, Path(filePath), outgoing)
 
     private val logger = createChildLogger(parentLogger)
     private val lazyHandle = lazy {
@@ -60,6 +62,10 @@ class PcapWriter(
 
     companion object {
         private val localhost = Inet4Address.getByName("127.0.0.1") as Inet4Address
+        private val remotehost = Inet4Address.getByName("192.0.2.0") as Inet4Address
+
+        private val localport = UdpPort(123, "blah")
+        private val remoteport = UdpPort(123, "blah")
         val directory: String by config("jmt.debug.pcap.directory".from(JitsiConfig.newConfig))
     }
 
@@ -70,18 +76,33 @@ class PcapWriter(
         val subBuf = ByteArray(packetInfo.packet.length)
         System.arraycopy(packetInfo.packet.buffer, packetInfo.packet.offset, subBuf, 0, packetInfo.packet.length)
         udpPayload.rawData(subBuf)
+        val srchost: Inet4Address
+        val dsthost: Inet4Address
+        val srcport: UdpPort
+        val dstport: UdpPort
+        if (outgoing) {
+            srchost = localhost
+            srcport = localport
+            dsthost = remotehost
+            dstport = remoteport
+        } else {
+            srchost = remotehost
+            srcport = remoteport
+            dsthost = remotehost
+            dstport = remoteport
+        }
         val udp = UdpPacket.Builder()
-            .srcPort(UdpPort(123, "blah"))
-            .dstPort(UdpPort(456, "blah"))
-            .srcAddr(localhost)
-            .dstAddr(localhost)
+            .srcPort(srcport)
+            .dstPort(dstport)
+            .srcAddr(srchost)
+            .dstAddr(dsthost)
             .correctChecksumAtBuild(true)
             .correctLengthAtBuild(true)
             .payloadBuilder(udpPayload)
 
         val ipPacket = IpV4Packet.Builder()
-            .srcAddr(localhost)
-            .dstAddr(localhost)
+            .srcAddr(srchost)
+            .dstAddr(dsthost)
             .protocol(IpNumber.UDP)
             .version(IpVersion.IPV4)
             .tos(IpV4Rfc1349Tos.newInstance(0))

jitsi-media-transform/src/main/kotlin/org/jitsi/nlj/transform/node/ToggleablePcapWriter.kt

@@ -25,7 +25,8 @@ import kotlin.io.path.Path
 
 class ToggleablePcapWriter(
     private val parentLogger: Logger,
-    private val prefix: String
+    private val prefix: String,
+    private val outgoing: Boolean
 ) {
     private var pcapWriter: PcapWriter? = null
     private val pcapLock = Any()
@@ -37,7 +38,11 @@ class ToggleablePcapWriter(
 
         synchronized(pcapLock) {
             if (pcapWriter == null) {
-                pcapWriter = PcapWriter(parentLogger, Path(PcapWriter.directory, "$prefix-${Date().toInstant()}.pcap"))
+                pcapWriter = PcapWriter(
+                    parentLogger,
+                    Path(PcapWriter.directory, "$prefix-${Date().toInstant()}.pcap"),
+                    outgoing
+                )
             }
         }
     }

jitsi-media-transform/src/test/kotlin/org/jitsi/nlj/dtls/DtlsTest.kt

@@ -45,7 +45,8 @@ class DtlsTest : ShouldSpec() {
     init {
         val dtlsServer = DtlsStack(logger).apply { actAsServer() }
         val dtlsClient = DtlsStack(logger).apply { actAsClient() }
-        val pcapWriter = if (pcapEnabled) PcapWriter(logger, "/tmp/dtls-test.pcap") else null
+        // TODO: should mark the two directions of DTLS traffic separately in the PCAP
+        val pcapWriter = if (pcapEnabled) PcapWriter(logger, "/tmp/dtls-test.pcap", true) else null
 
         dtlsClient.remoteFingerprints = mapOf(
             dtlsServer.localFingerprintHashFunction to dtlsServer.localFingerprint

jitsi-media-transform/src/test/kotlin/org/jitsi/nlj/stats/EndpointConnectionStatsTest.kt

@@ -61,7 +61,7 @@ class EndpointConnectionStatsTest : ShouldSpec() {
                     stats.rtcpPacketReceived(rrPacket, clock.instant())
                     context("the rtt") {
                         should("be updated correctly") {
-                            mostRecentPublishedRtt shouldBe(10.0 plusOrMinus .1)
+                            mostRecentPublishedRtt shouldBe (10.0 plusOrMinus .1)
                         }
                     }
                 }
@@ -78,7 +78,7 @@ class EndpointConnectionStatsTest : ShouldSpec() {
                         stats.rtcpPacketReceived(rrPacket, clock.instant())
                         context("the rtt") {
                             should("be updated correctly") {
-                                mostRecentPublishedRtt shouldBe(10.0.plusOrMinus(.1))
+                                mostRecentPublishedRtt shouldBe (10.0.plusOrMinus(.1))
                             }
                         }
                     }
@@ -124,7 +124,7 @@ class EndpointConnectionStatsTest : ShouldSpec() {
 
             context("the rtt") {
                 should("be updated correctly") {
-                    mostRecentPublishedRtt shouldBe(10.0.plusOrMinus(.1))
+                    mostRecentPublishedRtt shouldBe (10.0.plusOrMinus(.1))
                 }
             }
         }

jvb/src/main/kotlin/org/jitsi/videobridge/Endpoint.kt

@@ -33,6 +33,7 @@ import org.jitsi.nlj.rtp.VideoRtpPacket
 import org.jitsi.nlj.srtp.TlsRole
 import org.jitsi.nlj.stats.EndpointConnectionStats
 import org.jitsi.nlj.transform.node.ConsumerNode
+import org.jitsi.nlj.transform.pipeline
 import org.jitsi.nlj.util.Bandwidth
 import org.jitsi.nlj.util.LocalSsrcAssociation
 import org.jitsi.nlj.util.NEVER
@@ -287,6 +288,14 @@ class Endpoint @JvmOverloads constructor(
         recurringRunnableExecutor.registerRecurringRunnable(it)
     }
 
+    private val receivePcap = transceiver.getReceiverPcapNode()
+    private val sendPcap = transceiver.getSenderPcapNode()
+
+    private val sctpPipeline = pipeline {
+        node(receivePcap)
+        node(sctpHandler)
+    }
+
     /**
      * Manages remapping of video SSRCs when enabled.
      */
@@ -522,7 +531,7 @@ class Endpoint @JvmOverloads constructor(
      */
     // TODO(brian): change sctp handler to take buf, off, len
     fun dtlsAppPacketReceived(data: ByteArray, off: Int, len: Int) =
-        sctpHandler.processPacket(PacketInfo(UnparsedPacket(data, off, len)))
+        sctpPipeline.processPacket(PacketInfo(UnparsedPacket(data, off, len)))
 
     private fun effectiveVideoConstraintsChanged(
         oldEffectiveConstraints: EffectiveConstraintsMap,
@@ -577,6 +586,7 @@ class Endpoint @JvmOverloads constructor(
         // Create the SctpManager and provide it a method for sending SCTP data
         sctpManager = SctpManager(
             { data, offset, length ->
+                sendPcap.processPacket(PacketInfo(UnparsedPacket(data, offset, length)))
                 dtlsTransport.sendDtlsData(data, offset, length)
                 0
             },

pom.xml

@@ -30,7 +30,7 @@
         <jitsi.utils.version>1.0-127-g6c65524</jitsi.utils.version>
         <jicoco.version>1.1-140-g8f45a9f</jicoco.version>
         <mockk.version>1.13.8</mockk.version>
-        <ktlint-maven-plugin.version>3.0.0</ktlint-maven-plugin.version>
+        <ktlint-maven-plugin.version>3.2.0</ktlint-maven-plugin.version>
         <maven-shade-plugin.version>3.5.1</maven-shade-plugin.version>
         <spotbugs.version>4.6.0</spotbugs.version>
         <jersey.version>3.0.10</jersey.version>

rtp/src/main/kotlin/org/jitsi/rtp/rtp/RtpPacket.kt

@@ -173,6 +173,7 @@ open class RtpPacket(
     private val headerExtensionParser
         get() = HeaderExtensionHelpers.getHeaderExtensionParser(extensionsProfileType)
 
+    @field:Suppress("ktlint:standard:backing-property-naming")
     private val _encodedHeaderExtensions: EncodedHeaderExtensions = EncodedHeaderExtensions()
     private val encodedHeaderExtensions: EncodedHeaderExtensions
         get() {

rtp/src/test/kotlin/org/jitsi/rtp/rtp/RtpHeaderTest.kt

@@ -184,13 +184,13 @@ class RtpHeaderTest : ShouldSpec() {
         context("csrcs") {
             context("get") {
                 should("work correctly") {
-                    RtpHeader.getCsrcs(headerData, 0) shouldContainInOrder(listOf<Long>(123456, 45678))
+                    RtpHeader.getCsrcs(headerData, 0) shouldContainInOrder (listOf<Long>(123456, 45678))
                 }
             }
             context("set") {
                 should("work correctly") {
                     RtpHeader.setCsrcs(headerData, 0, listOf<Long>(2468, 1357))
-                    RtpHeader.getCsrcs(headerData, 0) shouldContainInOrder(listOf<Long>(2468, 1357))
+                    RtpHeader.getCsrcs(headerData, 0) shouldContainInOrder (listOf<Long>(2468, 1357))
                 }
             }
         }