Add SetPriorityMessageOnEstablishmentFunc, which registers a PeerPriorityMessageFunc callback invoked when a peer's session keypair is established or re-keyed for forward data transmission. The bytes it returns are transmitted to the peer as a transport message. The message is "priority" in two senses: it bypasses the staged packet queue entirely, so it cannot be evicted by TUN-sourced packets, and it is enqueued ahead of the keepalive/staged packets that follow keypair establishment. Updates tailscale/tailscale#20081 Signed-off-by: Jordan Whited <jordan@tailscale.com>
763 lines
23 KiB
Go
763 lines
23 KiB
Go
/* SPDX-License-Identifier: MIT
|
|
*
|
|
* Copyright (C) 2017-2025 WireGuard LLC. All Rights Reserved.
|
|
*/
|
|
|
|
package device
|
|
|
|
import (
|
|
"encoding/binary"
|
|
"errors"
|
|
"fmt"
|
|
"net"
|
|
"net/netip"
|
|
"os"
|
|
"sync"
|
|
"time"
|
|
|
|
"github.com/sagernet/wireguard-go/conn"
|
|
"github.com/sagernet/wireguard-go/tun"
|
|
"golang.org/x/crypto/chacha20poly1305"
|
|
"golang.org/x/net/ipv4"
|
|
"golang.org/x/net/ipv6"
|
|
)
|
|
|
|
/* Outbound flow
|
|
*
|
|
* 1. TUN queue
|
|
* 2. Routing (sequential)
|
|
* 3. Nonce assignment (sequential)
|
|
* 4. Encryption (parallel)
|
|
* 5. Transmission (sequential)
|
|
*
|
|
* The functions in this file occur (roughly) in the order in
|
|
* which the packets are processed.
|
|
*
|
|
* Locking, Producers and Consumers
|
|
*
|
|
* The order of packets (per peer) must be maintained,
|
|
* but encryption of packets happen out-of-order:
|
|
*
|
|
* The sequential consumers will attempt to take the lock,
|
|
* workers release lock when they have completed work (encryption) on the packet.
|
|
*
|
|
* If the element is inserted into the "encryption queue",
|
|
* the content is preceded by enough "junk" to contain the transport header
|
|
* (to allow the construction of transport messages in-place)
|
|
*/
|
|
|
|
type QueueOutboundElement struct {
|
|
buffer []byte // sing-allocated buffer holding the packet data
|
|
// packet is always a slice of "buffer". The starting offset in buffer
|
|
// is either:
|
|
// a) MessageEncapsulatingTransportSize+MessageTransportHeaderSize (plaintext)
|
|
// b) 0 (post-encryption)
|
|
packet []byte
|
|
nonce uint64 // nonce for encryption
|
|
keypair *Keypair // keypair for encryption
|
|
peer *Peer // related peer
|
|
}
|
|
|
|
type QueueOutboundElementsContainer struct {
|
|
// filling is a one-shot barrier signaling encryption→send handoff.
|
|
// SendStagedPackets calls Add(1) before sending the container down
|
|
// the encryption and outbound queues; RoutineEncryption calls Done
|
|
// after encrypting; RoutineSequentialSender calls Wait before
|
|
// reading the encrypted packets.
|
|
filling sync.WaitGroup
|
|
elems []*QueueOutboundElement
|
|
}
|
|
|
|
func (device *Device) NewOutboundElement() *QueueOutboundElement {
|
|
elem := device.GetOutboundElement()
|
|
elem.buffer = device.GetOutboundBuffer(MaxMessageSize)
|
|
elem.nonce = 0
|
|
// keypair and peer were cleared (if necessary) by clearPointers.
|
|
return elem
|
|
}
|
|
|
|
// clearPointers clears elem fields that contain pointers.
|
|
// This makes the garbage collector's life easier and
|
|
// avoids accidentally keeping other objects around unnecessarily.
|
|
// It also reduces the possible collateral damage from use-after-free bugs.
|
|
func (elem *QueueOutboundElement) clearPointers() {
|
|
elem.buffer = nil
|
|
elem.packet = nil
|
|
elem.keypair = nil
|
|
elem.peer = nil
|
|
}
|
|
|
|
/* Queues a keepalive if no packets are queued for peer
|
|
*/
|
|
func (peer *Peer) SendKeepalive() {
|
|
if len(peer.queue.staged) == 0 && peer.isRunning.Load() {
|
|
elem := peer.device.NewOutboundElement()
|
|
elemsContainer := peer.device.GetOutboundElementsContainer()
|
|
elemsContainer.elems = append(elemsContainer.elems, elem)
|
|
select {
|
|
case peer.queue.staged <- elemsContainer:
|
|
peer.queuedOutboundPackets.Add(1)
|
|
peer.device.log.Verbosef("%v - Sending keepalive packet", peer)
|
|
default:
|
|
peer.device.PutOutboundBuffer(elem.buffer)
|
|
peer.device.PutOutboundElement(elem)
|
|
peer.device.PutOutboundElementsContainer(elemsContainer)
|
|
}
|
|
}
|
|
peer.SendStagedPackets()
|
|
}
|
|
|
|
// SendPriorityMessage invokes the [PeerPriorityMessageFunc] callback if one is
|
|
// set, and queues the returned message for encryption and transmission if the
|
|
// current keypair is valid.
|
|
func (peer *Peer) SendPriorityMessage() {
|
|
f := peer.device.priorityMsgFn.Load()
|
|
if f == nil {
|
|
return
|
|
}
|
|
keypair := peer.keypairs.Current()
|
|
if keypair == nil || keypair.sendNonce.Load() >= RejectAfterMessages || time.Since(keypair.created) >= RejectAfterTime {
|
|
// SendStagedPackets initializes a handshake when the keypair is invalid,
|
|
// but we explicitly avoid that here. A priority message is only intended
|
|
// to flow around symmetric session establishment, but it should never
|
|
// trigger a new session. Reaching this branch due to nonce exhaustion
|
|
// or keypair expiration is highly unlikely considering where
|
|
// SendPriorityMessage is called (at current keypair establishment).
|
|
return
|
|
}
|
|
|
|
// get plaintext message to send
|
|
msg := (*f)(peer.handshake.remoteStatic)
|
|
if len(msg) == 0 {
|
|
return
|
|
}
|
|
if len(msg) > MaxPriorityMessageContentSize {
|
|
peer.device.log.Verbosef("%v - Failed to queue priority message due to size", peer)
|
|
return
|
|
}
|
|
|
|
// get pooled elements
|
|
elem := peer.device.NewOutboundElement()
|
|
elemsContainer := peer.device.GetOutboundElementsContainer()
|
|
elemsContainer.elems = append(elemsContainer.elems, elem)
|
|
packetQueued := false
|
|
defer func() {
|
|
if !packetQueued {
|
|
peer.device.PutOutboundBuffer(elem.buffer)
|
|
peer.device.PutOutboundElement(elem)
|
|
peer.device.PutOutboundElementsContainer(elemsContainer)
|
|
}
|
|
}()
|
|
|
|
// initialize outbound element
|
|
const offset = MessageEncapsulatingTransportSize + MessageTransportHeaderSize
|
|
n := copy(elem.buffer[offset:], msg)
|
|
elem.packet = elem.buffer[offset : offset+n]
|
|
elem.peer = peer
|
|
elem.nonce = keypair.sendNonce.Add(1) - 1
|
|
if elem.nonce >= RejectAfterMessages {
|
|
keypair.sendNonce.Store(RejectAfterMessages)
|
|
return
|
|
}
|
|
elem.keypair = keypair
|
|
|
|
// add to parallel and sequential queue
|
|
if peer.isRunning.Load() {
|
|
elemsContainer.filling.Add(1)
|
|
peer.queuedOutboundPackets.Add(1)
|
|
peer.queue.outbound.c <- elemsContainer
|
|
peer.device.queue.encryption.c <- elemsContainer
|
|
packetQueued = true
|
|
}
|
|
}
|
|
|
|
func (peer *Peer) SendHandshakeInitiation(isRetry bool) error {
|
|
if !isRetry {
|
|
peer.timers.handshakeAttempts.Store(0)
|
|
}
|
|
|
|
peer.handshake.mutex.RLock()
|
|
if time.Since(peer.handshake.lastSentHandshake) < RekeyTimeout {
|
|
peer.handshake.mutex.RUnlock()
|
|
return nil
|
|
}
|
|
peer.handshake.mutex.RUnlock()
|
|
|
|
peer.handshake.mutex.Lock()
|
|
if time.Since(peer.handshake.lastSentHandshake) < RekeyTimeout {
|
|
peer.handshake.mutex.Unlock()
|
|
return nil
|
|
}
|
|
peer.handshake.lastSentHandshake = time.Now()
|
|
peer.handshake.mutex.Unlock()
|
|
|
|
peer.device.log.Verbosef("%v - Sending handshake initiation", peer)
|
|
|
|
msg, err := peer.device.CreateMessageInitiation(peer)
|
|
if err != nil {
|
|
peer.device.log.Errorf("%v - Failed to create initiation message: %v", peer, err)
|
|
return err
|
|
}
|
|
|
|
buf := make([]byte, MessageEncapsulatingTransportSize+MessageInitiationSize)
|
|
packet := buf[MessageEncapsulatingTransportSize:]
|
|
_ = msg.marshal(packet)
|
|
peer.cookieGenerator.AddMacs(packet)
|
|
|
|
peer.timersAnyAuthenticatedPacketTraversal()
|
|
peer.timersAnyAuthenticatedPacketSent()
|
|
|
|
err = peer.SendBuffers([][]byte{buf})
|
|
if err != nil {
|
|
peer.device.log.Errorf("%v - Failed to send handshake initiation: %v", peer, err)
|
|
}
|
|
peer.timersHandshakeInitiated()
|
|
|
|
return err
|
|
}
|
|
|
|
func (peer *Peer) SendHandshakeResponse() error {
|
|
peer.handshake.mutex.Lock()
|
|
peer.handshake.lastSentHandshake = time.Now()
|
|
peer.handshake.mutex.Unlock()
|
|
|
|
peer.device.log.Verbosef("%v - Sending handshake response", peer)
|
|
|
|
response, err := peer.device.CreateMessageResponse(peer)
|
|
if err != nil {
|
|
peer.device.log.Errorf("%v - Failed to create response message: %v", peer, err)
|
|
return err
|
|
}
|
|
|
|
buf := make([]byte, MessageEncapsulatingTransportSize+MessageResponseSize)
|
|
packet := buf[MessageEncapsulatingTransportSize:]
|
|
_ = response.marshal(packet)
|
|
peer.cookieGenerator.AddMacs(packet)
|
|
|
|
err = peer.BeginSymmetricSession()
|
|
if err != nil {
|
|
peer.device.log.Errorf("%v - Failed to derive keypair: %v", peer, err)
|
|
return err
|
|
}
|
|
|
|
peer.timersSessionDerived()
|
|
peer.timersAnyAuthenticatedPacketTraversal()
|
|
peer.timersAnyAuthenticatedPacketSent()
|
|
|
|
// TODO: allocation could be avoided
|
|
err = peer.SendBuffers([][]byte{buf})
|
|
if err != nil {
|
|
peer.device.log.Errorf("%v - Failed to send handshake response: %v", peer, err)
|
|
}
|
|
return err
|
|
}
|
|
|
|
func (device *Device) SendHandshakeCookie(initiatingElem *QueueHandshakeElement) error {
|
|
device.log.Verbosef("Sending cookie response for denied handshake message for %v", initiatingElem.endpoint.DstToString())
|
|
|
|
sender := binary.LittleEndian.Uint32(initiatingElem.packet[4:8])
|
|
reply, err := device.cookieChecker.CreateReply(initiatingElem.packet, sender, initiatingElem.endpoint.DstToBytes())
|
|
if err != nil {
|
|
device.log.Errorf("Failed to create cookie reply: %v", err)
|
|
return err
|
|
}
|
|
|
|
buf := make([]byte, MessageEncapsulatingTransportSize+MessageCookieReplySize)
|
|
packet := buf[MessageEncapsulatingTransportSize:]
|
|
_ = reply.marshal(packet)
|
|
// TODO: allocation could be avoided
|
|
device.net.bind.Send([][]byte{buf}, initiatingElem.endpoint, MessageEncapsulatingTransportSize)
|
|
|
|
return nil
|
|
}
|
|
|
|
func (peer *Peer) keepKeyFreshSending() {
|
|
keypair := peer.keypairs.Current()
|
|
if keypair == nil {
|
|
return
|
|
}
|
|
nonce := keypair.sendNonce.Load()
|
|
if nonce > RekeyAfterMessages || (keypair.isInitiator && time.Since(keypair.created) > RekeyAfterTime) {
|
|
peer.SendHandshakeInitiation(false)
|
|
}
|
|
}
|
|
|
|
func (device *Device) RoutineReadFromTUN() {
|
|
defer func() {
|
|
device.log.Verbosef("Routine: TUN reader - stopped")
|
|
device.state.stopping.Done()
|
|
device.queue.encryption.wg.Done()
|
|
}()
|
|
|
|
device.log.Verbosef("Routine: TUN reader - started")
|
|
|
|
var (
|
|
batchSize = device.BatchSize()
|
|
readErr error
|
|
elems = make([]*QueueOutboundElement, batchSize)
|
|
bufs = make([][]byte, batchSize)
|
|
elemsByPeer = make(map[*Peer]*QueueOutboundElementsContainer, batchSize)
|
|
count = 0
|
|
sizes = make([]int, batchSize)
|
|
offset = MessageEncapsulatingTransportSize + MessageTransportHeaderSize
|
|
)
|
|
|
|
for i := range elems {
|
|
elems[i] = device.NewOutboundElement()
|
|
bufs[i] = elems[i].buffer[:]
|
|
}
|
|
|
|
defer func() {
|
|
for _, elem := range elems {
|
|
if elem != nil {
|
|
device.PutOutboundBuffer(elem.buffer)
|
|
device.PutOutboundElement(elem)
|
|
}
|
|
}
|
|
}()
|
|
|
|
for {
|
|
// read packets
|
|
count, readErr = device.tun.device.Read(bufs, sizes, offset)
|
|
for i := 0; i < count; i++ {
|
|
if sizes[i] < 1 {
|
|
continue
|
|
}
|
|
|
|
elem := elems[i]
|
|
elem.packet = bufs[i][offset : offset+sizes[i]]
|
|
|
|
// lookup peer
|
|
var peer *Peer
|
|
switch elem.packet[0] >> 4 {
|
|
case 4:
|
|
if len(elem.packet) < ipv4.HeaderLen {
|
|
continue
|
|
}
|
|
src := netip.AddrFrom4([4]byte(elem.packet[IPv4offsetSrc : IPv4offsetSrc+net.IPv4len]))
|
|
dst := netip.AddrFrom4([4]byte(elem.packet[IPv4offsetDst : IPv4offsetDst+net.IPv4len]))
|
|
peer = device.allowedips.LookupFromPacket(src, dst, elem.packet)
|
|
|
|
case 6:
|
|
if len(elem.packet) < ipv6.HeaderLen {
|
|
continue
|
|
}
|
|
src := netip.AddrFrom16([16]byte(elem.packet[IPv6offsetSrc : IPv6offsetSrc+net.IPv6len]))
|
|
dst := netip.AddrFrom16([16]byte(elem.packet[IPv6offsetDst : IPv6offsetDst+net.IPv6len]))
|
|
peer = device.allowedips.LookupFromPacket(src, dst, elem.packet)
|
|
|
|
default:
|
|
device.log.Verbosef("Received packet with unknown IP version")
|
|
}
|
|
|
|
if peer == nil {
|
|
continue
|
|
}
|
|
elemsForPeer, ok := elemsByPeer[peer]
|
|
if !ok {
|
|
elemsForPeer = device.GetOutboundElementsContainer()
|
|
elemsByPeer[peer] = elemsForPeer
|
|
}
|
|
elemsForPeer.elems = append(elemsForPeer.elems, elem)
|
|
elems[i] = device.NewOutboundElement()
|
|
bufs[i] = elems[i].buffer[:]
|
|
}
|
|
|
|
for peer, elemsForPeer := range elemsByPeer {
|
|
if peer.isRunning.Load() {
|
|
peer.StagePackets(elemsForPeer)
|
|
peer.SendStagedPackets()
|
|
} else {
|
|
for _, elem := range elemsForPeer.elems {
|
|
device.PutOutboundBuffer(elem.buffer)
|
|
device.PutOutboundElement(elem)
|
|
}
|
|
device.PutOutboundElementsContainer(elemsForPeer)
|
|
}
|
|
delete(elemsByPeer, peer)
|
|
}
|
|
|
|
if readErr != nil {
|
|
if errors.Is(readErr, tun.ErrTooManySegments) {
|
|
// TODO: record stat for this
|
|
// This will happen if MSS is surprisingly small (< 576)
|
|
// coincident with reasonably high throughput.
|
|
device.log.Verbosef("Dropped some packets from multi-segment read: %v", readErr)
|
|
continue
|
|
}
|
|
if !device.isClosed() {
|
|
if !errors.Is(readErr, os.ErrClosed) {
|
|
device.log.Errorf("Failed to read packet from TUN device: %v", readErr)
|
|
}
|
|
go device.Close()
|
|
}
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
// maxQueuedInputPackets bounds the staged+outbound backlog of a peer fed via
|
|
// InputPacket/InputPackets. Injected packets beyond it are dropped before they
|
|
// are copied into pooled message buffers, like a full qdisc: injection has no
|
|
// flow control, and the queues are bounded in containers (up to a full batch
|
|
// each), so without this cap a flood is buffered instead of dropped.
|
|
const maxQueuedInputPackets = 2048
|
|
|
|
func (device *Device) InputPacket(destination []byte, packetSlices [][]byte) {
|
|
peer := device.allowedips.Lookup(destination)
|
|
if peer == nil {
|
|
return
|
|
}
|
|
if peer.queuedOutboundPackets.Load() >= maxQueuedInputPackets {
|
|
return
|
|
}
|
|
var totalLength int
|
|
for _, packetSlice := range packetSlices {
|
|
totalLength += len(packetSlice)
|
|
}
|
|
allocLength := MessageEncapsulatingTransportSize + MessageTransportHeaderSize + totalLength + PaddingMultiple + chacha20poly1305.Overhead
|
|
if allocLength > MaxMessageSize {
|
|
return
|
|
}
|
|
elem := device.GetOutboundElement()
|
|
elem.buffer = device.GetOutboundBuffer(allocLength)
|
|
elem.nonce = 0
|
|
packet := elem.buffer[MessageEncapsulatingTransportSize+MessageTransportHeaderSize:]
|
|
var n int
|
|
for _, packetSlice := range packetSlices {
|
|
n += copy(packet[n:], packetSlice)
|
|
}
|
|
elem.packet = packet[:n]
|
|
elemsForPeer := device.GetOutboundElementsContainer()
|
|
if peer.isRunning.Load() {
|
|
elemsForPeer.elems = append(elemsForPeer.elems, elem)
|
|
peer.StagePackets(elemsForPeer)
|
|
peer.SendStagedPackets()
|
|
} else {
|
|
device.PutOutboundBuffer(elem.buffer)
|
|
device.PutOutboundElement(elem)
|
|
device.PutOutboundElementsContainer(elemsForPeer)
|
|
}
|
|
}
|
|
|
|
type InputPacketRef struct {
|
|
Destination []byte
|
|
PacketSlices [][]byte
|
|
}
|
|
|
|
func (device *Device) InputPackets(packets []*InputPacketRef) []*InputPacketRef {
|
|
var unmatched []*InputPacketRef
|
|
elemsByPeer := make(map[*Peer][]*QueueOutboundElementsContainer, len(packets))
|
|
for _, packetRef := range packets {
|
|
peer := device.allowedips.Lookup(packetRef.Destination)
|
|
if peer == nil {
|
|
unmatched = append(unmatched, packetRef)
|
|
continue
|
|
}
|
|
if peer.queuedOutboundPackets.Load() >= maxQueuedInputPackets {
|
|
continue
|
|
}
|
|
var totalLength int
|
|
for _, packetSlice := range packetRef.PacketSlices {
|
|
totalLength += len(packetSlice)
|
|
}
|
|
allocLength := MessageEncapsulatingTransportSize + MessageTransportHeaderSize + totalLength + PaddingMultiple + chacha20poly1305.Overhead
|
|
if allocLength > MaxMessageSize {
|
|
continue
|
|
}
|
|
elem := device.GetOutboundElement()
|
|
elem.buffer = device.GetOutboundBuffer(allocLength)
|
|
elem.nonce = 0
|
|
packet := elem.buffer[MessageEncapsulatingTransportSize+MessageTransportHeaderSize:]
|
|
var n int
|
|
for _, packetSlice := range packetRef.PacketSlices {
|
|
n += copy(packet[n:], packetSlice)
|
|
}
|
|
elem.packet = packet[:n]
|
|
containers := elemsByPeer[peer]
|
|
if len(containers) == 0 || len(containers[len(containers)-1].elems) >= conn.IdealBatchSize {
|
|
containers = append(containers, device.GetOutboundElementsContainer())
|
|
elemsByPeer[peer] = containers
|
|
}
|
|
elemsForPeer := containers[len(containers)-1]
|
|
elemsForPeer.elems = append(elemsForPeer.elems, elem)
|
|
}
|
|
for peer, containers := range elemsByPeer {
|
|
if peer.isRunning.Load() {
|
|
for _, elemsForPeer := range containers {
|
|
peer.StagePackets(elemsForPeer)
|
|
}
|
|
peer.SendStagedPackets()
|
|
} else {
|
|
for _, elemsForPeer := range containers {
|
|
for _, elem := range elemsForPeer.elems {
|
|
device.PutOutboundBuffer(elem.buffer)
|
|
device.PutOutboundElement(elem)
|
|
}
|
|
device.PutOutboundElementsContainer(elemsForPeer)
|
|
}
|
|
}
|
|
}
|
|
return unmatched
|
|
}
|
|
|
|
func (peer *Peer) StagePackets(elems *QueueOutboundElementsContainer) {
|
|
peer.queuedOutboundPackets.Add(int32(len(elems.elems)))
|
|
for {
|
|
select {
|
|
case peer.queue.staged <- elems:
|
|
return
|
|
default:
|
|
}
|
|
select {
|
|
case tooOld := <-peer.queue.staged:
|
|
peer.queuedOutboundPackets.Add(-int32(len(tooOld.elems)))
|
|
for _, elem := range tooOld.elems {
|
|
peer.device.PutOutboundBuffer(elem.buffer)
|
|
peer.device.PutOutboundElement(elem)
|
|
}
|
|
peer.device.PutOutboundElementsContainer(tooOld)
|
|
default:
|
|
}
|
|
}
|
|
}
|
|
|
|
func (peer *Peer) SendStagedPackets() {
|
|
top:
|
|
if len(peer.queue.staged) == 0 || !peer.device.isUp() {
|
|
return
|
|
}
|
|
|
|
keypair := peer.keypairs.Current()
|
|
if keypair == nil || keypair.sendNonce.Load() >= RejectAfterMessages || time.Since(keypair.created) >= RejectAfterTime {
|
|
peer.SendHandshakeInitiation(false)
|
|
return
|
|
}
|
|
|
|
for {
|
|
var elemsContainerOOO *QueueOutboundElementsContainer
|
|
select {
|
|
case elemsContainer := <-peer.queue.staged:
|
|
i := 0
|
|
for _, elem := range elemsContainer.elems {
|
|
elem.peer = peer
|
|
elem.nonce = keypair.sendNonce.Add(1) - 1
|
|
if elem.nonce >= RejectAfterMessages {
|
|
keypair.sendNonce.Store(RejectAfterMessages)
|
|
if elemsContainerOOO == nil {
|
|
elemsContainerOOO = peer.device.GetOutboundElementsContainer()
|
|
}
|
|
elemsContainerOOO.elems = append(elemsContainerOOO.elems, elem)
|
|
continue
|
|
} else {
|
|
elemsContainer.elems[i] = elem
|
|
i++
|
|
}
|
|
|
|
elem.keypair = keypair
|
|
}
|
|
elemsContainer.elems = elemsContainer.elems[:i]
|
|
|
|
if elemsContainerOOO != nil {
|
|
// Already counted at their original staging; StagePackets will count them again.
|
|
peer.queuedOutboundPackets.Add(-int32(len(elemsContainerOOO.elems)))
|
|
peer.StagePackets(elemsContainerOOO) // XXX: Out of order, but we can't front-load go chans
|
|
}
|
|
|
|
if len(elemsContainer.elems) == 0 {
|
|
peer.device.PutOutboundElementsContainer(elemsContainer)
|
|
goto top
|
|
}
|
|
|
|
// add to parallel and sequential queue
|
|
if peer.isRunning.Load() {
|
|
elemsContainer.filling.Add(1)
|
|
peer.queue.outbound.c <- elemsContainer
|
|
peer.device.queue.encryption.c <- elemsContainer
|
|
} else {
|
|
peer.queuedOutboundPackets.Add(-int32(len(elemsContainer.elems)))
|
|
for _, elem := range elemsContainer.elems {
|
|
peer.device.PutOutboundBuffer(elem.buffer)
|
|
peer.device.PutOutboundElement(elem)
|
|
}
|
|
peer.device.PutOutboundElementsContainer(elemsContainer)
|
|
}
|
|
|
|
if elemsContainerOOO != nil {
|
|
goto top
|
|
}
|
|
default:
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
func (peer *Peer) FlushStagedPackets() {
|
|
for {
|
|
select {
|
|
case elemsContainer := <-peer.queue.staged:
|
|
peer.queuedOutboundPackets.Add(-int32(len(elemsContainer.elems)))
|
|
for _, elem := range elemsContainer.elems {
|
|
peer.device.PutOutboundBuffer(elem.buffer)
|
|
peer.device.PutOutboundElement(elem)
|
|
}
|
|
peer.device.PutOutboundElementsContainer(elemsContainer)
|
|
default:
|
|
return
|
|
}
|
|
}
|
|
}
|
|
|
|
func calculatePaddingSize(packetSize, mtu int) int {
|
|
lastUnit := packetSize
|
|
if mtu == 0 {
|
|
return ((lastUnit + PaddingMultiple - 1) & ^(PaddingMultiple - 1)) - lastUnit
|
|
}
|
|
if lastUnit > mtu {
|
|
lastUnit %= mtu
|
|
}
|
|
paddedSize := ((lastUnit + PaddingMultiple - 1) & ^(PaddingMultiple - 1))
|
|
if paddedSize > mtu {
|
|
paddedSize = mtu
|
|
}
|
|
return paddedSize - lastUnit
|
|
}
|
|
|
|
/* Encrypts the elements in the queue
|
|
* and marks them for sequential consumption (by releasing the mutex)
|
|
*
|
|
* Obs. One instance per core
|
|
*/
|
|
func (device *Device) RoutineEncryption(id int) {
|
|
var paddingZeros [PaddingMultiple]byte
|
|
var nonce [chacha20poly1305.NonceSize]byte
|
|
|
|
defer device.log.Verbosef("Routine: encryption worker %d - stopped", id)
|
|
device.log.Verbosef("Routine: encryption worker %d - started", id)
|
|
|
|
for elemsContainer := range device.queue.encryption.c {
|
|
for _, elem := range elemsContainer.elems {
|
|
// populate header fields
|
|
header := elem.buffer[MessageEncapsulatingTransportSize : MessageEncapsulatingTransportSize+MessageTransportHeaderSize]
|
|
|
|
fieldType := header[0:4]
|
|
fieldReceiver := header[4:8]
|
|
fieldNonce := header[8:16]
|
|
|
|
binary.LittleEndian.PutUint32(fieldType, MessageTransportType)
|
|
binary.LittleEndian.PutUint32(fieldReceiver, elem.keypair.remoteIndex)
|
|
binary.LittleEndian.PutUint64(fieldNonce, elem.nonce)
|
|
|
|
// pad content to multiple of 16
|
|
paddingSize := calculatePaddingSize(len(elem.packet), int(device.tun.mtu.Load()))
|
|
elem.packet = append(elem.packet, paddingZeros[:paddingSize]...)
|
|
|
|
// encrypt content and release to consumer
|
|
|
|
binary.LittleEndian.PutUint64(nonce[4:], elem.nonce)
|
|
elem.packet = elem.keypair.send.Seal(
|
|
header,
|
|
nonce[:],
|
|
elem.packet,
|
|
nil,
|
|
)
|
|
|
|
// re-slice packet to include encapsulating transport space
|
|
elem.packet = elem.buffer[:MessageEncapsulatingTransportSize+len(elem.packet)]
|
|
}
|
|
elemsContainer.filling.Done()
|
|
}
|
|
}
|
|
|
|
func (peer *Peer) RoutineSequentialSender(maxBatchSize int) {
|
|
device := peer.device
|
|
defer func() {
|
|
defer device.log.Verbosef("%v - Routine: sequential sender - stopped", peer)
|
|
peer.stopping.Done()
|
|
}()
|
|
device.log.Verbosef("%v - Routine: sequential sender - started", peer)
|
|
|
|
bufs := make([][]byte, 0, maxBatchSize)
|
|
|
|
for elemsContainer := range peer.queue.outbound.c {
|
|
if elemsContainer == nil {
|
|
return
|
|
}
|
|
peer.processOutboundContainer(elemsContainer, bufs[:0])
|
|
}
|
|
}
|
|
|
|
// processOutboundContainer waits for the encryption routine to finish
|
|
// filling elemsContainer, then sends the batch (or drops it, if the peer
|
|
// has been stopped) and returns the container to the pool.
|
|
//
|
|
// scratch is a length-0 slice used to assemble the per-packet buffers
|
|
// passed to SendBuffers; its backing array is reused across calls.
|
|
func (peer *Peer) processOutboundContainer(elemsContainer *QueueOutboundElementsContainer, scratch [][]byte) {
|
|
// Invariants from RoutineSequentialSender; all should be unreachable.
|
|
if len(scratch) != 0 || cap(scratch) == 0 {
|
|
panic(fmt.Sprintf("processOutboundContainer: scratch must be empty with non-zero cap; got len=%d cap=%d",
|
|
len(scratch), cap(scratch)))
|
|
}
|
|
if cap(scratch) < len(elemsContainer.elems) {
|
|
panic(fmt.Sprintf("processOutboundContainer: scratch cap %d < elems %d",
|
|
cap(scratch), len(elemsContainer.elems)))
|
|
}
|
|
|
|
device := peer.device
|
|
defer device.PutOutboundElementsContainer(elemsContainer)
|
|
|
|
// Wait for RoutineEncryption to finish filling the container. After
|
|
// Wait returns we have happens-before with that goroutine and are the
|
|
// sole owner of the container until Put hands it back to the pool.
|
|
elemsContainer.filling.Wait()
|
|
|
|
if !peer.isRunning.Load() {
|
|
// peer has been stopped; return re-usable elems to the shared pool.
|
|
// This is an optimization only. It is possible for the peer to be stopped
|
|
// immediately after this check, in which case, elem will get processed.
|
|
// The timers and SendBuffers code are resilient to a few stragglers.
|
|
// TODO: rework peer shutdown order to ensure
|
|
// that we never accidentally keep timers alive longer than necessary.
|
|
peer.queuedOutboundPackets.Add(-int32(len(elemsContainer.elems)))
|
|
for _, elem := range elemsContainer.elems {
|
|
device.PutOutboundBuffer(elem.buffer)
|
|
device.PutOutboundElement(elem)
|
|
}
|
|
return
|
|
}
|
|
|
|
dataSent := false
|
|
for _, elem := range elemsContainer.elems {
|
|
if len(elem.packet[MessageEncapsulatingTransportSize:]) != MessageKeepaliveSize {
|
|
dataSent = true
|
|
}
|
|
scratch = append(scratch, elem.packet)
|
|
}
|
|
|
|
peer.timersAnyAuthenticatedPacketTraversal()
|
|
peer.timersAnyAuthenticatedPacketSent()
|
|
|
|
err := peer.SendBuffers(scratch)
|
|
if dataSent {
|
|
peer.timersDataSent()
|
|
}
|
|
peer.queuedOutboundPackets.Add(-int32(len(elemsContainer.elems)))
|
|
for _, elem := range elemsContainer.elems {
|
|
device.PutOutboundBuffer(elem.buffer)
|
|
device.PutOutboundElement(elem)
|
|
}
|
|
if err != nil {
|
|
var errGSO conn.ErrUDPGSODisabled
|
|
if errors.As(err, &errGSO) {
|
|
device.log.Verbosef(err.Error())
|
|
err = errGSO.RetryErr
|
|
}
|
|
}
|
|
if err != nil {
|
|
device.log.Errorf("%v - Failed to send data packets: %v", peer, err)
|
|
return
|
|
}
|
|
|
|
peer.keepKeyFreshSending()
|
|
}
|