From d60a3ce05af5141f3613d141c77758a4915cc098 Mon Sep 17 00:00:00 2001
From: Matt Nadareski <mnadareski@outlook.com>
Date: Thu, 9 Mar 2023 13:48:51 -0500
Subject: [PATCH] Add extractable interface (unused)

---
 .../IExtractable.cs                           | 26 +++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 BinaryObjectScanner.Interfaces/IExtractable.cs

diff --git a/BinaryObjectScanner.Interfaces/IExtractable.cs b/BinaryObjectScanner.Interfaces/IExtractable.cs
new file mode 100644
index 00000000..c038f967
--- /dev/null
+++ b/BinaryObjectScanner.Interfaces/IExtractable.cs
@@ -0,0 +1,26 @@
+using System.IO;
+
+namespace BinaryObjectScanner.Interfaces
+{
+    /// <summary>
+    /// Mark a file type as being able to be extracted
+    /// </summary>
+    public interface IExtractable
+    {
+        /// <summary>
+        /// Scan a file for all internal protections
+        /// </summary>
+        /// <param name="file">Path to the input file</param>
+        /// <returns>Path to extracted files, null on error</returns>
+        /// <remarks>Ideally, this should just point to the other extract implementation</remarks>
+        string Extract(string file);
+
+        /// <summary>
+        /// Scan a stream for all internal protections
+        /// </summary>
+        /// <param name="stream">Stream representing the input file</param>
+        /// <param name="file">Path to the input file</param>
+        /// <returns>Path to extracted files, null on error</returns>
+        string Extract(Stream stream, string file);
+    }
+}