diff --git a/README.md b/README.md index df7393b..af8e5b7 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ replacement for [`pull-box-stream`](https://github.com/dominictarr/pull-box-stre ```js const { randomBytes } = require('crypto') const pull = require('pull-stream') -const { KEYBYTES, createBoxStream, createUnboxStream } = require('pull-secretstream') +const { KEYBYTES, createEncryptStream, createDecryptStream } = require('pull-secretstream') // generate a random secret, `KEYBYTES` bytes long. const key = randomBytes(KEYBYTES) @@ -18,7 +18,7 @@ pull( pull.values([plaintext1]), // encrypt every byte - createBoxStream(key), + createEncryptStream(key), // the encrypted stream pull.through((ciphertext) => { @@ -26,7 +26,7 @@ pull( }), //decrypt every byte - createUnboxStream(key), + createDecryptStream(key), pull.concat((err, plaintext2) => { if (err) throw err diff --git a/examples/readme.js b/examples/readme.js index f02ab63..76447d3 100644 --- a/examples/readme.js +++ b/examples/readme.js @@ -1,6 +1,6 @@ const { randomBytes } = require('crypto') const pull = require('pull-stream') -const { KEYBYTES, createBoxStream, createUnboxStream } = require('../') +const { KEYBYTES, createEncryptStream, createDecryptStream } = require('../') // generate a random secret, `KEYBYTES` bytes long. const key = randomBytes(KEYBYTES) @@ -11,7 +11,7 @@ pull( pull.values([plaintext1]), // encrypt every byte - createBoxStream(key), + createEncryptStream(key), // the encrypted stream pull.through((ciphertext) => { @@ -19,7 +19,7 @@ pull( }), //decrypt every byte - createUnboxStream(key), + createDecryptStream(key), pull.concat((err, plaintext2) => { if (err) throw err diff --git a/src/index.js b/src/index.js index fd35536..6dc45e5 100644 --- a/src/index.js +++ b/src/index.js @@ -7,41 +7,41 @@ const pullHeader = require('pull-header') module.exports = { KEYBYTES, - createBoxStream, - createUnboxStream, + createEncryptStream, + createDecryptStream, } -function createBoxStream(key) { - const boxer = new Push(key) +function createEncryptStream(key) { + const encrypter = new Push(key) - const sendHeader = pull.values([boxer.header]) + const sendHeader = pull.values([encrypter.header]) - const boxMap = pullMapLast( + const encryptMap = pullMapLast( (plaintext) => { - return boxer.next(plaintext) + return encrypter.next(plaintext) }, () => { - return boxer.final() + return encrypter.final() }, ) return (stream) => { - return pullCat([sendHeader, pull(stream, boxMap)]) + return pullCat([sendHeader, pull(stream, encryptMap)]) } } -function createUnboxStream(key) { - const unboxer = new Pull(key) +function createDecryptStream(key) { + const decrypter = new Pull(key) const receiveHeader = pullHeader(HEADERBYTES, (header) => { - unboxer.init(header) + decrypter.init(header) }) - const unboxMap = pullMap((ciphertext) => { - return unboxer.next(ciphertext) + const decryptMap = pullMap((ciphertext) => { + return decrypter.next(ciphertext) }) return (stream) => { - return pull(stream, receiveHeader, unboxMap) + return pull(stream, receiveHeader, decryptMap) } } diff --git a/test/basics.test.js b/test/basics.test.js index 8fc2231..0f89b01 100644 --- a/test/basics.test.js +++ b/test/basics.test.js @@ -2,9 +2,9 @@ const test = require('node:test') const assert = require('node:assert') const pull = require('pull-stream') const { randomBytes } = require('crypto') -const { KEYBYTES, createBoxStream, createUnboxStream } = require('../') +const { KEYBYTES, createEncryptStream, createDecryptStream } = require('../') -test('test basic boxStream and unboxStream', async (t) => { +test('test basic encryptStream and decryptStream', async (t) => { // generate a random secret, `KEYBYTES` bytes long. const key = randomBytes(KEYBYTES) @@ -13,11 +13,11 @@ test('test basic boxStream and unboxStream', async (t) => { await new Promise((resolve, reject) => { pull( pull.values([plaintext1]), - createBoxStream(key), + createEncryptStream(key), pull.through((ciphertext) => { console.log('Encrypted: ', ciphertext) }), - createUnboxStream(key), + createDecryptStream(key), pull.concat((err, plaintext2) => { if (err) return reject(err) assert.equal(plaintext2.toString('ascii'), plaintext1.toString('ascii'))