Merge pull request #20 from mindcollapse/v1.1

Multiple improvements for version 1.1

Author: volodymyrsmirnov

MalwareMultiScan.Api/Attributes/IsHttpUrlAttribute.cs

@@ -8,9 +8,23 @@ namespace MalwareMultiScan.Api.Attributes
     /// </summary>
     public class IsHttpUrlAttribute : ValidationAttribute
     {
+        private readonly bool _failOnNull;
+
+        /// <summary>
+        /// Initialize http URL validation attribute.
+        /// </summary>
+        /// <param name="failOnNull">True if URL is mandatory, false otherwise.</param>
+        public IsHttpUrlAttribute(bool failOnNull = true)
+        {
+            _failOnNull = failOnNull;
+        }
+
         /// <inheritdoc />
         protected override ValidationResult IsValid(object value, ValidationContext validationContext)
         {
+            if (!_failOnNull && string.IsNullOrEmpty(value.ToString()))
+                return ValidationResult.Success;
+
             if (!Uri.TryCreate((string) value, UriKind.Absolute, out var uri)
                 || !uri.IsAbsoluteUri
                 || uri.Scheme.ToLowerInvariant() != "http"

MalwareMultiScan.Api/Controllers/QueueController.cs

@@ -1,3 +1,4 @@
+using System;
 using System.ComponentModel.DataAnnotations;
 using System.Threading.Tasks;
 using MalwareMultiScan.Api.Attributes;
@@ -31,13 +32,16 @@ public QueueController(IScanResultService scanResultService)
         /// Queue file for scanning.
         /// </summary>
         /// <param name="file">File from form data.</param>
+        /// <param name="callbackUrl">Optional callback URL.</param>
         [HttpPost("file")]
         [ProducesResponseType(typeof(ScanResult), StatusCodes.Status201Created)]
         [ProducesResponseType(StatusCodes.Status400BadRequest)]
         public async Task<IActionResult> ScanFile(
-            [Required] [MaxFileSize] IFormFile file)
+            [Required] [MaxFileSize] IFormFile file,
+            [FromForm] [IsHttpUrl(false)] string callbackUrl = null)
         {
-            var result = await _scanResultService.CreateScanResult();
+            var result = await _scanResultService.CreateScanResult(
+                string.IsNullOrEmpty(callbackUrl) ? null : new Uri(callbackUrl));
 
             string storedFileId;
 
@@ -56,13 +60,16 @@ public async Task<IActionResult> ScanFile(
         /// Queue URL for scanning.
         /// </summary>
         /// <param name="url">URL from form data.</param>
+        /// <param name="callbackUrl">Optional callback URL.</param>
         [HttpPost("url")]
         [ProducesResponseType(typeof(ScanResult), StatusCodes.Status201Created)]
         [ProducesResponseType(StatusCodes.Status400BadRequest)]
         public async Task<IActionResult> ScanUrl(
-            [FromForm] [Required] [IsHttpUrl] string url)
+            [FromForm] [Required] [IsHttpUrl] string url,
+            [FromForm] [IsHttpUrl(false)] string callbackUrl = null)
         {
-            var result = await _scanResultService.CreateScanResult();
+            var result = await _scanResultService.CreateScanResult(
+                string.IsNullOrEmpty(callbackUrl) ? null : new Uri(callbackUrl));
 
             await _scanResultService.QueueUrlScan(result, url);
 

MalwareMultiScan.Api/Controllers/ScanResultsController.cs

@@ -15,7 +15,7 @@ namespace MalwareMultiScan.Api.Controllers
     public class ScanResultsController : Controller
     {
         private readonly IScanResultService _scanResultService;
-        
+
         /// <summary>
         /// Initialize scan results controller.
         /// </summary>

MalwareMultiScan.Api/Data/Configuration/ScanBackend.cs

@@ -9,7 +9,7 @@ public class ScanBackend
         /// Backend id.
         /// </summary>
         public string Id { get; set; }
-        
+
         /// <summary>
         /// Backend state.
         /// </summary>

MalwareMultiScan.Api/Data/Models/ScanResult.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization.Attributes;
@@ -17,7 +18,12 @@ public class ScanResult
         public string Id { get; set; }
 
         /// <summary>
-        /// Result entries where key is backend id and value is <see cref="ScanResultEntry"/>.
+        /// Optional callback URL.
+        /// </summary>
+        public Uri CallbackUrl { get; set; }
+
+        /// <summary>
+        /// Result entries where key is backend id and value is <see cref="ScanResultEntry" />.
         /// </summary>
         public Dictionary<string, ScanResultEntry> Results { get; set; } =
             new Dictionary<string, ScanResultEntry>();

MalwareMultiScan.Api/Data/Models/ScanResultEntry.cs

@@ -9,17 +9,17 @@ public class ScanResultEntry
         /// Completion status.
         /// </summary>
         public bool Completed { get; set; }
-        
+
         /// <summary>
         /// Indicates that scanning completed without error.
         /// </summary>
         public bool? Succeeded { get; set; }
-        
+
         /// <summary>
         /// Scanning duration in seconds.
         /// </summary>
         public long Duration { get; set; }
-        
+
         /// <summary>
         /// Detected names of threats.
         /// </summary>

MalwareMultiScan.Api/Services/Implementations/ReceiverHostedService.cs

@@ -1,10 +1,14 @@
+using System;
+using System.Net.Http;
+using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
 using EasyNetQ;
 using MalwareMultiScan.Api.Services.Interfaces;
 using MalwareMultiScan.Backends.Messages;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.Logging;
+using Newtonsoft.Json;
 
 namespace MalwareMultiScan.Api.Services.Implementations
 {
@@ -13,6 +17,7 @@ public class ReceiverHostedService : IReceiverHostedService
     {
         private readonly IBus _bus;
         private readonly IConfiguration _configuration;
+        private readonly IHttpClientFactory _httpClientFactory;
         private readonly ILogger<ReceiverHostedService> _logger;
         private readonly IScanResultService _scanResultService;
 
@@ -23,31 +28,23 @@ public class ReceiverHostedService : IReceiverHostedService
         /// <param name="configuration">Configuration.</param>
         /// <param name="scanResultService">Scan result service.</param>
         /// <param name="logger">Logger.</param>
+        /// <param name="httpClientFactory">HTTP client factory.</param>
         public ReceiverHostedService(IBus bus, IConfiguration configuration, IScanResultService scanResultService,
-            ILogger<ReceiverHostedService> logger)
+            ILogger<ReceiverHostedService> logger, IHttpClientFactory httpClientFactory)
         {
             _bus = bus;
             _configuration = configuration;
             _scanResultService = scanResultService;
             _logger = logger;
+            _httpClientFactory = httpClientFactory;
         }
 
 
         /// <inheritdoc />
         public Task StartAsync(CancellationToken cancellationToken)
         {
-            _bus.Receive<ScanResultMessage>(_configuration.GetValue<string>("ResultsSubscriptionId"), async message =>
-            {
-                message.Threats ??= new string[] { };
-
-                _logger.LogInformation(
-                    $"Received a result from {message.Backend} for {message.Id} " +
-                    $"with threats {string.Join(",", message.Threats)}");
-
-                await _scanResultService.UpdateScanResultForBackend(
-                    message.Id, message.Backend, message.Duration, true,
-                    message.Succeeded, message.Threats);
-            });
+            _bus.Receive<ScanResultMessage>(
+                _configuration.GetValue<string>("ResultsSubscriptionId"), StoreScanResult);
 
             _logger.LogInformation(
                 "Started hosted service for receiving scan results");
@@ -65,5 +62,42 @@ public Task StopAsync(CancellationToken cancellationToken)
 
             return Task.CompletedTask;
         }
+
+        private async Task StoreScanResult(ScanResultMessage message)
+        {
+            message.Threats ??= new string[] { };
+
+            _logger.LogInformation(
+                $"Received a result from {message.Backend} for {message.Id} " +
+                $"with threats {string.Join(",", message.Threats)}");
+
+            await _scanResultService.UpdateScanResultForBackend(
+                message.Id, message.Backend, message.Duration, true,
+                message.Succeeded, message.Threats);
+
+            var result = await _scanResultService.GetScanResult(message.Id);
+
+            if (result?.CallbackUrl == null)
+                return;
+
+            var cancellationTokenSource = new CancellationTokenSource(
+                TimeSpan.FromSeconds(3));
+
+            using var httpClient = _httpClientFactory.CreateClient();
+
+            try
+            {
+                var response = await httpClient.PostAsync(
+                    result.CallbackUrl,
+                    new StringContent(JsonConvert.SerializeObject(result), Encoding.UTF8, "application/json"),
+                    cancellationTokenSource.Token);
+
+                response.EnsureSuccessStatusCode();
+            }
+            catch (Exception exception)
+            {
+                _logger.LogError(exception, $"Failed to POST to callback URL {result.CallbackUrl}");
+            }
+        }
     }
 }

MalwareMultiScan.Api/Services/Implementations/ScanResultService.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using System.Linq;
 using System.Threading.Tasks;
@@ -31,12 +32,14 @@ public ScanResultService(IMongoDatabase db, IGridFSBucket bucket, IScanBackendSe
 
             _collection = db.GetCollection<ScanResult>(CollectionName);
         }
-        
+
         /// <inheritdoc />
-        public async Task<ScanResult> CreateScanResult()
+        public async Task<ScanResult> CreateScanResult(Uri callbackUrl)
         {
             var scanResult = new ScanResult
             {
+                CallbackUrl = callbackUrl,
+
                 Results = _scanBackendService.List
                     .Where(b => b.Enabled)
                     .ToDictionary(k => k.Id, v => new ScanResultEntry())

MalwareMultiScan.Api/Services/Interfaces/IScanResultService.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using System.Threading.Tasks;
 using MalwareMultiScan.Api.Data.Models;
@@ -12,8 +13,9 @@ public interface IScanResultService
         /// <summary>
         /// Create scan result.
         /// </summary>
+        /// <param name="callbackUrl">Optional callback URL.</param>
         /// <returns>Scan result entry with id.</returns>
-        Task<ScanResult> CreateScanResult();
+        Task<ScanResult> CreateScanResult(Uri callbackUrl);
 
         /// <summary>
         /// Get scan result.

MalwareMultiScan.Api/Startup.cs

@@ -38,6 +38,8 @@ public void ConfigureServices(IServiceCollection services)
             services.AddControllers();
 
             services.AddHostedService<ReceiverHostedService>();
+
+            services.AddHttpClient();
         }
 
         public void Configure(IApplicationBuilder app)