PushEvent - Updated the validateRequest() method

+ Added ability to skip secret key validation, which is useful for newer version of gitea (as its depreciated now)

src/Api/Repositories.php

@@ -149,7 +149,7 @@ class Repositories extends AbstractAllApiRequester
      *
      * Example:
      * ```
-     * $client->repositories()->getRawFile($owner, $repoName, "README.md", "v2.0.0");
+     * $client->repositories()->getFileContents($owner, $repoName, "README.md", "v2.0.0");
      * ```
      *
      * @param string $owner The owner of the repository

src/PushEvent.php

@@ -59,9 +59,10 @@ class PushEvent extends AbstractApiModel {
      * @param array $server The HTTP SERVER array for the push event
      * @param string $body The raw data from the request body
      * @param string $secretKey The secret key to from your server
-     * @return void
+     * @param bool $skipSecretValidation If set to true, secret key validation will be skipped (used for newer versions of Gitea)
+     * @return bool
      */
-    public static function validateRequest(array $server, string $body, string $secretKey)
+    public static function validateRequest(array $server, string $body, string $secretKey, bool $skipSecretValidation = false)
     {
         // Validate request protocol
         if ($server['REQUEST_METHOD'] != 'POST') {
@@ -80,18 +81,20 @@ class PushEvent extends AbstractApiModel {
             throw new \RuntimeException("FAILED: Empty Body - The request has an empty body");
         }
 
-        // Validate header signature
-        $headerSignature = isset($server['HTTP_X_GITEA_SIGNATURE']) ? $server['HTTP_X_GITEA_SIGNATURE'] : '';
-        if (empty($headerSignature)) {
-            throw new \RuntimeException("FAILED: Signature Missing - The request is missing the Gitea signature");
-        }
-
-        // calculate payload signature
-        $payload_signature = hash_hmac('sha256', $rawContent, $secretKey, false);
-
-        // check payload signature against header signature
-        if ($headerSignature != $payload_signature) {
-            throw new \RuntimeException("FAILED: Access Denied - The push event's secret does not match the expected secret");
+        if (!$skipSecretValidation) {
+            // Validate header signature
+            $headerSignature = isset($server['HTTP_X_GITEA_SIGNATURE']) ? $server['HTTP_X_GITEA_SIGNATURE'] : '';
+            if (empty($headerSignature)) {
+                throw new \RuntimeException("FAILED: Signature Missing - The request is missing the Gitea signature");
+            }
+    
+            // calculate payload signature
+            $payload_signature = hash_hmac('sha256', $rawContent, $secretKey, false);
+    
+            // check payload signature against header signature
+            if ($headerSignature != $payload_signature) {
+                throw new \RuntimeException("FAILED: Access Denied - The push event's secret does not match the expected secret");
+            }
         }
 
         return true;

src/TestRun.php

@@ -82,7 +82,7 @@ if ($repository) {
 }
 
 // print("Getting contents of \"composer.json\" file \n\n");
-// $rawFile = $giteaClient->repositories()->getRawFile("Sitelease", "sl-theme-recipe", "composer.json");
+// $rawFile = $giteaClient->repositories()->getFileContents("Sitelease", "sl-theme-recipe", "composer.json");
 // if ($rawFile) {
 //     var_dump(json_encode($rawFile));
 //     print("\n\n");
@@ -91,7 +91,7 @@ if ($repository) {
 // }
 
 // print("Getting contents of \"composer.json\" file \n\n");
-// $rawFile = $giteaClient->repositories()->getRawFile("Sitelease", "sl-theme-recipe", "composer.json");
+// $rawFile = $giteaClient->repositories()->getFileContents("Sitelease", "sl-theme-recipe", "composer.json");
 // if ($rawFile) {
 //     var_dump($rawFile);
 //     print("\n\n");