Skip to content

Commit

Permalink
initial
Browse files Browse the repository at this point in the history
  • Loading branch information
dominictarr committed Jun 30, 2015
0 parents commit 1ef87c6
Show file tree
Hide file tree
Showing 3 changed files with 150 additions and 0 deletions.
24 changes: 24 additions & 0 deletions LICENSE
@@ -0,0 +1,24 @@
The MIT License (MIT)

Copyright (c) 2015 Dominic Tarr

Permission is hereby granted, free of charge,
to any person obtaining a copy of this software and
associated documentation files (the "Software"), to
deal in the Software without restriction, including
without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom
the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice
shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
106 changes: 106 additions & 0 deletions README.md
@@ -0,0 +1,106 @@
# private-box

an unaddressed box, with a private note-to-self so the sender can remember who it was for.

``` js

private_box(msg, nonce, recipient_pk, sender_sk, sender_key) => ciphertext

//then, the receiver can open it if they know the sender.

private_unbox(msg, nonce, sender_pk, recipient_sk) => plaintext

//OR, the sender can decrypt.

private_unbox2(msg, nonce, sender_sk, sender_key) => plaintext

```

In secure scuttlebutt, a potential receiver knows who posted
a message, because it has a pk/signature. The envelope is marked
with a _from_ field, but there is no _to_ field.

However, sometimes the sender needs to look at a message
they sent. If there is no _to_ field, the sender must encrypt
a short message _to themselves_.

## generate one time key.

generate a onetime keypair, box a message to the receipient
with it, and also box a message back to your self, including
the onetime secret, so that you can reopen the message if necessary.

```js
//two scalarmult + key_pair
//152 byte overhead
function private_box (msg, nonce, recipient_pk, sender_sk) {
var onetime = box_keypair()
return concat([
nonce, //24 bytes
onetime.publicKey, //32 bytes
box_easy( //32+32+16 = 80 bytes
concat([recipient_pk, onetime.secretKey]),
onetime.publicKey,
sender_sk
),
//msg.length + 16 bytes
box_easy(msg, nonce, recipient_pk, onetime.secretKey)
]
}
```
this design generates a new key pair on ever write,
and then uses two scalarmult operations.
there are 152 bytes of overhead.
One interesting benefit is that you could have a oneway
write, where the author forgets the onetime secret key,
so the box can only be opened by it's recipient.
## keep a symmetric key for the note-to-self
We have to keep track of another secret key
(it could be derived from the private key, though)
``` js

function private_box (msg, nonce, recipient_pk, sender_sk, sender_key) {
return concat([
nonce, //24 bytes
secretbox_easy(recipient_pk, nonce, sender_key), //32+16=40 bytes
box_easy(msg, nonce, recipient_pk, sender_sk) //msg.length + 16
])
}
```
Only 80 bytes overhead (just over half as much) and only one
scalarmult. This will be a more performant encrypt operation,
but decrypt will be only slightly better.
This construction could be used to store encrypted messages
for yourself, by "sending them" to a onetime key.
Also, it would mean that `sender_key` is
## one way box
you could have a box that only the recipient can open.
``` js
function oneway_box (msg, nonce, recipient_pk) {
var onetime = keypair()
return concat([
nonce,
onetime.publicKey,
box_easy(msg, nonce, recipient_pk, onetime.secretKey)
])
}
```
This would have the interesting property that the message
could not be opened by the sender (once they have deleted
`onetime.secretKey`)
This doesn't seem very useful for a database.
## License
MIT
20 changes: 20 additions & 0 deletions package.json
@@ -0,0 +1,20 @@
{
"name": "private-box",
"description": "",
"version": "0.0.0",
"homepage": "https://github.com/dominictarr/private-box",
"repository": {
"type": "git",
"url": "git://github.com/dominictarr/private-box.git"
},
"dependencies": {
},
"devDependencies": {
},
"scripts": {
"prepublish": "npm ls && npm test",
"test": "set -e; for t in test/*.js; do node $t; done"
},
"author": "Dominic Tarr <dominic.tarr@gmail.com> (http://dominictarr.com)",
"license": "MIT"
}

0 comments on commit 1ef87c6

Please sign in to comment.