Merge pull request #16 from approov/feature/dontWrapOnMissingIpk

Feature/dont wrap on missing ipk

Author: ivolz

CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this package will be documented in this file.
+
+The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
+
+
+## [3.5.5] - 2026-03-25
+
+### Added
+- ApproovServiceMutator protocol with default behavior to centralize decision points in the service flow.
+- Mutator hooks for precheck, token fetch, secure string fetch, custom JWT fetch, interceptor decisions, and pinning.
+- REFERENCE.md & CHANGELOG.md & USAGE.md
+- Added `setUseApproovStatusIfNoToken` to allow using status as token value when token is missing.
+### Changed
+- ApproovService now routes decision logic through the service mutator and exposes set/get APIs.
+- Pinning logic is now applied via `ApproovPinningInterceptor` which checks `ApproovServiceMutator.handlePinningShouldProcessRequest`.
+- Update version to 3.5.5
+### Fixed
+- Prevented exceptions when key-pair generation fails. The service now logs an error and continues without the install message signature, allowing the backend to decide whether to reject the request. (inherited from shared sdk update)
+- Memory leak fix in pinned handshake cache using LinkedHashSet.
+- Initialized the Retrofit instance cache statically to avoid `NullPointerException` when `setOkHttpClientBuilder` or `getRetrofit` are called before `initialize`.
+### Deprecated
+- ApproovInterceptorExtensions in favor of ApproovServiceMutator.
+- setProceedOnNetworkFail() and getProceedOnNetworkFail() in favor of setServiceMutator.
+- prefetch() is now automatically called when the service is initialized.

README.md

@@ -4,6 +4,18 @@ A wrapper for the [Approov SDK](https://github.com/approov/approov-android-sdk)
 
 See [Java](https://github.com/approov/quickstart-android-java-retrofit) and [Kotlin](https://github.com/approov/quickstart-android-kotlin-retrofit) quickstarts for instructions on how to use this.
 
+# Changelog
+
+Please see the [CHANGELOG.md](CHANGELOG.md) for more information on the changes in each version.
+
+# Reference
+
+Please see the [REFERENCE.md](REFERENCE.md) for more information on the Approov Service for Retrofit.
+
+# Usage
+
+Please see the [USAGE.md](USAGE.md) for more information on how to use this wrapper.
+
 ## Included 3rd party Source
 
 To support message signing, this repo has adapted code released by two 3rd

REFERENCE.md

@@ -26,6 +26,12 @@ android {
         sourceCompatibility JavaVersion.VERSION_1_8
         targetCompatibility JavaVersion.VERSION_1_8
     }
+    testOptions {
+        unitTests.returnDefaultValues = true
+        unitTests.all {
+            jvmArgs '-Dnet.bytebuddy.experimental=true'
+        }
+    }
 }
 
 dependencies {
@@ -36,4 +42,5 @@ dependencies {
     implementation 'com.squareup.retrofit2:converter-gson:2.11.0'
     implementation 'androidx.annotation:annotation-jvm:1.9.1'
     testImplementation 'junit:junit:4.13.2'
+    testImplementation 'org.mockito:mockito-inline:5.2.0'
 }

USAGE.md

@@ -39,7 +39,7 @@
     </dependency>
     <dependency>
       <groupId>org.bouncycastle</groupId>
-      <artifactId>bcprov-jdk18on</artifactId>
+      <artifactId>bcprov-jdk15to18</artifactId>
       <version>1.80</version>
       <scope>runtime</scope>
     </dependency>
@@ -52,15 +52,21 @@
     <dependency>
         <groupId>com.squareup.retrofit2</groupId>
         <artifactId>retrofit</artifactId>
-        <version>2.9.0</version>
+        <version>2.11.0</version>
         <scope>runtime</scope>
     </dependency>
     <dependency>
         <groupId>com.squareup.retrofit2</groupId>
         <artifactId>converter-gson</artifactId>
-        <version>2.9.0</version>
+        <version>2.11.0</version>
+        <scope>runtime</scope>
+    </dependency>
+    <dependency>
+        <groupId>androidx.annotation</groupId>
+        <artifactId>annotation-jvm</artifactId>
+        <version>1.9.1</version>
         <scope>runtime</scope>
     </dependency>
 </dependencies>
 
-</project>
+</project>

approov-service/build.gradle

@@ -135,6 +135,38 @@ protected SignatureParameters buildSignatureParameters(OkHttpComponentProvider p
         return factory.buildSignatureParameters(provider, changes);
     }
 
+    /**
+     * Retrieves an install message signature for the supplied message.
+     *
+     * @param message The message to be signed.
+     * @return The base64-encoded ASN.1 DER signature.
+     * @throws ApproovException If signing is unavailable.
+     */
+    protected String getInstallMessageSignature(String message) throws ApproovException {
+        return ApproovService.getInstallMessageSignature(message);
+    }
+
+    /**
+     * Retrieves an account message signature for the supplied message.
+     *
+     * @param message The message to be signed.
+     * @return The base64-encoded signature.
+     * @throws ApproovException If signing is unavailable.
+     */
+    protected String getAccountMessageSignature(String message) throws ApproovException {
+        return ApproovService.getAccountMessageSignature(message);
+    }
+
+    /**
+     * Decodes a base64-encoded signature value.
+     *
+     * @param base64 The signature bytes encoded as base64.
+     * @return The decoded bytes.
+     */
+    protected byte[] decodeBase64(String base64) {
+        return Base64.decode(base64, Base64.NO_WRAP);
+    }
+
     /**
      * Converts one part, encoded as an ASN1Integer, of an ASN.1 DER encoded ES256 signature to a byte array of
      * exactly 32 bytes. Throws IllegalArgumentException if this is not possible.
@@ -197,8 +229,18 @@ public Request processedRequest(Request request, ApproovRequestMutations changes
         switch (params.getAlg()) {
             case ALG_ES256: {
                 sigId = "install";
-                String base64 = ApproovService.getInstallMessageSignature(message);
-                signature = Base64.decode(base64, Base64.NO_WRAP);
+                String base64;
+                try {
+                    base64 = getInstallMessageSignature(message);
+                } catch (ApproovException e) {
+                    Log.d(TAG, "Failed to get InstallMessageSignature - skipping message signing " + e);
+                    return request;
+                }
+                if (base64.isEmpty()) {
+                    Log.d(TAG, "InstallMessageSignature is empty - skipping message signing");
+                    return request;
+                }
+                signature = decodeBase64(base64);
                 // decode the signature from ASN.1 DER format
                 try (ASN1InputStream asn1InputStream = new ASN1InputStream(signature)) {
                     ASN1Sequence sequence = (ASN1Sequence) asn1InputStream.readObject();
@@ -219,8 +261,8 @@ public Request processedRequest(Request request, ApproovRequestMutations changes
             }
             case ALG_HS256: {
                 sigId = "account";
-                String base64 = ApproovService.getAccountMessageSignature(message);
-                signature = Base64.decode(base64, Base64.NO_WRAP);
+                String base64 = getAccountMessageSignature(message);
+                signature = decodeBase64(base64);
                 break;
             }
             default:
@@ -242,16 +284,19 @@ public Request processedRequest(Request request, ApproovRequestMutations changes
         // Update the request from the one held by the component provider as the signature builder
         // may have modified it.
         Request.Builder signedBuilder = provider.getRequest().newBuilder()
-                .addHeader("Signature", sigHeader)
-                .addHeader("Signature-Input", sigInputHeader);
+                .removeHeader("Signature")
+                .removeHeader("Signature-Input")
+                .removeHeader("Signature-Base-Digest")
+                .header("Signature", sigHeader)
+                .header("Signature-Input", sigInputHeader);
         if (params.isDebugMode()) {
             try {
                 MessageDigest digestBuilder = MessageDigest.getInstance("SHA-256");
                 digestBuilder.reset();
                 byte[] digest = digestBuilder.digest(message.getBytes(StandardCharsets.UTF_8));
                 String digestHeader = Dictionary.valueOf(Map.of(
                         DIGEST_SHA256, ByteSequenceItem.valueOf(digest))).serialize();
-                signedBuilder.addHeader("Signature-Base-Digest", digestHeader);
+                signedBuilder.header("Signature-Base-Digest", digestHeader);
             } catch (NoSuchAlgorithmException e) {
                 Log.d(TAG, "Failed to get digest algorithm - no debug entry " + e);
             }
@@ -490,7 +535,7 @@ protected boolean generateBodyDigest(OkHttpComponentProvider provider, Signature
             // add the digest to the request
             Request request = provider.getRequest();
             request = request.newBuilder()
-                    .addHeader("Content-Digest", digestHeader.serialize())
+                    .header("Content-Digest", digestHeader.serialize())
                     .build();
             provider.setRequest(request);
             // add the header to the SignatureParameters

approov-service/pom.xml

@@ -0,0 +1,48 @@
+//
+// MIT License
+//
+// Copyright (c) 2016-present, Approov Ltd.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
+// (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge,
+// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+// subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
+// ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
+// THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+package io.approov.service.retrofit;
+
+import com.criticalblue.approovsdk.Approov;
+
+/**
+ * Exception raised when an Approov token fetch returns a status other than success.
+ */
+public class ApproovFetchStatusException extends ApproovException {
+
+    private final Approov.TokenFetchStatus tokenFetchStatus;
+
+    /**
+     * Constructs a token fetch status exception with the provided status.
+     *
+     * @param status status returned by the Approov SDK, may be {@code null} if unavailable
+     * @param message information describing the exception cause
+     */
+    public ApproovFetchStatusException(Approov.TokenFetchStatus status, String message) {
+        super(message);
+        this.tokenFetchStatus = status;
+    }
+
+    /**
+     * Retrieves the token fetch status associated with this exception.
+     *
+     * @return the status returned by the Approov SDK, or {@code null} if not provided
+     */
+    public Approov.TokenFetchStatus getTokenFetchStatus() {
+        return tokenFetchStatus;
+    }
+}

approov-service/src/main/java/io/approov/service/retrofit/ApproovDefaultMessageSigning.java

@@ -23,16 +23,34 @@
  * ApproovInterceptorExtensions provides an interface for handling callbacks during
  * the processing of network requests by Approov. It allows further modifications
  * to requests after Approov has applied its changes.
+ *
+ * @deprecated Replace implementations of this interface with ApproovServiceMutator
+ * while changing the name of the ApproovInterceptorExtensions.processedRequest
+ * method to ApproovServiceMutator.handleInterceptorProcessedRequest.
  */
-public interface ApproovInterceptorExtensions {
+@Deprecated
+public interface ApproovInterceptorExtensions extends ApproovServiceMutator{
 
     /**
-     * Called after Approov has processed a network request, allowing further modifications.
+     * Replace the default implementation of ApproovServiceMutator.handleInterceptorProcessedRequest
+     * to call the now deprecated ApproovInterceptorExtensions.processedRequest method. 
      *
      * @param request the processed request
      * @param changes the mutations applied to the request by Approov
-     * @return the modified request
+     * @return the final request to use to complete the Approov interceptor step.
      * @throws ApproovException if there is an error during processing
      */
-    Request processedRequest(Request request, ApproovRequestMutations changes) throws ApproovException;
+    default Request handleInterceptorProcessedRequest(Request request, ApproovRequestMutations changes) throws ApproovException {
+        // call the deprecated method to maintain backwards compatibility
+        return processedRequest(request, changes);
+    }
+
+    /**
+     * @deprecated Use ApproovServiceMutator.handleInterceptorProcessedRequest instead.
+     */
+    @Deprecated
+    default Request processedRequest(Request request, ApproovRequestMutations changes) throws ApproovException {
+        // No further changes to the request are required
+        return request;
+    }
 }

approov-service/src/main/java/io/approov/service/retrofit/ApproovFetchStatusException.java

@@ -1,6 +1,6 @@
 //
 // MIT License
-// 
+//
 // Copyright (c) 2016-present, Approov Ltd.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
@@ -9,24 +9,39 @@
 // subject to the following conditions:
 //
 // The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-// 
+//
 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
 // ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
 // THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 package io.approov.service.retrofit;
 
-// ApproovNetworkException indicates an exception caused by networking conditions which is likely to be
-// temporary so a user initiated retry should be performed
-public class ApproovNetworkException extends ApproovException {
+import com.criticalblue.approovsdk.Approov;
+
+/**
+ * @deprecated Use {@link ApproovFetchStatusException} instead. This subtype is retained only to avoid
+ *             breaking existing handlers and call sites; migrate any explicit catches to use the parent class.
+ */
+@Deprecated
+public class ApproovNetworkException extends ApproovFetchStatusException {
 
     /**
      * Constructs an Approov networking exception.
      *
-     * @param message is the basic information about the exception cause
+     * @param message basic information about the exception cause
      */
     public ApproovNetworkException(String message) {
-        super(message);
+        super(null, message);
+    }
+
+    /**
+     * Constructs an Approov networking exception with a specific token fetch status.
+     *
+     * @param status token fetch status that triggered the error
+     * @param message basic information about the exception cause
+     */
+    public ApproovNetworkException(Approov.TokenFetchStatus status, String message) {
+        super(status, message);
     }
 }