occulto/README.md
2022-10-14 15:10:46 +02:00

1.4 KiB
Raw Blame History

occulto 🔒

Occulto /okˈkul.to/

hidden, concealed. secret.

High level wrapper around the node native crypto API.

No Deps & Typescript typings included

Supports Hashes, Symmetric AES & ChaCha20 ciphers and Asymmetric RSA.

📒 DOCS HERE 📒

Quickstart 🚀

Requirements
  • Node >= 16 required
Install
npm i occulto

Examples

RSA

import { RSA } from 'occulto'

const pair = await RSA.gen()
const encrypted = RSA.encrypt('some text', pair.pub)
const decrypted = RSA.decrypt(encrypted, pair.prv)

Symmetric

Available Ciphers

import { Symmetric } from 'occulto'

const encrypted = Symmetric.encrypt('some string', 'myPass', Symmetric.Ciphers.AES_128_GCM)
const decrypted = Symmetric.decrypt(encrypted, 'myPadd')

Hash

Available hashes

import { Hash } from 'occulto'

const hash = Hash.digest('something')

const h = Hash.digest('something', Hash.Hashes.MD5)