node-ots

0.1.0 • Public • Published

node-ots

An API wrapper for One-Time Secret

Installing

node ots is available on npm

npm install --save node-ots

Usage

var ots = require('node-ots');
var OTS = new ots('yourname@email.com', 'ots-api-key');

References

Read One-Time Secret API for response values.

The following methods are available:

.status

System Status

OTS.status(function(error, response) {
    console.log(response.status);
});

.share

Share a Secret
secret: The secret to be shared.
passphrase: The passphrase to protect the secret.
recipient: The email of the person to be sent the secret.

OTS.share('I am in love with pie', 'TotallySecurePasswordWith$ymbols431', 'pieman@email.com', function(error, response) {
    console.log('Your secret key is: ' + response.secret_key);
});

.generate

Generate a Secret
passphrase: The passphrase to protect the generated code.
recipient: The email of the person to be sent the generation.

OTS.generate('AnotherTottally$ecur3P4$$word', 'pieman@email.com', function(error, response) {
    console.log('Your secret key is: ' + response.secret_key);
});

.secret

Retrieve a Secret
Secret: the key for the secret to be retrieved. passphrase: the passphrase for the secret to be retrieved.

OTS.secret('pgcdv7org3vtdurif809sygnt0mstw6', 'TotallySecurePasswordWith$ymbols431', function(error, response) { 
    console.log('Your secret is: ' + response.value);
});

.metadata

Retrieve Metadata
key: metadata key for the secret

OTS.metadata('qjpjroeit8wra0ojeyhcw5pjsgwtuq7', function(error, response) {
    console.log(response);
});

.recent

Retrieve Recent Metadata

OTS.recent(function(error, response) {
    console.log(response);
});

TODO

  • Allow ttl to be set globally and per request

Readme

Keywords

none

Package Sidebar

Install

npm i node-ots

Weekly Downloads

0

Version

0.1.0

License

MIT

Last publish

Collaborators

  • derekmartinez18