feat(scan): provide a default scan factory (#76)

closes #68

src/SecTester.Core/Utils/StringUtils.cs

@@ -1,5 +1,4 @@
 using System.Linq;
-using System.Text;
 using System.Text.RegularExpressions;
 
 namespace SecTester.Core.Utils;
@@ -21,6 +20,10 @@ public static class StringUtils
       : SupportedCaseRegexes.Aggregate(value!,
           (input, regex) => regex.Replace(input, "$1_$2"))
         .ToLowerInvariant();
+  }
 
+  public static string Truncate(this string value, int n)
+  {
+    return value.Length > n ? Regex.Replace(value.Substring(0, n), @"\w$", "…") : value;
   }
 }

src/SecTester.Scan/CI/DefaultCiDiscovery.cs

@@ -6,5 +6,4 @@ internal class DefaultCiDiscovery : CiDiscovery
   public CiServer? Server { get; }
 
   public bool IsCi => Server != null;
-
 }

src/SecTester.Scan/Commands/CreateScan.cs

@@ -27,7 +27,16 @@ public CreateScan(ScanConfig config, string configurationName, string configurat
       config.ProjectId,
       config.SlowEpTimeout,
       config.TargetTimeout,
-      Info = new { Source = "utlib", client = new { Name = configurationName, Version = configurationVersion }, Provider = ciProvider }
+      Info = new
+      {
+        Source = "utlib",
+        client = new
+        {
+          Name = configurationName,
+          Version = configurationVersion
+        },
+        Provider = ciProvider
+      }
     };
 
     Body = new StringContent(MessageSerializer.Serialize(payload), Encoding.UTF8, "application/json");

src/SecTester.Scan/Commands/UploadHar.cs

@@ -13,16 +13,17 @@ public UploadHar(UploadHarOptions options)
     : base("/api/v1/files", HttpMethod.Post)
   {
     Params = options.Discard
-      ? new[] { new KeyValuePair<string, string>("discard", options.Discard.ToString().ToLowerInvariant()) }
+      ? new[]
+      {
+        new KeyValuePair<string, string>("discard", options.Discard.ToString().ToLowerInvariant())
+      }
       : default;
 
 
     var content = new MultipartFormDataContent
     {
       {
-        new StringContent(MessageSerializer.Serialize(options.Har), Encoding.UTF8, "application/json"),
-        "file",
-        options.FileName
+        new StringContent(MessageSerializer.Serialize(options.Har), Encoding.UTF8, "application/json"), "file", options.FileName
       }
     };
 

src/SecTester.Scan/DefaultScanFactory.cs

@@ -0,0 +1,116 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using SecTester.Core;
+using SecTester.Core.Utils;
+using SecTester.Scan.Models;
+using SecTester.Scan.Models.HarSpec;
+
+namespace SecTester.Scan;
+
+public class DefaultScanFactory : ScanFactory
+{
+  internal const int MaxSlugLength = 200;
+
+  private static readonly IEnumerable<Discovery> DefaultDiscoveryTypes = new List<Discovery>
+  {
+    Discovery.Archive
+  };
+
+  private readonly Configuration _configuration;
+  private readonly ILogger _logger;
+
+  private readonly Scans _scans;
+  private readonly SystemTimeProvider _systemTimeProvider;
+
+  public DefaultScanFactory(Configuration configuration, Scans scans, ILogger logger,
+    SystemTimeProvider systemTimeProvider)
+  {
+    _scans = scans ?? throw new ArgumentNullException(nameof(scans));
+    _configuration = configuration ?? throw new ArgumentNullException(nameof(configuration));
+    _systemTimeProvider = systemTimeProvider ?? throw new ArgumentNullException(nameof(systemTimeProvider));
+    _logger = logger ?? throw new ArgumentNullException(nameof(logger));
+  }
+
+  public async Task<Scan> CreateScan(ScanSettingsOptions settingsOptions, ScanOptions? options)
+  {
+    var scanConfig = await BuildScanConfig(new ScanSettings(settingsOptions)).ConfigureAwait(false);
+    var scanId = await _scans.CreateScan(scanConfig).ConfigureAwait(false);
+
+    return new Scan(scanId, _scans, _logger, options ?? new ScanOptions());
+  }
+
+  private async Task<ScanConfig> BuildScanConfig(ScanSettings scanSettings)
+  {
+    var fileId = await CreateAndUploadHar((Target)scanSettings.Target).ConfigureAwait(false);
+
+    return new ScanConfig(scanSettings.Name!)
+    {
+      FileId = fileId,
+      Smart = scanSettings.Smart,
+      PoolSize = scanSettings.PoolSize,
+      SkipStaticParams = scanSettings.SkipStaticParams,
+      Module = Module.Dast,
+      DiscoveryTypes = DefaultDiscoveryTypes,
+      AttackParamLocations = scanSettings.AttackParamLocations,
+      Tests = scanSettings.Tests,
+      Repeaters = scanSettings.RepeaterId is null
+        ? default
+        : new List<string>
+        {
+          scanSettings.RepeaterId
+        },
+      SlowEpTimeout =
+        scanSettings.SlowEpTimeout is null ? default : (int)scanSettings.SlowEpTimeout.Value.TotalSeconds,
+      TargetTimeout =
+        scanSettings.TargetTimeout is null ? default : (int)scanSettings.TargetTimeout.Value.TotalSeconds
+    };
+  }
+
+  private async Task<string> CreateAndUploadHar(Target target)
+  {
+    var filename = GenerateFileName(target.Url);
+    var har = await CreateHar(target).ConfigureAwait(false);
+
+    return await _scans.UploadHar(new UploadHarOptions(har, filename, true)).ConfigureAwait(false);
+  }
+
+  private static string GenerateFileName(string url)
+  {
+    var host = new Uri(url).Host;
+
+    host = host.Length <= MaxSlugLength ? host : host.Substring(0, MaxSlugLength);
+
+    return $"{host.TrimEnd(".-".ToCharArray())}-{Guid.NewGuid()}.har";
+  }
+
+  private async Task<Entry> CreateHarEntry(Target target)
+  {
+    return new Entry(_systemTimeProvider.Now,
+      await target.ToHarRequest().ConfigureAwait(false),
+      new ResponseMessage(200, "OK", "", new Content(-1, "text/plain"))
+      {
+        HttpVersion = "HTTP/1.1"
+      },
+      new Timings(),
+      new Cache()
+    );
+  }
+
+  private async Task<Har> CreateHar(Target target)
+  {
+    var entry = await CreateHarEntry(target).ConfigureAwait(false);
+
+    return new Har(
+      new Log(
+        new Tool(_configuration.Name, _configuration.Version))
+      {
+        Entries = new List<Entry>
+        {
+          entry
+        }
+      }
+    );
+  }
+}

src/SecTester.Scan/DefaultScans.cs

@@ -11,9 +11,9 @@ namespace SecTester.Scan;
 
 public class DefaultScans : Scans
 {
-  private readonly Configuration _configuration;
-  private readonly CommandDispatcher _commandDispatcher;
   private readonly CiDiscovery _ciDiscovery;
+  private readonly CommandDispatcher _commandDispatcher;
+  private readonly Configuration _configuration;
 
   public DefaultScans(Configuration configuration, CommandDispatcher commandDispatcher, CiDiscovery ciDiscovery)
   {
@@ -60,7 +60,7 @@ public async Task<string> UploadHar(UploadHarOptions options)
 
   private async Task<T> SendCommand<T>(Command<T> command)
   {
-    var result = await this._commandDispatcher.Execute(command).ConfigureAwait(false);
+    var result = await _commandDispatcher.Execute(command).ConfigureAwait(false);
 
     return AssertReply(result);
   }

src/SecTester.Scan/Models/HarSpec/Cache.cs

@@ -0,0 +1,3 @@
+namespace SecTester.Scan.Models.HarSpec;
+
+public record Cache;

src/SecTester.Scan/Models/HarSpec/Content.cs

@@ -0,0 +1,3 @@
+namespace SecTester.Scan.Models.HarSpec;
+
+public record Content(int Size, string MimeType);

src/SecTester.Scan/Target/Har/Cookie.cs → src/SecTester.Scan/Models/HarSpec/Cookie.cs

@@ -1,6 +1,6 @@
 using System;
 
-namespace SecTester.Scan.Target.Har;
+namespace SecTester.Scan.Models.HarSpec;
 
 public record Cookie(string Name, string Value) : Parameter(Name, Value)
 {

src/SecTester.Scan/Models/HarSpec/Entry.cs

@@ -0,0 +1,8 @@
+using System;
+
+namespace SecTester.Scan.Models.HarSpec;
+
+public record Entry(DateTime StartedDateTime, RequestMessage RequestMessage, ResponseMessage ResponseMessage, Timings Timings, Cache Cache)
+{
+  public int Time { get; init; }
+}

src/SecTester.Scan/Target/Har/Message.cs → src/SecTester.Scan/Models/HarSpec/EntryMessage.cs

@@ -1,11 +1,11 @@
 using System.Collections.Generic;
 
-namespace SecTester.Scan.Target.Har;
+namespace SecTester.Scan.Models.HarSpec;
 
-public record Message
+public record EntryMessage
 {
   public int HeadersSize { get; init; } = -1;
-  public int? BodySize { get; init; } = -1;
+  public int BodySize { get; init; } = -1;
   public IEnumerable<Cookie> Cookies { get; init; } = new List<Cookie>();
   public IEnumerable<Header> Headers { get; init; } = new List<Header>();
   public string HttpVersion { get; init; } = "HTTP/0.9";

src/SecTester.Scan/Models/HarSpec/Har.cs

@@ -0,0 +1,3 @@
+namespace SecTester.Scan.Models.HarSpec;
+
+public record Har(Log Log);

src/SecTester.Scan/Target/Har/Header.cs → src/SecTester.Scan/Models/HarSpec/Header.cs

@@ -1,3 +1,3 @@
-namespace SecTester.Scan.Target.Har;
+namespace SecTester.Scan.Models.HarSpec;
 
 public record Header(string Name, string Value) : Parameter(Name, Value);

src/SecTester.Scan/Models/HarSpec/Log.cs

@@ -0,0 +1,9 @@
+using System.Collections.Generic;
+
+namespace SecTester.Scan.Models.HarSpec;
+
+public record Log(Tool Creator)
+{
+  public IEnumerable<Entry> Entries { get; init; } = new List<Entry>();
+  public string Version { get; init; } = "1.2";
+}

src/SecTester.Scan/Target/Har/Parameter.cs → src/SecTester.Scan/Models/HarSpec/Parameter.cs

@@ -1,3 +1,3 @@
-namespace SecTester.Scan.Target.Har;
+namespace SecTester.Scan.Models.HarSpec;
 
 public record Parameter(string Name, string Value);

src/SecTester.Scan/Target/Har/PostData.cs → src/SecTester.Scan/Models/HarSpec/PostData.cs

@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 
-namespace SecTester.Scan.Target.Har;
+namespace SecTester.Scan.Models.HarSpec;
 
 public record PostData
 {

src/SecTester.Scan/Target/Har/PostDataParameter.cs → src/SecTester.Scan/Models/HarSpec/PostDataParameter.cs

@@ -1,4 +1,4 @@
-namespace SecTester.Scan.Target.Har;
+namespace SecTester.Scan.Models.HarSpec;
 
 public record PostDataParameter(string Name, string Value) : Parameter(Name, Value)
 {

src/SecTester.Scan/Target/Har/QueryParameter.cs → src/SecTester.Scan/Models/HarSpec/QueryParameter.cs

@@ -1,3 +1,3 @@
-namespace SecTester.Scan.Target.Har;
+namespace SecTester.Scan.Models.HarSpec;
 
 public record QueryParameter(string Name, string Value) : Parameter(Name, Value);

src/SecTester.Scan/Target/Har/Request.cs → src/SecTester.Scan/Models/HarSpec/RequestMessage.cs

@@ -1,8 +1,8 @@
 using System.Collections.Generic;
 
-namespace SecTester.Scan.Target.Har;
+namespace SecTester.Scan.Models.HarSpec;
 
-public record Request : Message
+public record RequestMessage : EntryMessage
 {
   public string? Method { get; init; }
   public string? Url { get; init; }

src/SecTester.Scan/Models/HarSpec/ResponseMessage.cs

@@ -0,0 +1,3 @@
+namespace SecTester.Scan.Models.HarSpec;
+
+public record ResponseMessage(int Status, string StatusText, string RedirectUrl, Content Content) : EntryMessage;

src/SecTester.Scan/Models/HarSpec/Timings.cs

@@ -0,0 +1,3 @@
+namespace SecTester.Scan.Models.HarSpec;
+
+public record Timings(int Send = 0, int Wait = 0, int Receive = 0);

src/SecTester.Scan/Models/HarSpec/Tool.cs

@@ -0,0 +1,3 @@
+namespace SecTester.Scan.Models.HarSpec;
+
+public record Tool(string Name, string Version);

src/SecTester.Scan/Models/Identifiable.cs

@@ -1,7 +1,8 @@
 using System;
+
 namespace SecTester.Scan.Models;
 
 public record Identifiable<T>(T Id)
 {
   public T Id { get; } = Id ?? throw new ArgumentNullException(nameof(Id));
-};
+}

src/SecTester.Scan/Models/ScanConfig.cs

@@ -5,7 +5,7 @@ namespace SecTester.Scan.Models;
 
 public record ScanConfig(string Name)
 {
-  public string Name { get; init; } = Name ?? throw new ArgumentNullException(nameof(Name));
+  public string Name { get; } = Name ?? throw new ArgumentNullException(nameof(Name));
   public Module? Module { get; init; }
   public IEnumerable<TestType>? Tests { get; init; }
   public IEnumerable<Discovery>? DiscoveryTypes { get; init; }

src/SecTester.Scan/Target/Target.cs → src/SecTester.Scan/Models/Target.cs

@@ -5,9 +5,9 @@
 using System.Text;
 using System.Threading.Tasks;
 using SecTester.Core.Utils;
-using SecTester.Scan.Target.Har;
+using SecTester.Scan.Models.HarSpec;
 
-namespace SecTester.Scan.Target;
+namespace SecTester.Scan.Models;
 
 public sealed class Target : TargetOptions
 {
@@ -242,7 +242,7 @@ public Target WithHeaders(IEnumerable<KeyValuePair<string, IEnumerable<string>>>
   /// <summary>
   ///   Returns a HAR request containing detailed info about performed request
   /// </summary>
-  internal async Task<Request> ToHarRequest()
+  internal async Task<RequestMessage> ToHarRequest()
   {
     var uriBuilder = new UriBuilder(Url)
     {
@@ -254,7 +254,7 @@ internal async Task<Request> ToHarRequest()
     var headers = BuildHeaderParameters();
     var postData = _bodyGenerator is not null ? await _bodyGenerator.Invoke().ConfigureAwait(false) : null;
 
-    return new Request
+    return new RequestMessage
     {
       Url = url,
       Headers = headers,

src/SecTester.Scan/Target/TargetOptions.cs → src/SecTester.Scan/Models/TargetOptions.cs

@@ -1,7 +1,7 @@
 using System.Collections.Generic;
 using System.Net.Http;
 
-namespace SecTester.Scan.Target;
+namespace SecTester.Scan.Models;
 
 public interface TargetOptions
 {

src/SecTester.Scan/Models/UploadHarOptions.cs

@@ -1,5 +1,5 @@
 using System;
-using SecTester.Scan.Target.Har;
+using SecTester.Scan.Models.HarSpec;
 
 namespace SecTester.Scan.Models;