autopass

autopass

Distributed notes/password manager

npm install autopass

[!NOTE] Autopass needs Corestore 7, our latest major version that is backed by RocksDB for storage and atomicity.

Usage

First choose if you wanna pair or make a new instance.

import Autopass from 'autopass'
import Corestore from 'corestore'

const pass = new Autopass(new Corestore('./pass'))

const inv = await pass.createInvite()
console.log('share to add', inv)

Then invite another instance

const pair = Autopass.pair(new Corestore('./another-pass'), inv)

const anotherPass = await pair.finished()
await anotherPass.ready()

When paired you can simply start the instance again with the normal constructor.

await pass.add('a-note', 'hello this is a note')

Then on the other node you get it out with

const note = await pass.get('a-note')
console.log({ note })

API

pass = new Autopass(new Corestore(path))

Make a new pass instance.

pass.on('update', fn)

Triggered when it updates, ie something added/removed an entry

value = await pass.get(key)

Get an entry.

stream = pass.list()

Get all entries.

await pass.add(key, value, file)

Add new entry

await pass.remove(key)

Remove an entry.

stream = pass.listWriters(query)

List all writers, optionally takes a hyperdb query

`writer = await pass.getWriter(key)

Get a writer, object similar to the addWriter input.

await pass.removeWriter(writerKey)

Remove a writer explictly.

await pass.addWriter(writer)

Add a writer explictly. Writer should look like this

{
  key: otherSidesLocalWriterKey,
  name: 'optional name for the writer',
  readOnly: false // weather the person can write or only read
}

pass.writerKey

Get the local writer key.

inv = await pass.createInvite({ readOnly })

Get invite to add a writer.

await deleteInvite()

Delete the current invite.

await pass.ready()

Wait for the pass to load fully

pair = Autopass.pair(new Corestore(path), invite)

Pair with another instance.

pass = await pair.finished()

Wait for the pair to finish.

await pass.addMirror(key)

Add a blind mirror.

await getMirror()

Returns an array of blind mirrors

await removeMirror(key)

Remove a blind mirror

await pair.close()

Force close the pair instance. Only need to call this if you dont wait for it to finish.get

await pass.close()

Fully close the pass instance.

await pass.suspend()

Suspend the swarm and discovery

await pass.resume()

Resume the swarm is suspended

Contributors

Written with big contributions from @supersu