sendafriend/README.md

37 lines
1.3 KiB
Markdown
Raw 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
requires you to have go installed and your gopath configured correctly (sorry)
`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 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:
env SENDAFRIEND_FOLDER=$HOME/bob sendafriend info
2018-10-09 23:49:20 +00:00
## <3
made with love by errorinn