Add Project URL configuration

Author: Neno Stefanov

.github/workflows/ci.yml

@@ -89,8 +89,11 @@ jobs:
           TEST_CUV_CLIENT_SECRET: ${{ secrets.TEST_CUV_CLIENT_SECRET }}
           TEST_CUV_CLIENT_ID: ${{ vars.TEST_CUV_CLIENT_ID }}
           TEST_CUV_PROJECT_ID: ${{ vars.TEST_CUV_PROJECT_ID }}
+          TEST_CUV_PROJECT_URL: ${{ vars.TEST_CUV_PROJECT_URL }}
           TEST_DV_PROJECT_ID: ${{ vars.TEST_DV_PROJECT_ID }}
+          TEST_DV_PROJECT_URL: ${{ vars.TEST_DV_PROJECT_URL }}
           TEST_ECV_PROJECT_ID: ${{ vars.TEST_ECV_PROJECT_ID }}
+          TEST_ECV_PROJECT_URL: ${{ vars.TEST_ECV_PROJECT_URL }}
           GMAIL_CREDENTIALS: ${{ secrets.GMAIL_CREDENTIALS }}
           GMAIL_TOKEN: ${{ secrets.GMAIL_TOKEN }}
         with:

README.md

@@ -47,22 +47,22 @@ The MIRACL Trust Android SDK provides the following functionalities:
 
 To configure the SDK:
 
-1. Create an application in the MIRACL Trust platform. For information about how
+1. Create an account in the MIRACL Trust platform. For information about how
    to do it, see the
    [Getting Started](https://miracl.com/resources/docs/guides/get-started/)
    guide.
-2. Call the
+1. Call the
    [configure](https://miracl.github.io/trust-sdk-android/miracl-sdk/com.miracl.trust/-m-i-r-a-c-l-trust/-companion/configure.html)
    method with a configuration created by the [Configuration.Builder](https://miracl.github.io/trust-sdk-android/miracl-sdk/com.miracl.trust.configuration/-configuration/-builder/index.html)
-   class:
+   class using [your project properties](https://miracl.com/resources/docs/get-started/create-project/#project-properties):
 
 Kotlin:
 
 ```kotlin
 class YourApplication : Application() {
     override fun onCreate() {
         super.onCreate()
-        val configuration = Configuration.Builder(YOUR_PROJECT_ID).build()
+        val configuration = Configuration.Builder(PROJECT_ID, PROJECT_URL).build()
         MIRACLTrust.configure(applicationContext, configuration)
     }
 }
@@ -75,7 +75,7 @@ public class YourApplication extends Application {
     @Override
     public void onCreate() {
         super.onCreate();
-        Configuration configuration = new Configuration.Builder(YOUR_PROJECT_ID).build();
+        Configuration configuration = new Configuration.Builder(PROJECT_ID, PROJECT_URL).build();
         MIRACLTrust.configure(getApplicationContext(), configuration);
     }
 }

miracl-sdk/api/miracl-sdk.api

@@ -64,6 +64,7 @@ public final class com/miracl/trust/MIRACLTrust {
 	public final fun sign (Lcom/miracl/trust/session/CrossDeviceSession;Lcom/miracl/trust/model/User;Lcom/miracl/trust/delegate/PinProvider;Lcom/miracl/trust/delegate/ResultHandler;)V
 	public final fun sign ([BLcom/miracl/trust/model/User;Lcom/miracl/trust/delegate/PinProvider;Lcom/miracl/trust/delegate/ResultHandler;)V
 	public final fun sign ([BLcom/miracl/trust/model/User;Lcom/miracl/trust/session/SigningSessionDetails;Lcom/miracl/trust/delegate/PinProvider;Lcom/miracl/trust/delegate/ResultHandler;)V
+	public final fun updateProjectSettings (Ljava/lang/String;Ljava/lang/String;)V
 }
 
 public final class com/miracl/trust/MIRACLTrust$Companion {
@@ -130,14 +131,15 @@ public final class com/miracl/trust/configuration/Configuration {
 
 public final class com/miracl/trust/configuration/Configuration$Builder {
 	public fun <init> (Ljava/lang/String;)V
+	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
+	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public final fun applicationInfo (Ljava/lang/String;)Lcom/miracl/trust/configuration/Configuration$Builder;
 	public final fun build ()Lcom/miracl/trust/configuration/Configuration;
 	public final fun connectTimeout (I)Lcom/miracl/trust/configuration/Configuration$Builder;
 	public final fun deviceName (Ljava/lang/String;)Lcom/miracl/trust/configuration/Configuration$Builder;
 	public final fun httpRequestExecutor (Lcom/miracl/trust/network/HttpRequestExecutor;)Lcom/miracl/trust/configuration/Configuration$Builder;
 	public final fun logger (Lcom/miracl/trust/util/log/Logger;)Lcom/miracl/trust/configuration/Configuration$Builder;
 	public final fun loggingLevel (Lcom/miracl/trust/util/log/Logger$LoggingLevel;)Lcom/miracl/trust/configuration/Configuration$Builder;
-	public final fun platformUrl (Ljava/lang/String;)Lcom/miracl/trust/configuration/Configuration$Builder;
 	public final fun readTimeout (I)Lcom/miracl/trust/configuration/Configuration$Builder;
 	public final fun userStorage (Lcom/miracl/trust/storage/UserStorage;)Lcom/miracl/trust/configuration/Configuration$Builder;
 }
@@ -149,6 +151,10 @@ public final class com/miracl/trust/configuration/ConfigurationException$EmptyPr
 	public static final field INSTANCE Lcom/miracl/trust/configuration/ConfigurationException$EmptyProjectId;
 }
 
+public final class com/miracl/trust/configuration/ConfigurationException$InvalidProjectUrl : com/miracl/trust/configuration/ConfigurationException {
+	public static final field INSTANCE Lcom/miracl/trust/configuration/ConfigurationException$InvalidProjectUrl;
+}
+
 public abstract class com/miracl/trust/crypto/CryptoException : java/lang/Exception {
 	public synthetic fun <init> (Ljava/lang/Throwable;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public synthetic fun <init> (Ljava/lang/Throwable;Lkotlin/jvm/internal/DefaultConstructorMarker;)V

miracl-sdk/build.gradle

@@ -69,15 +69,16 @@ android {
         }
 
         debug {
-            buildConfigField "String", "BASE_URL", "\"${project.getProperties().get('miracltrust.baseUrl')}\""
-
             buildConfigField "String", "CUV_PROJECT_ID", "\"${project.getProperties().get('miracltrust.cuvProjectId')}\""
+            buildConfigField "String", "CUV_PROJECT_URL", "\"${project.getProperties().get('miracltrust.cuvProjectUrl')}\""
             buildConfigField "String", "CUV_CLIENT_ID", "\"${project.getProperties().get('miracltrust.cuvClientId')}\""
             buildConfigField "String", "CUV_CLIENT_SECRET", "\"${project.getProperties().get('miracltrust.cuvClientSecret')}\""
 
             buildConfigField "String", "DV_PROJECT_ID", "\"${project.getProperties().get('miracltrust.dvProjectId')}\""
+            buildConfigField "String", "DV_PROJECT_URL", "\"${project.getProperties().get('miracltrust.dvProjectUrl')}\""
 
             buildConfigField "String", "ECV_PROJECT_ID", "\"${project.getProperties().get('miracltrust.ecvProjectId')}\""
+            buildConfigField "String", "ECV_PROJECT_URL", "\"${project.getProperties().get('miracltrust.ecvProjectUrl')}\""
         }
     }
 

miracl-sdk/gradle.properties

@@ -1,9 +1,10 @@
-miracltrust.baseUrl=
-
 miracltrust.cuvProjectId=
+miracltrust.cuvProjectUrl=
 miracltrust.cuvClientId=
 miracltrust.cuvClientSecret=
 
 miracltrust.dvProjectId=
+miracltrust.dvProjectUrl=
 
-miracltrust.ecvProjectId=
+miracltrust.ecvProjectId=
+miracltrust.ecvProjectUrl=

miracl-sdk/src/androidTest/java/com/miracl/trust/MIRACLTrustJavaTest.java

@@ -54,6 +54,7 @@
 
 public class MIRACLTrustJavaTest {
     private final String projectId = BuildConfig.CUV_PROJECT_ID;
+    private final String projectUrl = BuildConfig.CUV_PROJECT_URL;
     private final String clientId = BuildConfig.CUV_CLIENT_ID;
     private final String clientSecret = BuildConfig.CUV_CLIENT_SECRET;
 
@@ -64,8 +65,7 @@ public class MIRACLTrustJavaTest {
 
     @Before
     public void setUp() throws ConfigurationException {
-        Configuration configuration = new Configuration.Builder(projectId)
-                .platformUrl(BuildConfig.BASE_URL)
+        Configuration configuration = new Configuration.Builder(projectId, projectUrl)
                 .coroutineContext$miracl_sdk_debug(testCoroutineDispatcher)
                 .build();
         MIRACLTrust.configure(InstrumentationRegistry.getInstrumentation().getContext(), configuration);
@@ -77,7 +77,7 @@ public void setUp() throws ConfigurationException {
 
     @Test
     public void testDefaultVerification() throws ConfigurationException {
-        miraclTrust.setProjectId(BuildConfig.DV_PROJECT_ID);
+        miraclTrust.updateProjectSettings(BuildConfig.DV_PROJECT_ID, BuildConfig.DV_PROJECT_URL);
 
         long timestamp = getUnixTime();
         miraclTrust.sendVerificationEmail(USER_ID, result -> {
@@ -104,6 +104,7 @@ public void testDefaultVerification() throws ConfigurationException {
     @Test
     public void testCustomVerification() {
         String verificationUrl = MIRACLService.INSTANCE.getVerificationUrl(
+                BuildConfig.CUV_PROJECT_URL,
                 BuildConfig.CUV_CLIENT_ID,
                 BuildConfig.CUV_CLIENT_SECRET,
                 USER_ID,
@@ -150,6 +151,7 @@ public void testQuickCode() {
     @Test
     public void testRegistration() {
         String activationToken = MIRACLService.INSTANCE.obtainActivationToken(
+                BuildConfig.CUV_PROJECT_URL,
                 BuildConfig.CUV_CLIENT_ID,
                 BuildConfig.CUV_CLIENT_SECRET,
                 USER_ID
@@ -172,15 +174,15 @@ public void testAuthentication() {
             Assert.assertTrue(result instanceof MIRACLSuccess);
 
             String token = ((MIRACLSuccess<String, AuthenticationException>) result).getValue();
-            Jws<Claims> claims = JwtHelper.INSTANCE.parseSignedClaims(token);
+            Jws<Claims> claims = JwtHelper.INSTANCE.parseSignedClaims(token, projectUrl);
             Assert.assertTrue(claims.getPayload().getAudience().contains(projectId));
         }));
         testCoroutineDispatcher.getScheduler().advanceUntilIdle();
     }
 
     @Test
     public void testAuthenticationWithCrossDeviceSession() {
-        String qrCode = MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL();
+        String qrCode = MIRACLService.INSTANCE.obtainAccessId().getQrURL();
         miraclTrust.getCrossDeviceSessionFromQRCode(qrCode, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
 
@@ -195,7 +197,7 @@ public void testAuthenticationWithCrossDeviceSession() {
 
     @Test
     public void testAppLinkAuthentication() {
-        Uri appLink = Uri.parse(MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL());
+        Uri appLink = Uri.parse(MIRACLService.INSTANCE.obtainAccessId().getQrURL());
         createUser(user -> miraclTrust.authenticateWithAppLink(user, appLink, pinProvider, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
         }));
@@ -204,7 +206,7 @@ public void testAppLinkAuthentication() {
 
     @Test
     public void testQRCodeAuthentication() {
-        String qrCode = MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL();
+        String qrCode = MIRACLService.INSTANCE.obtainAccessId().getQrURL();
         createUser(user -> miraclTrust.authenticateWithQRCode(user, qrCode, pinProvider, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
         }));
@@ -213,7 +215,7 @@ public void testQRCodeAuthentication() {
 
     @Test
     public void testNotificationAuthentication() {
-        String qrUrl = MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL();
+        String qrUrl = MIRACLService.INSTANCE.obtainAccessId().getQrURL();
         Map<String, String> payload = new HashMap<String, String>() {
             {
                 put("projectID", projectId);
@@ -236,7 +238,7 @@ public void testSigning() {
             SigningResult signingResult = ((MIRACLSuccess<SigningResult, SigningException>) result).getValue();
             Signature signature = signingResult.getSignature();
             int timestamp = (int) (signingResult.getTimestamp().getTime() / 1000);
-            boolean signatureVerified = MIRACLService.INSTANCE.verifySignature(projectId, clientId, clientSecret, signature, timestamp);
+            boolean signatureVerified = MIRACLService.INSTANCE.verifySignature(projectId, projectUrl, clientId, clientSecret, signature, timestamp);
             Assert.assertTrue(signatureVerified);
         }));
         testCoroutineDispatcher.getScheduler().advanceUntilIdle();
@@ -275,7 +277,7 @@ public void testDeleteUser() {
 
     @Test
     public void testGetAuthenticationSessionDetailsFromAppLink() {
-        Uri appLink = Uri.parse(MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL());
+        Uri appLink = Uri.parse(MIRACLService.INSTANCE.obtainAccessId().getQrURL());
         miraclTrust.getAuthenticationSessionDetailsFromAppLink(appLink, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
 
@@ -288,7 +290,7 @@ public void testGetAuthenticationSessionDetailsFromAppLink() {
 
     @Test
     public void testGetAuthenticationSessionDetailsFromQRCode() {
-        String qrCode = MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL();
+        String qrCode = MIRACLService.INSTANCE.obtainAccessId().getQrURL();
         miraclTrust.getAuthenticationSessionDetailsFromQRCode(qrCode, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
 
@@ -301,7 +303,7 @@ public void testGetAuthenticationSessionDetailsFromQRCode() {
 
     @Test
     public void testGetAuthenticationSessionDetailsFromNotificationPayload() {
-        String qrUrl = MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL();
+        String qrUrl = MIRACLService.INSTANCE.obtainAccessId().getQrURL();
         Map<String, String> payload = new HashMap<String, String>() {
             {
                 put("projectID", projectId);
@@ -322,7 +324,7 @@ public void testGetAuthenticationSessionDetailsFromNotificationPayload() {
 
     @Test
     public void testAbortAuthenticationSession() {
-        String qrCode = MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL();
+        String qrCode = MIRACLService.INSTANCE.obtainAccessId().getQrURL();
         miraclTrust.getAuthenticationSessionDetailsFromQRCode(qrCode, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
 
@@ -340,7 +342,7 @@ public void testGetSigningSessionDetailsFromAppLink() {
         String hash = randomUuidString();
         String description = randomUuidString();
         SigningSessionCreateResponse signingSessionCreateResponse =
-                MIRACLService.INSTANCE.createSigningSession(projectId, USER_ID, hash, description);
+                MIRACLService.INSTANCE.createSigningSession(projectId, projectUrl, USER_ID, hash, description);
         Uri appLink = Uri.parse(signingSessionCreateResponse.getQrURL());
         miraclTrust.getSigningSessionDetailsFromAppLink(appLink, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
@@ -360,7 +362,7 @@ public void testGetSigningSessionDetailsFromQRCode() {
         String hash = randomUuidString();
         String description = randomUuidString();
         SigningSessionCreateResponse signingSessionCreateResponse =
-                MIRACLService.INSTANCE.createSigningSession(projectId, USER_ID, hash, description);
+                MIRACLService.INSTANCE.createSigningSession(projectId, projectUrl, USER_ID, hash, description);
         String qrCode = signingSessionCreateResponse.getQrURL();
         miraclTrust.getSigningSessionDetailsFromQRCode(qrCode, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
@@ -379,7 +381,7 @@ public void testGetSigningSessionDetailsFromQRCode() {
     public void testAbortSigningSession() {
         String hash = randomUuidString();
         String description = randomUuidString();
-        Uri appLink = Uri.parse(MIRACLService.INSTANCE.createSigningSession(projectId, USER_ID, hash, description).getQrURL());
+        Uri appLink = Uri.parse(MIRACLService.INSTANCE.createSigningSession(projectId, projectUrl, USER_ID, hash, description).getQrURL());
         miraclTrust.getSigningSessionDetailsFromAppLink(appLink, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
 
@@ -394,7 +396,7 @@ public void testAbortSigningSession() {
 
     @Test
     public void testGetCrossDeviceSessionFromAppLink() {
-        Uri appLink = Uri.parse(MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL());
+        Uri appLink = Uri.parse(MIRACLService.INSTANCE.obtainAccessId().getQrURL());
         miraclTrust.getCrossDeviceSessionFromAppLink(appLink, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
 
@@ -407,7 +409,7 @@ public void testGetCrossDeviceSessionFromAppLink() {
 
     @Test
     public void testGetCrossDeviceSessionFromQRCode() {
-        String qrCode = MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL();
+        String qrCode = MIRACLService.INSTANCE.obtainAccessId().getQrURL();
         miraclTrust.getCrossDeviceSessionFromQRCode(qrCode, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
 
@@ -420,7 +422,7 @@ public void testGetCrossDeviceSessionFromQRCode() {
 
     @Test
     public void testGetCrossDeviceSessionFromNotificationPayload() {
-        String qrUrl = MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL();
+        String qrUrl = MIRACLService.INSTANCE.obtainAccessId().getQrURL();
         Map<String, String> payload = new HashMap<String, String>() {
             {
                 put("projectID", projectId);
@@ -441,7 +443,7 @@ public void testGetCrossDeviceSessionFromNotificationPayload() {
 
     @Test
     public void testAbortCrossDeviceSession() {
-        String qrCode = MIRACLService.INSTANCE.obtainAccessId(projectId, USER_ID).getQrURL();
+        String qrCode = MIRACLService.INSTANCE.obtainAccessId().getQrURL();
         miraclTrust.getCrossDeviceSessionFromQRCode(qrCode, result -> {
             Assert.assertTrue(result instanceof MIRACLSuccess);
 
@@ -456,6 +458,7 @@ public void testAbortCrossDeviceSession() {
 
     private void createUser(Consumer<User> callback) {
         String activationToken = MIRACLService.INSTANCE.obtainActivationToken(
+                BuildConfig.CUV_PROJECT_URL,
                 BuildConfig.CUV_CLIENT_ID,
                 BuildConfig.CUV_CLIENT_SECRET,
                 USER_ID

miracl-sdk/src/androidTest/java/com/miracl/trust/authentication/AppLinkAuthenticationTest.kt

@@ -24,6 +24,7 @@ import org.junit.Test
 
 class AppLinkAuthenticationTest {
     private val projectId = BuildConfig.CUV_PROJECT_ID
+    private val projectUrl = BuildConfig.CUV_PROJECT_URL
     private val clientId = BuildConfig.CUV_CLIENT_ID
     private val clientSecret = BuildConfig.CUV_CLIENT_SECRET
 
@@ -36,8 +37,7 @@ class AppLinkAuthenticationTest {
 
     @Before
     fun setUp() = runTest {
-        val configuration = Configuration.Builder(projectId)
-            .platformUrl(BuildConfig.BASE_URL)
+        val configuration = Configuration.Builder(projectId, projectUrl)
             .coroutineContext(testCoroutineDispatcher)
             .build()
 
@@ -47,7 +47,8 @@ class AppLinkAuthenticationTest {
 
         pin = randomNumericPin()
         pinProvider = PinProvider { pinConsumer -> pinConsumer.consume(pin) }
-        val activationToken = MIRACLService.obtainActivationToken(clientId, clientSecret, USER_ID)
+        val activationToken =
+            MIRACLService.obtainActivationToken(projectUrl, clientId, clientSecret, USER_ID)
 
         var registrationResult: MIRACLResult<User, RegistrationException>? = null
         miraclTrust.register(