Skip to content

keybase/node-saltpack

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lib
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

node-saltpack

our standard saltpack implementation in JS

Features

  • Full implementation of the saltpack spec (https://saltpack.org)
  • Written for streaming (composable with standard node streams)
  • Browser-ready

Encrypting and decrypting

First, you'll need to obtain keys somehow. See our NaCl library for info on how to do that. If you just want random keys for testing, there's an alice_and_bob function that returns two keypairs in lib/util.js.

Once you have keys for the encryptor and the public keys of each recipient:

//this is the fanciest `echo`  e v e r!
//(this script will read from stdin, encrypt, decrypt, and write to stdout)
var saltpack = require("saltpack");

//get some testing keys, create encrypt/decrypt streams
var alice, bob;
({alice, bob} = saltpack.lowlevel.util.alice_and_bob());

//to specify anonymous recipients, simply add an "anonymized_recipients" argument
//to the dict, with "null" in place of a public key for each recipient you want to hide.
var es = new saltpack.stream.EncryptStream({
    encryptor: alice,
    do_armoring: true,
    recipients: [bob.publicKey]
})
var ds = new saltpack.stream.DecryptStream({decryptor: bob, do_armoring: true})

//register error listeners
es.on('error', function (err) { throw err; })
ds.on('error', function (err) { throw err; })

//roundtrip encrypt/decrypt from stdin to stdout
process.stdin.pipe(es)
//{Encrypt,Decrypt}Streams don't yet know how to accept pipes, so we have to pipe to
//their .first_stream.
es.pipe(ds.first_stream);
ds.pipe(process.stdout)

Stream interface

EncryptStream and DecryptStream mimic the NodeJS stream API as closely as possible. Accordingly, you can watch for the following events:

  • Writable side (input):
    • drain
    • pipe
    • unpipe
  • Readable side (output):
    • close
    • data
    • end
    • finish
    • readable The events are propagated up to the caller by the wrapped stream classes. Additionally, 'error' events emitted by any stream in the pipeline will propagate up to the caller.

EncryptStream and DecryptStream also provide three stream-interface methods:

  • .write(chunk)
  • .pipe(dest)
  • .end()

Unfortunately, at this time it is not possibe to chain .pipe() calls, as explained above. Other than this you can treat EncryptStream and DecryptStream as standard NodeJS streams.

About

our standard saltpack implementation in JS

Resources

License

Stars

Watchers

Forks

Packages

No packages published