dha-encryption

The dha-encryption module provides aes-256-gcm encryption for JavaScript applications.

How to use

You can add this module to your app by running the following command

npm install dha-encryption

Usage

This module provides three functions

1. getKeyFromPassword - This function takes a password and returns a key that can be used for encryption and decryption
2. encrypt - This function takes a key object and a string and returns the encrypted string as an array buffer
3. decrypt - This function takes a key object and an array buffer and returns the decrypted string

Example

The following is an example of using the provided methods to generate a key and encrypt and decrypt a string

import { useEffect, useState } from 'react';

import type { DHAKeyObject } from 'dha-encryption';
import { encrypt, decrypt, getKeyFromPassword } from 'dha-encryption';

const Playground = () => {
  const [key, setKey] = useState<DHAKeyObject | null>(null);
  const [encrypted, setEncrypted] = useState<ArrayBuffer | null>(null);
  const [decrypted, setDecrypted] = useState<string>('This is not hello world blah blah blah blah');

  useEffect(() => {
    (async () => {
      const key = await getKeyFromPassword('password');
      setKey(key);

      const encrypted = await encrypt('Hello World', key);
      setEncrypted(encrypted);

      const decrypted = await decrypt(encrypted, key);
      setDecrypted(decrypted);
    })().catch((err) => console.error(err));
  }, []);

  const test = async () => {
    if (key && encrypted) {
      const decrypted = await decrypt(encrypted, key);
      setDecrypted(decrypted);
      console.log(decrypted, 'From test');

      return;
    }
  };

  return (
    <div>
      <div>{decrypted}</div>
      <button
        className="btn btn-primary"
        // eslint-disable-next-line @typescript-eslint/no-misused-promises
        onClick={() =>
          test().catch((err) => {
            console.error(err);
          })
        }
      >
        Test
      </button>
    </div>
  );
};

export default Playground;

Note

As of version 3.0.0 this module uses the browsers native crypto module instead of the one provided in node.js. This version of the module is not tested to be compatible with previous versions of the module, and does not provide and way to migrate data encrypted with previous versions of the module. If you are using a previous version of the module in an existing app, you should not upgrade to this version.

Documentation

Full documentation for this module can be found at https://mobile.health.mil/wmt-sdk-website/docs/encryption/

NPM

The NPM page for this module can be found at https://www.npmjs.com/package/dha-encryption

License

pending