fixes the casing for detections and mime-types (#399)

* fixes the casing for detections and mime-types * update java github actions * gradle/gradle-build-action@v3 v4 does not exist * updates python ci action * replace rust toolchain action * add path to go.mod file * add path to go.sum * only use the go-version-file parameter * the rust-cache action has no parameter working-directory --------- Co-authored-by: PT-ATA No One <[email protected]>
GDATASoftwareAG · Mar 14, 2024 · 70e6e53 · 70e6e53
1 parent dadea1b
commit 70e6e53
Show file tree

Hide file tree

Showing 28 changed files with 80 additions and 72 deletions.
diff --git a/.github/workflows/ci-dotnet.yaml b/.github/workflows/ci-dotnet.yaml
@@ -28,8 +28,8 @@ on:
 env:
   CLIENT_ID: ${{ secrets.CLIENT_ID }}
   CLIENT_SECRET: ${{secrets.CLIENT_SECRET}}
-  VAAS_URL: 'wss://gateway.production.vaas.gdatasecurity.de'
-  TOKEN_URL: 'https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token'
+  VAAS_URL: "wss://gateway.production.vaas.gdatasecurity.de"
+  TOKEN_URL: "https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token"
   VAAS_CLIENT_ID: ${{ secrets.VAAS_CLIENT_ID }}
   VAAS_USER_NAME: ${{ secrets.VAAS_USER_NAME }}
   VAAS_PASSWORD: ${{secrets.VAAS_PASSWORD}}
@@ -43,8 +43,8 @@ jobs:
         dotnet-version: ["8.0.x"]
 
     steps:
-      - uses: actions/checkout@v3
-          
+      - uses: actions/checkout@v4
+
       - name: set staging environment
         if: (inputs.environment == 'staging' || (startsWith(github.ref, 'refs/tags/cs') && endsWith(github.ref, '-beta')))
         run: |
@@ -105,9 +105,9 @@ jobs:
         run: dotnet run UrlScan
         working-directory: dotnet/examples/VaasExample
 
-      - name: Run example HashsumScan     
+      - name: Run example HashsumScan
         run: dotnet run HashsumScan
-        working-directory: dotnet/examples/VaasExample        
+        working-directory: dotnet/examples/VaasExample
 
       - name: Pack
         if: startsWith(github.ref, 'refs/tags/cs')

diff --git a/.github/workflows/ci-java-legacy.yaml b/.github/workflows/ci-java-legacy.yaml
@@ -41,7 +41,7 @@ jobs:
 
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set staging environment
         if: (inputs.environment == 'staging' || (startsWith(github.ref, 'refs/tags/java') && endsWith(github.ref, '-beta')))
@@ -66,18 +66,18 @@ jobs:
           echo "VAAS_PASSWORD=${{ secrets.DEVELOP_VAAS_PASSWORD }}" >> $GITHUB_ENV
 
       - name: install Java
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           java-version: "11"
           distribution: "temurin"
 
       - name: setup Gradle
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/gradle-build-action@v3
         with:
           gradle-version: "8.1"
 
       - name: run tests
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/gradle-build-action@v3
         with:
           arguments: test
           gradle-version: "8.1"
@@ -86,14 +86,14 @@ jobs:
       #- name: run examples for file
       #  env:
       #    SCAN_PATH: "src/main/java/de/gdata/vaasexample/Main.java"
-      #  uses: gradle/gradle-build-action@v2
+      #  uses: gradle/gradle-build-action@v3
       #  with:
       #    arguments: fileScan
       #    gradle-version: "8.1"
       #    build-root-directory: java/examples/VaasExample
 
       #- name: run examples for url
-      #  uses: gradle/gradle-build-action@v2
+      #  uses: gradle/gradle-build-action@v3
       #  with:
       #    arguments: urlScan
       #    gradle-version: "8.1"
@@ -122,7 +122,7 @@ jobs:
           ORG_GRADLE_PROJECT_password: ${{ secrets.ORG_GRADLE_PROJECT_PASSWORD }}
           ORG_GRADLE_PROJECT_signingPassword: ${{ secrets.ORG_GRADLE_PROJECT_SIGNINGPASSWORD }}
           ORG_GRADLE_PROJECT_signingKey: ${{ secrets.ORG_GRADLE_PROJECT_SIGNINGKEY }}
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/gradle-build-action@v3
         with:
           arguments: publish
           gradle-version: "8.1"
@@ -133,7 +133,7 @@ jobs:
         env:
           ORG_GRADLE_PROJECT_username: ${{ secrets.ORG_GRADLE_PROJECT_USERNAME }}
           ORG_GRADLE_PROJECT_password: ${{ secrets.ORG_GRADLE_PROJECT_PASSWORD }}
-        uses: gradle/gradle-build-action@v2
+        uses: gradle/gradle-build-action@v3
         with:
           arguments: closeAndReleaseRepository
           gradle-version: "8.1"

diff --git a/.github/workflows/ci-java.yaml b/.github/workflows/ci-java.yaml
@@ -41,7 +41,7 @@ jobs:
 
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set staging environment
         if: (inputs.environment == 'staging' || (startsWith(github.ref, 'refs/tags/java') && endsWith(github.ref, '-beta')))

diff --git a/.github/workflows/ci-php.yaml b/.github/workflows/ci-php.yaml
@@ -43,7 +43,7 @@ jobs:
         version: ["8.1", "8.2", "8.3"]
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set staging environment
         if: (inputs.environment == 'staging' || (startsWith(github.ref, 'refs/tags/php') && endsWith(github.ref, '-beta')))
@@ -65,7 +65,7 @@ jobs:
           echo "TOKEN_URL=https://account-staging.gdata.de/realms/vaas-develop/protocol/openid-connect/token" >> $GITHUB_ENV
           echo "VAAS_CLIENT_ID=${{ secrets.DEVELOP_VAAS_CLIENT_ID }}" >> $GITHUB_ENV
           echo "VAAS_USER_NAME=${{ secrets.DEVELOP_VAAS_USER_NAME }}" >> $GITHUB_ENV
-          echo "VAAS_PASSWORD=${{ secrets.DEVELOP_VAAS_PASSWORD }}" >> $GITHUB_ENV        
+          echo "VAAS_PASSWORD=${{ secrets.DEVELOP_VAAS_PASSWORD }}" >> $GITHUB_ENV
 
       - name: setup PHP with PECL extension
         uses: shivammathur/setup-php@v2
@@ -123,7 +123,7 @@ jobs:
 
       - name: checkout
         if: startsWith(github.ref, 'refs/tags/php')
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: publish on site repo
         if: startsWith(github.ref, 'refs/tags/php')

diff --git a/.github/workflows/ci-python.yaml b/.github/workflows/ci-python.yaml
@@ -40,7 +40,7 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: set staging environment
         if: (inputs.environment == 'staging' || (startsWith(github.ref, 'refs/tags/py') && endsWith(github.ref, '-beta')))
@@ -65,7 +65,7 @@ jobs:
           echo "VAAS_PASSWORD=${{ secrets.DEVELOP_VAAS_PASSWORD }}" >> $GITHUB_ENV
 
       - name: set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
       - name: install dependencies

diff --git a/.github/workflows/ci-ruby.yaml b/.github/workflows/ci-ruby.yaml
@@ -39,7 +39,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: "3.1" # Not needed with a .ruby-version file

diff --git a/.github/workflows/ci-rust.yaml b/.github/workflows/ci-rust.yaml
@@ -41,7 +41,7 @@ jobs:
 
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set staging environment
         if: (inputs.environment == 'staging' || (startsWith(github.ref, 'refs/tags/rs') && endsWith(github.ref, '-beta')))
@@ -63,16 +63,16 @@ jobs:
           echo "TOKEN_URL=https://account-staging.gdata.de/realms/vaas-develop/protocol/openid-connect/token" >> $GITHUB_ENV
           echo "VAAS_CLIENT_ID=${{ secrets.DEVELOP_VAAS_CLIENT_ID }}" >> $GITHUB_ENV
           echo "VAAS_USER_NAME=${{ secrets.DEVELOP_VAAS_USER_NAME }}" >> $GITHUB_ENV
-          echo "VAAS_PASSWORD=${{ secrets.DEVELOP_VAAS_PASSWORD }}" >> $GITHUB_ENV        
+          echo "VAAS_PASSWORD=${{ secrets.DEVELOP_VAAS_PASSWORD }}" >> $GITHUB_ENV
 
       - name: install Rust stable
-        uses: actions-rs/toolchain@v1
+        uses: actions-rust-lang/setup-rust-toolchain@v1
         with:
           toolchain: stable
 
       - uses: Swatinem/rust-cache@v2
         with:
-          working-directory: rust
+          workspaces: rust
 
       - name: run tests
         run: cargo test

diff --git a/.github/workflows/ci-typescript.yaml b/.github/workflows/ci-typescript.yaml
@@ -28,8 +28,8 @@ on:
 env:
   CLIENT_ID: ${{ secrets.CLIENT_ID }}
   CLIENT_SECRET: ${{secrets.CLIENT_SECRET}}
-  VAAS_URL: 'wss://gateway.production.vaas.gdatasecurity.de'
-  TOKEN_URL: 'https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token'
+  VAAS_URL: "wss://gateway.production.vaas.gdatasecurity.de"
+  TOKEN_URL: "https://account.gdata.de/realms/vaas-production/protocol/openid-connect/token"
   VAAS_CLIENT_ID: ${{ secrets.VAAS_CLIENT_ID }}
   VAAS_USER_NAME: ${{ secrets.VAAS_USER_NAME }}
   VAAS_PASSWORD: ${{secrets.VAAS_PASSWORD}}
@@ -41,7 +41,7 @@ jobs:
 
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: set staging environment
         if: (inputs.environment == 'staging' || (startsWith(github.ref, 'refs/tags/ts') && endsWith(github.ref, '-beta')))
@@ -63,7 +63,7 @@ jobs:
           echo "TOKEN_URL=https://account-staging.gdata.de/realms/vaas-develop/protocol/openid-connect/token" >> $GITHUB_ENV
           echo "VAAS_CLIENT_ID=${{ secrets.DEVELOP_VAAS_CLIENT_ID }}" >> $GITHUB_ENV
           echo "VAAS_USER_NAME=${{ secrets.DEVELOP_VAAS_USER_NAME }}" >> $GITHUB_ENV
-          echo "VAAS_PASSWORD=${{ secrets.DEVELOP_VAAS_PASSWORD }}" >> $GITHUB_ENV        
+          echo "VAAS_PASSWORD=${{ secrets.DEVELOP_VAAS_PASSWORD }}" >> $GITHUB_ENV
 
       - uses: pnpm/action-setup@v3
         name: install pnpm

diff --git a/.github/workflows/image-retention.yaml b/.github/workflows/image-retention.yaml
@@ -17,7 +17,8 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: 1.22.0
+          go-version-file: ./github-actions/cleanup-packages/go.mod
+          cache-dependency-path: ./github-actions/cleanup-packages/go.sum
 
       - name: Verify dependencies
         run: go mod verify

diff --git a/dotnet/Vaas/src/Vaas/Messages/Detection.cs b/dotnet/Vaas/src/Vaas/Messages/Detection.cs
@@ -6,10 +6,10 @@ public class Detection
 {
     [JsonPropertyName("engine")]
     public int? Engine { get; init; }
-    
-    [JsonPropertyName("fileName")]
+
+    [JsonPropertyName("file_name")]
     public string FileName { get; init; }
-    
+
     [JsonPropertyName("virus")]
     public string Virus { get; init; }
 }
diff --git a/dotnet/Vaas/src/Vaas/Messages/LibMagic.cs b/dotnet/Vaas/src/Vaas/Messages/LibMagic.cs
@@ -4,9 +4,9 @@ namespace Vaas.Messages;
 
 public class LibMagic
 {
-    [JsonPropertyName("fileType")]
+    [JsonPropertyName("file_type")]
     public string FileType { get; init; }
-    
-    [JsonPropertyName("mimeType")]
+
+    [JsonPropertyName("mime_type")]
     public string MimeType { get; init; }
 }
diff --git a/dotnet/Vaas/src/Vaas/Messages/VerdictResponse.cs b/dotnet/Vaas/src/Vaas/Messages/VerdictResponse.cs
@@ -14,7 +14,7 @@ public VerdictResponse(string sha256, Verdict verdict)
         Sha256 = sha256;
         Verdict = verdict;
     }
-    
+
     [JsonPropertyName("kind")]
     public string Kind { get; init; } = "VerdictResponse";
 
@@ -33,11 +33,11 @@ public VerdictResponse(string sha256, Verdict verdict)
 
     [JsonPropertyName("upload_token")]
     public string? UploadToken { get; init; }
-    
+
     [JsonPropertyName("detections")]
     public List<Detection>? Detections { get; init; }
-    
-    [JsonPropertyName("libMagic")]
+
+    [JsonPropertyName("lib_magic")]
     public LibMagic? LibMagic { get; init; }
 
     [MemberNotNullWhen(true, nameof(Sha256), nameof(Guid))]

diff --git a/golang/vaas/pkg/messages/detection.go b/golang/vaas/pkg/messages/detection.go
@@ -4,6 +4,6 @@ package messages
 // TokenResponse represents a response containing an access token.
 type Detection struct {
 	Engine   int    `json:"engine"`
-	FileName string `json:"fileName"`
+	FileName string `json:"file_name"`
 	Virus    string `json:"virus"`
 }
diff --git a/golang/vaas/pkg/messages/lib_magic.go b/golang/vaas/pkg/messages/lib_magic.go
@@ -3,6 +3,6 @@ package messages
 
 // TokenResponse represents a response containing an access token.
 type LibMagic struct {
-	FileType string `json:"fileType"`
-	MimeType string `json:"mimeType"`
+	FileType string `json:"file_type"`
+	MimeType string `json:"mime_type"`
 }
diff --git a/golang/vaas/pkg/messages/verdict_response.go b/golang/vaas/pkg/messages/verdict_response.go
@@ -10,7 +10,7 @@ type VerdictResponse struct {
 	URL         string      `json:"url"`
 	UploadToken string      `json:"upload_token"`
 	Detections  []Detection `json:"detections"`
-	LibMagic    LibMagic    `json:"libMagic"`
+	LibMagic    LibMagic    `json:"lib_magic"`
 }
 
 // IsValid checks if the VerdictResponse is valid.

diff --git a/java/src/main/java/de/gdata/vaas/messages/Detection.java b/java/src/main/java/de/gdata/vaas/messages/Detection.java
@@ -1,5 +1,7 @@
 package de.gdata.vaas.messages;
 
+import com.google.gson.annotations.SerializedName;
+
 import lombok.Getter;
 import lombok.NonNull;
 
@@ -8,8 +10,9 @@ public class Detection {
     int engine;
 
     @NonNull
+    @SerializedName("file_name")
     String fileName;
-    
+
     @NonNull
     String virus;
 }
diff --git a/java/src/main/java/de/gdata/vaas/messages/LibMagic.java b/java/src/main/java/de/gdata/vaas/messages/LibMagic.java
@@ -1,13 +1,17 @@
 package de.gdata.vaas.messages;
 
+import com.google.gson.annotations.SerializedName;
+
 import lombok.Getter;
 import lombok.NonNull;
 
 @Getter
 public class LibMagic {
     @NonNull
+    @SerializedName("file_type")
     String fileType;
-    
+
     @NonNull
+    @SerializedName("mime_type")
     String mimeType;
 }
diff --git a/java/src/main/java/de/gdata/vaas/messages/VerdictResponse.java b/java/src/main/java/de/gdata/vaas/messages/VerdictResponse.java
@@ -30,7 +30,7 @@ public class VerdictResponse extends MessageType {
     @SerializedName("detections")
     ArrayList<Detection> detections;
     @Getter
-    @SerializedName("libMagic")
+    @SerializedName("lib_magic")
     LibMagic libMagic;
 
     private VerdictResponse() {

diff --git a/php/src/vaas/Message/Detection.php b/php/src/vaas/Message/Detection.php
@@ -5,6 +5,6 @@
 class Detection
 {
     public ?int $engine;
-    public string $fileName;
+    public string $file_name;
     public string $virus;
 }
diff --git a/php/src/vaas/Message/LibMagic.php b/php/src/vaas/Message/LibMagic.php
@@ -4,6 +4,6 @@
 
 class LibMagic
 {
-    public string $fileType;
-    public string $mimeType;
+    public string $file_type;
+    public string $mime_type;
 }
diff --git a/php/src/vaas/Message/VaasVerdict.php b/php/src/vaas/Message/VaasVerdict.php
@@ -9,7 +9,7 @@ public function __construct(VerdictResponse $verdictResponse)
         $this->Sha256 = $verdictResponse->sha256 ?? "";
         $this->Verdict = $verdictResponse->verdict ?? Verdict::UNKNOWN;
         $this->Guid = $verdictResponse->guid ?? "";
-        $this->LibMagic = $verdictResponse->libMagic ?? null;
+        $this->LibMagic = $verdictResponse->lib_magic ?? null;
         $this->Detections = $verdictResponse->detections ?? null;
     }
 

diff --git a/php/src/vaas/Message/VerdictResponse.php b/php/src/vaas/Message/VerdictResponse.php
@@ -9,6 +9,6 @@ class VerdictResponse extends BaseMessage
     public string $guid;
     public string $sha256;
     public ?string $upload_token;
-    public ?LibMagic $libMagic;
+    public ?LibMagic $lib_magic;
     public ?array $detections;
 }