secure-webstore

KO | EN

gitlite — search

#hacktoberfest #llm #go #android #rust #linux #docker #java #nodejs #awesome #vue #pytorch #security #mcp

secure-webstore

(★ 48)

A secure IndexedDB store with built-in encryption

secure-webstore 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Secure-webstore

[![Build Status](https://api.travis-ci.org/AKASHAorg/secure-webstore.svg?branch=master)](https://travis-ci.org/AKASHAorg/secure-webstore)

This is a secure, promise-based keyval store that encrypts data stored in IndexedDB.

The symmetric encryption key is derived from the provided passphrase, and then stored in an encrypted
form within the provided store name. The encryption key is only used in memory and never revealed.

The IndexedDB wrapper used internally is [idb-keyval](https://github.com/jakearchibald/idb-keyval/),
while the cryptographic operations are handled by [easy-web-crypto](https://github.com/AkashaProject/easy-web-crypto),
a zero-dependency wrapper around the [Webcrypto API](https://caniuse.com/#search=web%20crypto) available in modern browsers.

Huge thanks to [@Jopie64](https://github.com/Jopie64) for Typescriptifying the source!

## Installing

### Via npm

```sh
npm install --save secure-webstore
```

### Via `<script>` tag

Either host `dist/cjs/secure-webstore.js` yourself or use a CDN (e.g. jsDelivr) like this:
```html
<script type="application/javascript" src="https://cdn.jsdelivr.net/npm/secure-webstore@1.3.7/dist/cjs/secure-webstore.js"></script>
```
*You can then use `window.SecureStore` to access the library.*

## Usage

### Initialize

The init step takes care of key derivation and setting up the encryption/decryption key.

```js
// Assuming you have loaded the secure-webstore module in your HTML file <script>
const Store = window.SecureStore.Store

const store = new Store('some-store-name', 'super-secure-passphrase')

store.init().then(() => {
  // store is ready
})
```

### set:

```js
store.set('hello', 'world')
```

Since this is IDB-backed, you can store anything structured-clonable (numbers, arrays, objects, dates, blobs etc).

All methods return promises:

```js
store.set('hello', 'world')
  .then(() => console.log('It worked!'))
  .catch(err => console.log('It failed!', err))
```

### get:

```js
// logs: "world"
const val = await store.get('hello')
// console.log(val) -> "world"
```

If there is no 'hello' key, then `val` will be `undefined`.

### keys:

```js
// logs: ["hello", "foo"]
keys().then(keys => console.log(keys))
```

### del:

```js
store.del('hello')
```

### clear:

```js
store.clear()
```

### destroy:

Completely remove a database.

```js
store.destroy()
```

### updatePassphrase:

Update the passphrase that is used for key derivation. The encryption key used for data will not be affected, just the key that protects it.

```js
store.updatePassphrase(oldPass, newPass)
```

### export:

Export all (encrypted) key/vals as one JSON object.

```js
const dump = await store.export()
```

### import:

```js
// using the dump above
store.import(dump)
```

That's it!

secure-webstore

secure-webstore 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

secure-webstore

secure-webstore 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README