Merge pull request #1158 from TGITS/feat/new_constructor_for_WebAuthn…

…ProcessingFilter Proposition to introduce a new constructor for WebAuthnProcessingFilter
webauthn4j · Mar 11, 2023 · 514f34e · 514f34e
2 parents 6a7aecb + 73d1a3f
commit 514f34e
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 6 deletions.
diff --git a/...-core/src/main/java/com/webauthn4j/springframework/security/WebAuthnProcessingFilter.java b/...-core/src/main/java/com/webauthn4j/springframework/security/WebAuthnProcessingFilter.java
@@ -36,9 +36,10 @@
 
 
 /**
- * Processes a WebAuthn authentication form submission. For supporting username/password authentication for first step of
- * two step authentication, if credentialId is not found in the HTTP request, this filter try to find username/password
- * parameters.
+ * Processes a WebAuthn authentication form submission.
+ * <p>
+ * For supporting the username/password authentication in the first step of a two factors authentication,
+ * if credentialId is not found in the HTTP request, this filter try to find username/password parameters.
  * <p>
  * Login forms must present WebAuthn parameters (credentialId, clientDataJSON, authenticatorData,signature and
  * clientExtensionJSON) or Password authentication parameters (username and password).
@@ -75,7 +76,7 @@ public class WebAuthnProcessingFilter extends UsernamePasswordAuthenticationFilt
     private String clientExtensionsJSONParameter = SPRING_SECURITY_FORM_CLIENT_EXTENSIONS_JSON_KEY;
 
     private ServerPropertyProvider serverPropertyProvider;
-    private UserVerificationStrategy userVerificationStrategy = new DefaultUserVerificationStrategy();
+    private UserVerificationStrategy userVerificationStrategy;
 
     private boolean postOnly = true;
 
@@ -91,7 +92,7 @@ public WebAuthnProcessingFilter() {
     }
 
     /**
-     * Constructor
+     * Constructor which initializes the filter with a default user verification strategy
      *
      * @param authorities            authorities for FirstOfMultiFactorAuthenticationToken
      * @param serverPropertyProvider provider for ServerProperty
@@ -101,6 +102,23 @@ public WebAuthnProcessingFilter(List<GrantedAuthority> authorities, ServerProper
         Assert.notNull(serverPropertyProvider, "serverPropertyProvider must not be null");
         this.authorities = authorities;
         this.serverPropertyProvider = serverPropertyProvider;
+        this.userVerificationStrategy = new DefaultUserVerificationStrategy();
+    }
+
+    /**
+     * Overloading constructor in which the user verification strategy with which initializing the filter can be specified
+     *
+     * @param authorities              authorities for FirstOfMultiFactorAuthenticationToken
+     * @param serverPropertyProvider   provider for ServerProperty
+     * @param userVerificationStrategy the user verification strategy to be used by the filter
+     */
+    public WebAuthnProcessingFilter(List<GrantedAuthority> authorities, ServerPropertyProvider serverPropertyProvider, UserVerificationStrategy userVerificationStrategy) {
+        Assert.notNull(authorities, "authorities must not be null");
+        Assert.notNull(serverPropertyProvider, "serverPropertyProvider must not be null");
+        Assert.notNull(userVerificationStrategy, "userVerificationStrategy must not be null");
+        this.authorities = authorities;
+        this.serverPropertyProvider = serverPropertyProvider;
+        this.userVerificationStrategy = userVerificationStrategy;
     }
 
     // ~ Methods

diff --git a/...e/src/test/java/com/webauthn4j/springframework/security/WebAuthnProcessingFilterTest.java b/...e/src/test/java/com/webauthn4j/springframework/security/WebAuthnProcessingFilterTest.java
@@ -247,12 +247,21 @@ public void attemptAuthentication_test_with_wrong_port() {
     }
 
     @Test
-    public void constructor_test() {
+    public void first_constructor_test() {
         ServerPropertyProvider serverPropertyProvider = mock(ServerPropertyProvider.class);
         WebAuthnProcessingFilter webAuthnProcessingFilter = new WebAuthnProcessingFilter(AuthorityUtils.NO_AUTHORITIES, serverPropertyProvider);
         assertThat(webAuthnProcessingFilter.getServerPropertyProvider()).isEqualTo(serverPropertyProvider);
         assertThat(webAuthnProcessingFilter.getUserVerificationStrategy()).isNotNull();
     }
 
+    @Test
+    public void second_constructor_test() {
+        ServerPropertyProvider serverPropertyProvider = mock(ServerPropertyProvider.class);
+        UserVerificationStrategy userVerificationStrategy = mock(UserVerificationStrategy.class);
+        WebAuthnProcessingFilter webAuthnProcessingFilter = new WebAuthnProcessingFilter(AuthorityUtils.NO_AUTHORITIES, serverPropertyProvider, userVerificationStrategy);
+        assertThat(webAuthnProcessingFilter.getServerPropertyProvider()).isEqualTo(serverPropertyProvider);
+        assertThat(webAuthnProcessingFilter.getUserVerificationStrategy()).isNotNull();
+    }
+
 
 }