Support all BigBlueButton hashing algorithms.

Author: GhaziTriki

src/BigBlueButton.php

@@ -21,6 +21,7 @@
 namespace BigBlueButton;
 
 use BigBlueButton\Core\ApiMethod;
+use BigBlueButton\Enum\HashingAlgorithm;
 use BigBlueButton\Exceptions\BadResponseException;
 use BigBlueButton\Parameters\CreateMeetingParameters;
 use BigBlueButton\Parameters\DeleteRecordingsParameters;
@@ -64,6 +65,9 @@ class BigBlueButton
     protected $bbbServerBaseUrl;
     protected $urlBuilder;
     protected $jSessionId;
+
+    protected $hashingAlgorithm;
+
     protected $curlopts = [];
     protected $timeOut  = 10;
 
@@ -80,10 +84,17 @@ public function __construct($baseUrl = null, $secret = null, $opts = null)
         // BBB_SECRET is the new variable name and have higher priority against the old named BBB_SECURITY_SALT
         $this->securitySecret   = $secret ?: getenv('BBB_SECRET') ?: getenv('BBB_SECURITY_SALT');
         $this->bbbServerBaseUrl = $baseUrl ?: getenv('BBB_SERVER_BASE_URL');
-        $this->urlBuilder       = new UrlBuilder($this->securitySecret, $this->bbbServerBaseUrl);
+        $this->hashingAlgorithm = HashingAlgorithm::SHA_256;
+        $this->urlBuilder       = new UrlBuilder($this->securitySecret, $this->bbbServerBaseUrl, $this->hashingAlgorithm);
         $this->curlopts         = $opts['curl'] ?? [];
     }
 
+    public function setHashingAlgorithm(string $hashingAlgorithm): void
+    {
+        $this->hashingAlgorithm = $hashingAlgorithm;
+        $this->urlBuilder->setHashingAlgorithm($hashingAlgorithm);
+    }
+
     /**
      * @return ApiVersionResponse
      *

src/Enum/HashingAlgorithm.php

@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * BigBlueButton open source conferencing system - https://www.bigbluebutton.org/.
+ *
+ * Copyright (c) 2016-2023 BigBlueButton Inc. and by respective authors (see below).
+ *
+ * This program is free software; you can redistribute it and/or modify it under the
+ * terms of the GNU Lesser General Public License as published by the Free Software
+ * Foundation; either version 3.0 of the License, or (at your option) any later
+ * version.
+ *
+ * BigBlueButton is distributed in the hope that it will be useful, but WITHOUT ANY
+ * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
+ * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along
+ * with BigBlueButton; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace BigBlueButton\Enum;
+
+use MabeEnum\Enum;
+
+class HashingAlgorithm extends Enum
+{
+    public const SHA_1   = 'sha1';
+    public const SHA_256 = 'sha256';
+    public const SHA_512 = 'sha512';
+    public const SHA_384 = 'sha384';
+}

src/Util/UrlBuilder.php

@@ -25,6 +25,8 @@
  */
 class UrlBuilder
 {
+    protected $hashingAlgorithm;
+
     /**
      * @var string
      */
@@ -40,11 +42,21 @@ class UrlBuilder
      *
      * @param mixed $secret
      * @param mixed $serverBaseUrl
+     * @param mixed $hashingAlgorithm
      */
-    public function __construct($secret, $serverBaseUrl)
+    public function __construct($secret, $serverBaseUrl, $hashingAlgorithm)
     {
         $this->securitySalt     = $secret;
         $this->bbbServerBaseUrl = $serverBaseUrl;
+        $this->hashingAlgorithm = $hashingAlgorithm;
+    }
+
+    /**
+     * Sets the hashing algorithm.
+     */
+    public function setHashingAlgorithm(string $hashingAlgorithm): void
+    {
+        $this->hashingAlgorithm = $hashingAlgorithm;
     }
 
     /**
@@ -71,6 +83,6 @@ public function buildUrl($method = '', $params = '', $append = true)
      */
     public function buildQs($method = '', $params = '')
     {
-        return $params . '&checksum=' . sha1($method . $params . $this->securitySalt);
+        return $params . '&checksum=' . hash($this->hashingAlgorithm, $method . $params . $this->securitySalt);
     }
 }