occulto/README.md

occulto 🔒

High level wrapper around forge.

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

Typescript typings included

Quickstart 🚀

Install

npm i node-forge occulto

// Whatever import you prefer
// const { RSA } = require('occulto')
import { RSA } from 'occulto'

const pair = await RSA.gen()

const encrypted = RSA.encrypt('some string', 'myPass')
const decrypted = RSA.decrypt(encrypted, 'myPass')

📒 DOCS HERE 📒

Examples

RSA

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

Symmetric

// Whatever import you prefer
// const { Symmetric } = require('occulto')
import { Symmetric } from 'occulto'

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

Hash

// Whatever import you prefer
// const { Hash } = require('occulto')
import { Hash } from 'occulto'

const hash = Hash.digest('something')

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