wireguard-go - peer goroutines can SIGSEGV on device.Close()

Spike Curtis spike at coder.com
Thu Jul 21 15:38:03 UTC 2022

I have encountered what I think is a bug in wireguard-go which causes
a SIGSEGV like:

panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x2 addr=0x20 pc=0x1006ce478]

goroutine 150 [running]:
{0x14000192000, 0x58, 0x100000000000000?}, 0x3?)
/Users/spike/go/pkg/mod/github.com/coder/wireguard-go/tun/netstack at v0.0.0-20220614153727-d82b4ba8619f/tun.go:192
/Users/spike/go/pkg/mod/golang.zx2c4.com/wireguard at v0.0.0-20220703234212-c31a7b1ab478/device/receive.go:476
created by golang.zx2c4.com/wireguard/device.(*Peer).Start
/Users/spike/go/pkg/mod/golang.zx2c4.com/wireguard at v0.0.0-20220703234212-c31a7b1ab478/device/peer.go:199

I believe this happens when I call `Close()` on the Device with this
Peer.  Closing the device triggers gVisor to Attach a nil
NetworkDispatcher to the tun, which the Peer goroutine attempts to
dereference via Write.  This is a race condition that depends on
whether any packets are queued up at the time: if the queues are
empty, we are fine.

I'm able to work around this issue by calling RemoveAllPeers() prior
to Close() on the device, but presumably it wasn't the intention to
make Close() on its own dangerous in this way.

I'm happy to offer a patch if you're interested.

Spike Curtis
Principal Engineer

More information about the WireGuard mailing list