https://github.com/tsmx/mongoose-encrypted-string

EncryptedString type for Mongoose schemas.
https://github.com/tsmx/mongoose-encrypted-string

encryption mongoose mongoose-schemas string-crypto

Last synced: about 1 month ago
JSON representation

EncryptedString type for Mongoose schemas.

• Host: GitHub
• URL: https://github.com/tsmx/mongoose-encrypted-string
• Owner: tsmx
• License: mit
• Created: 2020-10-12T20:57:53.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-08T18:49:00.000Z (5 months ago)
• Last Synced: 2024-08-08T21:25:39.701Z (5 months ago)
• Topics: encryption, mongoose, mongoose-schemas, string-crypto
• Language: JavaScript
• Homepage:
• Size: 498 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [**@tsmx/mongoose-encrypted-string**](https://github.com/tsmx/mongoose-encrypted-string)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

![npm (scoped)](https://img.shields.io/npm/v/@tsmx/mongoose-encrypted-string)

![node-current (scoped)](https://img.shields.io/node/v/@tsmx/mongoose-encrypted-string)

[![Build Status](https://img.shields.io/github/actions/workflow/status/tsmx/mongoose-encrypted-string/git-build.yml?branch=master)](https://img.shields.io/github/actions/workflow/status/tsmx/mongoose-encrypted-string/git-build.yml?branch=master)

[![Coverage Status](https://coveralls.io/repos/github/tsmx/mongoose-encrypted-string/badge.svg?branch=master)](https://coveralls.io/github/tsmx/mongoose-encrypted-string?branch=master)

> `EncryptedString` type for Mongoose schemas. Provides AES-256-CBC encryption-at-rest for strings.

## Usage

```js

var mongoose = require('mongoose');

const mes = require('@tsmx/mongoose-encrypted-string');

const key = 'YOUR KEY HERE';

// register the new type EncryptedString

mes.registerEncryptedString(mongoose, key);

// use EncryptedString in your schemas

Person = mongoose.model('Person', {

    id: { type: String, required: true },

    firstName: { type: mongoose.Schema.Types.EncryptedString },

    lastName: { type: mongoose.Schema.Types.EncryptedString }

});

let testPerson = new Person();

testPerson.id = 'id-test';

testPerson.firstName = 'Hans'; // stored encrypted

testPerson.lastName = 'Müller'; // stored encrypted

await testPerson.save();

let queriedPerson = await Person.findOne({ id: 'id-test' });

console.log(queriedPerson.firstName); // 'Hans', decrypted automatically

console.log(queriedPerson.lastName); // 'Müller, decrypted automatically

```

Directly querying the MongoDB will return the encrypted data.

```bash

> db.persons.findOne({ id: 'id-test' });

{

        "_id" : ObjectId("5f8576cc0a6ca01d8e5c479c"),

        "id" : "id-test",

        "firstName" : "66db1589b5c0de7f98f5260092e6799f|a6cb74bc05a52d1244addb125352bb0d",

        "lastName" : "2b85f4ca2d98ad1234da376a6d0d9128|d5b0257d3797da7047bfea6dfa62e19c",

        "__v" : 0

}

```

## API

### registerEncryptedString(mongoose, key)

Registers the new type `EncryptedString` in the `mongoose` instance's schema types. Encryption/decryption is done with AES-256-CBC using the given `key`. After calling this funtion you can start using the new type via `mongoose.Schema.Types.EncryptedString` in your schemas.

#### mongoose

The mongoose instance where `EncryptedString` should be registered.

#### key

The key used for encryption/decryption. Length must be 32 bytes. See [notes](#notes) for details.

## Use with lean() queries

For performance reasons it maybe useful to use Mongoose's `lean()` queries. Doing so, the query will return the raw JSON objects from the MongoDB database where all properties of type `EncryptedString` are encrypted.

To get the clear text values back you can directly use [@tsmx/string-crypto](https://www.npmjs.com/package/@tsmx/string-crypto) which is also used internally in this package for encryption and decryption.

```js

const key = 'YOUR KEY HERE';

const sc = require('@tsmx/string-crypto');

// query raw objects with encrypted string values

let person = await Person.findOne({ id: 'id-test' }).lean();

// decrypt using string-crypto

let firstName = sc.decrypt(person.firstName, { key: key });

let lastName = sc.decrypt(person.lastName, { key: key });

```

## Notes

- Encryption/decryption is done via the package [@tsmx/string-crypto](https://www.npmjs.com/package/@tsmx/string-crypto).

- Key length must be 32 bytes. The key can be provided as

    - a string of 32 characters length, or

    - a hexadecimal value of 64 characters length (= 32 bytes)

- Don't override getters/setter for `EncryptedString` class or schema elements of this type. This would break the encryption.