Add tests for XOR Obfuscation

nolze · Jan 5, 2024 · 1b79c13 · 1b79c13
1 parent 26d8823
commit 1b79c13
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ msoffcrypto-tool (formerly ms-offcrypto-tool) is Python tool and library for dec
 * [Resources](#resources)
 * [Use cases and mentions](#use-cases-and-mentions)
 * [Contributors](#contributors)
+* [Credits](#credits)
 
 ## Installation
 
@@ -206,3 +207,7 @@ poetry run coverage run -m pytest -v
 ## Contributors
 
 * <https://github.com/nolze/msoffcrypto-tool/graphs/contributors>
+
+## Credits
+
+* The sample file for XOR Obfuscation is from: <https://github.com/openwall/john-samples/tree/main/Office/Office_Secrets>
diff --git a/tests/inputs/xor_password_123456789012345.xls b/tests/inputs/xor_password_123456789012345.xls
diff --git a/tests/outputs/xor_password_123456789012345_plain.xls b/tests/outputs/xor_password_123456789012345_plain.xls
diff --git a/tests/test_compare_known_output.py b/tests/test_compare_known_output.py
@@ -30,12 +30,13 @@
 
 #: pairs of input/output files
 EXAMPLE_FILES = (
-    ("example_password.docx", "example.docx"),
-    ("example_password.xlsx", "example.xlsx"),
-    ("ecma376standard_password.docx", "ecma376standard_password_plain.docx"),
-    ("rc4cryptoapi_password.doc", "rc4cryptoapi_password_plain.doc"),
-    ("rc4cryptoapi_password.xls", "rc4cryptoapi_password_plain.xls"),
-    ("rc4cryptoapi_password.ppt", "rc4cryptoapi_password_plain.ppt"),
+    ("example_password.docx", "example.docx", PASSWORD),
+    ("example_password.xlsx", "example.xlsx", PASSWORD),
+    ("ecma376standard_password.docx", "ecma376standard_password_plain.docx", PASSWORD),
+    ("rc4cryptoapi_password.doc", "rc4cryptoapi_password_plain.doc", PASSWORD),
+    ("rc4cryptoapi_password.xls", "rc4cryptoapi_password_plain.xls", PASSWORD),
+    ("rc4cryptoapi_password.ppt", "rc4cryptoapi_password_plain.ppt", PASSWORD),
+    ("xor_password_123456789012345.xls", "xor_password_123456789012345_plain.xls", "123456789012345"),
 )
 
 #: output dir:
@@ -50,17 +51,17 @@ class KnownOutputCompare(unittest.TestCase):
 
     def test_known_output(self):
         """See module doc."""
-        for in_name, out_name in EXAMPLE_FILES:
+        for in_name, out_name, password in EXAMPLE_FILES:
             input_path = pjoin(TEST_BASE_DIR, INPUT_DIR, in_name)
             expect_path = pjoin(TEST_BASE_DIR, OUTPUT_DIR, out_name)
 
             # now run the relevant parts of __main__.main:
             with open(input_path, "rb") as input_handle:
                 file = msoffcrypto.OfficeFile(input_handle)
                 if file.format == "ooxml" and file.type in ["standard", "agile"]:
-                    file.load_key(password=PASSWORD, verify_password=True)
+                    file.load_key(password=password, verify_password=True)
                 else:
-                    file.load_key(password=PASSWORD)
+                    file.load_key(password=password)
 
                 out_desc = None
                 out_path = None