# private-box

> encrypt a message to a secret number of recipients

Latest version **0.3.1** (published 2019-12-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install private-box
pnpm add private-box
yarn add private-box
bun add private-box
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2019-12-19 |
| First published | 2015-07-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 30.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 102 |
| Author | Dominic Tarr |
| Maintainers | dominictarr |

## Links

- npm: https://www.npmjs.com/package/private-box
- Repository: https://github.com/auditdrivencrypto/private-box
- Issues: https://github.com/auditdrivencrypto/private-box/issues
- npm.io page: https://npm.io/package/private-box

## Dependencies (1)

- [chloride](https://npm.io/package/chloride.md) ^2.2.9

## Recent versions

- 0.3.1 (latest) — 2019-12-19
- 0.3.0 — 2018-05-06
- 0.2.1 — 2016-07-30
- 0.2.0 — 2016-03-31
- 0.1.1 — 2016-02-10
- 0.1.0 — 2016-01-26
- 0.0.3 — 2015-12-05
- 0.0.2 — 2015-07-31
- 0.0.0 — 2015-07-01

## README

# private-box

A format for encrypting a private message to many parties.
`private-box` is designed according to the [auditdrivencrypto design process](https://github.com/crypto-browserify/crypto-browserify/issues/128)

## API

### encrypt (plaintext Buffer, recipients Array<curve25519_pk>)

Takes a `plaintext` Buffer of the message you want to encrypt,
and an array of recipient public keys.
Returns a message that is encrypted to all recipients
and openable by them with `PrivateBox.decrypt`.
The `recipients` must be between 1 and 7 items long.

The encrypted length will be `56 + (recipients.length * 33) + plaintext.length` bytes long,
between 89 and 287 bytes longer than the plaintext.

### decrypt (cyphertext Buffer, secretKey curve25519_sk)

Attempt to decrypt a private-box message, using your secret key.
If you where an intended recipient then the plaintext will be returned.
If it was not for you, then `undefined` will be returned.

## Protocol

### Encryption

`private-box` generates an ephemeral curve25519 keypair that will only be used with this message (`ephemeral`),
and a random key that will be used to encrypt the plaintext body (`body_key`).
First, private-box outputs the ephemeral public key, then multiplies each recipient public key
with its secret to produce ephemeral shared keys (`shared_keys[1..n]`).
Then, private-box concatenates `body_key` with the number of recipients,
encrypts that to each shared key, and concatenates the encrypted body.

```
function encrypt (plaintext, recipients) {
  var ephemeral = keypair()
  var nonce     = random(24)
  var body_key  = random(32)
  var body_key_with_length = concat([body_key, recipients.length])
  return concat([
    nonce,
    ephemeral.publicKey,
    concat(recipients.map(function (publicKey) {
      return secretbox(
        body_key_with_length,
        nonce,
        scalarmult(publicKey, ephemeral.secretKey)
      )
    }),
    secretbox(plaintext, nonce, body_key)
  ])
}
```

## Decryption

`private-box` takes the nonce and ephemeral public key,
multiplies that with your secret key, then tests each possible
recipient slot until it either decrypts a key or runs out of slots.
If it runs out of slots, the message was not addressed to you,
so `undefined` is returned. Else, the message is found and the body
is decrypted.

``` js
function decrypt (cyphertext, secretKey) {
  var next = reader(cyphertext) // next() will read the passed N bytes
  var nonce = next(24)
  var publicKey = next(32)
  var sharedKey = salarmult(publicKey, secretKey)

  for(var i = 0; i < 7; i++) {
    var maybe_key = next(33)
    var key_with_length = secretbox_open(maybe_key, nonce, sharedKey)
    if (key_with_length) { // decrypted!
      var key = key_with_length.slice(0, 32)
      var length = key_with_length[32]
      return secretbox_open(
        key,
        cyphertext.slice(56 + 33*(length+1), cyphertext.length),
      )
    }
  }
  // this message was not addressed to the owner of secretKey
  return undefined
}
```

## Assumptions

Messages will be posted in public, so that the sender is likely to be known,
and everyone can read the messages. (This makes it possible to hide the recipient,
but probably not the sender.)

Resisting traffic analysis of the timing or size of messages is out of scope of this spec.

## Prior Art

### PGP

In PGP the recipient, the sender, and the subject are sent as plaintext.
If the recipient is known, then the metadata graph of who is communicating with who can be read,
which, since it is easier to analyze than the content, is important to protect.

### Sodium seal

The Sodium library provides a _seal_ function that generates an ephemeral keypair,
derives a shared key to encrypt a message, and then sends the ephemeral public key and the message.
The recipient is hidden, and it is forward secure if the sender throws out the ephemeral key.
However, it's only possible to have one recipient.

### Minilock

Minilock uses a similar approach to `private-box` but does not hide the
number of recipients. In the case of a group discussion where multiple rounds
of messages are sent to everyone, this may enable an eavesdropper to deanonymize
the participiants of a discussion if the sender of each message is known.

## Properties

This protocol was designed for use with secure-scuttlebutt.
In this place, messages are placed in public, and the sender is known via a signature,
but we can hide the recipient and the content.

### Recipients are hidden.

An eaves-dropper cannot know the recipients or their number.
Since the message is encrypted to each recipient, and then placed in public,
to receive a message you will have to decrypt every message posted.
This would not be scalable if you had to decrypt every message on the internet,
but if you can restrict the number of messages you might have to decrypt,
then it's reasonable. For example, if you frequented a forum which contained these messages,
then it would only be a reasonable number of messages, and posting a message would only
reveal that you where talking to some other member of that forum.

Hiding access to such a forum is another problem that's out of the current scope.

### The number of recipients are hidden.

If the number of recipients was not hidden, then sometimes it would be possible
to deanonymise the recipients, if there was a large group discussion with
an unusual number of recipients. Encrypting the number of recipients means that
when you fail to decrypt a message you must attempt to decrypt same number of times
as the maximum recipients.

### A valid recipient does not know the other recipients.

A valid recipient knows the number of recipients but now who they are.
This is more a sideeffect of the design than an intentional design element.

### By providing the `key` for a message a outside party could decrypt the message.

When you tell someone a secret you must trust them not to reveal it.
Anyone who knows the `key` could reveal that to some other party who could then read the message content,
but not the recipients (unless the sender revealed the ephemeral secret key).

## License

MIT

---
_Source: https://npm.io/package/private-box · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._