mirror of
https://github.com/cupcakearmy/occulto.git
synced 2024-11-01 06:04:17 +01:00
64 lines
1.3 KiB
Markdown
64 lines
1.3 KiB
Markdown
# occulto 🔒
|
|
|
|
High level wrapper around [forge](https://github.com/digitalbazaar/forge).
|
|
|
|
Supports Hashes, Symmetric AES & ChaCha20 ciphers and Asymmetric RSA.
|
|
|
|
**Typescript typings included**
|
|
|
|
## Quickstart 🚀
|
|
|
|
###### Install
|
|
|
|
```
|
|
npm i node-forge occulto
|
|
```
|
|
|
|
```javascript
|
|
// 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 📒**](https://cupcakearmy.github.io/occulto/index.html)
|
|
|
|
### Examples
|
|
|
|
## RSA
|
|
|
|
```javascript
|
|
const pair = await RSA.gen()
|
|
const encrypted = RSA.encrypt('some text', pair.pub)
|
|
const decrypted = RSA.decrypt(encrypted, pair.prv)
|
|
```
|
|
|
|
## Symmetric
|
|
|
|
```javascript
|
|
// 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
|
|
|
|
```javascript
|
|
// Whatever import you prefer
|
|
// const { Hash } = require('occulto')
|
|
import { Hash } from 'occulto'
|
|
|
|
const hash = Hash.digest('something')
|
|
|
|
const h = Hash.digest('something', Hashes.MD5)
|
|
|
|
```
|