Move packer scans to their own library

BinaryObjectScanner.Packer/ASPack.cs

@@ -5,7 +5,7 @@ using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Matching;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     public class ASPack : IExtractable, IPortableExecutableCheck

BinaryObjectScanner.Packer/AdvancedInstaller.cs

@@ -4,7 +4,7 @@ using System.Linq;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     // TODO: Verify that all versions are detected

BinaryObjectScanner.Packer/Armadillo.cs

@@ -4,7 +4,7 @@ using System.Linq;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     // TODO: Add version checking, if possible

BinaryObjectScanner.Packer/AutoPlayMediaStudio.cs

@@ -3,7 +3,7 @@ using System.IO;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // Created by IndigoRose (creators of Setup Factory), primarily to be used to create autorun menus for various media.
     // Official website: https://www.autoplay.org/

BinaryObjectScanner.Packer/BinaryObjectScanner.Packer.csproj

@@ -20,6 +20,10 @@
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="WiseUnpacker" Version="1.0.4" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\BinaryObjectScanner.Interfaces\BinaryObjectScanner.Interfaces.csproj" />
     <ProjectReference Include="..\BinaryObjectScanner.Matching\BinaryObjectScanner.Matching.csproj" />

BinaryObjectScanner.Packer/CExe.cs

@@ -8,7 +8,7 @@ using BinaryObjectScanner.Matching;
 using BinaryObjectScanner.Wrappers;
 using ICSharpCode.SharpZipLib.Zip.Compression;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // The official website for CExe also includes the source code (which does have to be retrieved by the Wayback Machine)
     // http://www.scottlu.com/Content/CExe.html

BinaryObjectScanner.Packer/EXEStealth.cs

@@ -4,7 +4,7 @@ using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Matching;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Figure out how to more granularly determine versions like PiD
     // TODO: Detect 3.15 and up (maybe looking for `Metamorphism`)

BinaryObjectScanner.Packer/EmbeddedExecutable.cs

@@ -5,7 +5,7 @@ using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Matching;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     /// <summary>
     /// Though not technically a packer, this detection is for any executables that include

BinaryObjectScanner.Packer/GenteeInstaller.cs

@@ -4,7 +4,7 @@ using System.Linq;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     // https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt

BinaryObjectScanner.Packer/HyperTechCrackProof.cs

@@ -3,7 +3,7 @@ using System.Linq;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // CrackProof is a packer/obfuscator created by Japanese company HyperTech (https://www.hypertech.co.jp/products/windows/).
     // It is known to be used along with other DRM, such as Shury2 (Redump entry 97135) and BDL.

BinaryObjectScanner.Packer/InnoSetup.cs

@@ -5,7 +5,7 @@ using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Matching;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction - https://github.com/dscharrer/InnoExtract
     // https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt

BinaryObjectScanner.Packer/InstallAnywhere.cs

@@ -3,7 +3,7 @@ using System.IO;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction, which may be possible with the current libraries but needs to be investigated further.
     // https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt

BinaryObjectScanner.Packer/InstallerVISE.cs

@@ -4,7 +4,7 @@ using System.Linq;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction - https://github.com/Bioruebe/UniExtract2
     // https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt

BinaryObjectScanner.Packer/IntelInstallationFramework.cs

@@ -3,7 +3,7 @@ using System.IO;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction, seems to primarily use MSZip compression.
     public class IntelInstallationFramework : IExtractable, IPortableExecutableCheck

BinaryObjectScanner.Packer/MicrosoftCABSFX.cs

@@ -5,7 +5,7 @@ using System.Linq;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction, which should be possible with LibMSPackN, but it refuses to extract due to SFX files lacking the typical CAB identifiers.
     // https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt

BinaryObjectScanner.Packer/NSIS.cs

@@ -4,7 +4,7 @@ using System.Linq;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     public class NSIS : IExtractable, IPortableExecutableCheck

BinaryObjectScanner.Packer/PECompact.cs

@@ -2,7 +2,7 @@
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Better version detection - https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt
     // TODO: Add extraction

BinaryObjectScanner.Packer/Petite.cs

@@ -2,7 +2,7 @@
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     // https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt

BinaryObjectScanner.Packer/SetupFactory.cs

@@ -3,7 +3,7 @@ using System.IO;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction, which is possible but the only tools available that can
     // do this seem to be Universal Extractor 2 and InstallExplorer (https://totalcmd.net/plugring/InstallExplorer.html)

BinaryObjectScanner.Packer/SevenZipSFX.cs

@@ -3,7 +3,7 @@ using System.Linq;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     public class SevenZipSFX : IExtractable, IPortableExecutableCheck

BinaryObjectScanner.Packer/Shrinker.cs

@@ -2,7 +2,7 @@ using System.IO;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     // https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt

BinaryObjectScanner.Packer/UPX.cs

@@ -6,7 +6,7 @@ using System.Text.RegularExpressions;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     // https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt

BinaryObjectScanner.Packer/WinRARSFX.cs

@@ -6,7 +6,7 @@ using BinaryObjectScanner.Wrappers;
 using SharpCompress.Archives;
 using SharpCompress.Archives.Rar;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     public class WinRARSFX : IExtractable, IPortableExecutableCheck
     {

BinaryObjectScanner.Packer/WinZipSFX.cs

@@ -7,7 +7,7 @@ using BinaryObjectScanner.Wrappers;
 using SharpCompress.Archives;
 using SharpCompress.Archives.Zip;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     public class WinZipSFX : IExtractable, INewExecutableCheck, IPortableExecutableCheck
     {

BinaryObjectScanner.Packer/WiseInstaller.cs

@@ -8,7 +8,7 @@ using BinaryObjectScanner.Utilities;
 using BinaryObjectScanner.Wrappers;
 using Wise = WiseUnpacker.WiseUnpacker;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // https://raw.githubusercontent.com/wolfram77web/app-peid/master/userdb.txt
     public class WiseInstaller : IExtractable, INewExecutableCheck, IPortableExecutableCheck

BinaryObjectScanner.Packer/dotFuscator.cs

@@ -4,7 +4,7 @@ using System.Linq;
 using BinaryObjectScanner.Interfaces;
 using BinaryObjectScanner.Wrappers;
 
-namespace BurnOutSharp.PackerType
+namespace BinaryObjectScanner.Packer
 {
     // TODO: Add extraction
     public class dotFuscator : IExtractable, IPortableExecutableCheck

BurnOutSharp/BurnOutSharp.csproj

@@ -32,7 +32,6 @@
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
     <PackageReference Include="UnshieldSharp" Version="1.6.9" />
-    <PackageReference Include="WiseUnpacker" Version="1.0.4" />
   </ItemGroup>
 
   <!-- These are needed for dealing with submodules -->
@@ -78,6 +77,10 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </ProjectReference>
+    <ProjectReference Include="..\BinaryObjectScanner.Packer\BinaryObjectScanner.Packer.csproj">
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      <PrivateAssets>all</PrivateAssets>
+    </ProjectReference>
     <ProjectReference Include="..\BinaryObjectScanner.Protection\BinaryObjectScanner.Protection.csproj">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>

BurnOutSharp/ScanningClasses.cs

@@ -120,7 +120,9 @@ namespace BurnOutSharp
         /// Initialize all implementations of a type
         /// </summary>
         private static IEnumerable<T> InitCheckClasses<T>()
-            => InitCheckClasses<T>(Assembly.GetExecutingAssembly()).Concat(InitCheckClasses<T>(typeof(BinaryObjectScanner.Protection._DUMMY).Assembly));
+            => InitCheckClasses<T>(Assembly.GetExecutingAssembly())
+                .Concat(InitCheckClasses<T>(typeof(BinaryObjectScanner.Packer._DUMMY).Assembly))
+                .Concat(InitCheckClasses<T>(typeof(BinaryObjectScanner.Protection._DUMMY).Assembly));
 
         /// <summary>
         /// Initialize all implementations of a type

Coding Guide.md

@@ -320,7 +320,6 @@ This section contains information on project and class organization principles t
 | `BurnOutSharp` | One file per class. See below for details on subdirectories. |
 | `BurnOutSharp/External` | One directory per external project. |
 | `BurnOutSharp/FileType` | One file per file type. |
-| `BurnOutSharp/PackerType` | At least one file per packer type. Partial classes allowed. |
 | `BurnOutSharp/Tools` | Two files - one for extension methods and one for utilities. |
 | `BinaryObjectScanner.ASN1` | Flat directory structure. |
 | `BinaryObjectScanner.Builders` | One file per executable type. |
@@ -328,6 +327,7 @@ This section contains information on project and class organization principles t
 | `BinaryObjectScanner.Interfaces` | One file per interface. |
 | `BinaryObjectScanner.Matching` | Flat directory structure. Include interfaces and base classes. |
 | `BinaryObjectScanner.Models` | One directory per executable type. One file per object model. |
+| `BinaryObjectScanner.Packer` | At least one file per packer type. Partial classes allowed. |
 | `BinaryObjectScanner.Protection` | At least one file per protection type. Partial classes allowed. |
 | `BinaryObjectScanner.Utilities` | Flat directory structure. |
 | `BinaryObjectScanner.Wrappers` | One file per executable type. Common functionality goes in `WrapperBase.cs`. |
@@ -344,7 +344,6 @@ This section contains information on in-code organization principles that depend
 | --- | --- |
 | `BurnOutSharp` | Varies from file to file. |
 | `BurnOutSharp/FileType` | `IExtractable` implementations, `IScannable` implementations, helper methods. |
-| `BurnOutSharp/PackerType` | `IContentCheck` implementations, `ILinearExecutableCheck` implementations, `INewExecutableCheck` implementations, `IPortableExecutableCheck` implementations, `IPathCheck` implementations, `IExtractable` implementations, helper methods. |
 | `BurnOutSharp/Tools` | Methods grouped by function. Regions ordered alphabetically. |
 | `BinaryObjectScanner.ASN1` | Partial classes suggested for different implmentations. |
 | `BinaryObjectScanner.Builders` | Two copies of each non-generic method: one for byte arrays and one for Streams. |
@@ -352,6 +351,7 @@ This section contains information on in-code organization principles that depend
 | `BinaryObjectScanner.Interfaces` | Methods ordered alphabetically. |
 | `BinaryObjectScanner.Matching` | Varies from file to file. |
 | `BinaryObjectScanner.Models` | No methods at all, just properties. |
+| `BinaryObjectScanner.Packer` | `IContentCheck` implementations, `ILinearExecutableCheck` implementations, `INewExecutableCheck` implementations, `IPortableExecutableCheck` implementations, `IPathCheck` implementations, `IExtractable` implementations, helper methods. |
 | `BinaryObjectScanner.Protection` | `IContentCheck` implementations, `ILinearExecutableCheck` implementations, `INewExecutableCheck` implementations, `IPortableExecutableCheck` implementations, `IPathCheck` implementations, `IExtractable` implementations, helper methods. |
 | `BinaryObjectScanner.Utilities` | Varies from file to file. |
 | `BurnOutSharp.Wrappers` | Follow region and method grouping from existing wrappers. |

Developer Guide.md

@@ -8,13 +8,14 @@ This is a guide for any developers who wish to research protections, implement n
 
 | Project | Description |
 | --- | --- |
-| `BurnOutSharp` | Main library that contains all supported file formats and packers. It also houses most of the utilities and structures needed when `BurnOutSharp` is used by another project. Many code additions will happen here. |
+| `BurnOutSharp` | Main library that contains all supported file formats. It also houses most of the utilities and structures needed when `BurnOutSharp` is used by another project. Some code additions will happen here. |
 | `BinaryObjectScanner.ASN1` | Library containing classes and methods associated with Abstract Syntax Notation One and OID parsing. |
 | `BinaryObjectScanner.Builder` | Library containing classes that assist in populating the various object models defined in `BinaryObjectScanner.Models`. Builders can work with either byte arrays or streams for input. At the time of writing, the following executable types have builders: **MS-DOS**, **New Executable**, **Portable Executable**. |
 | `BinaryObjectScanner.Compression` | Library containing classes that deal with different compression formats. This library is used extensively by the wrappers in `BinaryObjectScanner.Wrappers`. |
 | `BinaryObjectScanner.Interfaces` | Library containing interface definitions for scanning and detection. |
 | `BinaryObjectScanner.Matching` | Library containing models and logic for generic searching and matching. This library is used extensively by the packer and protection checks in `BurnOutSharp`. |
 | `BinaryObjectScanner.Models` | Library containing object models that represent various pieces of known executable formats. At the time of writing, the following executable types have models: **MS-DOS**, **New Executable**, **Linear Executable (partial)**, **Portable Executable**. |
+| `BinaryObjectScanner.Packer` | Library containing packer scanning definitions. |
 | `BinaryObjectScanner.Protection` | Library containing protection scanning definitions. |
 | `BinaryObjectScanner.Utilities` | Library containing helper and extension methods that don't rely on any other libraries. |
 | `BinaryObjectScanner.Wrappers` | Library that acts as a custom wrapper around both `BinaryObjectScanner.Builder` and `BinaryObjectScanner.Models` that allows for easier access to executable information. Each of the wrappers may also include additional functionality that would not otherwise be found in the models, e.g. Data and string reading from sections. |
@@ -89,7 +90,7 @@ Adding a new checker or format should happen in a few distinct steps:
 
     - If it is a new supported file type (such as an archive format), create the file in `BurnOutSharp/FileType/`. By default, you will need to implement `BurnOutSharp.Interfaces.IScannable` or `BinaryObjectScanner.Interfaces.IExtractable`. Do not implement any other interfaces. Please consider asking project maintainers before doing this work, especially if there are external dependencies.
 
-    - If it is a new supported executable packer, compressor, or installer format, create the file in `BurnOutSharp/PackerType/`. By default, you will need to implement `BinaryObjectScanner.Interfaces.IExtractable` as well as at least one of: `BinaryObjectScanner.Interfaces.ILinearExecutableCheck`, `BinaryObjectScanner.Interfaces.INewExecutableCheck`, and `BinaryObjectScanner.Interfaces.IPortableExecutableCheck`. It is exceptionally rare to need to implement `BinaryObjectScanner.Interfaces.IPathCheck`.
+    - If it is a new supported executable packer, compressor, or installer format, create the file in `BinaryObjectScanner.Packer`. By default, you will need to implement `BinaryObjectScanner.Interfaces.IExtractable` as well as at least one of: `BinaryObjectScanner.Interfaces.ILinearExecutableCheck`, `BinaryObjectScanner.Interfaces.INewExecutableCheck`, and `BinaryObjectScanner.Interfaces.IPortableExecutableCheck`. It is exceptionally rare to need to implement `BinaryObjectScanner.Interfaces.IPathCheck`.
 
     - If it is a new supported DRM scheme, copy protection, or obfuscator, create the file in `BinaryObjectScanner.Protection`. By default, you will need to implement at least one of:`BinaryObjectScanner.Interfaces.ILinearExecutableCheck`, `BinaryObjectScanner.Interfaces.INewExecutableCheck`, `BinaryObjectScanner.Interfaces.IPortableExecutableCheck`, and `BinaryObjectScanner.Interfaces.IPathCheck`. It is exceptionally rare to need to implement `BinaryObjectScanner.Interfaces.Extractable`.