Release 3.12.0

pom.xml

@@ -25,11 +25,12 @@
     <maven.min.version>3.8.5</maven.min.version>
 
     <!-- plugin versions -->
-    <maven-deploy-plugin.version>3.1.1</maven-deploy-plugin.version>
+    <maven-deploy-plugin.version>3.1.4</maven-deploy-plugin.version>
     <properties-maven-plugin.version>1.2.1</properties-maven-plugin.version>
-    <spotbugs-maven-plugin.version>4.8.3.1</spotbugs-maven-plugin.version>
-    <maven-enforcer-plugin.version>3.4.1</maven-enforcer-plugin.version>
-    <extra-enforcer-rules.version>1.7.0</extra-enforcer-rules.version>
+    <!-- Spotbugs spotbugs-maven-plugin 4.9.x requires JDK 11+   -->
+    <spotbugs-maven-plugin.version>4.8.6.6</spotbugs-maven-plugin.version>
+    <maven-enforcer-plugin.version>3.5.0</maven-enforcer-plugin.version>
+    <extra-enforcer-rules.version>1.10.0</extra-enforcer-rules.version>
   </properties>
 
   <build>

yoti-sdk-api/pom.xml

@@ -19,7 +19,7 @@
 
     <dependency>
       <groupId>org.bouncycastle</groupId>
-      <artifactId>bcpkix-jdk15on</artifactId>
+      <artifactId>bcpkix-jdk18on</artifactId>
     </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>

yoti-sdk-api/src/main/java/com/yoti/api/client/DigitalIdentityClient.java

@@ -4,6 +4,8 @@
 import java.security.KeyPair;
 import java.security.Security;
 
+import com.yoti.api.client.identity.MatchRequest;
+import com.yoti.api.client.identity.MatchResult;
 import com.yoti.api.client.identity.ShareSession;
 import com.yoti.api.client.identity.ShareSessionQrCode;
 import com.yoti.api.client.identity.ShareSessionRequest;
@@ -54,6 +56,10 @@ public Receipt fetchShareReceipt(String receiptId) throws DigitalIdentityExcepti
         return identityService.fetchShareReceipt(sdkId, keyPair, receiptId);
     }
 
+    public MatchResult fetchMatch(MatchRequest request) throws DigitalIdentityException {
+        return identityService.fetchMatch(sdkId, keyPair, request);
+    }
+
     private KeyPair loadKeyPair(KeyPairSource keyPairSource) throws InitialisationException {
         try {
             return keyPairSource.getFromStream(new KeyStreamVisitor());

yoti-sdk-api/src/main/java/com/yoti/api/client/identity/MatchNotification.java

@@ -0,0 +1,107 @@
+package com.yoti.api.client.identity;
+
+import static com.yoti.api.client.spi.remote.call.HttpMethod.SUPPORTED_HTTP_METHODS;
+
+import java.net.URI;
+import java.util.HashMap;
+import java.util.Locale;
+import java.util.Map;
+
+import com.yoti.validation.Validation;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public final class MatchNotification {
+
+    @JsonProperty(Property.URL)
+    private final String endpoint;
+
+    @JsonProperty(Property.METHOD)
+    private final String method;
+
+    @JsonProperty(Property.VERIFY_TLS)
+    private final boolean verifyTls;
+
+    @JsonProperty(Property.HEADERS)
+    private final Map<String, String> headers;
+
+    private MatchNotification(Builder builder) {
+        endpoint = builder.endpoint;
+        method = builder.method;
+        verifyTls = builder.verifyTls;
+        headers = builder.headers;
+    }
+
+    public String getEndpoint() {
+        return endpoint;
+    }
+
+    public String getMethod() {
+        return method;
+    }
+
+    public boolean isVerifyTls() {
+        return verifyTls;
+    }
+
+    public Map<String, String> getHeaders() {
+        return headers;
+    }
+
+    public static Builder forUrl(URI uri) {
+        return new Builder(uri);
+    }
+
+    public static final class Builder {
+
+        private final String endpoint;
+        private final Map<String, String> headers;
+
+        private String method;
+        private boolean verifyTls;
+
+        private Builder(URI uri) {
+            Validation.notNull(uri, Property.URL);
+
+            endpoint = uri.toString();
+            headers = new HashMap<>();
+        }
+
+        public Builder withMethod(String method) {
+            Validation.withinList(method.toUpperCase(Locale.ROOT), SUPPORTED_HTTP_METHODS);
+
+            this.method = method;
+            return this;
+        }
+
+        public Builder withVerifyTls(boolean verifyTls) {
+            this.verifyTls = verifyTls;
+            return this;
+        }
+
+        public Builder withHeaders(Map<String, String> headers) {
+            this.headers.putAll(headers);
+            return this;
+        }
+
+        public Builder withHeader(String key, String value) {
+            headers.put(key, value);
+            return this;
+        }
+
+        public MatchNotification build() {
+            return new MatchNotification(this);
+        }
+
+    }
+
+    private static final class Property {
+
+        private static final String URL = "url";
+        private static final String METHOD = "method";
+        private static final String VERIFY_TLS = "verifyTls";
+        private static final String HEADERS = "headers";
+
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/identity/MatchRequest.java

@@ -0,0 +1,62 @@
+package com.yoti.api.client.identity;
+
+import com.yoti.validation.Validation;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public final class MatchRequest {
+
+    @JsonProperty(Property.VALUE)
+    private final String value;
+
+    @JsonProperty(Property.NOTIFICATION)
+    private final MatchNotification notification;
+
+    private MatchRequest(Builder builder) {
+        value = builder.value;
+        notification = builder.notification;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
+    public MatchNotification getNotification() {
+        return notification;
+    }
+
+    public static Builder builder(String value) {
+        return new Builder(value);
+    }
+
+    public static final class Builder {
+
+        private final String value;
+
+        private MatchNotification notification;
+
+        private Builder(String value) {
+            Validation.notNullOrEmpty(value, Property.VALUE);
+
+            this.value = value;
+        }
+
+        public Builder withNotification(MatchNotification notification) {
+            this.notification = notification;
+            return this;
+        }
+
+        public MatchRequest build() {
+            return new MatchRequest(this);
+        }
+
+    }
+
+    private static final class Property {
+
+        private static final String VALUE = "value";
+        private static final String NOTIFICATION = "notification";
+
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/identity/MatchResult.java

@@ -0,0 +1,36 @@
+package com.yoti.api.client.identity;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public final class MatchResult {
+
+    @JsonProperty(Property.ID)
+    private String id;
+
+    @JsonProperty(Property.RESULT)
+    private String result;
+
+    public String getId() {
+        return id;
+    }
+
+    public String getResult() {
+        return result;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public void setResult(String result) {
+        this.result = result;
+    }
+
+    private static final class Property {
+
+        private static final String ID = "id";
+        private static final String RESULT = "result";
+
+    }
+
+}

yoti-sdk-api/src/main/java/com/yoti/api/client/spi/remote/call/factory/UnsignedPathFactory.java

@@ -15,6 +15,9 @@ public class UnsignedPathFactory {
     private static final String IDENTITY_SESSION_RECEIPT_RETRIEVAL = "/v2/receipts/%s";
     private static final String IDENTITY_SESSION_RECEIPT_KEY_RETRIEVAL = "/v2/wrapped-item-keys/%s";
 
+    // Match
+    private static final String DIGITAL_ID_MATCH = "/v1/matches";
+
     // Share V1
     private static final String PROFILE = "/profile/%s?appId=%s";
     private static final String QR_CODE = "/qrcodes/apps/%s";
@@ -66,6 +69,10 @@ private static String base64ToBase64url(String value) {
         return value.replace('+', '-').replace('/', '_');
     }
 
+    public String createIdentityMatchPath() {
+        return DIGITAL_ID_MATCH;
+    }
+
     public String createProfilePath(String appId, String connectToken) {
         return format(PROFILE, connectToken, appId);
     }

yoti-sdk-api/src/main/java/com/yoti/api/client/spi/remote/call/identity/DigitalIdentityService.java

@@ -16,6 +16,8 @@
 import java.security.KeyPair;
 import java.util.Optional;
 
+import com.yoti.api.client.identity.MatchRequest;
+import com.yoti.api.client.identity.MatchResult;
 import com.yoti.api.client.identity.ShareSession;
 import com.yoti.api.client.identity.ShareSessionQrCode;
 import com.yoti.api.client.identity.ShareSessionRequest;
@@ -189,6 +191,30 @@ private ReceiptItemKey fetchShareReceiptKey(String sdkId, KeyPair keyPair, Wrapp
         }
     }
 
+    public MatchResult fetchMatch(String sdkId, KeyPair keyPair, MatchRequest matchRequest)
+            throws DigitalIdentityException {
+        Validation.notNullOrEmpty(sdkId, "SDK ID");
+        Validation.notNull(keyPair, "Application Key Pair");
+        Validation.notNull(matchRequest, "DID Match request");
+
+        String path = pathFactory.createIdentityMatchPath();
+
+        LOG.debug("Requesting digital ID Match for SDK ID '{}' at '{}'", sdkId, path);
+
+        try {
+            byte[] payload = ResourceMapper.writeValueAsString(matchRequest);
+            return createSignedRequest(sdkId, keyPair, path, HTTP_POST, payload).execute(MatchResult.class);
+        } catch (IOException ex) {
+            throw new DigitalIdentityException("Error while parsing the DID Match request", ex);
+        } catch (URISyntaxException ex) {
+            throw new DigitalIdentityException("Error while building the DID Match request", ex);
+        } catch (GeneralSecurityException ex) {
+            throw new DigitalIdentityException("Error while signing the DID Match request", ex);
+        } catch (ResourceException ex) {
+            throw new DigitalIdentityException("Error while executing the DID Match request", ex);
+        }
+    }
+
     SignedRequest createSignedRequest(String sdkId, KeyPair keyPair, String path)
             throws GeneralSecurityException, UnsupportedEncodingException, URISyntaxException {
         return createSignedRequest(sdkId, keyPair, path, HTTP_GET, null);

yoti-sdk-api/src/test/java/com/yoti/api/client/DigitalIdentityClientTest.java

@@ -13,6 +13,7 @@
 import java.io.InputStream;
 import java.security.KeyPair;
 
+import com.yoti.api.client.identity.MatchRequest;
 import com.yoti.api.client.identity.ShareSessionRequest;
 import com.yoti.api.client.spi.remote.KeyStreamVisitor;
 import com.yoti.api.client.spi.remote.call.identity.DigitalIdentityException;
@@ -37,6 +38,7 @@ public class DigitalIdentityClientTest {
     @Mock(answer = RETURNS_DEEP_STUBS) KeyPair keyPair;
     @Mock DigitalIdentityService identityService;
     @Mock ShareSessionRequest shareSessionRequest;
+    @Mock MatchRequest matchRequest;
 
     private KeyPairSource validKeyPairSource;
 
@@ -224,6 +226,28 @@ public void client_FetchShareReceiptException_DigitalIdentityException() throws
         assertThat(ex.getMessage(), equalTo(exMessage));
     }
 
+    @Test
+    public void client_FetchDigitalIdMatchException_DigitalIdentityException() throws IOException {
+        when(keyPairSource.getFromStream(any(KeyStreamVisitor.class))).thenReturn(keyPair);
+
+        DigitalIdentityClient identityClient = new DigitalIdentityClient(
+                AN_SDK_ID,
+                keyPairSource,
+                identityService
+        );
+
+        String exMessage = "Fetch digital identity match error";
+        when(identityService.fetchMatch(AN_SDK_ID, keyPair, matchRequest))
+                .thenThrow(new DigitalIdentityException(exMessage));
+
+        DigitalIdentityException ex = assertThrows(
+                DigitalIdentityException.class,
+                () -> identityClient.fetchMatch(matchRequest)
+        );
+
+        assertThat(ex.getMessage(), equalTo(exMessage));
+    }
+
     private static class KeyPairSourceTest implements KeyPairSource {
 
         private final String keyPair;