Simplify option classes (#15)

jpassing · Mar 15, 2024 · 23920da · 23920da
1 parent d85c2a6
commit 23920da
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 20 deletions.
diff --git a/sources/Jpki.Security.WebAuthn.Test/Security/WebAuthn/Windows/TestWindowsHello.cs b/sources/Jpki.Security.WebAuthn.Test/Security/WebAuthn/Windows/TestWindowsHello.cs
@@ -126,7 +126,7 @@ public void WhenNoPlatformAuthenticatorPresent_ThenCreateCredentialThrowsExcepti
                         ClientData.FromJson("{}"),
                         new AttestationOptions()
                         {
-                            Authenticator = AuthenticatorAttachment.Platform
+                            AuthenticatorAttachment = AuthenticatorAttachment.Platform
                         },
                         CancellationToken.None)
                     .Wait());

diff --git a/sources/Jpki.Security.WebAuthn/Security/WebAuthn/IAuthenticator.cs b/sources/Jpki.Security.WebAuthn/Security/WebAuthn/IAuthenticator.cs
@@ -27,6 +27,9 @@
 
 namespace Jpki.Security.WebAuthn
 {
+    /// <summary>
+    /// WebAuthn authenticator.
+    /// </summary>
     public interface IAuthenticator
     {
         /// <summary>
@@ -51,41 +54,61 @@ Task<Assertion> CreateAssertionAsync(
             CancellationToken cancellationToken);
     }
 
+    public abstract class AuthenticatorOptions
+    {
+
+        /// <summary>
+        /// Types of authenticator the user is allowed to use.
+        /// </summary>
+        public AuthenticatorAttachment AuthenticatorAttachment { get; set; }
+            = AuthenticatorAttachment.Any;
+
+        /// <summary>
+        /// Type of verification the user is expected to perform.
+        /// </summary>
+        public UserVerificationRequirement UserVerification { get; set; }
+            = UserVerificationRequirement.Any;
+
+        /// <summary>
+        /// Timeout allotted for authentication.
+        /// </summary>
+        public TimeSpan Timeout { get; set; } = TimeSpan.Zero;
+    }
+
     /// <summary>
     /// Options for creating credential attestations.
     /// </summary>
-    public class AttestationOptions
+    public class AttestationOptions : AuthenticatorOptions
     {
+        /// <summary>
+        /// Signature algorithms the authenticator
+        /// is allowed to use.
+        /// </summary>
         public CoseSignatureAlgorithm[] SignatureAlgorithms { get; set; }
             = new[] { CoseSignatureAlgorithm.ES256 };
 
-        public AuthenticatorAttachment Authenticator { get; set; }
-            = AuthenticatorAttachment.CrossPlatform;
-
-        public UserVerificationRequirement UserVerification { get; set; }
-            = UserVerificationRequirement.Preferred;
-
+        /// <summary>
+        /// Determines whether the authenticator is expected to
+        /// return an attestation.
+        /// </summary>
         public AttestationConveyance Attestation { get; set; }
             = AttestationConveyance.None;
 
+        /// <summary>
+        /// Determines whether the authenticator is expected
+        /// to allocate a resident key or not.
+        /// </summary>
         public ResidentKeyRequirement ResidentKey { get; set; }
-
-        public TimeSpan Timeout { get; set; } = TimeSpan.Zero;
     }
 
     /// <summary>
     /// Options for creating assertions.
     /// </summary>
-    public class AssertionOptions
+    public class AssertionOptions : AuthenticatorOptions
     {
+        /// <summary>
+        /// Set of existing credentials the authenticator can use.
+        /// </summary>
         public ICollection<CredentialId>? AllowedCredentials { get; set; }
-
-        public AuthenticatorAttachment AuthenticatorAttachment { get; set; }
-            = AuthenticatorAttachment.Any;
-
-        public UserVerificationRequirement UserVerification { get; set; }
-            = UserVerificationRequirement.Any;
-
-        public TimeSpan Timeout { get; set; } = TimeSpan.Zero;
     }
 }
diff --git a/sources/Jpki.Security.WebAuthn/Security/WebAuthn/Windows/WindowsHello.cs b/sources/Jpki.Security.WebAuthn/Security/WebAuthn/Windows/WindowsHello.cs
@@ -131,7 +131,7 @@ private static Credential CreateCredential(
                         cExtensions = 0
                     },
 
-                    dwAuthenticatorAttachment = (WEBAUTHN_AUTHENTICATOR_ATTACHMENT)options.Authenticator,
+                    dwAuthenticatorAttachment = (WEBAUTHN_AUTHENTICATOR_ATTACHMENT)options.AuthenticatorAttachment,
                     bRequireResidentKey = options.ResidentKey == ResidentKeyRequirement.Required,
                     bPreferResidentKey = options.ResidentKey == ResidentKeyRequirement.Preferred,
                     dwUserVerificationRequirement = (WEBAUTHN_USER_VERIFICATION_REQUIREMENT)options.UserVerification,