wormhole

wormhole-william

Wormhole is a Go implementation of magic wormhole. It provides secure end-to-end encrypted file transfers between computers. The endpoints are connected using the same "wormhole code". This client is compatible with the official Python and Rust clients for magic-wormhole.

This repository implements some improvements that were not accepted upstream. As well as some improvements that make the library more suited for non cli usages. We will try to upstream as much as possible and recommend users to use upstream unless specifically needing to use this project.

Improvements over upstream

• Converted a few global variables into constants.
• Optimized the wordlist package for improved performance.
• Added a fast path for getting the contents of text receives.
• Removed all usage of runtime reflection and replace it with faster type-checked code.
• Updated minimum Go version to 1.19 and updated code to use newer features.
• Updated dependencies to newer versions for performance and security reasons.
• Removed deprecated APIs.
• Various other improvements, cleanups and code optimizations.

Future improvements

• Potentially decreasing the reliance on io.ReadSeeker for better mobile support.

API Usage

Sending text:

package main

import (
	"context"
	"fmt"
	"io/ioutil"
	"log"

	"github.com/rymdport/wormhole/wormhole"
)

func sendText() {
	var c wormhole.Client

	msg := "Dillinger-entertainer"

	ctx := context.Background()

	code, status, err := c.SendText(ctx, msg)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println("On the other computer, please run: wormhole receive")
	fmt.Printf("Wormhole code is: %s\n", code)

	s := <-status

	if s.OK {
		fmt.Println("OK!")
	} else {
		log.Fatalf("Send error: %s", s.Error)
	}
}

func recvText(code string) {
	var c wormhole.Client

	ctx := context.Background()
	msg, err := c.Receive(ctx, code)
	if err != nil {
		log.Fatal(err)
	}

	if msg.Type != wormhole.TransferText {
		log.Fatalf("Expected a text message but got type %s", msg.Type)
	}

	msgBody, err := ioutil.ReadAll(msg)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println("got message:")
	fmt.Println(msgBody)
}

See the examples directory for working examples of how to use the API to send and receive text, files and directories.