From 63ace6099508664b51b671f95a84bd891736e0d3 Mon Sep 17 00:00:00 2001
From: Mike Auty <mike.auty@gmail.com>
Date: Tue, 17 Oct 2023 15:54:10 +0100
Subject: [PATCH] Core: Add (optional) sanitization to the FileHandler class

---
 volatility3/framework/interfaces/plugins.py | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/volatility3/framework/interfaces/plugins.py b/volatility3/framework/interfaces/plugins.py
index 0de109c5e8..29395aadf3 100644
--- a/volatility3/framework/interfaces/plugins.py
+++ b/volatility3/framework/interfaces/plugins.py
@@ -43,7 +43,7 @@ def preferred_filename(self):
         return self._preferred_filename
 
     @preferred_filename.setter
-    def preferred_filename(self, filename):
+    def preferred_filename(self, filename: str):
         """Sets the preferred filename"""
         if self.closed:
             raise IOError("FileHandler name cannot be changed once closed")
@@ -57,6 +57,18 @@ def preferred_filename(self, filename):
     def close(self):
         """Method that commits the file and fixes the final filename for use"""
 
+    @staticmethod
+    def sanitize_filename(filename: str) -> str:
+        """Sanititizes the filename to ensure only a specific whitelist of characters is allowed through"""
+        allowed = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.- ()[]\{\}!$%^:#~?<>,|"
+        result = ""
+        for char in filename:
+            if char in allowed:
+                result += char
+            else:
+                result += "?"
+        return result
+
     def __enter__(self):
         return self