ImageWizardOptions: Use key property as byte array

Author: usercode

README.md

@@ -83,9 +83,9 @@ services.AddImageWizard();
 
 services.AddImageWizard(options => 
                        {
-                           options.AllowUnsafeUrl = true;             
-                           options.AllowedDPR = new[] { 1.0, 1.5, 2.0, 3.0, 4.0 };
-                           options.Key = "DEMO-KEY..."; //64 byte key encoded in Base64Url
+                           options.AllowUnsafeUrl = true;
+                           options.AllowedDPR = new double[] { 1.0, 1.5, 2.0, 3.0, 4.0 };
+                           options.Key = new byte[64] { .. };
                            options.UseETag = true;                                                
                            options.CacheControl.IsEnabled = true;
                            options.CacheControl.MaxAge = TimeSpan.FromDays(365);
@@ -507,7 +507,7 @@ static:
     volumes:
       - file_cache:/data
     environment:
-      - General__Key=DEMO-KEY---PLEASE-CHANGE-THIS-KEY---PLEASE-CHANGE-THIS-KEY---PLEASE-CHANGE-THIS-KEY---==
+      - General__Key=DEMO+KEY+++PLEASE+CHANGE+THIS+KEY+++PLEASE+CHANGE+THIS+KEY+++PLEASE+CHANGE+THIS+KEY+++==
       - General__AllowUnsafeUrl=false
       - General__UseAcceptHeader=false
       - General__UseETag=true

src/ImageWizard.Client/Builder/UrlBuilderContext.cs

@@ -67,7 +67,7 @@ public string BuildUrl()
 
         if (ImageUrlBuilder.Settings.UseUnsafeUrl == false)
         {
-            signature = signatureService.Encrypt(ImageUrlBuilder.Settings.KeyInBytes, new ImageWizardRequest(url, new HostString(ImageUrlBuilder.Settings.Host)));
+            signature = signatureService.Encrypt(ImageUrlBuilder.Settings.Key, new ImageWizardRequest(url, new HostString(ImageUrlBuilder.Settings.Host)));
         }
 
         return $"{ImageUrlBuilder.Settings.BaseUrl.TrimEnd('/')}/{signature}/{url.Path}";

src/ImageWizard.Core/Middlewares/ImageWizardApi.cs

@@ -91,7 +91,7 @@ public async Task ExecuteAsync(
         else
         {
             //check signature
-            string validSignature = signatureService.Encrypt(options.Value.KeyInBytes, new ImageWizardRequest(url, context.Request.Host));
+            string validSignature = signatureService.Encrypt(options.Value.Key, new ImageWizardRequest(url, context.Request.Host));
 
             if (signature == validSignature)
             {

src/ImageWizard.Core/Middlewares/ImageWizardOptions.cs

@@ -28,8 +28,6 @@ public ImageWizardOptions()
         UseAcceptHeader = false;
         RefreshLastAccessInterval = TimeSpan.FromDays(1);
 
-        Key = string.Empty;
-
         AllowedDPR = ImageWizardDefaults.AllowedDPR;
 
         CacheControl = new CacheControl();
@@ -74,16 +72,4 @@ public ImageWizardOptions()
     /// FallbackHandler
     /// </summary>
     public FallbackHandler? FallbackHandler { get; set; }
-
-    /// <summary>
-    /// Generates random 64 byte key.
-    /// </summary>
-    public void GenerateRandomKey()
-    {
-        //generate random key
-        byte[] keyBuffer = new byte[64];
-        RandomNumberGenerator.Create().GetBytes(keyBuffer);
-
-        Key = WebEncoders.Base64UrlEncode(keyBuffer);
-    }
 }

src/ImageWizard.TestApp/Startup.cs

@@ -36,10 +36,10 @@ public Startup(IConfiguration configuration)
     // This method gets called by the runtime. Use this method to add services to the container.
     public void ConfigureServices(IServiceCollection services)
     {
-        //generate random key
-        byte[] keyBuffer = RandomNumberGenerator.GetBytes(64);
+        services.Configure<ImageWizardOptions>(Configuration.GetSection("General"));
 
-        string key = WebEncoders.Base64UrlEncode(keyBuffer);
+        //generate random key
+        byte[] key = RandomNumberGenerator.GetBytes(64);
 
         services.AddImageWizard(x =>
         {

src/ImageWizard.TestApp/appsettings.Development.json

@@ -5,5 +5,8 @@
       "System": "Information",
       "Microsoft": "Information"
     }
+  },
+  "General": {
+    "Key": "DEMO+KEY+++PLEASE+CHANGE+THIS+KEY+++PLEASE+CHANGE+THIS+KEY+++PLEASE+CHANGE+THIS+KEY+++=="
   }
 }

src/ImageWizard.Utils/ImageWizardBaseOptions.cs

@@ -15,33 +15,11 @@ public abstract class ImageWizardBaseOptions
 {
     public ImageWizardBaseOptions()
     {
-        _key = string.Empty;
-        _keyDecoded = Array.Empty<byte>();
-    }
-
-    private string _key;
-    private byte[] _keyDecoded;
-
-    /// <summary>
-    /// Key encoded in Base64Url
-    /// </summary>
-    public string Key
-    {
-        get => _key;
-        set
-        {
-            if (_key != value)
-            {
-                _key = value;
-
-                _keyDecoded = WebEncoders.Base64UrlDecode(_key);
-            }
-        }
+        Key = Array.Empty<byte>();
     }
 
     /// <summary>
-    /// GetKeyInBytes
+    /// Key
     /// </summary>
-    /// <returns></returns>
-    public byte[] KeyInBytes => _keyDecoded;
+    public byte[] Key { get; set; }
 }