add ice port range in configuration for host candidates

Author: QuasarStream Team

README.md

@@ -64,7 +64,7 @@ guide for detailed instructions on how to get involved. Together, we can make a
 ### Our Plans for the Future
 We are not stopping here. We're actively continuing development on the PHP WebRTC packages.
 
-Right now, we're working privately on a **[Selective Forwarding Unit (SFU)](https://getstream.io/resources/projects/webrtc/architectures/sfu/)** implementation and a **Laravel package that bundles everything together**, including this WebRTC package. Once that's ready, our goal is to build a **minimal video conferencing web** app using Laravel, and to continue maintaining this repository along with 24 other related packages.
+Right now, we're working privately on a **[Selective Forwarding Unit (SFU)](https://quasarstream.com/blog/sfu/)** implementation and a **Laravel package that bundles everything together**, including this WebRTC package. Once that's ready, our goal is to build a **minimal video conferencing web** app using Laravel, and to continue maintaining this repository along with 24 other related packages.
 
 If you're interested in building real-time communication tools in PHP, like a video conferencing app, you are more than welcome to join the project. Fork the repos, contribute to them, and help grow this community.
 
@@ -79,16 +79,6 @@ If that sounds like you, this could be a great place to get involved.
 
 Feel free to reach out by email(via github@aminyazdanpanah.com) with your GitHub username (for example: github.com/your-username) and we’ll get back to you soon.
 
-### About Git History
-We've been working on this repository and many other PHP WebRTC-related ones
-(**such as ICE, RTP, RTCP, and more than 22 others**)
-for a long time privately(in our git server) before making them open source(**We released our packages only after they have been fully tested and thoroughly debugged**).
-Originally, there was a long commit history that reflected all our work.
-
-However, we decided to **remove that history** in the initial public commit to **protect our privacy**. The original commits included details like our **working hours based on commit times and counts**, as well as our **personal email addresses**, which we did not feel comfortable sharing publicly.
-
-**Removing the history helps us keep that information private and stay a bit safer from potential security risks.**
-
 
 ## License
 

src/RTCConfiguration.php

@@ -12,6 +12,7 @@
 namespace Webrtc\Webrtc;
 
 use Webrtc\Exception\InvalidArgumentException;
+use Webrtc\ICE\Enum\TransportPolicyType;
 use Webrtc\ICE\RTCIceServer;
 use Webrtc\ICE\RTCIceServerInterface;
 
@@ -52,21 +53,23 @@ class RTCConfiguration implements RTCConfigurationInterface
      */
     private ?string $privateKeyPath = null;
 
+    private ?array $icePortRange = null;
+    private ?TransportPolicyType $transportPolicy = null;
+
     /**
      * Constructs a new RTCConfiguration instance
      *
-     * @param array<RTCIceServerInterface> $iceServers
-     * @param string|null $certificatePath
-     * @param string|null $privateKeyPath
+     * @param array|null $configuration Optional configuration array. If null,
+     *        default configuration with a Google STUN server will be used.
+     *        Expected keys:
+     *        - 'iceServers': Array of ICE server configurations
+     *        - 'certificatePath': Path to a certificate file (optional)
+     *        - 'privateKeyPath': Path to a private key file (optional)
+     * @throws InvalidArgumentException If iceServer configuration is invalid
      */
-    public function __construct(
-        array $iceServers = [],
-        ?string $certificatePath = null,
-        ?string $privateKeyPath = null
-    ) {
-        $this->iceServers = empty($iceServers) ? $this->getDefaultIceServer() : $iceServers;
-        $this->certificatePath = $certificatePath;
-        $this->privateKeyPath = $privateKeyPath;
+    public function __construct(?array $configuration = null)
+    {
+        $configuration !== null ? $this->parseConfiguration($configuration) : $this->getDefaultConfiguration();
     }
 
     /**
@@ -150,11 +153,11 @@ public function setPrivateKeyPath(?string $privateKeyPath): void
      *        - 'iceServers': Array of ICE server configurations (required if present)
      *        - 'certificatePath': Path to a certificate file (optional)
      *        - 'privateKeyPath': Path to a private key file (optional)
-     * @return RTCConfiguration
+     * @return void
+     * @throws InvalidArgumentException If iceServer configuration is missing required 'urls' key
      */
-    public static function parseConfiguration(array $configuration): self
+    private function parseConfiguration(array $configuration): void
     {
-        $iceServers = [];
         if (isset($configuration['iceServers'])) {
             foreach ($configuration["iceServers"] as $iceServer) {
                 if (!isset($iceServer["urls"])) {
@@ -167,28 +170,46 @@ public static function parseConfiguration(array $configuration): self
                 $iceServerObj->setCredential($iceServer["credential"] ?? null);
                 $iceServerObj->setCredentialType($iceServer["credentialType"] ?? null);
 
-                $iceServers[] = $iceServerObj;
+                $this->addIceServer($iceServerObj);
             }
-        }else{
-            $iceServers = (new RTCConfiguration)->getDefaultIceServer();
         }
 
-        $certificatePath = $configuration["certificatePath"] ?? null;
-        $privateKeyPath = $configuration["privateKeyPath"] ?? null;
-
-        return new static($iceServers, $certificatePath, $privateKeyPath);
+        $this->certificatePath = $configuration["certificatePath"] ?? null;
+        $this->privateKeyPath = $configuration["privateKeyPath"] ?? null;
     }
 
     /**
-     * return the default ice configuration with Google's public STUN server
+     * Sets up default configuration with Google's public STUN server
      *
-     * @return array<RTCIceServer>
+     * @return void
      */
-    private function getDefaultIceServer(): array
+    private function getDefaultConfiguration(): void
     {
         $iceServer  = new RTCIceServer();
         $iceServer->setUrls([self::DEFAULT_STUN_SERVER]);
+        $this->addIceServer($iceServer);
+    }
 
-        return [$iceServer];
+    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");
+        }
+        $this->icePortRange = [$minPort, $maxPort];
+    }
+
+    public function getTransportPolicy(): ?TransportPolicyType
+    {
+        return $this->transportPolicy;
+    }
+
+    public function setTransportPolicy(?TransportPolicyType $transportPolicy): void
+    {
+        $this->transportPolicy = $transportPolicy;
     }
 }

src/RTCPeerConnection.php

@@ -245,14 +245,13 @@ class RTCPeerConnection extends EventEmitter implements RTCPeerConnectionInterfa
     /**
      * Creates a new RTCPeerConnection instance.
      *
-     * @param array|RTCConfigurationInterface $configuration Configuration options for the connection
-     * @throws DateInvalidOperationException If there's an SSL-related error
-     * @throws OpenSSLException If there's an SSL-related error
+     * @param array|RTCConfiguration|null $configuration Configuration options for the connection
      * @throws RTCCertificateException If certificate generation fails
+     * @throws OpenSSLException|DateInvalidOperationException If there's an SSL-related error
      */
-    public function __construct(array|RTCConfigurationInterface $configuration = [])
+    public function __construct(null|array|RTCConfigurationInterface $configuration = null)
     {
-        $this->configuration = $configuration instanceof RTCConfigurationInterface ? $configuration : RTCConfiguration::parseConfiguration($configuration);
+        $this->configuration = $configuration instanceof RTCConfigurationInterface ? $configuration : new RTCConfiguration($configuration);
         $this->certificates[] = new RTCCertificate($this->configuration->getPrivateKeyPath(), $this->configuration->getCertificatePath());
         $this->cname = Uuid::uuid4()->toString();
         $this->streamId = Uuid::uuid4()->toString();
@@ -735,7 +734,7 @@ private function createSctpTransport(): void
     private function createDtlsTransport(): RTCDtlsTransport
     {
         // create ICE transport
-        $iceGatherer = new RTCIceGatherer($this->configuration->getIceServers());
+        $iceGatherer = new RTCIceGatherer($this->configuration->getIceServers(), $this->configuration->getIcePortRange(), $this->configuration->getTransportPolicy(), logger: $this->logger);
         $iceGatherer->on("statechange", fn() => $this->updateIceGatheringState());
         $iceTransport = new RTCIceTransport($iceGatherer, $this->logger);
         $iceTransport->on("statechange", fn() => $this->updateIceConnectionState());
@@ -977,14 +976,14 @@ public function setLocalDescription(RTCSessionDescription $rtcSessionDescription
                 }
             }
 
-            async(fn() => $this->connect())();
-
             if ($sessionDescription->isType("answer")) {
                 $this->currentLocalDescription = $sessionDescription;
                 $this->pendingLocalDescription = null;
             } else {
                 $this->pendingLocalDescription = $sessionDescription;
             }
+
+            async(fn() => $this->connect())();
         })();
     }
 
@@ -1246,7 +1245,6 @@ private function removeBundleTransport(GroupDescription $bundleGroupDescription,
             }
         }
 
-
         if ($this->sctp and $this->sctp->getMid() == $masterMid) {
             $masterTransport = $this->sctp->getDtlsTransport();
         }