عکس m-esm
Step by step demo to showcase how you can have e2e encryption for your database and files.TypeScript
موضوع‌ها
۰
فورک‌ها
۱
ستاره‌ها
۶
تاریخ ایجاد
۲۱ مرداد ۱۳۹۹
آخرین بروزرسانی
بیشتر از ۱ سال قبل
لایسنس
MIT License

E2DB - e2e encryption for your database and files

NPM Maintenance GitHub stars

Install

npm install e2db

Run tests

npm run test

Demo

https://runkit.io/m-esm/e2db/branches/master

🚀 Usage

const Cipher = require("e2db").Cipher;

async function doExample() {
  const userCloudPassword = "user cloud password";
  const globalRsaPass = "global rsa passphrase";
  // key.privateKey is encrypted with AES secret ( user cloud password )
  // key.privateKey is also protected by rsa pass phrase ( global rsa pass for your app )
  // key._id is auto generated bson object id
  const key = await Cipher.keyMaker.createKey(userCloudPassword, globalRsaPass);

  const model = {
    message: "hello world",
    secretMessage: "privacy matters",
  };

  // models could be encrypted by multiple keys
  const encryptedModel = Cipher.encryptModel(model, [key], {
    fields: ["secretMessage"],
  });

  console.log(JSON.stringify(encryptedModel, null, 2));

  // note that 5f38843239e984113d8eb8fa is our key._id
  // outputs:
  //   {
  //     "message": "hello world",
  //     "secretMessage": "P9acGm+rBD4TaUpNRZVx2/5UW8BY0d0frHHiF2l6flU=",
  //     "_cipherKeys": {
  //       "5f38843239e984113d8eb8fa": "RANDOM_AES_SECRET_ENCRYPTED_BY_RSA_KEY"
  //     },
  //     "_cipherFields": [
  //       "secretMessage"
  //     ]
  //   }

  const decryptedModel = Cipher.decryptModel(
    encryptedModel,
    key,
    userCloudPassword,
    globalRsaPass
  );

  console.log(JSON.stringify(decryptedModel, null, 2));

  // outputs:
  // {
  //   "message": "hello world",
  //   "secretMessage": "privacy matters"
  // }
}

Why?

For the sake of security and privacy for users and their data. services need only have access to part of user's data which they granted access to, remaining data should be only decrypted on user read demand. E2DB is providing a set of tools that will help you with this.

What?

  • Sensitive and private information in database records
  • Private stored files on buckets and storages

When?

When inserting the document, it should encrypt specific fields of a document that only could be decrypted when reading with a key.

How?

To ensure data is end to end encrypted on your backend:

  • Encrypt sensitive part of the document with AES

    • Keep AES secret encrypted by the RSA key alongside the document.
  • RSA public key is available in raw format to encrypt random AES secret which is used to encrypt database records/documents.

  • RSA private keys need to be encrypted using AES and persisted. the secret key for this AES cipher is our "cloud password"

  • When the cloud password changes, only RSA keys need to be encrypted again.

  • Cloud passwords should always be received from the client-side and not persisted on the server-side.

    • To prevent leaking cloud passwords in clear text format in logs or etc, we need to encrypt them by an hourly rotated secret ( cloud password salt ) which is only available on-memory with specific expire time.
  • Documents AES secret could be encrypted by multiple keys.

Road map

  • Create RSA key pairs encrypted by AES secret
  • Changes AES secret of a RSA key
  • PassTrough stream with AES cipher
  • Cipher usage example
  • Create cloud password salt
  • Mongoose example
  • NestJs example
  • ExpressJs example

Resources

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Mohsen Esmaeili m-esm@hotmail.com.
This project is MIT licensed.

Author

👤 Mohsen Esmaeili m-esm@hotmail.com