Add ICE Setting and minor improvements

Author: QuasarStream Team

.github/FUNDING.yml

@@ -1 +1,4 @@
-github: [php-webrtc]
+github:
+  - php-webrtc
+  - quasarstream
+

CHANGELOG.md

@@ -8,4 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 ## [1.0.0] - 2025-05-13
 
 ### Added
-- First release
+- First release
+
+
+## [1.0.3] - 2025-10-08
+
+### Added
+- Add ICESetting class that represent low level ice setting

src/RTCICESetting.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Webrtc\ICE;
+
+use Webrtc\Exception\InvalidArgumentException;
+use Webrtc\ICE\Enum\IceRole;
+use Webrtc\ICE\Enum\TransportPolicyType;
+
+class RTCICESetting
+{
+    private ?array $icePortRange = null;
+    private TransportPolicyType $transportPolicy = TransportPolicyType::ALL;
+    private ?array $nat1to1 = null;
+    private bool $iceLite = false;
+    // it will be changed for only testing purpose
+    private IceRole $iceRole = IceRole::Controlling;
+
+    public function getIcePortRange(): ?array
+    {
+        return $this->icePortRange;
+    }
+
+    public function setIcePortRange(int $minPort, int $maxPort): void
+    {
+        if ($maxPort- $minPort < 100) {
+            throw new InvalidArgumentException("maxPort - minPort must be greater than 100");
+        }
+
+        if ($minPort < 1024 || $maxPort > 65535 || $minPort > $maxPort) {
+            throw new InvalidArgumentException("Invalid port range [$minPort, $maxPort]");
+        }
+
+        $this->icePortRange = [$minPort, $maxPort];
+    }
+
+    public function getTransportPolicy(): TransportPolicyType
+    {
+        return $this->transportPolicy;
+    }
+
+    public function setTransportPolicy(TransportPolicyType $transportPolicy): void
+    {
+        $this->transportPolicy = $transportPolicy;
+    }
+
+    public function getNat1to1(): ?array
+    {
+        return $this->nat1to1;
+    }
+
+    public function setNat1to1(?array $nat1to1): void
+    {
+        $this->nat1to1 = $nat1to1;
+    }
+
+    public function isIceLite(): bool
+    {
+        return $this->iceLite;
+    }
+
+    public function setIceLite(bool $iceLite): void
+    {
+        $this->iceLite = $iceLite;
+    }
+
+    public function getIceRole(): IceRole
+    {
+        return $this->iceRole;
+    }
+
+    public function setIceRole(IceRole $iceRole): void
+    {
+        $this->iceRole = $iceRole;
+    }
+
+}

src/RTCIceConnection.php

@@ -71,8 +71,6 @@ class RTCIceConnection extends EventEmitter implements RTCIceConnectionInterface
 {
     use NetworkAdapter, Mdns, DNS;
 
-    use NetworkAdapter, Mdns, DNS;
-
     /* Constants */
 
     /** @var int Maximum number of binding retry attempts */
@@ -179,15 +177,14 @@ class RTCIceConnection extends EventEmitter implements RTCIceConnectionInterface
     /** @var int Count of failed binding attempts */
     private int $tryFailedCount = 0;
 
+    /** @var ?array Range of ports that host candidates allow */
     private ?array $icePortRange = null;
 
     /**
-     * Constructor - Creates a new ICE connection
-     *
-     * @param RTCIceProtocolConfigurationInterface $configuration ICE protocol configuration
-     * @param IceRole $iceRole The role of this ICE agent
-     * @throws RandomException If random number generation fails
+     * @var ?array If set, this will result in all host candidates (which normally have a private IP address)
+     * to be rewritten with the public address provided in the settings
      */
+    private ?array $nat1to1 = null;
 
     /**
      * Constructor - Creates a new ICE connection
@@ -454,7 +451,7 @@ private function getCandidate(int $componentId): array
      */
     private function getHostCandidates(int $componentId): array
     {
-        $addresses = $this->getHostAddresses($this->useIPv4, $this->useIPv6);
+        $addresses = $this->nat1to1 ?? $this->getHostAddresses($this->useIPv4, $this->useIPv6);
         $candidates = [];
 
         foreach ($addresses as $address) {
@@ -2065,4 +2062,14 @@ public function setIcePortRange(?array $icePortRange): void
     {
         $this->icePortRange = $icePortRange;
     }
+
+    public function getNat1to1(): ?array
+    {
+        return $this->nat1to1;
+    }
+
+    public function setNat1to1(?array $nat1to1): void
+    {
+        $this->nat1to1 = $nat1to1;
+    }
 }

src/RTCIceGatherer.php

@@ -16,8 +16,6 @@
 use Random\RandomException;
 use Throwable;
 use Webrtc\ICE\Enum\IceGatheringState;
-use Webrtc\ICE\Enum\IceRole;
-use Webrtc\ICE\Enum\TransportPolicyType;
 
 /**
  * The RTCIceGatherer is responsible for gathering ICE candidates on the local machine.
@@ -40,29 +38,27 @@ class RTCIceGatherer extends EventEmitter implements RTCIceGathererInterface
      * Initializes ICE connection with the given ICE servers and role. Optionally accepts a logger.
      *
      * @param array $iceServes List of ICE server configurations.
-     * @param IceRole $role The ICE role (Controlling or Controlled).
+     * @param ?RTCICESetting $setting The ICE settings.
      * @param LoggerInterface|null $logger Optional logger for debugging.
      *
      * @throws RandomException
      */
-    public function __construct(
-        private readonly array $iceServes,
-        ?array $icePortRange = null,
-        ?TransportPolicyType $transportPolicy = null,
-        IceRole $role = IceRole::Controlling,
-        ?LoggerInterface $logger = null
-    )
+    public function __construct(private array $iceServes, ?RTCICESetting $setting = null, ?LoggerInterface $logger = null)
     {
         $protocolParser = new IceProtocolParser($iceServes);
-        $this->iceConnection = new RTCIceConnection($protocolParser->getIceConnectionConfiguration(), $role);
-        $this->iceConnection->setIcePortRange($icePortRange);
 
-        if ($logger) {
-            $this->iceConnection->setLogger($logger);
+        if (!$setting) {
+            $setting = new RTCICESetting();
         }
 
-        if ($transportPolicy) {
-            $this->iceConnection->setTransportPolicy($transportPolicy);
+        $this->iceConnection = new RTCIceConnection($protocolParser->getIceConnectionConfiguration(), $setting->getIceRole());
+        $this->iceConnection->setIcePortRange($setting->getIcePortRange());
+        $this->iceConnection->setTransportPolicy($setting->getTransportPolicy());
+        $this->iceConnection->setRemoteIsLite($setting->isIceLite());
+        $this->iceConnection->setNat1to1($setting->getNat1to1());
+
+        if ($logger) {
+            $this->iceConnection->setLogger($logger);
         }
     }
 

tests/RTCIceConnectionTest.php

@@ -410,7 +410,7 @@ public function testConnectToIceLiteNominationFails()
         $this->inviteAccept($connection1, $connection2);
 
         async(function () use ($connection1, $connection2) {
-            delay(1);
+            delay(5);
             $connection1->close();
             $connection2->close();
         })();

tests/RTCIceTransportTest.php

@@ -1,6 +1,5 @@
 <?php
 
-namespace Tests\Webrtc\ICE;
 
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\UsesClass;
@@ -20,6 +19,7 @@
 use Webrtc\ICE\RTCIceGatherer;
 use Webrtc\ICE\RTCIceParameters;
 use Webrtc\ICE\RTCIceProtocolConfiguration;
+use Webrtc\ICE\RTCICESetting;
 use Webrtc\ICE\RTCIceTransport;
 use Webrtc\ICE\Trait\Mdns;
 use Webrtc\ICE\Trait\NetworkAdapter;
@@ -107,10 +107,14 @@ public function testConstruct()
 
     public function testConnect()
     {
-        $gatherer1 = new RTCIceGatherer([], role: IceRole::Controlling);
+        $iceSetting1 = new RTCICESetting;
+        $iceSetting1->setIceRole(IceRole::Controlling);
+        $gatherer1 = new RTCIceGatherer([], $iceSetting1);
         $transport1 = new RTCIceTransport($gatherer1);
 
-        $gatherer2 = new RTCIceGatherer([], role: IceRole::Controlled);
+        $iceSetting2 = new RTCICESetting;
+        $iceSetting2->setIceRole(IceRole::Controlled);
+        $gatherer2 = new RTCIceGatherer([], $iceSetting2);
         $transport2 = new RTCIceTransport($gatherer2);
 
         $gatherer1->gather();
@@ -140,10 +144,14 @@ public function testConnect()
 
     public function testConnectFail()
     {
-        $gatherer1 = new RTCIceGatherer([], role: IceRole::Controlling);
+        $iceSetting1 = new RTCICESetting;
+        $iceSetting1->setIceRole(IceRole::Controlling);
+        $gatherer1 = new RTCIceGatherer([], $iceSetting1);
         $transport1 = new RTCIceTransport($gatherer1);
 
-        $gatherer2 = new RTCIceGatherer([], role: IceRole::Controlled);
+        $iceSetting2 = new RTCICESetting;
+        $iceSetting2->setIceRole(IceRole::Controlled);
+        $gatherer2 = new RTCIceGatherer([], $iceSetting2);
         $transport2 = new RTCIceTransport($gatherer2);
 
         $gatherer1->gather();
@@ -173,10 +181,14 @@ public function testConnectFail()
 
     public function testConnectThenConsentExpires()
     {
-        $gatherer1 = new RTCIceGatherer([], role: IceRole::Controlling);
+        $iceSetting1 = new RTCICESetting;
+        $iceSetting1->setIceRole(IceRole::Controlling);
+        $gatherer1 = new RTCIceGatherer([], $iceSetting1);
         $transport1 = new RTCIceTransport($gatherer1);
 
-        $gatherer2 = new RTCIceGatherer([], role: IceRole::Controlled);
+        $iceSetting2 = new RTCICESetting;
+        $iceSetting2->setIceRole(IceRole::Controlled);
+        $gatherer2 = new RTCIceGatherer([], $iceSetting2);
         $transport2 = new RTCIceTransport($gatherer2);
 
         $gatherer1->gather();