Wormhole
Overview
Wormhole (magic-wormhole) is a command-line tool that provides secure, peer-to-peer file transfer between computers over the internet. Developed by the Magic Wormhole project, it uses a simple “wormhole code” — a short, human-readable phrase — to establish an encrypted connection between the sender and receiver. This eliminates the need for IP addresses, port forwarding, or any complex network configuration.
The workflow is straightforward: the sender uses `wormhole send filename` and receives a wormhole code like “7-cactus-suitcase”. They share this code with the recipient, who runs `wormhole receive` and enters the code. The file is then transferred directly over an encrypted channel. The wormhole code is generated using a secure random algorithm and includes a checksum that allows the receiving side to detect typos before the transfer begins.
Magic-wormhole is written in Python and is available on all major platforms through pip. The protocol uses a “rendezvous” server to coordinate the initial connection, but the actual file data is transferred directly between peers using a transit relay if direct connections are not possible. The entire communication is encrypted with the wormhole code as the key, ensuring that only the intended recipient can decrypt the file.
Key Features
- Simple wormhole codes: Easy-to-read phrases like “7-cactus-suitcase” replace complex IP addresses and passwords.
- End-to-end encryption: Data is encrypted with the wormhole code before leaving the sender’s device.
- No account required: Works instantly without registration, login, or account setup.
- Cross-platform: Available on Linux, macOS, Windows, via pip or native packages.
- Command-line interface: Perfect for scripting, automation, and headless server transfers.
- Directory and file transfer: Send single files or entire directories with a single command.
- Transit relay fallback: Works even when devices cannot connect directly (NAT traversal).
Use Cases
- Sending sensitive documents to colleagues without uploading to a cloud service.
- Transferring files between headless servers or remote machines.
- Scripting automated file transfers in backup or deployment pipelines.
- Sharing large files that exceed email attachment limits with end-to-end encryption.
Platforms
Linux, macOS, Windows, BSD
Licence
Massachusetts Institute of Technology (MIT)