@cipherstash/ore

Node-ORE

This package is a thin wrapper around FASTORE for use in Node.js projects.

Usage

const ORE = require('./node-ore');

const PRF_KEY = Buffer.from('2e877eebe7f0b8ef1492f314d66c4dcc', 'hex');
const PRP_KEY = Buffer.from('e6c53234aa05cfe2dd54df83d18d09be', 'hex');

const plaintext = 1566n;
const ore = new ORE(PRP_KEY, PRF_KEY);
const {left: left, right: right} = ore.encrypt(plaintext);

Note: This library does not implement compare functions!

Building

NOTE: this package contains a symbolic link to fastore in src that points to the fastore directory in the same Git repo.

This package is built using node-gyp.

Config is managed in binding.gyp.

To build, run:

node-gyp configure
node-gyp build

Publishing

The package is configured to publish to the private Github repo at https://github.com/cipherstash/node-ore/packages.

To publish, run npm publish.

See also the GitHub Guide.