sendafriend/README.md

40 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2018-10-09 23:49:20 +00:00
## sendafriend
2018-10-10 07:07:18 +00:00
WARNING: sendafriend has not been audited and probably contains security vulnerabilities. please do not use it for anything sensitive yet
2018-10-09 23:52:32 +00:00
quickly send files or control signals between machines by piping them on the command line, with bidirectional authentication and metadata resistance via tor (built on cwtch)
2018-10-09 23:49:20 +00:00
2018-10-09 23:52:32 +00:00
includes a way to quickly exchange onion addresses using a low-entropy shared secret (using pairwise socialist millionaires' protocol on a bbs) and a contact manager
2018-10-09 23:49:20 +00:00
2018-10-09 23:52:32 +00:00
note that we only support data up to 64k right now, sorry :( (a fix for this is in the works)
2018-10-09 23:49:20 +00:00
2018-10-10 07:07:18 +00:00
sendafriend is rated Adults Only because it generates random words sometimes and i haven't read all the words personally
2018-10-09 23:49:20 +00:00
## installation
2018-10-10 23:00:24 +00:00
requires you to have go installed and your gopath configured correctly (sorry). it also requires tor to be installed and running, with no authentication on the default control port (sorry, fixing now)
2018-10-09 23:49:20 +00:00
`go get openprivacy.ca/openprivacy/sendafriend`
## usage
one-time setup, on both machines:
`sendafriend pair [make-up-a-name]`
activate the receiver first:
`sendafriend receive [made-up-name] > file.ext`
then the sender:
`sendafriend send [made-up-name] < file.ext`
2018-10-10 22:53:10 +00:00
the pairing feature is experimental and kinda flakey right now. you may find it easier to `sendafriend info` to get your identity string, transfer it over some other secure channel, and then `sendafriend add [make-up-a-name] [identity string]` to add it to the contact list
2018-10-10 01:23:27 +00:00
## manage multiple identities
to have multiple addresses and contact lists, create a directory to hold them and prefix commands like so:
2018-10-10 23:04:56 +00:00
`env SENDAFRIEND_FOLDER=$HOME/bob sendafriend info`
2018-10-10 01:23:27 +00:00
2018-10-09 23:49:20 +00:00
## <3
made with love by errorinn