SabreTools/BinaryObjectScanner
1
0
Fork 0
mirror of https://github.com/SabreTools/BinaryObjectScanner.git synced 2026-09-23 15:24:45 +00:00
Code Issues 295 Packages Projects Releases 20 Wiki Activity

Add Options class, allow multiple features

Browse Source
This commit is contained in:
Matt Nadareski
2023-01-16 21:52:32 -08:00
parent 7e7b2ee64a
commit 2c979f291e
5 changed files with 338 additions and 197 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Test/App.config
View File

@@ -1,6 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.2"/>
</startup>
</configuration>

282
Test/Options.cs Normal file
View File

@@ -0,0 +1,282 @@
using System;
using System.Collections.Generic;
using System.IO;
namespace Test
{
/// <summary>
/// Set of options for the test executable
/// </summary>
internal sealed class Options
{
#region Properties
/// <summary>
/// Enable debug output for relevant operations
/// </summary>
public bool Debug { get; private set; } = false;
/// <summary>
/// Set of input paths to use for operations
/// </summary>
public List<string> InputPaths { get; private set; } = new List<string>();
#region Extraction
/// <summary>
/// Perform archive extraction
/// </summary>
public bool EnableExtraction { get; private set; } = false;
/// <summary>
/// Output path for archive extraction
/// </summary>
public string OutputPath { get; private set; } = string.Empty;
#endregion
#region Information
/// <summary>
/// Perform information printing
/// </summary>
public bool EnableInformation { get; private set; } = false;
#if NET6_0_OR_GREATER
/// <summary>
/// Enable JSON output
/// </summary>
public bool Json { get; private set; } = false;
#endif
#endregion
#region Scanning
/// <summary>
/// Perform protection scanning
/// </summary>
public bool EnableScanning { get; private set; } = false;
/// <summary>
/// Scan archives during protection scanning
/// </summary>
public bool ScanArchives { get; private set; } = true;
/// <summary>
/// Scan file contents during protection scanning
/// </summary>
public bool ScanContents { get; private set; } = true;
/// <summary>
/// Scan packers during protection scanning
/// </summary>
public bool ScanPackers { get; private set; } = true;
/// <summary>
/// Scan file paths during protection scanning
/// </summary>
public bool ScanPaths { get; private set; } = true;
#endregion
#endregion
/// <summary>
/// Parse commandline arguments into an Options object
/// </summary>
public static Options ParseOptions(string[] args)
{
// If we have invalid arguments
if (args == null || args.Length == 0)
return null;
// Create an Options object
var options = new Options();
// Parse the features
int index = 0;
for (; index < args.Length; index++)
{
string arg = args[index];
bool featureFound = false;
switch (arg)
{
case "-?":
case "-h":
case "--help":
return null;
case "-x":
case "--extract":
options.EnableExtraction = true;
featureFound = true;
break;
case "-i":
case "--info":
options.EnableInformation = true;
featureFound = true;
break;
case "-s":
case "--scan":
options.EnableScanning = true;
featureFound = true;
break;
default:
break;
}
// If the flag wasn't a feature
if (!featureFound)
break;
}
// Parse the options and paths
for (; index < args.Length; index++)
{
string arg = args[index];
switch (arg)
{
case "-d":
case "--debug":
options.Debug = true;
break;
#region Extraction
case "-o":
case "--outdir":
options.OutputPath = index + 1 < args.Length ? args[++index] : null;
break;
#endregion
#region Information
#if NET6_0_OR_GREATER
case "-j":
case "--json":
options.Json = true;
break;
#endif
#endregion
#region Scanning
case "-na":
case "--no-archives":
options.ScanArchives = false;
break;
case "-nc":
case "--no-contents":
options.ScanContents = false;
break;
case "-np":
case "--no-packers":
options.ScanPackers = false;
break;
case "-ns":
case "--no-paths":
options.ScanPaths = false;
break;
#endregion
default:
options.InputPaths.Add(arg);
break;
}
}
// If we have no features set, enable protection scanning
if (!options.EnableExtraction && !options.EnableInformation && !options.EnableScanning)
options.EnableScanning = true;
// Validate we have any input paths to work on
if (options.InputPaths.Count == 0)
{
Console.WriteLine("At least one path is required!");
return null;
}
// If we have extraction enabled, validate the path
if (options.EnableExtraction)
{
bool validPath = ValidateExtractionPath(options);
if (!validPath)
return null;
}
return options;
}
/// <summary>
/// Display help text
/// </summary>
public static void DisplayHelp()
{
Console.WriteLine("BurnOutSharp Test Program");
Console.WriteLine();
Console.WriteLine("test.exe <features> <options> file|directory ...");
Console.WriteLine();
Console.WriteLine("Features:");
Console.WriteLine("-x, --extract Extract archive formats");
Console.WriteLine("-i, --info Print executable info");
Console.WriteLine("-s, --scan Enable protection scanning (default if none)");
Console.WriteLine();
Console.WriteLine("Common options:");
Console.WriteLine("-?, -h, --help Display this help text and quit");
Console.WriteLine("-d, --debug Enable debug mode");
Console.WriteLine();
Console.WriteLine("Extraction options:");
Console.WriteLine("-o, --outdir [PATH] Set output path for extraction (required)");
#if NET6_0_OR_GREATER
Console.WriteLine();
Console.WriteLine("Information options:");
Console.WriteLine("-j, --json Print executable info as JSON");
#endif
Console.WriteLine();
Console.WriteLine("Scanning options:");
Console.WriteLine("-nc, --no-contents Disable scanning for content checks");
Console.WriteLine("-na, --no-archives Disable scanning archives");
Console.WriteLine("-np, --no-packers Disable scanning for packers");
Console.WriteLine("-ns, --no-paths Disable scanning for path checks");
}
/// <summary>
/// Validate the extraction path
/// </summary>
private static bool ValidateExtractionPath(Options options)
{
// Null or empty output path
if (string.IsNullOrWhiteSpace(options.OutputPath))
{
Console.WriteLine("Output directory required for extraction!");
Console.WriteLine();
return false;
}
// Malformed output path or invalid location
try
{
options.OutputPath = Path.GetFullPath(options.OutputPath);
Directory.CreateDirectory(options.OutputPath);
}
catch
{
Console.WriteLine("Output directory could not be created!");
Console.WriteLine();
return false;
}
return true;
}
}
}

39
Test/Printer.cs
View File

@@ -16,20 +16,32 @@ namespace Test
/// <param name="path">File or directory path</param>
/// <param name="json">Enable JSON output, if supported</param>
/// <param name="debug">Enable debug output</param>
#if NET6_0_OR_GREATER
public static void PrintPathInfo(string path, bool json, bool debug)
#else
public static void PrintPathInfo(string path, bool debug)
#endif
{
Console.WriteLine($"Checking possible path: {path}");
// Check if the file or directory exists
if (File.Exists(path))
{
#if NET6_0_OR_GREATER
PrintFileInfo(path, json, debug);
#else
PrintFileInfo(path, debug);
#endif
}
else if (Directory.Exists(path))
{
foreach (string file in Directory.EnumerateFiles(path, "*", SearchOption.AllDirectories))
{
#if NET6_0_OR_GREATER
PrintFileInfo(file, json, debug);
#else
PrintFileInfo(file, debug);
#endif
}
}
else
@@ -41,7 +53,11 @@ namespace Test
/// <summary>
/// Print information for a single file, if possible
/// </summary>
#if NET6_0_OR_GREATER
private static void PrintFileInfo(string file, bool json, bool debug)
#else
private static void PrintFileInfo(string file, bool debug)
#endif
{
Console.WriteLine($"Attempting to print info for {file}");
@@ -260,6 +276,9 @@ namespace Test
// Print the wrapper name
Console.WriteLine($"{wrapperName} wrapper created successfully!");
// Get the base info output name
string filenameBase = $"info-{DateTime.Now:yyyy-MM-dd_HHmmss.ffff}";
#if NET6_0_OR_GREATER
// If we have the JSON flag
if (json)
@@ -269,24 +288,20 @@ namespace Test
Console.WriteLine(serializedData);
// Write the output data
using (var sw = new StreamWriter(File.OpenWrite($"info-{DateTime.Now:yyyy-MM-dd_HHmmss.ffff}.json")))
using (var sw = new StreamWriter(File.OpenWrite($"{filenameBase}.json")))
{
sw.WriteLine(serializedData);
}
}
#endif
// If we don't have the JSON flag
if (!json)
{
// Create the output data
StringBuilder builder = wrapper.PrettyPrint();
Console.WriteLine(builder);
// Create the output data
StringBuilder builder = wrapper.PrettyPrint();
Console.WriteLine(builder);
// Write the output data
using (var sw = new StreamWriter(File.OpenWrite($"info-{DateTime.Now:yyyy-MM-dd_HHmmss.ffff}.txt")))
{
sw.WriteLine(builder.ToString());
}
// Write the output data
using (var sw = new StreamWriter(File.OpenWrite($"{filenameBase}.txt")))
{
sw.WriteLine(builder.ToString());
}
}
}

172
Test/Program.cs
View File

@@ -1,6 +1,4 @@
using System;
using System.Collections.Generic;
using System.IO;
using System.Text;
using BurnOutSharp;
@@ -14,164 +12,52 @@ namespace Test
Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
// Create progress indicator
var p = new Progress<ProtectionProgress>();
p.ProgressChanged += Protector.Changed;
var fileProgress = new Progress<ProtectionProgress>();
fileProgress.ProgressChanged += Protector.Changed;
// Set initial values for scanner flags
bool debug = false, archives = true, contents = true, json = false, packers = true, paths = true, info = false, extract = false;
string outputPath = string.Empty;
var inputPaths = new List<string>();
// Get the options from the arguments
var options = Options.ParseOptions(args);
// Loop through the arguments to get the flags
for (int i = 0; i < args.Length; i++)
// If we have an invalid state
if (options == null)
{
string arg = args[i];
switch (arg)
{
case "-?":
case "-h":
case "--help":
DisplayHelp();
Console.WriteLine("Press enter to close the program...");
Console.ReadLine();
return;
case "-d":
case "--debug":
debug = true;
break;
case "-na":
case "--no-archives":
archives = false;
break;
case "-nc":
case "--no-contents":
contents = false;
break;
#if NET6_0_OR_GREATER
case "-j":
case "--json":
json = true;
break;
#endif
case "-np":
case "--no-packers":
packers = false;
break;
case "-ns":
case "--no-paths":
paths = false;
break;
case "-i":
case "--info":
info = true;
break;
case "-x":
case "--extract":
extract = true;
break;
case "-o":
case "--outdir":
outputPath = i + 1 < args.Length ? args[++i] : null;
break;
default:
inputPaths.Add(arg);
break;
}
}
// If we have no arguments, show the help
if (inputPaths.Count == 0)
{
DisplayHelp();
Options.DisplayHelp();
Console.WriteLine("Press enter to close the program...");
Console.ReadLine();
return;
}
// Create scanner for all paths
var scanner = new Scanner(archives, contents, packers, paths, debug, p);
// If we have extraction, check the output path exists and is valid
if (extract)
{
// Null or empty output path
if (string.IsNullOrWhiteSpace(outputPath))
{
Console.WriteLine("Output directory required for extraction!");
Console.WriteLine();
DisplayHelp();
Console.WriteLine("Press enter to close the program...");
Console.ReadLine();
return;
}
// Malformed output path or invalid location
try
{
outputPath = Path.GetFullPath(outputPath);
Directory.CreateDirectory(outputPath);
}
catch
{
Console.WriteLine("Output directory could not be created!");
Console.WriteLine();
DisplayHelp();
Console.WriteLine("Press enter to close the program...");
Console.ReadLine();
return;
}
}
var scanner = new Scanner(
options.ScanArchives,
options.ScanContents,
options.ScanPackers,
options.ScanPaths,
options.Debug,
fileProgress);
// Loop through the input paths
foreach (string inputPath in inputPaths)
foreach (string inputPath in options.InputPaths)
{
if (info)
Printer.PrintPathInfo(inputPath, json, debug);
else if (extract)
Extractor.ExtractPath(inputPath, outputPath);
else
// Extraction
if (options.EnableExtraction)
Extractor.ExtractPath(inputPath, options.OutputPath);
// Information printing
if (options.EnableInformation)
#if NET6_0_OR_GREATER
Printer.PrintPathInfo(inputPath, options.Json, options.Debug);
#else
Printer.PrintPathInfo(inputPath, options.Debug);
#endif
// Scanning
if (options.EnableScanning)
Protector.GetAndWriteProtections(scanner, inputPath);
}
Console.WriteLine("Press enter to close the program...");
Console.ReadLine();
}
/// <summary>
/// Display help text
/// </summary>
private static void DisplayHelp()
{
Console.WriteLine("BurnOutSharp Test Program");
Console.WriteLine();
Console.WriteLine("test.exe <options> file|directory ...");
Console.WriteLine();
Console.WriteLine("Possible options:");
Console.WriteLine("-?, -h, --help Display this help text and quit");
Console.WriteLine("-d, --debug Enable debug mode");
Console.WriteLine("-nc, --no-contents Disable scanning for content checks");
Console.WriteLine("-na, --no-archives Disable scanning archives");
Console.WriteLine("-np, --no-packers Disable scanning for packers");
Console.WriteLine("-ns, --no-paths Disable scanning for path checks");
Console.WriteLine("-i, --info Print executable info");
#if NET6_0_OR_GREATER
Console.WriteLine("-j, --json Print executable info as JSON");
#endif
Console.WriteLine("-x, --extract Extract archive formats (Requires -o)");
Console.WriteLine("-o, --outdir [PATH] Set output path for extraction (Requires -x)");
}
}
}

36
Test/Properties/AssemblyInfo.cs
View File

@@ -1,36 +0,0 @@
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
// General Information about an assembly is controlled through the following
// set of attributes. Change these attribute values to modify the information
// associated with an assembly.
[assembly: AssemblyTitle("Test")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("")]
[assembly: AssemblyProduct("Test")]
[assembly: AssemblyCopyright("Copyright © 2018")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]
// Setting ComVisible to false makes the types in this assembly not visible
// to COM components. If you need to access a type in this assembly from
// COM, set the ComVisible attribute to true on that type.
[assembly: ComVisible(false)]
// The following GUID is for the ID of the typelib if this project is exposed to COM
[assembly: Guid("88735ba2-778d-4192-8eb2-fff6843719e2")]
// Version information for an assembly consists of the following four values:
//
// Major Version
// Minor Version
// Build Number
// Revision
//
// You can specify all the values or you can default the Build and Revision Numbers
// by using the '*' as shown below:
// [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyFileVersion("1.0.0.0")]