Isomorphic encryption library that works both in the browser and node.
Go to file
Niccolo Borgioli 72a31ab3e2
update deps
2024-03-19 13:52:14 +01:00
.github/workflows pipeline 2024-02-09 14:44:04 +01:00
.vscode 2.0.0 (#3) 2022-10-18 15:53:43 +02:00
src add generate key 2023-01-13 20:42:36 +01:00
test add generate key 2023-01-13 20:42:36 +01:00
.gitignore 2.0.0 (#3) 2022-10-18 15:53:43 +02:00
.karma.cjs 2.0.0 (#3) 2022-10-18 15:53:43 +02:00
.mocharc.yaml 2.0.0 (#3) 2022-10-18 15:53:43 +02:00
.nvmrc update deps 2024-02-09 14:32:04 +01:00
CHANGELOG.md update deps 2024-03-19 13:52:14 +01:00
LICENSE 2.0.0 (#3) 2022-10-18 15:53:43 +02:00
README.md readme 2023-01-14 18:49:31 +01:00
ROADMAP.md 2.0.0 (#3) 2022-10-18 15:53:43 +02:00
package.json update deps 2024-03-19 13:52:14 +01:00
pnpm-lock.yaml update deps 2024-03-19 13:52:14 +01:00
tsconfig.json 2.0.0 (#3) 2022-10-18 15:53:43 +02:00
typedoc.json 2.0.0 (#3) 2022-10-18 15:53:43 +02:00

README.md

occulto 🔒

Occulto /okˈkul.to/

hidden, concealed. secret.

version badge downloads badge dependency count minzip size badge types badge

Isomorphic encryption library that works both in the browser and node with no dependencies and written in Typescript.

📒 API Documentation 📒

Quickstart 🚀

Requirements
  • Node >= 16 required
Install
npm i occulto

Examples

RSA

import { RSA } from 'occulto'

const pair = await RSA.generateKeyPair(2 ** 11)
const bytes = Bytes.encode(message)

const encrypted = await RSA.encrypt(bytes, pair.public)
const decrypted = await RSA.decrypt(encrypted, pair.private)

AES

Available Modes

There is an easy API, that will take care of everything for you.

import { AES } from 'occulto'

const password = 'foobar'
const message = 'this is a secret'

const encrypted = await AES.encryptEasy(message, password)
const decrypted = await AES.decryptEasy(encrypted, password)

The low level API is also exposed for advanced usages.

import { AES } from 'occulto'

const message = 'this is a secret'
const key = await AES.generateKey()
const data = Bytes.encode(message)

const ciphertext = await AES.encrypt(data, key)
const plaintext = await AES.decrypt(ciphertext, key)

Hash

Available hashes

import { Hash, Hashes } from 'occulto'

const hashed = await Hash.hash('Some value', Hashes.SHA_512)