Php/105/useshed usecache flags (#368)

* Implements the Cache and Shed flag renaming in the json was not an option for the JsonMapper we are currently using wil have a look into the symfony/serializer soon * make the messages use the BaseMessage * Adds the ForStreamWithFlags Function * use enums as we now only support php versions greater than 8.1 we can use enums https://www.php.net/manual/de/class.backedenum.php * use the value property
GDATASoftwareAG · Feb 26, 2024 · 5b29f22 · 5b29f22
1 parent bcf3a3e
commit 5b29f22
Show file tree

Hide file tree

Showing 16 changed files with 270 additions and 164 deletions.
diff --git a/php/examples/VaasExample/GetVerdictByFile.php b/php/examples/VaasExample/GetVerdictByFile.php
@@ -2,7 +2,6 @@
 
 namespace VaasExamples;
 
-use Monolog\Logger;
 use VaasSdk\ClientCredentialsGrantAuthenticator;
 use VaasSdk\Vaas;
 
@@ -22,4 +21,4 @@
 $scanPath = getenv("SCAN_PATH");
 $vaasVerdict = $vaas->ForFile($scanPath);
 
-fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is $vaasVerdict->Verdict \n");
+fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is " . $vaasVerdict->Verdict->value . " \n");
diff --git a/php/examples/VaasExample/GetVerdictByHash.php b/php/examples/VaasExample/GetVerdictByHash.php
@@ -10,15 +10,16 @@
 $authenticator = new ClientCredentialsGrantAuthenticator(
     getenv("CLIENT_ID"),
     getenv("CLIENT_SECRET"),
-    getenv("TOKEN_URL") ?? "https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token");
+    getenv("TOKEN_URL") ?? "https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token"
+);
 $vaas = new Vaas(
     getenv("VAAS_URL") ?? "wss://gateway.production.vaas.gdatasecurity.de"
 );
 $vaas->Connect($authenticator->getToken());
 
 // EICAR
 $vaasVerdict = $vaas->ForSha256("000005c43196142f01d615a67b7da8a53cb0172f8e9317a2ec9a0a39a1da6fe8");
-fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is $vaasVerdict->Verdict \n");
+fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is " . $vaasVerdict->Verdict->value . " \n");
 // SOMEFILE
 $vaasVerdict = $vaas->ForSha256("70caea443deb0d0a890468f9ac0a9b1187676ba3e66eb60a722b187107eb1ea8");
-fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is $vaasVerdict->Verdict \n");
+fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is " . $vaasVerdict->Verdict->value . " \n");
diff --git a/php/examples/VaasExample/GetVerdictByUrl.php b/php/examples/VaasExample/GetVerdictByUrl.php
@@ -10,15 +10,16 @@
 $authenticator = new ClientCredentialsGrantAuthenticator(
     getenv("CLIENT_ID"),
     getenv("CLIENT_SECRET"),
-    getenv("TOKEN_URL") ?? "https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token");
+    getenv("TOKEN_URL") ?? "https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token"
+);
 $vaas = new Vaas(
     getenv("VAAS_URL") ?? "wss://gateway.production.vaas.gdatasecurity.de"
 );
 $vaas->Connect($authenticator->getToken());
 
 // EICAR
 $vaasVerdict = $vaas->ForUrl("https://secure.eicar.org/eicar.com");
-fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is $vaasVerdict->Verdict \n");
+fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is " . $vaasVerdict->Verdict->value . " \n");
 // SOMEFILE
 $vaasVerdict = $vaas->ForUrl("https://www.gdatasoftware.com/oem/verdict-as-a-service");
-fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is $vaasVerdict->Verdict \n");
+fwrite(STDOUT, "Verdict for $vaasVerdict->Sha256 is " . $vaasVerdict->Verdict->value . " \n");
diff --git a/php/src/vaas/Message/AuthRequest.php b/php/src/vaas/Message/AuthRequest.php
@@ -2,17 +2,14 @@
 
 namespace VaasSdk\Message;
 
-use Ramsey\Uuid\Rfc4122\UuidV4;
-
-class AuthRequest
+class AuthRequest extends BaseMessage
 {
-    public Kind $kind;
     public string $token;
     public string $session_id;
 
     public function __construct(string $token, string $sessionId = "")
     {
-        $this->kind = new Kind(Kind::AUTH_REQUEST);
+        $this->kind = Kind::AuthRequest;
         $this->token = $token;
         $this->session_id = $sessionId;
     }

diff --git a/php/src/vaas/Message/AuthResponse.php b/php/src/vaas/Message/AuthResponse.php
@@ -2,10 +2,14 @@
 
 namespace VaasSdk\Message;
 
-class AuthResponse
+class AuthResponse extends BaseMessage
 {
-    public Kind $kind;
     public bool $success;
     public ?string $session_id;
     public string $text;
+
+    public function __construct()
+    {
+        $this->kind = Kind::AuthResponse;
+    }
 }
diff --git a/php/src/vaas/Message/BaseMessage.php b/php/src/vaas/Message/BaseMessage.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace VaasSdk\Message;
+
+class BaseMessage
+{
+    public Kind $kind;
+}
diff --git a/php/src/vaas/Message/BaseVerdictRequest.php b/php/src/vaas/Message/BaseVerdictRequest.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace VaasSdk\Message;
+
+use Ramsey\Uuid\Rfc4122\UuidV4;
+
+class BaseVerdictRequest extends BaseMessage
+{
+    public string $guid;
+    public string $session_id;
+    public bool $UseShed; # no simple way to rename the field in the json output
+    public bool $UseCache;
+
+    public function __construct(kind $kind, string $uuid = null, string $SessionId)
+    {
+        $this->kind = $kind;
+        $this->guid = $uuid != null ? $uuid : UuidV4::getFactory()->uuid4()->toString();
+        $this->session_id = $SessionId;
+    }
+}
diff --git a/php/src/vaas/Message/Error.php b/php/src/vaas/Message/Error.php
@@ -2,7 +2,7 @@
 
 namespace VaasSdk\Message;
 
-class Error
+class Error extends BaseMessage
 {
     public string $type;
 
@@ -12,7 +12,10 @@ class Error
 
     public ?ProblemDetails $problem_details;
 
-    public Kind $kind;
+    public function __construct()
+    {
+        $this->kind = Kind::Error;
+    }
 
     /**
      * @return string

diff --git a/php/src/vaas/Message/Kind.php b/php/src/vaas/Message/Kind.php
@@ -2,57 +2,13 @@
 
 namespace VaasSdk\Message;
 
-use JsonSerializable;
-use VaasSdk\Exceptions\UnknownKindException;
-
-class Kind implements JsonSerializable
+enum Kind: string
 {
-    public const AUTH_REQUEST = "AuthRequest";
-    public const AUTH_RESPONSE = "AuthResponse";
-    public const VERDICT_REQUEST = "VerdictRequest";
-    public const VERDICT_RESPONSE = "VerdictResponse";
-    public const VERDICT_REQUEST_FOR_URL = "VerdictRequestForUrl";
-    public const VERDICT_REQUEST_FOR_STREAM = "VerdictRequestForStream";
-    public const ERROR = "Error";
-
-    private string $_kindString = "";
-
-    public function __construct(string $type)
-    {
-        switch ($type) {
-            case self::AUTH_REQUEST:
-                $this->_kindString = self::AUTH_REQUEST;
-                break;
-            case self::AUTH_RESPONSE:
-                $this->_kindString = self::AUTH_RESPONSE;
-                break;
-            case self::VERDICT_REQUEST:
-                $this->_kindString = self::VERDICT_REQUEST;
-                break;
-            case self::VERDICT_RESPONSE:
-                $this->_kindString = self::VERDICT_RESPONSE;
-                break;
-            case self::VERDICT_REQUEST_FOR_URL:
-                $this->_kindString = self::VERDICT_REQUEST_FOR_URL;
-                break;
-            case self::VERDICT_REQUEST_FOR_STREAM:
-                $this->_kindString = self::VERDICT_REQUEST_FOR_STREAM;
-                break;
-            case self::ERROR:
-                $this->_kindString = self::ERROR;
-                break;
-            default:
-                throw new UnknownKindException();
-        }
-    }
-
-    public function __toString()
-    {
-        return $this->_kindString;
-    }
-
-    public function jsonSerialize(): string
-    {
-        return $this->_kindString;
-    }
+    case AuthRequest = "AuthRequest";
+    case AuthResponse = "AuthResponse";
+    case VerdictRequest = "VerdictRequest";
+    case VerdictResponse = "VerdictResponse";
+    case VerdictRequestForUrl = "VerdictRequestForUrl";
+    case VerdictRequestForStream = "VerdictRequestForStream";
+    case Error = "Error";
 }
diff --git a/php/src/vaas/Message/Verdict.php b/php/src/vaas/Message/Verdict.php
@@ -2,46 +2,10 @@
 
 namespace VaasSdk\Message;
 
-use VaasSdk\Exceptions\UnkownVerdictException;
-use JsonSerializable;
-
-class Verdict implements JsonSerializable
+enum Verdict: string
 {
-    public const MALICIOUS = "Malicious";
-    public const CLEAN = "Clean";
-    public const UNKNOWN = "Unknown";
-    public const PUP = "Pup";
-
-    private string $_verdictString = "";
-
-    public function __construct(string $type)
-    {
-        switch ($type) {
-            case self::MALICIOUS:
-                $this->_verdictString = Verdict::MALICIOUS;
-                break;
-            case self::CLEAN:
-                $this->_verdictString = Verdict::CLEAN;
-                break;
-            case self::UNKNOWN:
-                $this->_verdictString = Verdict::UNKNOWN;
-                break;
-            case self::PUP:
-                $this->_verdictString = Verdict::PUP;
-                break;
-
-            default:
-                throw new UnkownVerdictException();
-        }
-    }
-
-    public function __toString()
-    {
-        return $this->_verdictString;
-    }
-
-    public function jsonSerialize(): string
-    {
-        return $this->_verdictString;
-    }
+    case MALICIOUS = "Malicious";
+    case CLEAN = "Clean";
+    case UNKNOWN = "Unknown";
+    case PUP = "Pup";
 }
diff --git a/php/src/vaas/Message/VerdictRequest.php b/php/src/vaas/Message/VerdictRequest.php
@@ -2,20 +2,13 @@
 
 namespace VaasSdk\Message;
 
-use Ramsey\Uuid\Rfc4122\UuidV4;
-
-class VerdictRequest
+class VerdictRequest extends BaseVerdictRequest
 {
     public string $sha256;
-    public string $guid;
-    public Kind $kind;
-    public string $session_id;
 
     public function __construct(string $sha256, string $uuid = null, string $SessionId)
     {
-        $this->kind = new Kind(Kind::VERDICT_REQUEST);
-        $this->guid = $uuid != null ? $uuid : UuidV4::getFactory()->uuid4()->toString();
+        parent::__construct(Kind::VerdictRequest, $uuid, $SessionId);
         $this->sha256 = $sha256;
-        $this->session_id = $SessionId;
     }
 }
diff --git a/php/src/vaas/Message/VerdictRequestForStream.php b/php/src/vaas/Message/VerdictRequestForStream.php
@@ -4,16 +4,10 @@
 
 use Ramsey\Uuid\Rfc4122\UuidV4;
 
-class VerdictRequestForStream
+class VerdictRequestForStream extends BaseVerdictRequest
 {
-    public string $guid;
-    public Kind $kind;
-    public string $session_id;
-
     public function __construct(string $SessionId, string $uuid = null)
     {
-        $this->kind = new Kind(Kind::VERDICT_REQUEST_FOR_STREAM);
-        $this->guid = $uuid != null ? $uuid : UuidV4::getFactory()->uuid4()->toString();
-        $this->session_id = $SessionId;
+        parent::__construct(Kind::VerdictRequestForStream, $uuid, $SessionId);
     }
 }
diff --git a/php/src/vaas/Message/VerdictRequestForUrl.php b/php/src/vaas/Message/VerdictRequestForUrl.php
@@ -4,18 +4,13 @@
 
 use Ramsey\Uuid\Rfc4122\UuidV4;
 
-class VerdictRequestForUrl
+class VerdictRequestForUrl extends BaseVerdictRequest
 {
     public string $url;
-    public string $guid;
-    public Kind $kind;
-    public string $session_id;
 
     public function __construct(string $url, string $uuid = null, string $SessionId)
     {
-        $this->kind = new Kind(Kind::VERDICT_REQUEST_FOR_URL);
-        $this->guid = $uuid != null ? $uuid : UuidV4::getFactory()->uuid4()->toString();
+        parent::__construct(Kind::VerdictRequestForUrl, $uuid, $SessionId);
         $this->url = $url;
-        $this->session_id = $SessionId;
     }
 }
diff --git a/php/src/vaas/Message/VerdictResponse.php b/php/src/vaas/Message/VerdictResponse.php
@@ -2,7 +2,7 @@
 
 namespace VaasSdk\Message;
 
-class VerdictResponse
+class VerdictResponse extends BaseMessage
 {
     public Verdict $verdict;
     public ?string $url;