croc

README

Easily and securely transfer stuff from one computer to another.

croc allows any two computers to directly and securely transfer files and folders. When sending a file, croc generates a random code phrase which must be shared with the recipient so they can receive the file. The code phrase encrypts all data and metadata and also serves to authorize the connection between the two computers in a intermediary relay. The relay connects the TCP ports between the two computers and does not store any information (and all information passing through it is encrypted).

I hear you asking, Why another open-source peer-to-peer file transfer utilities? There are great tools that already do this. But, after review, I found it was useful to make another. Namely, croc has no dependencies (just download a binary and run), it works on any operating system, and its blazingly fast because it does parallel transfer over multiple TCP ports.

Example

These two gifs should run in sync if you force-reload (Ctl+F5)

Sender:

Receiver:

Install

Download the latest release for your system.

Or, you can install Go and build from source with go get github.com/schollz/croc.

Usage

The basic usage is to just do

$ croc send FILE

to send and then on the other computer you can just do

$ croc [code phrase]

to receive (you'll be prompted to enter the code phrase). Note, by default, you don't need any arguments for receiving, instead you will be prompted to enter the code phrase. This makes it possible for you to just double click the executable to run (nice for those of us that aren't computer wizards).

Custom code phrase

You can send with your own code phrase (must be more than 4 characters).

$ croc send --code [code phrase] [filename]

Use locally

croc automatically will attempt to start a local connection on your LAN to transfer the file much faster. It uses peer discovery, basically broadcasting a message on the local subnet to see if another croc user wants to receive the file. croc will utilize the first incoming connection from either the local network or the public relay and follow through with PAKE.

You can change this behavior by forcing croc to use only local connections (--local) or force to use the public relay only (--no-local):

$ croc --local/--no-local send [filename]

Using pipes - stdin and stdout

You can easily use croc in pipes when you need to send data through stdin or get data from stdout. To send you can just use pipes:

$ cat [filename] | croc send

In this case croc will automatically use the stdin data and send and assign a filename like "croc-stdin-123456789". To receive to stdout at you can always just use the -yes and -stdout flags which will automatically approve the transfer and pipe it out to stdout.

$ croc -yes -stdout [code phrase] > out

All of the other text printed to the console is going to stderr so it will not interfere with the message going to stdout.

Self-host relay

The relay is needed to staple the parallel incoming and outgoing connections. The relay temporarily stores connection information and the encrypted meta information. The default uses a public relay at, wss://croc3.schollz.com. You can also run your own relay, it is very easy, just run:

$ croc relay

Make sure to open up TCP ports (see croc relay --help for which ports to open). You can also define your own ports with -tcp and -port. Relays can also be customized to which elliptic curve they will use (default is siec).

You can send files using your relay by entering -relay to change the relay that you are using if you want to custom host your own.

$ croc -relay "ws://myrelay.example.com" send [filename]

How does it work?

croc is similar to magic-wormhole in spirit and design. Like magic-wormhole, croc generates a code phrase for you to share with your friend which allows secure end-to-end transferring of files and folders through a intermediary relay that connects the TCP ports between the two computers. Also like magic-wormhole, security is enabled by performing password-authenticated key exchange (PAKE) with the weak code phrase to generate a session key on both machines without passing any private information between the two. The session key is then verified and used to encrypt the content and meta-data with AES-256. If at any point the PAKE fails, an error will be reported and the file will not be transferred. More details on the PAKE transfer can be found at github.com/schollz/pake and below in the protocol.

The intermediary relay uses websockets to have bidirectional communication with potential senders and recipients. Only one sender and one recipient is allowed in a channel at once. The relay helps to deliver the PAKE information, and once both parties agree, it will staple the connections between the sender and recipient and pipe all incoming TCP data from the sender to the recipient.

When sending a file with croc, a local relay is initiated which will try to discover local peers for connection. If a recipient is found locally, then the local connections are used and the public relay is never used. This way, croc can be used without a public internet connection (i.e. to transfer files over LAN).

Protocol

This is an outline of the protocol used here. The basic PAKE protocol is from Dan Boneh and Victor Shoup's crypto book (pg 789, "PAKE2 protocol).

1. Sender requests new channel and receives empty channel from Relay, or obtains the channel they request (or an error if it is already occupied).
2. Sender generates u using PAKE from secret pw.
3. Sender sends u to Relay and the type of curve being used. Returns error if channel is already occupied by sender, otherwise it uses it.
4. Sender communicates channel + secret pw to Recipient (human interaction).
5. Recipient connects to channel and receives UUID.
6. Recipient requests u from Relay using the channel. Returns error if it doesn't exist yet.
7. Recipient generates v, session key k_B, and hashed session key H(k_B) using PAKE from secret pw.
8. Recipient sends v, H(H(k_B)) to Relay.
9. Sender requests v, H(H(k_B)) from Relay.
10. Sender uses v to generate its session key k_A and H(k_A), and checks H(H(k_A))==H(H(k_B)). Sender aborts here if it is incorrect.
11. Sender gives the Relay authentication H(k_A).
12. Recipient requests H(k_A) from relay and checks against its own. If it doesn't match, then bail.
13. Sender connects to Relay tcp ports and identifies itself using channel+UUID.
14. Sender encrypts data with k.
15. Recipient connects to Relay tcp ports and identifies itself using channel+UUID.
16. Relay realizes it has both recipient and sender for the same channel so it staples their connections. Sets stapled to true.
17. Sender asks Relay whether connections are stapled.
18. Sender sends data over TCP.
19. Recipient closes relay when finished. Anyone participating in the channel can close the relay at any time. Any of the routes except the first ones will return errors if stuff doesn't exist.

Conditions of state

The websocket implementation means that each client and relay follows their specific state machine conditions.

Sender

Initialize

• Requests to join.

Does X not exist?

• Generates X from pw.
• Update relay with X.

Is Y and Bcrypt(k_B) available?

• Use v to generate its session key k_A.
• Check that Bcrypt(k_B) comes from k_A. Abort here if it is incorrect.
• Encrypts data using k_A.
• Connect to TCP ports of Relay.
• Update relay with Bcrypt(k_A).

Are ports stapled?

• Send data over TCP

Recipient

Initialize

• Request to join

Is X available?

• Generate v, session key k_B, and hashed session key H(k_B) using PAKE from secret pw.
• Send the Relay Bcrypt(k_B)

Is Bcrypt(k_A) available?

• Verify that Bcrypt(k_A) comes from k_B
• Connect to TCP ports of Relay and listen.
• Once file is received, Send close signal to Relay.

Relay

Is there a listener for sender and recipient?

• Staple connections.
• Send out to all parties that connections are stapled.

License

MIT

Acknowledgements

I am awed by all the great contributions made! If you feel like contributing, in any way, by all means you can send an Issue, a PR, ask a question, or tweet me (@yakczar).

Thanks...

• ...@warner for the idea.
• ...@tscholl2 for the encryption gists.
• ...@skorokithakis for code on proxying two connections.
• ...for making pull requests @Girbons, @techtide, @heymatthew, @Lunsford94, @lummie, @jesuiscamille, @threefjord, @marcossegovia, @csleong98, @afotescu, @callmefever, @El-JojA, @anatolyyyyyy, @goggle, @smileboywtu!