hypercore-encryption

hypercore-encryption

Dyanmic Hypercore encryption provider

Usage

const HypercoreEncryption = require('hypercore-encryption')

const encryption = new HypercoreEncryption({
  blindingKey,
  getBlockKey (id, contexxt) {
    // get key info corresponding to id and context...

    return {
      version, // encryption scheme
      padding, // padding byte length
      key // block key
    }
  }
})

const core = new Hypercore(storage, { encryption })
await core.ready()

await core.append('encrypt with key 1')

await encryption.load(99)

await core.append('encrypt with key 99')

API

const enc = new HypercoreEncryption({ blindingKey, getBlockKey, getBlindingKey })

Instantiate a new encryption provider. Optionally pass a preopen promise that resolves to a key id to be loaded initially.

Provide a hooks with the signature:

function getBlockKey (id, context) {
  // context provides information about the core, eg:
  //   context.key
  //   context.manifest

  // id id is passed as -1, the module expects the key to be updated

  return {
    version, // encryption scheme
    padding, // padding byte length
    key // block key
  }
}

function getBlockKey (context) {
  return blindingKey // 32 byte blinding key
}

const padding = enc.padding(context)

The number of padding bytes.

enc.seekable

Boolean on whether the current scheme allows for seeks.

enc.version

The version of the currently loaded scheme.

await enc.load(id, context)

Load the key under id and set to be the current encryption info.

await enc.encrypt(index, block, fork)

Encrypt a block in place.

await enc.decrypt(index, block)

Decrypt a block in place.

const blockKey = HypercoreEncryption.getBlockKey(hypercoreKey, encryptionKey)

Helper to generate namespaced block keys.

License

Apache-2.0