Remove Origin property and make Origins readonly (#393)

passwordless-lib · Jun 26, 2023 · 53caf81 · 53caf81
1 parent 2cc296d
commit 53caf81
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 28 deletions.
diff --git a/Demo/TestController.cs b/Demo/TestController.cs
@@ -10,7 +10,6 @@
 
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
-using Microsoft.Extensions.Caching.Distributed;
 using Microsoft.Extensions.Options;
 
 namespace Fido2Demo;

diff --git a/Src/Fido2.Models/Fido2Configuration.cs b/Src/Fido2.Models/Fido2Configuration.cs
@@ -7,8 +7,8 @@ namespace Fido2NetLib;
 
 public class Fido2Configuration
 {
-    private ISet<string> _origins;
-    private ISet<string> _fullyQualifiedOrigins;
+    private IReadOnlySet<string> _origins;
+    private IReadOnlySet<string> _fullyQualifiedOrigins;
 
     /// <summary>
     /// Create the configuration for Fido2.
@@ -34,7 +34,7 @@ public Fido2Configuration()
     public int ChallengeSize { get; set; } = 16;
 
     /// <summary>
-    /// The effetive domain of the RP. Should be unique and will be used as the identity for the RP.
+    /// The effective domain of the RP. Should be unique and will be used as the identity for the RP.
     /// </summary>
     public string ServerDomain { get; set; }
 
@@ -48,30 +48,16 @@ public Fido2Configuration()
     /// </summary>
     public string ServerIcon { get; set; }
 
-    /// <summary>
-    /// Server origin, including protocol host and port.
-    /// </summary>
-    [Obsolete("This property is obsolete. Use Origins instead.")]
-    public string Origin { get; set; }
-
     /// <summary>
     /// Server origins, including protocol host and port.
     /// </summary>
-    public ISet<string> Origins
+    public IReadOnlySet<string> Origins
     {
         get
         {
             if (_origins == null)
             {
-                _origins = new HashSet<string>();
-
-                // Since we're depricating Origin we ease the transition to move the value automatically, unless its null
-#pragma warning disable CS0618 // Type or member is obsolete
-                if (Origin != null)
-                {
-                    _origins.Add(Origin);
-                }
-#pragma warning restore CS0618 // Type or member is obsolete
+                _origins = new HashSet<string>(0);
             }
 
             return _origins;
@@ -87,15 +73,17 @@ public ISet<string> Origins
     /// <summary>
     /// Fully Qualified Server origins, generated automatically from Origins.
     /// </summary>
-    public ISet<string> FullyQualifiedOrigins
+    public IReadOnlySet<string> FullyQualifiedOrigins
     {
-        get => _fullyQualifiedOrigins ?? new HashSet<string>
+        get
         {
-#pragma warning disable CS0618
-            Origin?.ToFullyQualifiedOrigin()
-#pragma warning restore CS0618
-        };
-        private set => _fullyQualifiedOrigins = value;
+            if (_fullyQualifiedOrigins == null)
+            {
+                Origins = new HashSet<string>(0);
+            }
+
+            return _fullyQualifiedOrigins;
+        }
     }
 
     /// <summary>

diff --git a/Src/Fido2/AuthenticatorResponse.cs b/Src/Fido2/AuthenticatorResponse.cs
@@ -63,7 +63,7 @@ protected AuthenticatorResponse(ReadOnlySpan<byte> utf8EncodedJson)
     [JsonPropertyName("origin")]
     public string Origin { get; set; }
 
-    protected void BaseVerify(ISet<string> fullyQualifiedExpectedOrigins, ReadOnlySpan<byte> originalChallenge)
+    protected void BaseVerify(IReadOnlySet<string> fullyQualifiedExpectedOrigins, ReadOnlySpan<byte> originalChallenge)
     {
         if (Type is not "webauthn.create" && Type is not "webauthn.get")
             throw new Fido2VerificationException(Fido2ErrorCode.InvalidAuthenticatorResponse, $"Type must be 'webauthn.create' or 'webauthn.get'. Was '{Type}'");