mirror of
https://github.com/cupcakearmy/occulto.git
synced 2024-11-01 06:04:17 +01:00
Nicco
56a8103582
* rewrite * testing worklflow * sprcify version * config stuff * add hash as buffer * delete docs * use typedarray everywhere and docs * readme * aes * cleanup * rsa * testing with playwright * fix playwright * readme * docs * update deps * use headless * add prepublish * build pipeline * move types up * move types up * add types legacy * packaging * versions bump * cleanup * maybe this time * drop support for commonjs * version bump * cleanup
63 lines
1.5 KiB
Markdown
63 lines
1.5 KiB
Markdown
# occulto 🔒
|
||
|
||
> Occulto <kbd>/okˈkul.to/</kbd>
|
||
>
|
||
> _hidden, concealed. secret._
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Isomorphic encryption library that works both in the browser and node with _no dependencies_ and written in Typescript.
|
||
|
||
[**📒 API Documentation 📒**](https://occulto.pages.dev)
|
||
|
||
## Quickstart 🚀
|
||
|
||
###### Requirements
|
||
|
||
- Node >= 16 required
|
||
|
||
###### Install
|
||
|
||
```
|
||
npm i occulto
|
||
```
|
||
|
||
## Examples
|
||
|
||
### [RSA](https://occulto.pages.dev/classes/RSA)
|
||
|
||
```typescript
|
||
import { RSA } from 'occulto'
|
||
|
||
const pair = await RSA.generateKeyPair()
|
||
const encrypted = await RSA.encrypt('some text', pair.public)
|
||
const decrypted = await RSA.decrypt(encrypted, pair.private)
|
||
```
|
||
|
||
### [AES](https://occulto.pages.dev/classes/AES)
|
||
|
||
[Available Modes](https://occulto.pages.dev/enums/Modes)
|
||
|
||
```javascript
|
||
import { Symmetric } from 'occulto'
|
||
|
||
const encrypted = await Symmetric.encryptEasy('some string', 'myPass')
|
||
const decrypted = await Symmetric.decryptEasy(encrypted, 'myPass')
|
||
```
|
||
|
||
### [Hash](https://occulto.pages.dev/classes/Hash)
|
||
|
||
[Available hashes](https://occulto.pages.dev/enums/Hashes)
|
||
|
||
```typescript
|
||
import { Hash } from 'occulto'
|
||
|
||
const hash = Hash.digest('something')
|
||
|
||
const h = Hash.digest('something', Hash.Hashes.MD5)
|
||
```
|