Skip to content

Latest commit

 

History

History
61 lines (46 loc) · 2.99 KB

README.md

File metadata and controls

61 lines (46 loc) · 2.99 KB
Raw

OutSystems Secure SQLite Plugin

⚠️ This plugin is SUPPORTED by OutSystems. Customers entitled to Support Services may obtain assistance through Support.

Cordova meta-plugin that bundles requirements for secure SQLite device storage and initialization code for easy usage within OutSystems Platform native mobile apps.

Supported Platforms

  • iOS
  • Android

Installation

cordova plugin add https://github.com/OutSystems/cordova-outsystems-secure-sqlite-bundle.git

Usage

The API is essentially unchanged from the bundled Cordova SQLCipher Adapter, but the encryption key creation and usage is completely managed by this plugin using SecureStorage.

var options = { 
  name: 'sample.db',
  location: 'default',
  key: 'secure-encryption-key' /* not used, will be overriden by this plugin */
};
window.sqlitePlugin.openDatabase(options, successCallback, errorCallback);

Refer to the Cordova SQLCipher Adapter plugin documentation for samples and details of the supported features.

Limitations

Android Auto Backup for Apps is not compatible with Cipher Local Storage plugin which automatically backs up a user's data from apps that target and run on Android 6.0 (API level 23) or later in enabled in settings. Said that AndroidManifest.xml is modified to disable auto backup by setting android:allowBackup attribute to false, avoiding backing up or restoring the app data.

Known Issues

  • The usage of the SecureStorage plugin requires Android devices to have a PIN (or similar) set. Removal of the PIN will effectively render the database unreadable, as the key will be lost.
  • It is not possible to open existing databases that are not encrypted.
    • Workaround: either delete them prior to calling openDatabase or use a different database name.

LICENSE

The MIT License (MIT)

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.