fix(Glimps): fixture test and add deprecated old actions

SEKOIA-IO · Dec 18, 2024 · 4901e72 · 4901e72
1 parent 5894cdd
commit 4901e72
Show file tree

Hide file tree

Showing 11 changed files with 468 additions and 52 deletions.
diff --git a/Glimps/action_retrieve_the_analysis.json b/Glimps/action_retrieve_the_analysis.json
@@ -0,0 +1,148 @@
+{
+  "uuid": "31d90d77-a480-408b-9ce3-d565ff161231",
+  "name": "[Deprecated] Get the results of an analysis",
+  "description": "",
+  "docker_parameters": "get-results/{uuid}",
+  "arguments": {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "Get the results of an analysis",
+    "properties": {
+      "uuid": {
+        "in": "path",
+        "description": "Unique analysis identifier",
+        "example": "9618ae7e-e284-405d-8998-ff1e12c7ca27",
+        "type": "string"
+      }
+    },
+    "required": [
+      "uuid"
+    ]
+  },
+  "results": {
+    "properties": {
+      "done": {
+        "description": "is the analysis finished",
+        "type": "boolean"
+      },
+      "duration": {
+        "description": "duration of the analysis in milliseconds",
+        "example": 998,
+        "type": "integer"
+      },
+      "error": {
+        "description": "error message if Status is false",
+        "type": "string"
+      },
+      "errors": {
+        "additionalProperties": {
+          "type": "string"
+        },
+        "description": "error message by services",
+        "type": "object"
+      },
+      "file_count": {
+        "description": "amount of file in the submission (input + extracted)",
+        "example": 1,
+        "type": "integer"
+      },
+      "filenames": {
+        "description": "list of analysed filename",
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "files": {
+        "description": "array of submission files (input file and extracted sub-files)",
+        "items": {
+          "$ref": "#/components/schemas/fileEntry"
+        },
+        "type": "array"
+      },
+      "filetype": {
+        "description": "",
+        "type": "string"
+      },
+      "is_malware": {
+        "description": "analysis result, is a malware or not",
+        "type": "boolean"
+      },
+      "malwares": {
+        "description": "list of malware names found in analysis",
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "md5": {
+        "description": "string hex encoded input file MD5",
+        "example": "8437115b99341df5becdb03a4d091654",
+        "type": "string"
+      },
+      "score": {
+        "description": "highest score given by probes",
+        "example": 1000,
+        "type": "integer"
+      },
+      "sha1": {
+        "description": "string hex encoded input file SHA1",
+        "example": "f9a0a612aa694acc24726ed8610981db9798dde0",
+        "type": "string"
+      },
+      "sha256": {
+        "description": "string hex encoded input file SHA256",
+        "example": "c253396cf740b03629b1a76f071eb3594099eebc130f47ae8fe15ef47679e209",
+        "type": "string"
+      },
+      "sid": {
+        "description": "analysis UUID handled by GLIMPS malware finder - expert\ncould be used to construct expert link like:\nhttps://gmalware.useddomain.glimps.re/expert/en/analysis/results/advanced/${SID}",
+        "example": "2z4zfg66Sm3k0Y2KcjgqoK",
+        "type": "string"
+      },
+      "size": {
+        "description": "input file size (in bytes)",
+        "type": "integer"
+      },
+      "ssdeep": {
+        "description": "string input file SSDeep",
+        "example": "384:4fpWcehzJFYKWYGWhdffa3zWzc3fpCLrsjHIX69URc+hmnulY1qHprFKt6zW8zZn:4fkcY/WYf/ffa3axfpWcehzJFYKWYGWv",
+        "type": "string"
+      },
+      "status": {
+        "description": "true => no error to report,\nfalse => an error occurred",
+        "type": "boolean"
+      },
+      "timestamp": {
+        "description": "timestamp of the start of analysis in milliseconds",
+        "type": "integer"
+      },
+      "token": {
+        "description": "token that can be used to view analysis result in expert view",
+        "type": "string"
+      },
+      "uuid": {
+        "description": "Unique analysis identifier",
+        "example": "9618ae7e-e284-405d-8998-ff1e12c7ca27",
+        "type": "string"
+      }
+    },
+    "required": [
+      "status",
+      "uuid",
+      "sid",
+      "sha256",
+      "sha1",
+      "md5",
+      "ssdeep",
+      "is_malware",
+      "score",
+      "done",
+      "timestamp",
+      "duration",
+      "filetype",
+      "filecount"
+    ],
+    "type": "object"
+  }
+}
diff --git a/Glimps/action_search_a_previous_analysis.json b/Glimps/action_search_a_previous_analysis.json
@@ -0,0 +1,148 @@
+{
+  "uuid": "28608954-4683-49fe-a494-333d3254720b",
+  "name": "[Deprecated] Search previous analysis",
+  "description": "",
+  "docker_parameters": "get-search/{sha256}",
+  "arguments": {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "Search a previous analysis of a file",
+    "properties": {
+      "sha256": {
+        "in": "path",
+        "description": "string hex encoded input file SHA256",
+        "example": "c253396cf740b03629b1a76f071eb3594099eebc130f47ae8fe15ef47679e209",
+        "type": "string"
+      }
+    },
+    "required": [
+      "sha256"
+    ]
+  },
+  "results": {
+    "properties": {
+      "done": {
+        "description": "is the analysis finished",
+        "type": "boolean"
+      },
+      "duration": {
+        "description": "duration of the analysis in milliseconds",
+        "example": 998,
+        "type": "integer"
+      },
+      "error": {
+        "description": "error message if Status is false",
+        "type": "string"
+      },
+      "errors": {
+        "additionalProperties": {
+          "type": "string"
+        },
+        "description": "error message by services",
+        "type": "object"
+      },
+      "file_count": {
+        "description": "amount of file in the submission (input + extracted)",
+        "example": 1,
+        "type": "integer"
+      },
+      "filenames": {
+        "description": "list of analysed filename",
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "files": {
+        "description": "array of submission files (input file and extracted sub-files)",
+        "items": {
+          "$ref": "#/components/schemas/fileEntry"
+        },
+        "type": "array"
+      },
+      "filetype": {
+        "description": "",
+        "type": "string"
+      },
+      "is_malware": {
+        "description": "analysis result, is a malware or not",
+        "type": "boolean"
+      },
+      "malwares": {
+        "description": "list of malware names found in analysis",
+        "items": {
+          "type": "string"
+        },
+        "type": "array"
+      },
+      "md5": {
+        "description": "string hex encoded input file MD5",
+        "example": "8437115b99341df5becdb03a4d091654",
+        "type": "string"
+      },
+      "score": {
+        "description": "highest score given by probes",
+        "example": 1000,
+        "type": "integer"
+      },
+      "sha1": {
+        "description": "string hex encoded input file SHA1",
+        "example": "f9a0a612aa694acc24726ed8610981db9798dde0",
+        "type": "string"
+      },
+      "sha256": {
+        "description": "string hex encoded input file SHA256",
+        "example": "c253396cf740b03629b1a76f071eb3594099eebc130f47ae8fe15ef47679e209",
+        "type": "string"
+      },
+      "sid": {
+        "description": "analysis UUID handled by GLIMPS malware finder - expert\ncould be used to construct expert link like:\nhttps://gmalware.useddomain.glimps.re/expert/en/analysis/results/advanced/${SID}\n",
+        "example": "2z4zfg66Sm3k0Y2KcjgqoK",
+        "type": "string"
+      },
+      "size": {
+        "description": "input file size (in bytes)",
+        "type": "integer"
+      },
+      "ssdeep": {
+        "description": "string input file SSDeep",
+        "example": "384:4fpWcehzJFYKWYGWhdffa3zWzc3fpCLrsjHIX69URc+hmnulY1qHprFKt6zW8zZn:4fkcY/WYf/ffa3axfpWcehzJFYKWYGWv",
+        "type": "string"
+      },
+      "status": {
+        "description": "true => no error to report,\nfalse => an error occurred\n",
+        "type": "boolean"
+      },
+      "timestamp": {
+        "description": "timestamp of the start of analysis in milliseconds",
+        "type": "integer"
+      },
+      "token": {
+        "description": "token that can be used to view analysis result in expert view",
+        "type": "string"
+      },
+      "uuid": {
+        "description": "Unique analysis identifier\n",
+        "example": "9618ae7e-e284-405d-8998-ff1e12c7ca27",
+        "type": "string"
+      }
+    },
+    "required": [
+      "status",
+      "uuid",
+      "sid",
+      "sha256",
+      "sha1",
+      "md5",
+      "ssdeep",
+      "is_malware",
+      "score",
+      "done",
+      "timestamp",
+      "duration",
+      "filetype",
+      "filecount"
+    ],
+    "type": "object"
+  }
+}
diff --git a/Glimps/action_submit_a_file_to_be_analysed.json b/Glimps/action_submit_a_file_to_be_analysed.json
@@ -0,0 +1,45 @@
+{
+  "uuid": "8c7a4d68-e8b1-4c28-964e-c7a93e7a6e19",
+  "name": "[Deprecated] Analyse a file",
+  "description": "",
+  "docker_parameters": "post-submit",
+  "arguments": {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "title": "Analyse a file",
+    "properties": {
+      "bypass-cache": {
+        "in": "query",
+        "type": "boolean",
+        "description": "ask the API to bypass cache and always submit the file to the orchestrator (optional)"
+      },
+      "file": {
+        "description": "The file to scan",
+        "type": "string",
+        "in": "body"
+      }
+    }
+  },
+  "results": {
+    "properties": {
+      "error": {
+        "description": "string describing error",
+        "type": "string"
+      },
+      "status": {
+        "default": false,
+        "description": "false => an error occurred",
+        "type": "boolean"
+      },
+      "uuid": {
+        "type": "string",
+        "description": "Unique analysis identifier",
+        "example": "9618ae7e-e284-405d-8998-ff1e12c7ca27"
+      }
+    },
+    "required": [
+      "status"
+    ],
+    "type": "object"
+  }
+}