Trusted entitlements: Support signing static endpoints #1119

tonidero · 2023-07-03T16:01:50Z

Description

This adds support for static endpoint signing. Currently, that would be the offerings and product-entitlement mapping endpoints.

codecov · 2023-07-03T16:10:43Z

Codecov Report

Merging #1119 (6575c19) into new-trusted-entitlements-signature-format (77e8fb3) will increase coverage by 0.22%.
The diff coverage is 100.00%.

❗ Current head 6575c19 differs from pull request most recent head 784f8d9. Consider uploading reports for the commit 784f8d9 to get more accurate results

@@                              Coverage Diff                              @@
##           new-trusted-entitlements-signature-format    #1119      +/-   ##
=============================================================================
+ Coverage                                      84.91%   85.13%   +0.22%     
=============================================================================
  Files                                            186      186              
  Lines                                           6614     6586      -28     
  Branches                                         947      944       -3     
=============================================================================
- Hits                                            5616     5607       -9     
+ Misses                                           622      603      -19     
  Partials                                         376      376

Impacted Files	Coverage Δ
...java/com/revenuecat/purchases/common/HTTPClient.kt	`90.07% <100.00%> (+0.07%)`	⬆️
...revenuecat/purchases/common/networking/Endpoint.kt	`100.00% <100.00%> (ø)`

... and 1 file with indirect coverage changes

tonidero · 2023-07-04T08:25:26Z

Backend integration tests are expected to fail until the backend changes have been deployed. I'm also pointing these changes to an integration branch until those changes are deployed.

NachoSoto · 2023-07-04T16:19:57Z

common/src/main/java/com/revenuecat/purchases/common/networking/Endpoint.kt

+                false
+        }
+
+    val needsNonceToPerformSigning: Boolean


This is great 👍🏻

tonidero · 2023-07-05T17:29:11Z

...c/test/java/com/revenuecat/purchases/backend_integration_tests/BaseBackendIntegrationTest.kt

@@ -87,14 +96,12 @@ abstract class BaseBackendIntegrationTest {
            every { edit() } returns sharedPreferencesEditor
        }
        eTagManager = ETagManager(sharedPreferences)
-        signingManager = SigningManager(SignatureVerificationMode.Disabled, appConfig, apiKey())
+        signingManager = spyk(SigningManager(signatureVerificationMode, appConfig, apiKey()))


Here I changed to a spy so we can see and verify the calls more easily, but it's using the actual implementation. Since there is no way to know that the offerings/product-entitlement mapping calls were verified or not, this made easier to make sure we were verifying those endpoints

Since there is no way to know that the offerings/product-entitlement mapping calls were verified or not

I checked that by using the "fake invalid signature" thing. Did you add a way to do that in Android too?

Well, I meant in the "success" case, we should make sure we are verifying the signature. But right now there is no way to detect whether a SUCCESS or a NOT_REQUESTED happened. We could maybe if we could verify the logs, but I haven't added that in Android yet. Until then, this makes sure we are at least calling the signingManager.verify method, so it shouldn't be NOT_REQUESTED.

NachoSoto

Love it.

NachoSoto · 2023-07-05T19:26:34Z

common/src/main/java/com/revenuecat/purchases/common/verification/SigningManager.kt

@@ -142,6 +143,7 @@ class SigningManager(
                )

                return if (verificationResult) {
+                    verboseLog(NetworkStrings.VERIFICATION_SUCCESS.format(urlPath))


NachoSoto · 2023-07-05T19:27:19Z

...c/test/java/com/revenuecat/purchases/backend_integration_tests/BaseBackendIntegrationTest.kt

@@ -87,14 +96,12 @@ abstract class BaseBackendIntegrationTest {
            every { edit() } returns sharedPreferencesEditor
        }
        eTagManager = ETagManager(sharedPreferences)
-        signingManager = SigningManager(SignatureVerificationMode.Disabled, appConfig, apiKey())
+        signingManager = spyk(SigningManager(signatureVerificationMode, appConfig, apiKey()))


Since there is no way to know that the offerings/product-entitlement mapping calls were verified or not

I checked that by using the "fake invalid signature" thing. Did you add a way to do that in Android too?

common/src/test/java/com/revenuecat/purchases/common/HTTPClientVerificationTest.kt

common/src/test/java/com/revenuecat/purchases/common/networking/EndpointTest.kt

NachoSoto · 2023-07-05T19:28:39Z

common/src/test/java/com/revenuecat/purchases/common/networking/EndpointTest.kt

+    }
+
+    @Test
+    fun `needsNonceToPerformSigning is true for expected values`() {


These tests are great.

common/src/main/java/com/revenuecat/purchases/common/networking/Endpoint.kt

NachoSoto · 2023-07-05T22:28:36Z

common/src/main/java/com/revenuecat/purchases/common/networking/Endpoint.kt

@@ -33,6 +33,22 @@ sealed class Endpoint(val pathTemplate: String, val name: String) {
    }

    val supportsSignatureValidation: Boolean


Also this isn't used now?

Done in iOS: RevenueCat/purchases-ios#2752

Also this isn't used now?

It's used in the signing manager:

purchases-android/purchases/src/main/kotlin/com/revenuecat/purchases/common/verification/SigningManager.kt

Line 23 in ef34062

return endpoint.supportsSignatureValidation && signatureVerificationMode.shouldVerify

tonidero · 2023-07-06T08:53:31Z

Will merge this and rerun the backend integration tests there once the backend is deployed.

…oints with no signature (#2752) Equivalent to RevenueCat/purchases-android#1119

### Description Integration branch for the changes in trusted entitlements. Includes changes from: - #1111 - #1114 - #1118 - #1119 - #1124

### Description This is based on #1119. Looks like the merge commit for that PR was lost in a rebase in the base PR #1117 😬. This adds support for static endpoint signing. Currently, that would be the offerings and product-entitlement mapping endpoints.

tonidero added the refactor label Jul 3, 2023

tonidero added 4 commits July 4, 2023 09:50

Support signing static endpoints

accfeee

Add backend integration tests

4c2db46

Add more backend integration tests

a8dc79f

Verify that signing is happening

d29e3a5

tonidero force-pushed the toniricodiez/sdk-2990-add-signing-to-the-entitlementmapping-endpoint-android branch from 6575c19 to d29e3a5 Compare July 4, 2023 08:10

Add verbose log to indicate successful verification

784f8d9

tonidero marked this pull request as ready for review July 4, 2023 08:14

tonidero requested a review from a team July 4, 2023 08:14

tonidero mentioned this pull request Jul 4, 2023

Trusted entitlements: New trusted entitlements signature format #1117

Merged

NachoSoto reviewed Jul 4, 2023

View reviewed changes

tonidero commented Jul 5, 2023

View reviewed changes

NachoSoto approved these changes Jul 5, 2023

View reviewed changes

NachoSoto reviewed Jul 5, 2023

View reviewed changes

common/src/main/java/com/revenuecat/purchases/common/networking/Endpoint.kt Outdated Show resolved Hide resolved

NachoSoto reviewed Jul 5, 2023

View reviewed changes

NachoSoto mentioned this pull request Jul 5, 2023

Trusted Entitlements: produce verification failures for static endpoints with no signature RevenueCat/purchases-ios#2752

Merged

Changes from PR review

7d337ca

tonidero merged commit 467003f into new-trusted-entitlements-signature-format Jul 6, 2023

tonidero deleted the toniricodiez/sdk-2990-add-signing-to-the-entitlementmapping-endpoint-android branch July 6, 2023 09:00

NachoSoto added a commit to RevenueCat/purchases-ios that referenced this pull request Jul 6, 2023

Trusted Entitlements: produce verification failures for static endp…

bd3ac5f

…oints with no signature (#2752) Equivalent to RevenueCat/purchases-android#1119

tonidero added a commit that referenced this pull request Jul 7, 2023

Trusted entitlements: New trusted entitlements signature format (#1117)

e8a90a0

### Description Integration branch for the changes in trusted entitlements. Includes changes from: - #1111 - #1114 - #1118 - #1119 - #1124

tonidero mentioned this pull request Jul 10, 2023

Trusted entitlements: Support signing static endpoints #1131

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Trusted entitlements: Support signing static endpoints #1119

Trusted entitlements: Support signing static endpoints #1119

tonidero commented Jul 3, 2023

codecov bot commented Jul 3, 2023 •

edited

Loading

tonidero commented Jul 4, 2023

NachoSoto Jul 4, 2023

tonidero Jul 5, 2023

NachoSoto Jul 5, 2023

tonidero Jul 6, 2023

NachoSoto left a comment

NachoSoto Jul 5, 2023

NachoSoto Jul 5, 2023

NachoSoto Jul 5, 2023

NachoSoto Jul 5, 2023

NachoSoto Jul 5, 2023

tonidero Jul 6, 2023

tonidero commented Jul 6, 2023

		@@ -33,6 +33,22 @@ sealed class Endpoint(val pathTemplate: String, val name: String) {
		}

		val supportsSignatureValidation: Boolean

Trusted entitlements: Support signing static endpoints #1119

Trusted entitlements: Support signing static endpoints #1119

Conversation

tonidero commented Jul 3, 2023

Description

codecov bot commented Jul 3, 2023 • edited Loading

Codecov Report

tonidero commented Jul 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NachoSoto left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonidero commented Jul 6, 2023

codecov bot commented Jul 3, 2023 •

edited

Loading