@capawesome/capacitor-app-integrity 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/AppIntegrity.java

@@ -0,0 +1,208 @@
+package io.capawesome.capacitorjs.plugins.appintegrity;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.google.android.gms.common.ConnectionResult;
+import com.google.android.gms.common.GoogleApiAvailabilityLight;
+import com.google.android.play.core.integrity.IntegrityManagerFactory;
+import com.google.android.play.core.integrity.IntegrityServiceException;
+import com.google.android.play.core.integrity.IntegrityTokenRequest;
+import com.google.android.play.core.integrity.StandardIntegrityException;
+import com.google.android.play.core.integrity.StandardIntegrityManager;
+import com.google.android.play.core.integrity.model.IntegrityErrorCode;
+import com.google.android.play.core.integrity.model.StandardIntegrityErrorCode;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.CustomException;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.CustomExceptions;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.options.PrepareIntegrityTokenOptions;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.options.RequestIntegrityTokenOptions;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.results.IsAvailableResult;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.results.RequestIntegrityTokenResult;
+import io.capawesome.capacitorjs.plugins.appintegrity.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.appintegrity.interfaces.NonEmptyResultCallback;
+
+public class AppIntegrity {
+
+    @NonNull
+    private final AppIntegrityPlugin plugin;
+
+    @Nullable
+    private StandardIntegrityManager.StandardIntegrityTokenProvider standardIntegrityTokenProvider;
+
+    public AppIntegrity(@NonNull AppIntegrityPlugin plugin) {
+        this.plugin = plugin;
+    }
+
+    public void isAvailable(@NonNull NonEmptyResultCallback<IsAvailableResult> callback) {
+        int status = GoogleApiAvailabilityLight.getInstance().isGooglePlayServicesAvailable(plugin.getContext());
+        callback.success(new IsAvailableResult(status == ConnectionResult.SUCCESS));
+    }
+
+    public void prepareIntegrityToken(@NonNull PrepareIntegrityTokenOptions options, @NonNull EmptyCallback callback) {
+        StandardIntegrityManager standardIntegrityManager = IntegrityManagerFactory.createStandard(plugin.getContext());
+        StandardIntegrityManager.PrepareIntegrityTokenRequest request = StandardIntegrityManager.PrepareIntegrityTokenRequest.builder()
+            .setCloudProjectNumber(options.getCloudProjectNumber())
+            .build();
+        standardIntegrityManager
+            .prepareIntegrityToken(request)
+            .addOnSuccessListener(provider -> {
+                standardIntegrityTokenProvider = provider;
+                callback.success();
+            })
+            .addOnFailureListener(exception -> callback.error(mapException(exception)));
+    }
+
+    public void requestIntegrityToken(
+        @NonNull RequestIntegrityTokenOptions options,
+        @NonNull NonEmptyResultCallback<RequestIntegrityTokenResult> callback
+    ) throws Exception {
+        String nonce = options.getNonce();
+        String requestHash = options.getRequestHash();
+        if (requestHash != null) {
+            requestStandardIntegrityToken(requestHash, callback);
+        } else if (nonce != null) {
+            requestClassicIntegrityToken(nonce, options.getCloudProjectNumber(), callback);
+        } else {
+            throw CustomExceptions.NONCE_OR_REQUEST_HASH_MISSING;
+        }
+    }
+
+    @NonNull
+    private static Exception mapException(@NonNull Exception exception) {
+        if (exception instanceof IntegrityServiceException) {
+            return mapIntegrityServiceException((IntegrityServiceException) exception);
+        }
+        if (exception instanceof StandardIntegrityException) {
+            return mapStandardIntegrityException((StandardIntegrityException) exception);
+        }
+        return exception;
+    }
+
+    @NonNull
+    private static Exception mapIntegrityServiceException(@NonNull IntegrityServiceException exception) {
+        switch (exception.getErrorCode()) {
+            case IntegrityErrorCode.API_NOT_AVAILABLE:
+                return new CustomException("API_NOT_AVAILABLE", "The Play Integrity API is not available on this device.");
+            case IntegrityErrorCode.APP_NOT_INSTALLED:
+                return new CustomException("APP_NOT_INSTALLED", "The calling app is not installed.");
+            case IntegrityErrorCode.APP_UID_MISMATCH:
+                return new CustomException("APP_UID_MISMATCH", "The calling app UID does not match the one from the package manager.");
+            case IntegrityErrorCode.CANNOT_BIND_TO_SERVICE:
+                return new CustomException("CANNOT_BIND_TO_SERVICE", "The app could not bind to the integrity service in the Play Store.");
+            case IntegrityErrorCode.CLIENT_TRANSIENT_ERROR:
+                return new CustomException(
+                    "CLIENT_TRANSIENT_ERROR",
+                    "A transient error occurred on the device. Retry with an exponential backoff."
+                );
+            case IntegrityErrorCode.CLOUD_PROJECT_NUMBER_IS_INVALID:
+                return new CustomException(null, "cloudProjectNumber is invalid.");
+            case IntegrityErrorCode.GOOGLE_SERVER_UNAVAILABLE:
+                return new CustomException(
+                    "GOOGLE_SERVER_UNAVAILABLE",
+                    "The Google server is currently unavailable. Retry with an exponential backoff."
+                );
+            case IntegrityErrorCode.INTERNAL_ERROR:
+                return new CustomException("INTERNAL_ERROR", "An internal error occurred. Retry with an exponential backoff.");
+            case IntegrityErrorCode.NETWORK_ERROR:
+                return new CustomException("NETWORK_ERROR", "No network connection is available. Retry when the device is online.");
+            case IntegrityErrorCode.NONCE_IS_NOT_BASE64:
+                return new CustomException(null, "nonce must be encoded as a base64 web-safe no-wrap string.");
+            case IntegrityErrorCode.NONCE_TOO_LONG:
+                return new CustomException(null, "nonce must not be longer than 500 bytes.");
+            case IntegrityErrorCode.NONCE_TOO_SHORT:
+                return new CustomException(null, "nonce must be at least 16 bytes long.");
+            case IntegrityErrorCode.PLAY_SERVICES_NOT_FOUND:
+                return new CustomException("PLAY_SERVICES_NOT_FOUND", "Google Play Services is not available on this device.");
+            case IntegrityErrorCode.PLAY_SERVICES_VERSION_OUTDATED:
+                return new CustomException("PLAY_SERVICES_VERSION_OUTDATED", "Google Play Services needs to be updated.");
+            case IntegrityErrorCode.PLAY_STORE_NOT_FOUND:
+                return new CustomException("PLAY_STORE_NOT_FOUND", "No official Play Store app was found on the device.");
+            case IntegrityErrorCode.PLAY_STORE_VERSION_OUTDATED:
+                return new CustomException("PLAY_STORE_VERSION_OUTDATED", "The Play Store app needs to be updated.");
+            case IntegrityErrorCode.TOO_MANY_REQUESTS:
+                return new CustomException("TOO_MANY_REQUESTS", "The calling app is making too many requests and has been throttled.");
+            default:
+                return exception;
+        }
+    }
+
+    @NonNull
+    private static Exception mapStandardIntegrityException(@NonNull StandardIntegrityException exception) {
+        switch (exception.getErrorCode()) {
+            case StandardIntegrityErrorCode.API_NOT_AVAILABLE:
+                return new CustomException("API_NOT_AVAILABLE", "The Play Integrity API is not available on this device.");
+            case StandardIntegrityErrorCode.APP_NOT_INSTALLED:
+                return new CustomException("APP_NOT_INSTALLED", "The calling app is not installed.");
+            case StandardIntegrityErrorCode.APP_UID_MISMATCH:
+                return new CustomException("APP_UID_MISMATCH", "The calling app UID does not match the one from the package manager.");
+            case StandardIntegrityErrorCode.CANNOT_BIND_TO_SERVICE:
+                return new CustomException("CANNOT_BIND_TO_SERVICE", "The app could not bind to the integrity service in the Play Store.");
+            case StandardIntegrityErrorCode.CLIENT_TRANSIENT_ERROR:
+                return new CustomException(
+                    "CLIENT_TRANSIENT_ERROR",
+                    "A transient error occurred on the device. Retry with an exponential backoff."
+                );
+            case StandardIntegrityErrorCode.CLOUD_PROJECT_NUMBER_IS_INVALID:
+                return new CustomException(null, "cloudProjectNumber is invalid.");
+            case StandardIntegrityErrorCode.GOOGLE_SERVER_UNAVAILABLE:
+                return new CustomException(
+                    "GOOGLE_SERVER_UNAVAILABLE",
+                    "The Google server is currently unavailable. Retry with an exponential backoff."
+                );
+            case StandardIntegrityErrorCode.INTEGRITY_TOKEN_PROVIDER_INVALID:
+                return new CustomException(
+                    "INTEGRITY_TOKEN_PROVIDER_INVALID",
+                    "The integrity token provider is invalid. Call prepareIntegrityToken() again."
+                );
+            case StandardIntegrityErrorCode.INTERNAL_ERROR:
+                return new CustomException("INTERNAL_ERROR", "An internal error occurred. Retry with an exponential backoff.");
+            case StandardIntegrityErrorCode.NETWORK_ERROR:
+                return new CustomException("NETWORK_ERROR", "No network connection is available. Retry when the device is online.");
+            case StandardIntegrityErrorCode.PLAY_SERVICES_NOT_FOUND:
+                return new CustomException("PLAY_SERVICES_NOT_FOUND", "Google Play Services is not available on this device.");
+            case StandardIntegrityErrorCode.PLAY_SERVICES_VERSION_OUTDATED:
+                return new CustomException("PLAY_SERVICES_VERSION_OUTDATED", "Google Play Services needs to be updated.");
+            case StandardIntegrityErrorCode.PLAY_STORE_NOT_FOUND:
+                return new CustomException("PLAY_STORE_NOT_FOUND", "No official Play Store app was found on the device.");
+            case StandardIntegrityErrorCode.PLAY_STORE_VERSION_OUTDATED:
+                return new CustomException("PLAY_STORE_VERSION_OUTDATED", "The Play Store app needs to be updated.");
+            case StandardIntegrityErrorCode.REQUEST_HASH_TOO_LONG:
+                return new CustomException(null, "requestHash must not be longer than 500 bytes.");
+            case StandardIntegrityErrorCode.TOO_MANY_REQUESTS:
+                return new CustomException("TOO_MANY_REQUESTS", "The calling app is making too many requests and has been throttled.");
+            default:
+                return exception;
+        }
+    }
+
+    private void requestClassicIntegrityToken(
+        @NonNull String nonce,
+        @Nullable Long cloudProjectNumber,
+        @NonNull NonEmptyResultCallback<RequestIntegrityTokenResult> callback
+    ) {
+        IntegrityTokenRequest.Builder requestBuilder = IntegrityTokenRequest.builder().setNonce(nonce);
+        if (cloudProjectNumber != null) {
+            requestBuilder.setCloudProjectNumber(cloudProjectNumber);
+        }
+        IntegrityManagerFactory.create(plugin.getContext())
+            .requestIntegrityToken(requestBuilder.build())
+            .addOnSuccessListener(response -> callback.success(new RequestIntegrityTokenResult(response.token())))
+            .addOnFailureListener(exception -> callback.error(mapException(exception)));
+    }
+
+    private void requestStandardIntegrityToken(
+        @NonNull String requestHash,
+        @NonNull NonEmptyResultCallback<RequestIntegrityTokenResult> callback
+    ) throws Exception {
+        StandardIntegrityManager.StandardIntegrityTokenProvider provider = standardIntegrityTokenProvider;
+        if (provider == null) {
+            throw CustomExceptions.INTEGRITY_TOKEN_PROVIDER_NOT_PREPARED;
+        }
+        StandardIntegrityManager.StandardIntegrityTokenRequest request = StandardIntegrityManager.StandardIntegrityTokenRequest.builder()
+            .setRequestHash(requestHash)
+            .build();
+        provider
+            .request(request)
+            .addOnSuccessListener(token -> callback.success(new RequestIntegrityTokenResult(token.token())))
+            .addOnFailureListener(exception -> callback.error(mapException(exception)));
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/AppIntegrityPlugin.java

@@ -0,0 +1,137 @@
+package io.capawesome.capacitorjs.plugins.appintegrity;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.CustomException;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.options.PrepareIntegrityTokenOptions;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.options.RequestIntegrityTokenOptions;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.results.IsAvailableResult;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.results.RequestIntegrityTokenResult;
+import io.capawesome.capacitorjs.plugins.appintegrity.interfaces.EmptyCallback;
+import io.capawesome.capacitorjs.plugins.appintegrity.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.appintegrity.interfaces.Result;
+
+@CapacitorPlugin(name = "AppIntegrity")
+public class AppIntegrityPlugin extends Plugin {
+
+    public static final String ERROR_UNKNOWN_ERROR = "An unknown error has occurred.";
+    public static final String TAG = "AppIntegrity";
+
+    private AppIntegrity implementation;
+
+    @Override
+    public void load() {
+        this.implementation = new AppIntegrity(this);
+    }
+
+    @PluginMethod
+    public void attestKey(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+
+    @PluginMethod
+    public void generateAssertion(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+
+    @PluginMethod
+    public void generateKey(PluginCall call) {
+        rejectCallAsUnimplemented(call);
+    }
+
+    @PluginMethod
+    public void isAvailable(PluginCall call) {
+        try {
+            NonEmptyResultCallback<IsAvailableResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull IsAvailableResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.isAvailable(callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void prepareIntegrityToken(PluginCall call) {
+        try {
+            PrepareIntegrityTokenOptions options = new PrepareIntegrityTokenOptions(call);
+            EmptyCallback callback = new EmptyCallback() {
+                @Override
+                public void success() {
+                    resolveCall(call);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.prepareIntegrityToken(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void requestIntegrityToken(PluginCall call) {
+        try {
+            RequestIntegrityTokenOptions options = new RequestIntegrityTokenOptions(call);
+            NonEmptyResultCallback<RequestIntegrityTokenResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull RequestIntegrityTokenResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.requestIntegrityToken(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    private void rejectCall(@NonNull PluginCall call, @NonNull Exception exception) {
+        String message = exception.getMessage();
+        if (message == null) {
+            message = ERROR_UNKNOWN_ERROR;
+        }
+        String code = null;
+        if (exception instanceof CustomException) {
+            code = ((CustomException) exception).getCode();
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message, code);
+    }
+
+    private void rejectCallAsUnimplemented(@NonNull PluginCall call) {
+        call.unimplemented("This method is not available on this platform.");
+    }
+
+    private void resolveCall(@NonNull PluginCall call) {
+        call.resolve();
+    }
+
+    private void resolveCall(@NonNull PluginCall call, @Nullable Result result) {
+        if (result == null) {
+            call.resolve();
+        } else {
+            call.resolve(result.toJSObject());
+        }
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/classes/CustomException.java

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.classes;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public class CustomException extends Exception {
+
+    @Nullable
+    private final String code;
+
+    public CustomException(@Nullable String code, @NonNull String message) {
+        super(message);
+        this.code = code;
+    }
+
+    @Nullable
+    public String getCode() {
+        return code;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/classes/CustomExceptions.java

@@ -0,0 +1,11 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.classes;
+
+public class CustomExceptions {
+
+    public static final CustomException CLOUD_PROJECT_NUMBER_MISSING = new CustomException(null, "cloudProjectNumber must be provided.");
+    public static final CustomException INTEGRITY_TOKEN_PROVIDER_NOT_PREPARED = new CustomException(
+        null,
+        "No integrity token provider available. Call prepareIntegrityToken() first."
+    );
+    public static final CustomException NONCE_OR_REQUEST_HASH_MISSING = new CustomException(null, "nonce or requestHash must be provided.");
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/classes/options/PrepareIntegrityTokenOptions.java

@@ -0,0 +1,26 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.classes.options;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.CustomExceptions;
+
+public class PrepareIntegrityTokenOptions {
+
+    private final long cloudProjectNumber;
+
+    public PrepareIntegrityTokenOptions(@NonNull PluginCall call) throws Exception {
+        this.cloudProjectNumber = PrepareIntegrityTokenOptions.getCloudProjectNumberFromCall(call);
+    }
+
+    public long getCloudProjectNumber() {
+        return cloudProjectNumber;
+    }
+
+    private static long getCloudProjectNumberFromCall(@NonNull PluginCall call) throws Exception {
+        Object value = call.getData().opt("cloudProjectNumber");
+        if (value instanceof Number) {
+            return ((Number) value).longValue();
+        }
+        throw CustomExceptions.CLOUD_PROJECT_NUMBER_MISSING;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/classes/options/RequestIntegrityTokenOptions.java

@@ -0,0 +1,51 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.appintegrity.classes.CustomExceptions;
+
+public class RequestIntegrityTokenOptions {
+
+    @Nullable
+    private final Long cloudProjectNumber;
+
+    @Nullable
+    private final String nonce;
+
+    @Nullable
+    private final String requestHash;
+
+    public RequestIntegrityTokenOptions(@NonNull PluginCall call) throws Exception {
+        this.cloudProjectNumber = RequestIntegrityTokenOptions.getCloudProjectNumberFromCall(call);
+        this.nonce = call.getString("nonce");
+        this.requestHash = call.getString("requestHash");
+        if (this.nonce == null && this.requestHash == null) {
+            throw CustomExceptions.NONCE_OR_REQUEST_HASH_MISSING;
+        }
+    }
+
+    @Nullable
+    public Long getCloudProjectNumber() {
+        return cloudProjectNumber;
+    }
+
+    @Nullable
+    public String getNonce() {
+        return nonce;
+    }
+
+    @Nullable
+    public String getRequestHash() {
+        return requestHash;
+    }
+
+    @Nullable
+    private static Long getCloudProjectNumberFromCall(@NonNull PluginCall call) {
+        Object value = call.getData().opt("cloudProjectNumber");
+        if (value instanceof Number) {
+            return ((Number) value).longValue();
+        }
+        return null;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/classes/results/IsAvailableResult.java

@@ -0,0 +1,22 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.appintegrity.interfaces.Result;
+
+public class IsAvailableResult implements Result {
+
+    private final boolean available;
+
+    public IsAvailableResult(boolean available) {
+        this.available = available;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("available", available);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/classes/results/RequestIntegrityTokenResult.java

@@ -0,0 +1,23 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.classes.results;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.appintegrity.interfaces.Result;
+
+public class RequestIntegrityTokenResult implements Result {
+
+    @NonNull
+    private final String token;
+
+    public RequestIntegrityTokenResult(@NonNull String token) {
+        this.token = token;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("token", token);
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/interfaces/Callback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.interfaces;
+
+public interface Callback {
+    void error(Exception exception);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/interfaces/EmptyCallback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.interfaces;
+
+public interface EmptyCallback extends Callback {
+    void success();
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends Callback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/appintegrity/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.appintegrity.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}