https://github.com/donedeal0/deepvault
DeepVault allows you to store data in the browser with AES encryption.
https://github.com/donedeal0/deepvault
aes aes-256 aes-gcm cryptography encryption encryption-decryption gcm local-storage localstorage security
Last synced: 2 months ago
JSON representation
DeepVault allows you to store data in the browser with AES encryption.
- Host: GitHub
- URL: https://github.com/donedeal0/deepvault
- Owner: DoneDeal0
- Created: 2021-06-29T10:20:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-02T18:54:42.000Z (almost 4 years ago)
- Last Synced: 2025-07-19T08:56:10.413Z (3 months ago)
- Topics: aes, aes-256, aes-gcm, cryptography, encryption, encryption-decryption, gcm, local-storage, localstorage, security
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/deepvault
- Size: 18.6 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DEEPVAULT - DOCUMENTATION
## WHAT IS IT?
**DeepVault** allows you to store data in the browser with AES encryption.
## MOTIVATION
Storing data in the browser is very convenient, but not secure. Thanks to **DeepVault**, you can now directly encrypt sensitive data (geolocation, email, etc.), in your browser and access it with a cryptographic key as if you were using good old local storage.
## SECURITY
By nature, **DeepVault** is not completely secure since it only provide security through obfuscation. But albeit it won't stop a determined hacker, it will mitigate the vast majority of automated attacks. Please weight up the pros and cons and design your app carefully.
You can learn more about Advanced Encryption Standard and Galois Counter Mode here:
- https://en.wikipedia.org/wiki/Galois/Counter_Mode
- https://fr.wikipedia.org/wiki/Advanced_Encryption_Standard
### features:
- Save, read, update and delete encrypted data in the browser.
- Supports Typescript.
- No dependencies.
- Extra-light package.
## HOW DOES IT WORK?
#### Vaults file
- Create a `vaults.js` file (the name and the extension doesn't matter).
- Create as many instances of DeepVault as you want and export them.
- Each instance is dedicated to a single dataset.
```javascript
import DeepVault from "deepvault";
export const userVault = new DeepVault("user");
export const cashVault = new DeepVault("cash");
```
#### Save data
```javascript
import { userVault } from "./vaults";
const onLogin = async (form) => {
try {
const user = await login(form)
await userVault.encryptAndSaveData(user)
return saveUserInGlobalState(user)
}
catch(err){
throw new Error(err)
}
```
#### Read data
```javascript
import { userVault } from "./vaults";
const getUser = async () => {
try {
const user = await userVault.getDecryptedData()
if (user) return saveUserInGlobalState(user)
return null
}
catch(err){
throw new Error(err)
}
```
#### Update data
```javascript
import { userVault } from "./vaults";
const updateUser = async (user) => {
try {
await userVault.updateData(user)
return saveUserInGlobalState(user)
}
catch(err){
throw new Error(err)
}
```
#### Delete data
```javascript
import { userVault } from "./vaults";
const logout = async () => {
try {
await userVault.deleteData()
return clearGlobalState()
}
catch(err){
throw new Error(err)
}
```
> The dummy functions `saveUserInGlobalState()` and `clearGlobalState()` are not part of DeepVault. You should implement them yourself. If you use React, Redux or Zustand will work fine.
## Methods
**DeepVault** offers you 6 methods:
| |Type |Role |
|----------------|-------------------------------|-----------------------------|
|decryptData |`(data: string) => Promise` |Decrypt data. |
|deleteData |`() => void` |Delete data. |
|encryptAndSaveData |`(data: any) => void`|Encrypt and save data|
|getEncryptedData |`() => string`|Get data without decrypting it. Useful to check the existence of an item without any need to access its information.|
|getDecryptedData |`() => Promise`|Get decrypted data.|
|updateData |`(data: any) => Promise`|Update an item already encrypted and saved. This method will replace the former data with the new one.|
## CONTRIBUTING
Feel free to send your pull requests or to raise issues on the github repository.
## CREDITS
DoneDeal0
Logo made by throwaway icons from the Noun Project