Fix #1502: FIDO2: Return excludeCredentials in RegistrationChallenge …

…(backport) (#1507)
wultra · May 3, 2024 · fa0d785 · fa0d785
1 parent 4ebccb7
commit fa0d785
Show file tree

Hide file tree

Showing 13 changed files with 62 additions and 27 deletions.
diff --git a/.../model/entity/fido2/AllowCredentials.java → ...client/model/entity/fido2/Credential.java b/.../model/entity/fido2/AllowCredentials.java → ...client/model/entity/fido2/Credential.java
@@ -23,12 +23,12 @@
 import java.util.List;
 
 /**
- * Representation of an allowed authenticator instance.
+ * Representation of a FIDO2 Credential.
  *
  * @author Jan Pesek, jan.pesek@wultra.com
  */
 @Data
-public class AllowCredentials {
+public class Credential {
 
     private byte[] credentialId;
 

diff --git a/...com/wultra/security/powerauth/client/model/response/fido2/AssertionChallengeResponse.java b/...com/wultra/security/powerauth/client/model/response/fido2/AssertionChallengeResponse.java
@@ -18,7 +18,7 @@
 
 package com.wultra.security.powerauth.client.model.response.fido2;
 
-import com.wultra.security.powerauth.client.model.entity.fido2.AllowCredentials;
+import com.wultra.security.powerauth.client.model.entity.fido2.Credential;
 import lombok.Data;
 import lombok.ToString;
 
@@ -38,6 +38,6 @@ public class AssertionChallengeResponse {
     private String userId;
     private Long failedAttempts;
     private Long maxFailedAttempts;
-    private List<AllowCredentials> allowCredentials;
+    private List<Credential> allowCredentials;
 
 }
diff --git a/.../wultra/security/powerauth/client/model/response/fido2/RegistrationChallengeResponse.java b/.../wultra/security/powerauth/client/model/response/fido2/RegistrationChallengeResponse.java
@@ -18,9 +18,12 @@
 
 package com.wultra.security.powerauth.client.model.response.fido2;
 
+import com.wultra.security.powerauth.client.model.entity.fido2.Credential;
 import lombok.Data;
 import lombok.ToString;
 
+import java.util.List;
+
 /**
  * @author Roman Strobl, roman.strobl@wultra.com
  */
@@ -32,5 +35,6 @@ public class RegistrationChallengeResponse {
     @ToString.Exclude
     private String challenge;
     private String userId;
+    private List<Credential> excludeCredentials;
 
 }
diff --git a/...ain/java/com/wultra/powerauth/fido2/rest/model/converter/AssertionChallengeConverter.java b/...ain/java/com/wultra/powerauth/fido2/rest/model/converter/AssertionChallengeConverter.java
@@ -18,7 +18,7 @@
 
 package com.wultra.powerauth.fido2.rest.model.converter;
 
-import com.wultra.powerauth.fido2.rest.model.entity.AllowCredentials;
+import com.wultra.powerauth.fido2.rest.model.entity.Credential;
 import com.wultra.powerauth.fido2.rest.model.entity.AssertionChallenge;
 import com.wultra.powerauth.fido2.rest.model.entity.AuthenticatorDetail;
 import com.wultra.powerauth.fido2.rest.model.entity.Fido2DefaultAuthenticators;
@@ -108,7 +108,7 @@ public static AssertionChallenge convertAssertionChallengeFromOperationDetail(Op
         destination.setMaxFailedAttempts(source.getMaxFailureCount());
 
         if (authenticatorDetails != null && !authenticatorDetails.isEmpty()) {
-            final List<AllowCredentials> allowCredentials = new ArrayList<>();
+            final List<Credential> allowCredentials = new ArrayList<>();
             for (AuthenticatorDetail ad: authenticatorDetails) {
 
                 @SuppressWarnings("unchecked")
@@ -121,11 +121,11 @@ public static AssertionChallenge convertAssertionChallengeFromOperationDetail(Op
                     credentialId = ByteUtils.concat(credentialId, operationDataBytes);
                 }
 
-                final AllowCredentials ac = AllowCredentials.builder()
+                final Credential credential = Credential.builder()
                         .credentialId(credentialId)
                         .transports(transports)
                         .build();
-                allowCredentials.add(ac);
+                allowCredentials.add(credential);
             }
             destination.setAllowCredentials(allowCredentials);
         }

diff --git a/.../java/com/wultra/powerauth/fido2/rest/model/converter/RegistrationChallengeConverter.java b/.../java/com/wultra/powerauth/fido2/rest/model/converter/RegistrationChallengeConverter.java
@@ -18,11 +18,16 @@
 
 package com.wultra.powerauth.fido2.rest.model.converter;
 
+import com.wultra.powerauth.fido2.rest.model.entity.AuthenticatorDetail;
+import com.wultra.powerauth.fido2.rest.model.entity.Credential;
 import com.wultra.powerauth.fido2.rest.model.entity.RegistrationChallenge;
 import com.wultra.powerauth.fido2.rest.model.response.RegistrationChallengeResponse;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.stereotype.Component;
 
+import java.util.Base64;
+import java.util.List;
+
 /**
  * @author Petr Dvorak, petr@wultra.com
  */
@@ -45,7 +50,19 @@ public RegistrationChallengeResponse fromChallenge(RegistrationChallenge source)
         destination.setActivationId(source.getActivationId());
         destination.setApplicationId(source.getApplicationId());
         destination.setChallenge(source.getChallenge());
+        destination.setExcludeCredentials(source.getExcludeCredentials());
         return destination;
     }
 
+    public static Credential toCredentialDescriptor(final AuthenticatorDetail authenticatorDetail) {
+        @SuppressWarnings("unchecked")
+        final List<String> transports = (List<String>) authenticatorDetail.getExtras().get("transports");
+        final byte[] credentialId = Base64.getDecoder().decode(authenticatorDetail.getCredentialId());
+
+        return Credential.builder()
+                .credentialId(credentialId)
+                .transports(transports)
+                .build();
+    }
+
 }
diff --git a/...-fido2/src/main/java/com/wultra/powerauth/fido2/rest/model/entity/AssertionChallenge.java b/...-fido2/src/main/java/com/wultra/powerauth/fido2/rest/model/entity/AssertionChallenge.java
@@ -35,6 +35,6 @@ public class AssertionChallenge {
     private String userId;
     private Long failedAttempts;
     private Long maxFailedAttempts;
-    private List<AllowCredentials> allowCredentials;
+    private List<Credential> allowCredentials;
 
 }
diff --git a/...2/rest/model/entity/AllowCredentials.java → ...h/fido2/rest/model/entity/Credential.java b/...2/rest/model/entity/AllowCredentials.java → ...h/fido2/rest/model/entity/Credential.java
@@ -27,15 +27,15 @@
 import java.util.List;
 
 /**
- * Representation of an allowed authenticator instance.
+ * Representation of a FIDO2 Credential.
  *
  * @author Petr Dvorak, petr@wultra.com
  */
 @Getter
 @EqualsAndHashCode
 @ToString
 @Builder
-public class AllowCredentials {
+public class Credential {
 
     private final byte[] credentialId;
 

diff --git a/...do2/src/main/java/com/wultra/powerauth/fido2/rest/model/entity/RegistrationChallenge.java b/...do2/src/main/java/com/wultra/powerauth/fido2/rest/model/entity/RegistrationChallenge.java
@@ -20,6 +20,8 @@
 
 import lombok.Data;
 
+import java.util.List;
+
 /**
  * Model class representing registration challenge.
  *
@@ -31,4 +33,5 @@ public class RegistrationChallenge {
     private String applicationId;
     private String challenge;
     private String userId;
+    private List<Credential> excludeCredentials;
 }
diff --git a/.../main/java/com/wultra/powerauth/fido2/rest/model/response/AssertionChallengeResponse.java b/.../main/java/com/wultra/powerauth/fido2/rest/model/response/AssertionChallengeResponse.java
@@ -18,7 +18,7 @@
 
 package com.wultra.powerauth.fido2.rest.model.response;
 
-import com.wultra.powerauth.fido2.rest.model.entity.AllowCredentials;
+import com.wultra.powerauth.fido2.rest.model.entity.Credential;
 import lombok.Data;
 
 import java.util.List;
@@ -36,6 +36,6 @@ public class AssertionChallengeResponse {
     private String userId;
     private Long failedAttempts;
     private Long maxFailedAttempts;
-    private List<AllowCredentials> allowCredentials;
+    private List<Credential> allowCredentials;
 
 }
diff --git a/...in/java/com/wultra/powerauth/fido2/rest/model/response/RegistrationChallengeResponse.java b/...in/java/com/wultra/powerauth/fido2/rest/model/response/RegistrationChallengeResponse.java
@@ -18,8 +18,11 @@
 
 package com.wultra.powerauth.fido2.rest.model.response;
 
+import com.wultra.powerauth.fido2.rest.model.entity.Credential;
 import lombok.Data;
 
+import java.util.List;
+
 /**
  * Registration challenge response.
  *
@@ -32,6 +35,6 @@ public class RegistrationChallengeResponse {
     private String applicationId;
     private String challenge;
     private String userId;
-
+    private List<Credential> excludeCredentials;
 
 }
diff --git a/...java/com/wultra/powerauth/fido2/rest/model/converter/AssertionChallengeConverterTest.java b/...java/com/wultra/powerauth/fido2/rest/model/converter/AssertionChallengeConverterTest.java
@@ -18,7 +18,7 @@
 
 package com.wultra.powerauth.fido2.rest.model.converter;
 
-import com.wultra.powerauth.fido2.rest.model.entity.AllowCredentials;
+import com.wultra.powerauth.fido2.rest.model.entity.Credential;
 import com.wultra.powerauth.fido2.rest.model.entity.AssertionChallenge;
 import com.wultra.powerauth.fido2.rest.model.entity.AuthenticatorDetail;
 import com.wultra.powerauth.fido2.rest.model.request.AssertionChallengeRequest;
@@ -121,7 +121,7 @@ void testConvertAssertionChallengeFromOperationDetail_nonWultraAuthenticatorDeta
         assertEquals(5L, assertionChallenge.getMaxFailedAttempts());
 
         assertNotNull(assertionChallenge.getAllowCredentials());
-        final AllowCredentials allowCredential = assertionChallenge.getAllowCredentials().get(0);
+        final Credential allowCredential = assertionChallenge.getAllowCredentials().get(0);
         assertArrayEquals("credential-1".getBytes(), allowCredential.getCredentialId());
         assertEquals("hybrid", allowCredential.getTransports().get(0));
         assertEquals("public-key", allowCredential.getType());
@@ -154,7 +154,7 @@ void testConvertAssertionChallengeFromOperationDetail_withWultraAuthenticatorDet
 
         assertNotNull(assertionChallenge.getAllowCredentials());
         assertEquals(1, assertionChallenge.getAllowCredentials().size());
-        final AllowCredentials allowCredential = assertionChallenge.getAllowCredentials().get(0);
+        final Credential allowCredential = assertionChallenge.getAllowCredentials().get(0);
         assertArrayEquals("credential-1A1*A100CZK".getBytes(), allowCredential.getCredentialId());
         assertEquals("usb", allowCredential.getTransports().get(0));
         assertEquals("public-key", allowCredential.getType());
@@ -194,12 +194,12 @@ void testConvertAssertionChallengeFromOperationDetail_multipleWultraAuthenticato
 
         assertNotNull(assertionChallenge.getAllowCredentials());
         assertEquals(2, assertionChallenge.getAllowCredentials().size());
-        final AllowCredentials allowCredential1 = assertionChallenge.getAllowCredentials().get(0);
+        final Credential allowCredential1 = assertionChallenge.getAllowCredentials().get(0);
         assertArrayEquals("credential-1A1*A100CZK".getBytes(), allowCredential1.getCredentialId());
         assertEquals("usb", allowCredential1.getTransports().get(0));
         assertEquals("public-key", allowCredential1.getType());
 
-        final AllowCredentials allowCredential2 = assertionChallenge.getAllowCredentials().get(1);
+        final Credential allowCredential2 = assertionChallenge.getAllowCredentials().get(1);
         assertArrayEquals("credential-2A1*A100CZK".getBytes(), allowCredential2.getCredentialId());
         assertEquals("usb", allowCredential2.getTransports().get(0));
         assertEquals("public-key", allowCredential2.getType());

diff --git a/...io/getlime/security/powerauth/app/server/service/fido2/PowerAuthRegistrationProvider.java b/...io/getlime/security/powerauth/app/server/service/fido2/PowerAuthRegistrationProvider.java
@@ -19,6 +19,8 @@
 package io.getlime.security.powerauth.app.server.service.fido2;
 
 import com.wultra.powerauth.fido2.errorhandling.Fido2AuthenticationFailedException;
+import com.wultra.powerauth.fido2.rest.model.converter.RegistrationChallengeConverter;
+import com.wultra.powerauth.fido2.rest.model.entity.Credential;
 import com.wultra.powerauth.fido2.rest.model.entity.RegistrationChallenge;
 import com.wultra.powerauth.fido2.service.provider.RegistrationProvider;
 import com.wultra.security.powerauth.client.model.entity.ApplicationConfigurationItem;
@@ -42,11 +44,7 @@
 import org.springframework.transaction.annotation.Transactional;
 
 import java.nio.ByteBuffer;
-import java.nio.charset.StandardCharsets;
-import java.util.Date;
-import java.util.List;
-import java.util.Optional;
-import java.util.UUID;
+import java.util.*;
 
 import static com.wultra.powerauth.fido2.rest.model.enumeration.Fido2ConfigKeys.CONFIG_KEY_ALLOWED_AAGUIDS;
 import static com.wultra.powerauth.fido2.rest.model.enumeration.Fido2ConfigKeys.CONFIG_KEY_ALLOWED_ATTESTATION_FMT;
@@ -62,25 +60,33 @@ public class PowerAuthRegistrationProvider implements RegistrationProvider {
 
     private final RepositoryCatalogue repositoryCatalogue;
     private final ServiceBehaviorCatalogue serviceBehaviorCatalogue;
-
+    private final PowerAuthAuthenticatorProvider authenticatorProvider;
     private final KeyConvertor keyConvertor = new KeyConvertor();
 
     @Autowired
-    public PowerAuthRegistrationProvider(RepositoryCatalogue repositoryCatalogue, ServiceBehaviorCatalogue serviceBehaviorCatalogue) {
+    public PowerAuthRegistrationProvider(final RepositoryCatalogue repositoryCatalogue, final ServiceBehaviorCatalogue serviceBehaviorCatalogue, final PowerAuthAuthenticatorProvider authenticatorProvider) {
         this.repositoryCatalogue = repositoryCatalogue;
         this.serviceBehaviorCatalogue = serviceBehaviorCatalogue;
+        this.authenticatorProvider = authenticatorProvider;
     }
 
     @Override
     @Transactional
-    public RegistrationChallenge provideChallengeForRegistration(String userId, String applicationId) throws GenericServiceException {
+    public RegistrationChallenge provideChallengeForRegistration(String userId, String applicationId) throws GenericServiceException, Fido2AuthenticationFailedException {
         final InitActivationResponse initActivationResponse = serviceBehaviorCatalogue.getActivationServiceBehavior()
                 .initActivation(Protocols.FIDO2, applicationId, userId, null, null, ActivationOtpValidation.NONE, null, null, keyConvertor);
+
+        final List<Credential> excludeCredentials = authenticatorProvider.findByUserId(userId, applicationId)
+                .stream()
+                .map(RegistrationChallengeConverter::toCredentialDescriptor)
+                .toList();
+
         final RegistrationChallenge registrationChallenge = new RegistrationChallenge();
         registrationChallenge.setUserId(initActivationResponse.getUserId());
         registrationChallenge.setApplicationId(initActivationResponse.getApplicationId());
         registrationChallenge.setActivationId(initActivationResponse.getActivationId());
         registrationChallenge.setChallenge(initActivationResponse.getActivationCode());
+        registrationChallenge.setExcludeCredentials(excludeCredentials);
         return registrationChallenge;
     }
 

diff --git a/powerauth-java-server/src/test/java/com/wultra/powerauth/fido2/Fido2AuthenticatorTest.java b/powerauth-java-server/src/test/java/com/wultra/powerauth/fido2/Fido2AuthenticatorTest.java
@@ -51,6 +51,7 @@
 import com.wultra.security.powerauth.client.model.response.OperationTemplateDetailResponse;
 import io.getlime.security.powerauth.app.server.Application;
 import io.getlime.security.powerauth.app.server.service.PowerAuthService;
+import jakarta.transaction.Transactional;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
@@ -72,6 +73,7 @@
  */
 @SpringBootTest(classes = Application.class)
 @ActiveProfiles("test")
+@Transactional
 class Fido2AuthenticatorTest {
 
     private final CBORMapper CBOR_MAPPER = new CBORMapper();