Easy-simple-encryption NPM

React - Easy Simple Encryption

Easily add simple encryption / decryption to React and Nextjs applications.

Easy Simple Encryption

Installation

To install the library, run:

$ npm i easy-simple-encryption

Usage

Secret

Add a secret key that will be used to generate the encypted text. This is optional.

Setting a key is recommended to add additional security

Usage:

secret("some key");

Options:

key (Required)

Type	value	Description
string	"key"	A secret key

Example:

import { secret as SecretKey } from "easy-simple-encryption";
SecretKey(process.env.SECRET);

useEncryption

The hook that can be used from any client side component. The hook uses async calls.

Usage:

const { encrypt, decrypt } = useEncryption();

encrypt

Usage:

encrypt("text");

Options:

text (Required)

Type	value	Description
string	"text"	The string to be encrypted

Example:

outputs: 4330776p5k6l24246779624o664024255o2631

import { useEncryption } from "easy-simple-encryption";

function MyComponent() {
  const { encrypt } = useEncryption();

  // on async call
  const onSubmit = async (e: any) => {
    e.preventDefault();
    const password = await encrypt("S0mePa$$worD");
  }

  return (
    <div>
      <button onClick={onSubmit}>
    </div>
  );
}
export default MyComponent;

decrypt

Usage:

decrypt("encrypted_key");

Options:

encrypted_key (Required)

Type	value	Description
string	"encrypted_key"	The key to be decrypted

Example:

outputs S0mePa$$worD

import { useEncryption } from "easy-simple-encryption";

function MyComponent() {
  const { decrypt } = useEncryption();

  // on submit
  const onSubmit = async (e: any) => {
    e.preventDefault();
    const password = await decrypt("4330776p5k6l24246779624o664024255o2631");
  }

  return (
    <div>
      <button onClick={onSubmit}>
    </div>
  );
}
export default MyComponent;

encrypt function

This function can be used on server side components.

Usage:

encrypt("text");

Options:

text (Required)

Type	value	Description
string	"text"	The string to be encrypted

Example:

"use server";
import { encrypt, decrypt } from "easy-simple-encryption";

export const login = async (
  details: Authentication
): Promise<AuthenticationResult> => {
  const { password } = details;

  const account: UserAccount = await checkAccount(await encrypt(password));
  if (account.error) {
    return {
      result: AUTHPAGERESULT.FAIL,
    };
  }

  return {
    result: AUTHPAGERESULT.SUCCESS,
  };
};

decrypt function

This function can be used on server side components.

Usage:

decrypt("text");

Options:

encrypted_key (Required)

Type	value	Description
string	"encrypted_key"	The key to be decrypted

Example:

"use server";
import { encrypt, decrypt } from "easy-simple-encryption";

export const login = async (
  details: Authentication
): Promise<AuthenticationResult> => {
  const { email, password } = details;

  const account: UserAccount = await getAccount(email);
  const auth = await decrypt(account.password);
  if (auth !== password) {
    return {
      result: AUTHPAGERESULT.FAIL,
    };
  }

  return {
    result: AUTHPAGERESULT.SUCCESS,
  };
};