better-sqlite3-multiple-ciphers 7.4.5-beta.0 → 7.4.7-beta.0

package/.github/workflows/prebuild.yml

@@ -35,3 +35,15 @@ jobs:
       - run: apk add build-base git python3 --update-cache
       - run: npm install --ignore-scripts
       - run: npx --no-install prebuild -r node -t 10.20.0 -t 12.0.0 -t 14.0.0 -t 16.0.0 --include-regex 'better_sqlite3.node$' -u ${{ secrets.GITHUB_TOKEN }}
+
+  prebuild-alpine-arm64:
+    name: Prebuild on alpine (arm64)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: docker/setup-qemu-action@v1
+      - run: |
+          docker run --rm --entrypoint /bin/sh --platform linux/arm64 node:16-alpine -c "apk add build-base git python3 --update-cache && \
+          git clone ${{ github.event.repository.clone_url }} && \
+          cd ${{ github.event.repository.name }} && \
+          npm install --ignore-scripts && \
+          npx --no-install prebuild -r node -t 10.20.0 -t 12.0.0 -t 14.0.0 -t 16.0.0 --include-regex 'better_sqlite3.node$' -u ${{ secrets.GITHUB_TOKEN }}"

package/.github/workflows/test.yml

@@ -44,3 +44,16 @@ jobs:
       - run: npm install --ignore-scripts
       - run: npm run build-debug
       - run: npm test
+
+  test-alpine-arm64:
+    name: Testing Node 16 on apline (arm64)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: docker/setup-qemu-action@v1
+      - run: |
+          docker run --rm --entrypoint /bin/sh --platform linux/arm64 node:16-alpine -c "apk add build-base git python3 --update-cache && \
+          git clone ${{ github.event.repository.clone_url }} && \
+          cd ${{ github.event.repository.name }} && \
+          npm install --ignore-scripts && \
+          npm run build-debug && \
+          npm test"

package/README.md

@@ -1,13 +1,8 @@
 # better-sqlite3-multiple-ciphers
 
-<a href="https://www.npmjs.com/package/better-sqlite3-multiple-ciphers">
-    <img src="https://img.shields.io/npm/v/better-sqlite3-multiple-ciphers?logo=npm&color=cc3838&style=for-the-badge" alt="NPM Version">
-</a>
-<a href="https://www.npmjs.com/package/better-sqlite3-multiple-ciphers">
-    <img src="https://img.shields.io/npm/dt/better-sqlite3-multiple-ciphers?logo=DocuSign&logoColor=FFF&color=2757c4&style=for-the-badge" alt="Downloads">
-</a>
-
-####
+[![NPM version](https://img.shields.io/npm/v/better-sqlite3-multiple-ciphers?logo=npm&color=cc3838&style=for-the-badge)](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers)
+[![Downloads](https://img.shields.io/npm/dt/better-sqlite3-multiple-ciphers?logo=DocuSign&logoColor=FFF&color=2757c4&style=for-the-badge)](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers)
+[![Build status](https://img.shields.io/github/workflow/status/m4heshd/better-sqlite3-multiple-ciphers/test?label=Build%2FTest&logo=github&style=for-the-badge)](https://github.com/m4heshd/better-sqlite3-multiple-ciphers/actions/workflows/test.yml)
 
 The fastest and simplest library for SQLite3 in Node.js. This particular fork supports multiple-cipher encryption using [SQLite3MultipleCiphers](https://github.com/utelle/SQLite3MultipleCiphers). Check [usage](#usage) to learn more.
 
@@ -17,18 +12,19 @@ The fastest and simplest library for SQLite3 in Node.js. This particular fork su
 - Support for user-defined functions, aggregates, virtual tables, and extensions
 - 64-bit integers *(invisible until you need them)*
 - Worker thread support *(for large/slow queries)*
+- Encryption support using multiple algorithms
 
 ## Current versions
 
 - ### Stable
-  - **better-sqlite3-multiple-ciphers** - `7.4.4`
-  - **SQLite** - `3.36.0`
-  - **SQLite3 Multiple Ciphers** - `1.3.4`
+  - **better-sqlite3-multiple-ciphers** - [`7.4.6`](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers/v/7.4.6)
+  - **SQLite** - `3.37.0`
+  - **SQLite3 Multiple Ciphers** - `1.3.5`
 
 - ### Beta
-  - **better-sqlite3-multiple-ciphers** - [`7.4.5-beta.0`](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers/v/7.4.5-beta.0)
-  - **SQLite** - `3.36.0`
-  - **SQLite3 Multiple Ciphers** - `1.3.4`
+  - **better-sqlite3-multiple-ciphers** - [`7.4.7-beta.0`](https://www.npmjs.com/package/better-sqlite3-multiple-ciphers/v/7.4.7-beta.0)
+  - **SQLite** - `3.37.1`
+  - **SQLite3 Multiple Ciphers** - `1.3.6`
 
 ## Help this project stay strong! &#128170;
 
@@ -40,6 +36,10 @@ The fastest and simplest library for SQLite3 in Node.js. This particular fork su
 
 Also head over to [SQLite3MultipleCiphers](https://github.com/utelle/SQLite3MultipleCiphers) repo and give some support to the developer to keep this very useful extension alive.
 
+You can also support me (the maintainer of this fork) by buying me a coffee. 😊
+
+[![ko-fi](https://i.ibb.co/QmQknmc/ko-fi.png)](https://ko-fi.com/m4heshd)
+
 ## How other libraries compare
 
 |   |select 1 row &nbsp;`get()`&nbsp;|select 100 rows &nbsp;&nbsp;`all()`&nbsp;&nbsp;|select 100 rows `iterate()` 1-by-1|insert 1 row `run()`|insert 100 rows in a transaction|
@@ -63,7 +63,7 @@ npm install better-sqlite3-multiple-ciphers
 npm install better-sqlite3-multiple-ciphers@beta
 ```
 
-> You must be using Node.js v10.20.1 or above. Prebuilt binaries are available for Node.js [LTS versions](https://nodejs.org/en/about/releases/) and Electron.
+> You must be using Node.js v10.20.1 or above. Prebuilt binaries are available for Node.js [LTS versions](https://nodejs.org/en/about/releases/) and Electron. If you have trouble installing, check the [troubleshooting guide](./docs/troubleshooting.md).
 
 > If you have trouble installing, check the [troubleshooting guide](./docs/troubleshooting.md).
 
@@ -76,6 +76,13 @@ const row = db.prepare('SELECT * FROM users WHERE id = ?').get(userId);
 console.log(row.firstName, row.lastName, row.email);
 ```
 
+##### In ES6 module notation:
+
+```js
+import Database from 'better-sqlite3-multiple-ciphers';
+const db = new Database('foobar.db', options);
+```
+
 ### Encryption
 
 A database can be encrypted and decrypted simply using `key` and `rekey` `PRAGMA` statements.

package/deps/setup.ps1

@@ -2,7 +2,7 @@
 $ErrorActionPreference = "Stop"
 
 # SQLite Info
-$SQLITEMC_VER = "v1.3.4"
+$SQLITEMC_VER = "v1.3.6"
 $API_URL = "https://api.github.com/repos/utelle/SQLite3MultipleCiphers/releases/tags/" + $SQLITEMC_VER
 
 # Paths

package/deps/sqlite3.gyp

@@ -63,6 +63,10 @@
         ['OS=="win"', {
           'cflags!': ['-maes', '-msse4.2'],
         }],
+        ['target_arch=="arm64"', {
+          'cflags!': ['-maes', '-msse4.2'],
+          'cflags': ['-march=native'],
+        }],
       ],
       'configurations': {
         'Debug': {

package/docs/compilation.md

@@ -1,17 +1,17 @@
 # Custom configuration
 
-If you want to use a customized version of [SQLite3](https://www.sqlite.org) with `better-sqlite3`, you can do so by specifying the directory of your [custom amalgamation](https://www.sqlite.org/amalgamation.html) during installation.
+If you want to use a customized version of [SQLite3](https://www.sqlite.org) with `better-sqlite3-multiple-ciphers`, you can do so by specifying the directory of your [custom amalgamation](https://www.sqlite.org/amalgamation.html) during installation.
 
 ```bash
-npm install better-sqlite3 --build-from-source --sqlite3=/path/to/sqlite-amalgamation
+npm install better-sqlite3-multiple-ciphers --build-from-source --sqlite3=/path/to/sqlite-amalgamation
 ```
 
-However, if you simply run `npm install` while `better-sqlite3` is listed as a dependency in your `package.json`, the required flags above will *not* be applied. Therefore, it's recommended that you remove `better-sqlite3` from your dependency list, and instead add a [`preinstall` script](https://docs.npmjs.com/misc/scripts) like the one shown below.
+However, if you simply run `npm install` while `better-sqlite3-multiple-ciphers` is listed as a dependency in your `package.json`, the required flags above will *not* be applied. Therefore, it's recommended that you remove `better-sqlite3-multiple-ciphers` from your dependency list, and instead add a [`preinstall` script](https://docs.npmjs.com/misc/scripts) like the one shown below.
 
 ```json
 {
   "scripts": {
-    "preinstall": "npm install better-sqlite3@'^7.0.0' --no-save --build-from-source --sqlite3=\"$(pwd)/sqlite-amalgamation\""
+    "preinstall": "npm install better-sqlite3-multiple-ciphers@'^7.0.0' --no-save --build-from-source --sqlite3=\"$(pwd)/sqlite-amalgamation\""
   }
 }
 ```
@@ -20,7 +20,7 @@ Your amalgamation directory must contain `sqlite3.c` and `sqlite3.h`. Any desire
 
 ### Step by step example
 
-If you're creating a package that relies on a custom build of `better-sqlite3`, you can follow these steps to get started.
+If you're creating a package that relies on a custom build of `better-sqlite3-multiple-ciphers`, you can follow these steps to get started.
 
 1. Download the SQLite3 source code from [their website](https://sqlite.com/download.html) (e.g., `sqlite-amalgamation-1234567.zip`)
 2. Unzip the compressed archive
@@ -34,7 +34,7 @@ If you're using a SQLite3 encryption extension that is a drop-in replacement for
 
 # Bundled configuration
 
-By default, this distribution currently uses SQLite3 **version 3.36.0** with the following [compilation options](https://www.sqlite.org/compile.html):
+By default, this distribution currently uses SQLite3 **version 3.37.1** with the following [compilation options](https://www.sqlite.org/compile.html):
 
 ```
 SQLITE_DQS=0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "better-sqlite3-multiple-ciphers",
-  "version": "7.4.5-beta.0",
+  "version": "7.4.7-beta.0",
   "description": "better-sqlite3 with multiple-cipher encryption support",
   "homepage": "https://github.com/m4heshd/better-sqlite3-multiple-ciphers",
   "author": "Mahesh Bandara Wijerathna (m4heshd) <m4heshd@gmail.com>",
@@ -35,15 +35,15 @@
     "download": "bash ./deps/download.sh",
     "setup": "powershell ./deps/setup.ps1",
     "lzz": "lzz -hx hpp -sx cpp -k BETTER_SQLITE3 -d -hl -sl -e ./src/better_sqlite3.lzz",
-    "release:patch": "npm --no-git-tag-version version patch",
-    "release:minor": "npm --no-git-tag-version version minor",
-    "release:major": "npm --no-git-tag-version version major",
-    "release:patch:beta": "npm --no-git-tag-version --preid=beta version prepatch",
-    "release:minor:beta": "npm --no-git-tag-version --preid=beta version preminor",
-    "release:major:beta": "npm --no-git-tag-version --preid=beta version premajor",
-    "release:prerelease:beta": "npm --no-git-tag-version --preid=beta version prerelease",
-    "publish": "npm publish",
-    "publish:beta": "npm publish --tag beta"
+    "bump:patch": "npm --no-git-tag-version version patch",
+    "bump:minor": "npm --no-git-tag-version version minor",
+    "bump:major": "npm --no-git-tag-version version major",
+    "bump:patch:beta": "npm --no-git-tag-version --preid=beta version prepatch",
+    "bump:minor:beta": "npm --no-git-tag-version --preid=beta version preminor",
+    "bump:major:beta": "npm --no-git-tag-version --preid=beta version premajor",
+    "bump:prerelease:beta": "npm --no-git-tag-version --preid=beta version prerelease",
+    "release": "npm publish",
+    "release:beta": "npm publish --tag beta"
   },
   "license": "MIT",
   "keywords": [

package/test/46.encryption.js

@@ -1,7 +1,7 @@
 'use strict';
 const Database = require('../.');
 
-describe('Encryption using default method (Sqleet)', () => {
+describe('Encryption using default cipher (Sqleet)', () => {
     afterEach(() => {
         this.db.close();
     });
@@ -17,16 +17,11 @@ describe('Encryption using default method (Sqleet)', () => {
         this.db = new Database(util.current());
         expect(() => this.db.prepare('SELECT * FROM user')).to.throw(Database.SqliteError);
     });
-    /*
-        Temporarily commenting out this test since having `SQLITE_DEBUG` enabled
-        throws an assertion failure exception if an incorrect passphrase is used.
-        It cannot be caught in JS which leads to the whole test process being broken.
-     */
-    // it('should not allow access with an incorrect passphrase', () => {
-    //     this.db = new Database(util.current());
-    //     this.db.pragma(`key='false_passphrase'`);
-    //     expect(() => this.db.prepare('SELECT * FROM user')).to.throw(Database.SqliteError);
-    // });
+    it('should not allow access with an incorrect passphrase', () => {
+        this.db = new Database(util.current());
+        this.db.pragma(`key='false_passphrase'`);
+        expect(() => this.db.prepare('SELECT * FROM user')).to.throw(Database.SqliteError);
+    });
     it('should allow access with the correct passphrase', () => {
         this.db = new Database(util.current());
         this.db.pragma(`key='passphrase'`);
@@ -34,3 +29,41 @@ describe('Encryption using default method (Sqleet)', () => {
         expect(stmt.get()).to.deep.equal({name: 'octocat'});
     });
 });
+
+describe('Encryption using SQLCiper', () => {
+    afterEach(() => {
+        this.db.close();
+    });
+
+    it('should create an encrypted database', () => {
+        this.db = new Database(util.next());
+        this.db.pragma(`cipher='sqlcipher'`);
+        this.db.pragma(`rekey='passphrase'`);
+        this.db.prepare('CREATE TABLE user ("name" TEXT)').run();
+        this.db.prepare("INSERT INTO user (name) VALUES ('octocat')").run();
+        this.db.prepare('VACUUM').run();
+    });
+    it('should not allow access without decryption', () => {
+        this.db = new Database(util.current());
+        this.db.pragma(`cipher='sqlcipher'`);
+        expect(() => this.db.prepare('SELECT * FROM user')).to.throw(Database.SqliteError);
+    });
+    it('should not allow access with an incorrect passphrase', () => {
+        this.db = new Database(util.current());
+        this.db.pragma(`cipher='sqlcipher'`);
+        this.db.pragma(`key='false_passphrase'`);
+        expect(() => this.db.prepare('SELECT * FROM user')).to.throw(Database.SqliteError);
+    });
+    it('should not allow access with a different cipher', () => {
+        this.db = new Database(util.current());
+        this.db.pragma(`key='passphrase'`);
+        expect(() => this.db.prepare('SELECT * FROM user')).to.throw(Database.SqliteError);
+    });
+    it('should allow access with the correct passphrase and cipher', () => {
+        this.db = new Database(util.current());
+        this.db.pragma(`cipher='sqlcipher'`);
+        this.db.pragma(`key='passphrase'`);
+        const stmt = this.db.prepare('SELECT * FROM user');
+        expect(stmt.get()).to.deep.equal({name: 'octocat'});
+    });
+});