extended invitation parser so that it also can handle URI's which is very common in invitation redirects

Signed-off-by: Philipp Etschel <philipp.etschel@ch.bosch.com>

Author: Philipp Etschel

backend/business-partner-agent/pom.xml

@@ -219,6 +219,12 @@
             <artifactId>mockito-junit-jupiter</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.squareup.okhttp3</groupId>
+            <artifactId>mockwebserver</artifactId>
+            <version>4.9.3</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

backend/business-partner-agent/src/main/java/org/hyperledger/bpa/impl/InvitationParser.java

@@ -38,25 +38,32 @@
 import org.hyperledger.bpa.controller.api.invitation.CheckInvitationResponse;
 import org.hyperledger.bpa.impl.util.Converter;
 
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.net.URLDecoder;
 import java.nio.charset.StandardCharsets;
 import java.util.Base64;
 import java.util.List;
 import java.util.Map;
 
 @Slf4j
-@NoArgsConstructor
 @Singleton
 public class InvitationParser {
 
-    OkHttpClient httpClient = new OkHttpClient.Builder().followRedirects(false).build();
+    private final OkHttpClient httpClient;
 
-    static List<String> CONNECTION_INVITATION_TYPES = List.of(
+    private static final List<String> paramNames = List.of("c_i", "d_m", "oob");
+
+    static final List<String> CONNECTION_INVITATION_TYPES = List.of(
             "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/connections/1.0/invitation",
             "https://didcomm.org/connections/1.0/invitation");
-    static List<String> OOB_INVITATION_TYPES = List.of("did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/out-of-band/1.0/invitation",
+    static final List<String> OOB_INVITATION_TYPES = List.of("did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/out-of-band/1.0/invitation",
             "https://didcomm.org/out-of-band/1.0/invitation");
 
+    public InvitationParser() {
+        this.httpClient = new OkHttpClient.Builder().followRedirects(false).build();
+    }
+
     @Inject
     @Setter(AccessLevel.PACKAGE)
     ObjectMapper mapper;
@@ -187,7 +194,6 @@ public Invitation parseInvitation(String invitationBlock) {
     }
 
     private String parseInvitationBlock(@NonNull HttpUrl url) {
-        List<String> paramNames = List.of("c_i", "d_m", "oob");
         for (String name : paramNames) {
             String invitationBlock = url.queryParameter(name);
             if (StringUtils.isNotEmpty(invitationBlock))
@@ -213,7 +219,7 @@ private String parseInvitationBlockFromRedirect(@NonNull HttpUrl url) {
                 if (response.isRedirect()) {
                     String location = response.header("location");
                     if (StringUtils.isNotEmpty(location)) {
-                        HttpUrl locationUrl = HttpUrl.parse(location);
+                        HttpUrl locationUrl = getQueryFromLocation(location);
                         if (locationUrl != null)
                             return parseInvitationBlock(locationUrl);
                     }
@@ -225,4 +231,25 @@ private String parseInvitationBlockFromRedirect(@NonNull HttpUrl url) {
         return null;
     }
 
+    /**
+     * The location header can either be an HTTP URL or simply a URI, as we
+     * only process the query, and we do not want to rewrite the query parser
+     * the query is extracted from the URI and then wrapped again into a dummy HTTP URL
+     * @param location the content of the location header
+     * @return {@link HttpUrl} or null
+     */
+    private HttpUrl getQueryFromLocation(String location) {
+        HttpUrl result = null;
+        try {
+            URI uri = new URI(location);
+            String query = uri.getQuery();
+            if (StringUtils.isNotEmpty(query)) {
+                result = HttpUrl.parse("https://placeholder.co?" + query);
+            }
+        } catch (URISyntaxException e) {
+            log.error("Location header contained a invalid URI", e);
+        }
+        return result;
+    }
+
 }

backend/business-partner-agent/src/test/java/org/hyperledger/bpa/impl/InvitationParserTest.java

@@ -18,16 +18,35 @@
 package org.hyperledger.bpa.impl;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
+import okhttp3.mockwebserver.MockResponse;
+import okhttp3.mockwebserver.MockWebServer;
+import org.hyperledger.bpa.controller.api.invitation.CheckInvitationResponse;
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 public class InvitationParserTest {
 
-    @Test
-    void TestParseReceiveInvitation() {
-        InvitationParser p = new InvitationParser();
+    public static MockWebServer mockWebServer;
+    private InvitationParser p;
+
+    @BeforeEach
+    void init() throws Exception {
+        p = new InvitationParser();
         p.setMapper(new ObjectMapper());
 
+        mockWebServer = new MockWebServer();
+        mockWebServer.start();
+    }
+
+    @AfterEach
+    void tearDown() throws Exception {
+        mockWebServer.shutdown();
+    }
+
+    @Test
+    void TestParseReceiveInvitation() {
         InvitationParser.Invitation invitation = p.parseInvitation(this.invitation);
         Assertions.assertFalse(invitation.isOob());
         Assertions.assertTrue(invitation.isParsed());
@@ -36,9 +55,6 @@ void TestParseReceiveInvitation() {
 
     @Test
     void TestParseReceiveOOBInvitation() {
-        InvitationParser p = new InvitationParser();
-        p.setMapper(new ObjectMapper());
-
         InvitationParser.Invitation invitation = p.parseInvitation(oob);
         Assertions.assertTrue(invitation.isOob());
         Assertions.assertTrue(invitation.isParsed());
@@ -47,9 +63,6 @@ void TestParseReceiveOOBInvitation() {
 
     @Test
     void TestParseReceiveDidCommInvitation() {
-        InvitationParser p = new InvitationParser();
-        p.setMapper(new ObjectMapper());
-
         InvitationParser.Invitation invitation = p.parseInvitation(this.didCommInvitation);
         Assertions.assertFalse(invitation.isOob());
         Assertions.assertTrue(invitation.isParsed());
@@ -58,19 +71,28 @@ void TestParseReceiveDidCommInvitation() {
 
     @Test
     void TestParseReceiveOOBDidCommInvitation() {
-        InvitationParser p = new InvitationParser();
-        p.setMapper(new ObjectMapper());
-
         InvitationParser.Invitation invitation = p.parseInvitation(didCommOob);
         Assertions.assertTrue(invitation.isOob());
         Assertions.assertTrue(invitation.isParsed());
         Assertions.assertNotNull(invitation.getInvitation());
     }
 
+    @Test
+    void testStreetcredURI() {
+        MockResponse response = new MockResponse()
+                .setResponseCode(301)
+                .setHeader("location", streetCredRedirect);
+        mockWebServer.enqueue(response);
+        String httpUrl = mockWebServer.url("/46yG3VegpCqc").toString();
+        CheckInvitationResponse parsed = p.checkInvitation(httpUrl);
+        Assertions.assertEquals("Snapper", parsed.getLabel());
+    }
+
     private final String invitation = "ewogICAgIkB0eXBlIjogImRpZDpzb3Y6QnpDYnNOWWhNcmpIaXFaRFRVQVNIZztzcGVjL2Nvbm5lY3Rpb25zLzEuMC9pbnZpdGF0aW9uIiwKICAgICJAaWQiOiAiNGQ1OGJhZjktZDIwOS00MTE4LThkOTQtNGE0OTBlNGEwNGFhIiwKICAgICJzZXJ2aWNlRW5kcG9pbnQiOiAiaHR0cDovL2hvc3QuZG9ja2VyLmludGVybmFsOjgwMzAiLAogICAgInJlY2lwaWVudEtleXMiOiBbCiAgICAgICAgIjZCTlF1dFJIalNWNmJwQ0E2djVkRVB2NW12dWlRS2hyc256cEN4dUgzdXdqIgogICAgXSwKICAgICJsYWJlbCI6ICJCdXNpbmVzcyBQYXJ0bmVyIEFnZW50IDEiCn0=";
     private final String oob = "eyJAdHlwZSI6ICJkaWQ6c292OkJ6Q2JzTlloTXJqSGlxWkRUVUFTSGc7c3BlYy9vdXQtb2YtYmFuZC8xLjAvaW52aXRhdGlvbiIsICJAaWQiOiAiMmZhYmJhNzYtZTlhNy00Yzk4LTg2ZjMtMTFkNGE1MTYzYjQyIiwgImhhbmRzaGFrZV9wcm90b2NvbHMiOiBbImRpZDpzb3Y6QnpDYnNOWWhNcmpIaXFaRFRVQVNIZztzcGVjL2RpZGV4Y2hhbmdlLzEuMCJdLCAic2VydmljZXMiOiBbImRpZDpzb3Y6RXJhWUNESlVQc0NoYmt3N1MxdlY5NiJdLCAibGFiZWwiOiAiYm9iIn0=";
 
     private final String didCommInvitation = "eyJAdHlwZSI6ICJodHRwczovL2RpZGNvbW0ub3JnL2Nvbm5lY3Rpb25zLzEuMC9pbnZpdGF0aW9uIiwgIkBpZCI6ICJkNGE5ZmY4YS1jNjlmLTRiMWQtODJlYi04NzQwYWRiMzE0MmEiLCAic2VydmljZUVuZHBvaW50IjogImh0dHBzOi8vaW52aXRlMS1icGEtYWNhcHktZGV2LmFwcHMuc2lsdmVyLmRldm9wcy5nb3YuYmMuY2EiLCAibGFiZWwiOiAiaW52aXRlMSIsICJyZWNpcGllbnRLZXlzIjogWyI5MnV2TTFFOG9RbXFUNGZLZkdtam5UTndiandqYUZXYVRpRmtMZXNvbnhSVCJdfQ==";
     private final String didCommOob = "eyJAdHlwZSI6ICJodHRwczovL2RpZGNvbW0ub3JnL291dC1vZi1iYW5kLzEuMC9pbnZpdGF0aW9uIiwgIkBpZCI6ICI2ZmYzY2UzNy1kYjM1LTRjYTctYTNkOS03MWJmNGYxYzhkYzQiLCAibGFiZWwiOiAiaW52aXRlMSIsICJzZXJ2aWNlcyI6IFsiZGlkOnNvdjpXc3FWaW4xWjRZdnZiODdzU1E3QzJtIl0sICJoYW5kc2hha2VfcHJvdG9jb2xzIjogWyJodHRwczovL2RpZGNvbW0ub3JnL2RpZGV4Y2hhbmdlLzEuMCJdfQ==";
 
+    private final String streetCredRedirect = "id.streetcred://launch/?d_m=eyJsYWJlbCI6IlNuYXBwZXIiLCJpbWFnZVVybCI6bnVsbCwic2VydmljZUVuZHBvaW50IjoiaHR0cHM6Ly90cmluc2ljLW1lZGlhdG9yLWFnZW50LWV1cm9wZS5henVyZXdlYnNpdGVzLm5ldC8iLCJyb3V0aW5nS2V5cyI6WyJDTFBmc3hVaDNMOWR2U2huNjRmYkZKZExrbzZHbmVhQkNEWkJQNjZpWVV3RCJdLCJyZWNpcGllbnRLZXlzIjpbIkc5cDVydVRqcDJiVHhWellIUVpySmZISkNDaENRVUpOVllrUWhTcGlmWTdkIl0sIkBpZCI6IjBiNTc1Zjc4LTNiNTQtNGFhNS1hMzMyLTcwNTljZDg5YzA1NiIsIkB0eXBlIjoiZGlkOnNvdjpCekNic05ZaE1yakhpcVpEVFVBU0hnO3NwZWMvY29ubmVjdGlvbnMvMS4wL2ludml0YXRpb24ifQ%3D%3D&orig=https%3a%2f%2fredir.trinsic.id%2f46yG3VegpCqc";
 }

backend/pom.xml

@@ -63,7 +63,7 @@
         <mockito.version>4.1.0</mockito.version>
         <org.mapstruct.version>1.4.2.Final</org.mapstruct.version>
         <pmd.version>6.41.0</pmd.version>
-        <spotbugs.version>4.5.0</spotbugs.version>
+        <spotbugs.version>4.5.1</spotbugs.version>
         <testcontainers.version>1.16.2</testcontainers.version>
         <!-- Plugin Versions -->
         <license-maven-plugin.version>4.1</license-maven-plugin.version>
@@ -264,7 +264,7 @@
             <plugin>
                 <groupId>net.revelc.code.formatter</groupId>
                 <artifactId>formatter-maven-plugin</artifactId>
-                <version>2.17.0</version>
+                <version>2.17.1</version>
                 <executions>
                     <execution>
                         <goals>