package
new private message format for ssb
npm install envelope-jsGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
A javascript tool for cryptographically "boxing" and "unboxing" messages following the envelope spec.
envelope supports encryption to individuals and groups
var { box, unbox, CloakedMsgId } = require('envelope-js')...
box(plain_text, feed_id, prev_msg_id, msg_key, recp_keys) => ciphertextwhere:
plain_text Buffer is the content to be "enveloped"feed_id Buffer is a type-format-key (TFK) encoded value for the feed authoring a messageprev_msg_id Buffer is a TFK encoded value of the id of last message of this feeds chainmsg_key Buffer a randomised 32 Bytes which will be the unique key for this messagerecps_keys Array is a collection of items of form { key, scheme }, where
key Buffer is the key the particular recipientscheme String|Buffer is the type of key / the key management scheme for this recipientunbox(ciphertext, feed_id, prev_msg_id, trial_keys, max_attempts) => plain_text | nullwhere:
ciphertext Buffer is envelopefeed_id Buffer is a type-format-key (TFK) encoded value for the feed authoring a messageprev_msg_id Buffer is a TFK encoded value of the id of last message of this feeds chaintrial_keys Array is a collection of items of form { key, scheme }, where
key Buffer is the key the particular recipientscheme String|Buffer is the type of key / the key management scheme for this recipientmax_attempts Integer (default: 8) how many key_slots you want to assume the envelope hasplain_text Buffer the envelope contentsNOTE: we also expose unboxKey and unboxBody for convenience.
DeriveSecret(feed_id, prev_msg_id) => deriveUsed for taking a msg_key (the one-time key for a particular envelope) and deriving other keys used in the envelope (e.g. read_key)
where:
feed_id Buffer is a TFK encoded id for the feed the envelope is part ofprev_msg_id Buffer is a TFK encoded id for the message prior to one where our envelope is
prev_msg_id's TFK is a zero-filled Buffer.derive(key, labels) => new_key function where:
key Buffer is a seed key which we're going to derive fromlabels Array is a an array of Strings which help define a derivationnew CloakedMsgId(public_msg_id, read_key) => cloakedMsgIdDetermine a cloaked message id for a published message following the envelope-spec/cloaked_msg_id/README.md
where:
public_msg_id Buffer is the id of a enveloped message that's been published (it has an id as it's part of a feed / chain)read_key Buffer is the read capability (NOT the msg_key) for this message envelopecloakedMsgId is an instance with methods:
toBuffer() => Buffer which returns the cloaked id key as a BuffertoString(encoding) => String which returns the cloaked id key as a Buffer (encoding defaults to 'base64')mock() => cloakedMsgId a method for testing. populates the id with random content. if using this, instantiate with no args.slp.encode(info) => Bufferwhere info is an Array of Buffers.
This is "short length-prefixed encoding", see https://github.com/ssbc/envelope-spec/blob/master/encoding/slp.md
...
MIT
arj03
arj03@protonmail.ch
Estimated unpacked size across 19 packages.
25.1 MB
Includes dependencies.
5 direct · 1 outdated
^3.3.0
3.7.0
^2.0.2
2.0.2
^1.5.1
1.5.3
^1.0.0
1.1.1
^3.1.0
5.0.1