@capacitor-community/sqlite 3.4.0-1 → 3.4.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Quéau Jean Pierre
+Copyright (c) 2022 Quéau Jean Pierre
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -28,6 +28,20 @@
 
 ## CAPACITOR 3 (Master)
 
+🚨 Since release 3.4.0-2 ->> 🚨 
+
+- iOS & Android only
+  Adding biometric FaceID/TouchID to secure the pass phrase in the Keychain/SharedPreferences stores. see:
+   [Biometric_Authentication](https://github.com/capacitor-community/sqlite/blob/master/docs/Biometric-Authentication.md)
+
+- iOS only
+  Fix identical pass phrase stored in the Keychain for differents applications using the plugin by adding an application prefix to the Keychain account.
+  Before the account `"CapacitorSQLitePlugin"` was used and was the same for all applications.
+  Now by adding `iosKeychainPrefix: 'YOUR_APP_NAME'`in the `capacitor.config.ts` of your application,
+  the account will be `"YOUR_APP_NAME_CapacitorSQLitePlugin"`
+  If you were having a pass phrase stored, first modify the `capacitor.config.ts` and then run the command `isSecretStored` which will manage the upgrade of the Keychain account. 
+🚨 Since release 3.4.0-2 <<- 🚨
+
 🚨 Since release 3.3.3-2 ->> 🚨
 
   - iOS only
@@ -240,6 +254,7 @@ No configuration required for this plugin
 | createNCConnection          | ✅      | ✅  | ❌        | ❌  |
 | closeNCConnection           | ✅      | ✅  | ❌        | ❌  |
 | isNCDatabase                | ✅      | ✅  | ❌        | ❌  |
+| transaction                 | ✅      | ✅  | ✅        | ✅  |
 
 ## Supported SQLite Types
 
@@ -267,6 +282,8 @@ No configuration required for this plugin
 
 - [Non_Conformed_Databases_Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/NonConformedDatabases.md)
 
+- [Biometric_Authentication](https://github.com/capacitor-community/sqlite/blob/master/docs/Biometric-Authentication.md)
+
 ### Framework's Usage 
 
 - [Ionic/Angular_Usage_Documentation](https://github.com/capacitor-community/sqlite/blob/master/docs/Ionic-Angular-Usage.md)

package/android/build.gradle

@@ -61,6 +61,6 @@ dependencies {
     implementation "androidx.sqlite:sqlite:2.1.0"
     //security library
     implementation "androidx.security:security-crypto:1.1.0-alpha03"
+    implementation "androidx.biometric:biometric:1.1.0"
     annotationProcessor 'androidx.room:room-compiler:2.2.5'
-
 }

package/android/src/main/java/com/getcapacitor/community/database/sqlite/CapacitorSQLite.java

@@ -4,14 +4,21 @@ import android.content.Context;
 import android.content.SharedPreferences;
 import android.text.TextUtils;
 import android.util.Log;
+import android.widget.Toast;
+import androidx.biometric.BiometricManager;
+import androidx.biometric.BiometricPrompt;
 import androidx.security.crypto.EncryptedSharedPreferences;
 import androidx.security.crypto.MasterKey;
 import androidx.security.crypto.MasterKeys;
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.community.database.sqlite.SQLite.BiometricListener;
 import com.getcapacitor.community.database.sqlite.SQLite.Database;
 import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.JsonSQLite;
 import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.UtilsJson;
+import com.getcapacitor.community.database.sqlite.SQLite.SqliteConfig;
+import com.getcapacitor.community.database.sqlite.SQLite.UtilsBiometric;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsFile;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsMigrate;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsNCDatabase;
@@ -19,15 +26,21 @@ import com.getcapacitor.community.database.sqlite.SQLite.UtilsSQLite;
 import com.getcapacitor.community.database.sqlite.SQLite.UtilsSecret;
 import java.io.File;
 import java.io.IOException;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
 import java.security.GeneralSecurityException;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.Dictionary;
 import java.util.Enumeration;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Hashtable;
+import java.util.Map;
 import java.util.Set;
+import javax.crypto.BadPaddingException;
+import javax.crypto.IllegalBlockSizeException;
 import org.json.JSONException;
 import org.json.JSONObject;
 
@@ -43,13 +56,86 @@ public class CapacitorSQLite {
     private UtilsNCDatabase uNCDatabase = new UtilsNCDatabase();
     private UtilsSecret uSecret;
     private SharedPreferences sharedPreferences;
-
-    public CapacitorSQLite(Context context) throws Exception {
+    private MasterKey masterKeyAlias;
+    private BiometricManager biometricManager;
+    private SqliteConfig config;
+    private Boolean biometricAuth = false;
+    private String biometricTitle;
+    private String biometricSubTitle;
+    private int VALIDITY_DURATION = 1;
+    private RetHandler rHandler = new RetHandler();
+    private PluginCall call;
+
+    public CapacitorSQLite(Context context, SqliteConfig config) throws Exception {
         this.context = context;
+        this.call = call;
+        this.config = config;
+        this.biometricAuth = this.config.getBiometricAuth();
+        this.biometricTitle = this.config.getBiometricTitle();
+        this.biometricSubTitle = this.config.getBiometricSubTitle();
         try {
             // create or retrieve masterkey from Android keystore
             // it will be used to encrypt the passphrase for a database
-            MasterKey masterKeyAlias = new MasterKey.Builder(context).setKeyScheme(MasterKey.KeyScheme.AES256_GCM).build();
+
+            if (biometricAuth) {
+                biometricManager = BiometricManager.from(this.context);
+                BiometricListener listener = new BiometricListener() {
+                    @Override
+                    public void onSuccess(BiometricPrompt.AuthenticationResult result) {
+                        try {
+                            masterKeyAlias =
+                                new MasterKey.Builder(context)
+                                    .setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
+                                    .setUserAuthenticationRequired(true, VALIDITY_DURATION)
+                                    .build();
+                            setSharedPreferences();
+                            notifyBiometricEvent(true, null);
+                            return;
+                        } catch (Exception e) {
+                            String input = e.getMessage();
+                            Log.e("MY_APP_TAG", input);
+                            //                            Toast.makeText(context, input, Toast.LENGTH_LONG).show();
+                            notifyBiometricEvent(false, input);
+                        }
+                    }
+
+                    @Override
+                    public void onFailed() {
+                        String input = "Error in authenticating biometric";
+                        Log.e("MY_APP_TAG", input);
+                        //                        Toast.makeText(context, input, Toast.LENGTH_LONG).show();
+                        notifyBiometricEvent(false, input);
+                    }
+                };
+                UtilsBiometric uBiom = new UtilsBiometric(context, biometricManager, listener);
+                if (uBiom.checkBiometricIsAvailable()) {
+                    uBiom.showBiometricDialog(this.biometricTitle, this.biometricSubTitle);
+                } else {
+                    masterKeyAlias = new MasterKey.Builder(context).setKeyScheme(MasterKey.KeyScheme.AES256_GCM).build();
+                    setSharedPreferences();
+                }
+            } else {
+                masterKeyAlias = new MasterKey.Builder(context).setKeyScheme(MasterKey.KeyScheme.AES256_GCM).build();
+                setSharedPreferences();
+            }
+        } catch (Exception e) {
+            throw new Exception(e.getMessage());
+        }
+    }
+
+    private void notifyBiometricEvent(Boolean ret, String msg) {
+        Map<String, Object> info = new HashMap<String, Object>() {
+            {
+                put("result", ret);
+                put("message", msg);
+            }
+        };
+        Log.v(TAG, "$$$$$ in notifyBiometricEvent " + info);
+        NotificationCenter.defaultCenter().postNotification("biometricResults", info);
+    }
+
+    private void setSharedPreferences() throws Exception {
+        try {
             // get instance of the EncryptedSharedPreferences class
             this.sharedPreferences =
                 EncryptedSharedPreferences.create(
@@ -107,12 +193,47 @@ public class CapacitorSQLite {
      * @param oldPassphrase
      * @throws Exception
      */
-    public void changeEncryptionSecret(String passphrase, String oldPassphrase) throws Exception {
+    public void changeEncryptionSecret(PluginCall call, String passphrase, String oldPassphrase) throws Exception {
+        this.call = call;
         try {
             // close all connections
             closeAllConnections();
-            // change encryption secret
-            uSecret.changeEncryptionSecret(passphrase, oldPassphrase);
+            if (biometricAuth) {
+                BiometricListener listener = new BiometricListener() {
+                    @Override
+                    public void onSuccess(BiometricPrompt.AuthenticationResult result) {
+                        try {
+                            // change encryption secret
+                            uSecret.changeEncryptionSecret(passphrase, oldPassphrase);
+                            rHandler.retResult(call, null, null);
+                            return;
+                        } catch (Exception e) {
+                            String input = e.getMessage();
+                            Log.e("MY_APP_TAG", input);
+                            Toast.makeText(context, input, Toast.LENGTH_LONG).show();
+                            rHandler.retResult(call, null, e.getMessage());
+                        }
+                    }
+
+                    @Override
+                    public void onFailed() {
+                        String input = "Error in authenticating biometric";
+                        Log.e("MY_APP_TAG", input);
+                        Toast.makeText(context, input, Toast.LENGTH_LONG).show();
+                        rHandler.retResult(call, null, input);
+                    }
+                };
+
+                UtilsBiometric uBiom = new UtilsBiometric(context, biometricManager, listener);
+                if (uBiom.checkBiometricIsAvailable()) {
+                    uBiom.showBiometricDialog(biometricTitle, biometricSubTitle);
+                } else {
+                    throw new Exception("Biometric features are currently unavailable.");
+                }
+            } else {
+                // change encryption secret
+                uSecret.changeEncryptionSecret(passphrase, oldPassphrase);
+            }
         } catch (Exception e) {
             throw new Exception(e.getMessage());
         }

package/android/src/main/java/com/getcapacitor/community/database/sqlite/CapacitorSQLitePlugin.java

@@ -10,9 +10,11 @@ import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
 import com.getcapacitor.community.database.sqlite.SQLite.Database;
 import com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson.JsonSQLite;
+import com.getcapacitor.community.database.sqlite.SQLite.SqliteConfig;
 import java.util.Dictionary;
 import java.util.Hashtable;
 import org.json.JSONArray;
+import org.json.JSONException;
 import org.json.JSONObject;
 
 @CapacitorPlugin(name = "CapacitorSQLite")
@@ -20,9 +22,12 @@ public class CapacitorSQLitePlugin extends Plugin {
 
     private static final String TAG = CapacitorSQLitePlugin.class.getName();
     private Context context;
+    private SqliteConfig config;
     private CapacitorSQLite implementation;
     private Dictionary<String, Dictionary<Integer, JSONObject>> versionUpgrades = new Hashtable<>();
     private RetHandler rHandler = new RetHandler();
+    private String passphrase = null;
+    private String oldpassphrase = null;
 
     /**
      * Load Method
@@ -31,8 +36,12 @@ public class CapacitorSQLitePlugin extends Plugin {
     public void load() {
         context = getContext();
         try {
-            implementation = new CapacitorSQLite(context);
+            config = getSqliteConfig();
             AddObserversToNotificationCenter();
+            implementation = new CapacitorSQLite(context, config);
+        } catch (JSONException e) {
+            implementation = null;
+            Log.e(TAG, "CapacitorSQLitePlugin: " + e.getMessage());
         } catch (Exception e) {
             implementation = null;
             Log.e(TAG, "CapacitorSQLitePlugin: " + e.getMessage());
@@ -42,6 +51,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * Echo Method
      * test the plugin
+     *
      * @param call
      */
     @PluginMethod
@@ -59,6 +69,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * IsSecretStored
      * Check if a secret has been stored
+     *
      * @param call
      */
     @PluginMethod
@@ -77,6 +88,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * SetEncryptionSecret
      * set a passphrase secret for a database
+     *
      * @param call
      */
     @PluginMethod
@@ -103,33 +115,40 @@ public class CapacitorSQLitePlugin extends Plugin {
      * ChangeEncryptionSecret
      * change a passphrase secret for a database
      * with a new passphrase
+     *
      * @param call
      */
     @PluginMethod
     public void changeEncryptionSecret(PluginCall call) {
-        String passphrase = null;
         if (!call.getData().has("passphrase")) {
             String msg = "SetEncryptionSecret: Must provide a passphrase";
             rHandler.retResult(call, null, msg);
             return;
         }
         passphrase = call.getString("passphrase");
-        String oldpassphrase = null;
+
         if (!call.getData().has("oldpassphrase")) {
             String msg = "SetEncryptionSecret: Must provide a oldpassphrase";
             rHandler.retResult(call, null, msg);
             return;
         }
         oldpassphrase = call.getString("oldpassphrase");
-        try {
-            implementation.changeEncryptionSecret(passphrase, oldpassphrase);
-            rHandler.retResult(call, null, null);
-            return;
-        } catch (Exception e) {
-            String msg = "ChangeEncryptionSecret: " + e.getMessage();
-            rHandler.retResult(call, null, msg);
-            return;
-        }
+        getActivity()
+            .runOnUiThread(
+                new Runnable() {
+                    @Override
+                    public void run() {
+                        try {
+                            implementation.changeEncryptionSecret(call, passphrase, oldpassphrase);
+                            return;
+                        } catch (Exception e) {
+                            String msg = "ChangeEncryptionSecret: " + e.getMessage();
+                            rHandler.retResult(call, null, msg);
+                            return;
+                        }
+                    }
+                }
+            );
     }
 
     @PluginMethod
@@ -162,6 +181,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * CreateNCConnection Method
      * Create a non-conformed connection to a database
+     *
      * @param call
      */
     @PluginMethod
@@ -189,6 +209,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * CreateConnection Method
      * Create a connection to a database
+     *
      * @param call
      */
     @PluginMethod
@@ -204,6 +225,7 @@ public class CapacitorSQLitePlugin extends Plugin {
         }
         dbName = call.getString("database");
         dbVersion = call.getInt("version", 1);
+
         boolean encrypted = call.getBoolean("encrypted", false);
         if (encrypted) {
             inMode = call.getString("mode", "no-encryption");
@@ -234,6 +256,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * Open Method
      * Open a database
+     *
      * @param call
      */
     @PluginMethod
@@ -258,6 +281,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * Close Method
      * Close a Database
+     *
      * @param call
      */
     @PluginMethod
@@ -282,6 +306,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * GetUrl Method
      * Get a database Url
+     *
      * @param call
      */
     @PluginMethod
@@ -306,6 +331,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * GetVersion Method
      * Get a database Version
+     *
      * @param call
      */
     @PluginMethod
@@ -330,6 +356,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * CloseNCConnection Method
      * Close a non-conformed database connection
+     *
      * @param call
      */
     @PluginMethod
@@ -354,6 +381,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * CloseConnection Method
      * Close the connection to a database
+     *
      * @param call
      */
     @PluginMethod
@@ -378,6 +406,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * CheckConnectionsConsistency Method
      * Check the connections consistency JS <=> Native
+     *
      * @param call
      */
     @PluginMethod
@@ -402,6 +431,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * IsDatabase Method
      * Check if the database file exists
+     *
      * @param call
      */
     @PluginMethod
@@ -425,6 +455,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * IsDatabase Method
      * Check if the database file exists
+     *
      * @param call
      */
     @PluginMethod
@@ -448,6 +479,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * IsTableExists Method
      * Check if a table exists in a database
+     *
      * @param call
      */
     @PluginMethod
@@ -575,6 +607,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * Execute Method
      * Execute SQL statements provided in a String
+     *
      * @param call
      */
     @PluginMethod
@@ -609,6 +642,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * ExecuteSet Method
      * Execute a Set of raw sql statement
+     *
      * @param call
      * @throws Exception
      */
@@ -660,6 +694,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * Run method
      * Execute a raw sql statement
+     *
      * @param call
      */
     @PluginMethod
@@ -701,6 +736,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * Query Method
      * Execute an sql query
+     *
      * @param call
      */
     @PluginMethod
@@ -737,6 +773,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * IsDBExists Method
      * check if the database exists on the database folder
+     *
      * @param call
      */
     @PluginMethod
@@ -762,6 +799,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * IsDBOpen Method
      * check if the database is opened
+     *
      * @param call
      */
     @PluginMethod
@@ -786,6 +824,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * DeleteDatabase Method
      * delete a database from the database folder
+     *
      * @param call
      */
     @PluginMethod
@@ -810,6 +849,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * CreateSyncTable Method
      * Create the synchronization table
+     *
      * @param call
      */
     @PluginMethod
@@ -836,6 +876,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * SetSyncDate Method
      * set the synchronization date
+     *
      * @param call
      */
     @PluginMethod
@@ -867,6 +908,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * GetSyncDate Method
      * Get the synchronization date
+     *
      * @param call
      */
     @PluginMethod
@@ -893,6 +935,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * AddUpgradeStatement Method
      * Define an upgrade object when updating to a new version
+     *
      * @param call
      */
     @PluginMethod
@@ -925,6 +968,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * IsJsonValid
      * Check the validity of a given Json object
+     *
      * @param call
      */
     @PluginMethod
@@ -949,6 +993,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * ImportFromJson Method
      * Import from a given Json object
+     *
      * @param call
      */
     @PluginMethod
@@ -975,6 +1020,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * ExportToJson Method
      * Export the database to Json Object
+     *
      * @param call
      */
     @PluginMethod
@@ -1014,6 +1060,7 @@ public class CapacitorSQLitePlugin extends Plugin {
     /**
      * CopyFromAssets
      * copy all databases from public/assets/databases to application folder
+     *
      * @param call
      */
     @PluginMethod
@@ -1060,5 +1107,40 @@ public class CapacitorSQLitePlugin extends Plugin {
                     }
                 }
             );
+        NotificationCenter
+            .defaultCenter()
+            .addMethodForNotification(
+                "biometricResults",
+                new MyRunnable() {
+                    @Override
+                    public void run() {
+                        JSObject data = new JSObject();
+                        data.put("result", this.getInfo().get("result"));
+                        data.put("message", this.getInfo().get("message"));
+                        notifyListeners("sqliteBiometricEvent", data);
+                        return;
+                    }
+                }
+            );
+    }
+
+    private SqliteConfig getSqliteConfig() throws JSONException {
+        SqliteConfig config = new SqliteConfig();
+        JSONObject androidBiometric = getConfig().getObject("androidBiometric");
+        if (androidBiometric != null) {
+            Boolean biometricAuth = androidBiometric.has("biometricAuth")
+                ? androidBiometric.getBoolean("biometricAuth")
+                : config.getBiometricAuth();
+            config.setBiometricAuth(biometricAuth);
+            String biometricTitle = androidBiometric.has("biometricTitle")
+                ? androidBiometric.getString("biometricTitle")
+                : config.getBiometricTitle();
+            config.setBiometricTitle(biometricTitle);
+            String biometricSubTitle = androidBiometric.has("biometricSubTitle")
+                ? androidBiometric.getString("biometricSubTitle")
+                : config.getBiometricSubTitle();
+            config.setBiometricSubTitle(biometricSubTitle);
+        }
+        return config;
     }
 }

package/android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/BiometricListener.java

@@ -0,0 +1,8 @@
+package com.getcapacitor.community.database.sqlite.SQLite;
+
+import androidx.biometric.BiometricPrompt;
+
+public interface BiometricListener {
+    void onSuccess(BiometricPrompt.AuthenticationResult result);
+    void onFailed();
+}

package/android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/SqliteConfig.java

@@ -0,0 +1,32 @@
+package com.getcapacitor.community.database.sqlite.SQLite;
+
+public class SqliteConfig {
+
+    private boolean biometricAuth = false;
+    private String biometricTitle = "Biometric login for capacitor sqlite";
+    private String biometricSubTitle = "Log in using your biometric";
+
+    public boolean getBiometricAuth() {
+        return biometricAuth;
+    }
+
+    public void setBiometricAuth(boolean biometricAuth) {
+        this.biometricAuth = biometricAuth;
+    }
+
+    public String getBiometricTitle() {
+        return biometricTitle;
+    }
+
+    public void setBiometricTitle(String biometricTitle) {
+        this.biometricTitle = biometricTitle;
+    }
+
+    public String getBiometricSubTitle() {
+        return biometricSubTitle;
+    }
+
+    public void setBiometricSubTitle(String biometricSubTitle) {
+        this.biometricSubTitle = biometricSubTitle;
+    }
+}