hyperdrive storage module for dat secret keys
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test
.gitignore
.travis.yml
LICENSE.md
README.md
index.js
package.json

README.md

dat-secret-storage

Store secret keys for hyperdrive archives in the user's home directory.

npm travis standard

Install

npm install dat-secret-storage

Usage

Return for the secret_key storage in hyperdrive/hypercore. To avoid local ownership conflicts, pass the local directory as the first argument. dat-secret-storage will check for a non-empty ownership file in the source directory storage.

var secretStore = require('dat-secret-storage')

var storage = {
  metadata: function (name, opts) {
    if (name === 'secret_key') return secretStore()(path.join(dir, '.dat/metadata.ogd'), opts)
    return // other storage
  },
  content: function (name, opts) {
    return // other storage
  }
}

// store secret key in ~/.dat/secret_keys
var archive = hyperdrive(storage)

API

secretStorage([dir])(ownershipFile, opts)

  • dir: directory to store keys under dir/.dat/secret_keys. Defaults to users home directory.
  • ownershipFile: non-empty file that denotes ownership. This helps avoid local ownership conflicts of the same dat.

License

MIT