-
Notifications
You must be signed in to change notification settings - Fork 2
/
transport.go
583 lines (490 loc) · 16 KB
/
transport.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
// SPDX-License-Identifier: MPL-2.0
/*
* Copyright (C) 2024 The Noisy Sockets Authors.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* Portions of this file are based on code originally from wireguard-go,
*
* Copyright (C) 2017-2023 WireGuard LLC. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is furnished to do
* so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package transport
import (
"context"
"fmt"
"log/slog"
"net/netip"
"runtime"
"sync"
"sync/atomic"
"time"
"github.com/noisysockets/netutil/triemap"
"github.com/noisysockets/netutil/waitpool"
"github.com/noisysockets/network"
"github.com/noisysockets/noisysockets/internal/conn"
"github.com/noisysockets/noisysockets/internal/ratelimiter"
"github.com/noisysockets/noisysockets/types"
)
type Transport struct {
ctx context.Context
cancel context.CancelFunc
logger *slog.Logger
state struct {
// state holds the transport's state. It is accessed atomically.
// Use the transport.transportState method to read it.
// transport.transportState does not acquire the mutex, so it captures only a snapshot.
// During state transitions, the state variable is updated before the transport itself.
// The state is thus either the current state of the transport or
// the intended future state of the transport.
// For example, while executing a call to Up, state will be transportStateUp.
// There is no guarantee that that intended future state of the transport
// will become the actual state; Up can fail.
// The transport can also change state multiple times between time of check and time of use.
// Unsynchronized uses of state must therefore be advisory/best-effort only.
state atomic.Uint32 // actually a transportState, but typed uint32 for convenience
// stopping blocks until all inputs to Transport have been closed.
stopping sync.WaitGroup
// mu protects state changes.
sync.Mutex
}
net struct {
stopping sync.WaitGroup
sync.RWMutex
bind conn.Bind // bind interface
port uint16 // listening port
}
staticIdentity struct {
sync.RWMutex
privateKey types.NoisePrivateKey
publicKey types.NoisePublicKey
}
peers struct {
sync.RWMutex // protects keyMap
keyMap map[types.NoisePublicKey]*Peer
}
rate struct {
underLoadUntil atomic.Int64
limiter ratelimiter.Ratelimiter
}
allowedips *triemap.TrieMap[*Peer]
indexTable IndexTable
cookieChecker CookieChecker
pool struct {
packets *network.PacketPool
inboundElementsContainer *waitpool.WaitPool[*QueueInboundElementsContainer]
outboundElementsContainer *waitpool.WaitPool[*QueueOutboundElementsContainer]
inboundElements *waitpool.WaitPool[*QueueInboundElement]
outboundElements *waitpool.WaitPool[*QueueOutboundElement]
}
queue struct {
encryption *outboundQueue
decryption *inboundQueue
handshake *handshakeQueue
}
nic struct {
nic network.Interface
mtu atomic.Int32
}
closed chan struct{}
}
// transportState represents the state of a Transport.
// There are three states: down, up, closed.
// Transitions:
//
// down -----+
// ↑↓ ↓
// up -> closed
type transportState uint32
const (
transportStateDown transportState = iota
transportStateUp
transportStateClosed
)
func (state transportState) String() string {
switch state {
case transportStateDown:
return "down"
case transportStateUp:
return "up"
case transportStateClosed:
return "closed"
default:
return "unknown"
}
}
// transportState returns transport.state.state as a transportState
// See those docs for how to interpret this value.
func (transport *Transport) transportState() transportState {
return transportState(transport.state.state.Load())
}
// isClosed reports whether the transport is closed (or is closing).
// See transport.state.state comments for how to interpret this value.
func (transport *Transport) isClosed() bool {
return transport.transportState() == transportStateClosed
}
// isUp reports whether the transport is up (or is attempting to come up).
// See transport.state.state comments for how to interpret this value.
func (transport *Transport) isUp() bool {
return transport.transportState() == transportStateUp
}
// Must hold transport.peers.Lock()
func removePeerLocked(transport *Transport, peer *Peer, key types.NoisePublicKey) {
// stop routing and processing of packets
transport.allowedips.RemoveValue(peer)
peer.Stop()
// remove from peer map
delete(transport.peers.keyMap, key)
}
// changeState attempts to change the transport state to match want.
func (transport *Transport) changeState(want transportState) (err error) {
transport.state.Lock()
defer transport.state.Unlock()
old := transport.transportState()
if old == transportStateClosed {
// once closed, always closed
transport.logger.Debug("Interface closed, ignored requested state", slog.String("want", want.String()))
return nil
}
switch want {
case old:
return nil
case transportStateUp:
transport.state.state.Store(uint32(transportStateUp))
err = transport.upLocked()
if err == nil {
break
}
fallthrough // up failed; bring the transport all the way back down
case transportStateDown:
transport.state.state.Store(uint32(transportStateDown))
errDown := transport.downLocked()
if err == nil {
err = errDown
}
}
transport.logger.Debug("Interface state change requested",
slog.String("old", old.String()), slog.String("want", want.String()),
slog.String("now", transport.transportState().String()))
return
}
// upLocked attempts to bring the transport up and reports whether it succeeded.
// The caller must hold transport.state.mu and is responsible for updating transport.state.state.
func (transport *Transport) upLocked() error {
if err := transport.BindUpdate(); err != nil {
transport.logger.Error("Unable to update bind", slog.Any("error", err))
return err
}
transport.peers.RLock()
for _, peer := range transport.peers.keyMap {
peer.Start()
if peer.keepAliveInterval.Load() > 0 {
if err := peer.SendKeepalive(); err != nil {
transport.logger.Error("Failed to send keepalive",
slog.String("peer", peer.String()), slog.Any("error", err))
}
}
}
transport.peers.RUnlock()
return nil
}
// downLocked attempts to bring the transport down.
// The caller must hold transport.state.mu and is responsible for updating transport.state.state.
func (transport *Transport) downLocked() error {
err := transport.BindClose()
if err != nil {
transport.logger.Error("Bind close failed", slog.Any("error", err))
}
transport.peers.RLock()
for _, peer := range transport.peers.keyMap {
peer.Stop()
}
transport.peers.RUnlock()
return err
}
func (transport *Transport) Up() error {
return transport.changeState(transportStateUp)
}
func (transport *Transport) Down() error {
return transport.changeState(transportStateDown)
}
func (transport *Transport) IsUnderLoad() bool {
// check if currently under load
now := time.Now()
underLoad := len(transport.queue.handshake.c) >= QueueHandshakeSize/8
if underLoad {
transport.rate.underLoadUntil.Store(now.Add(UnderLoadAfterTime).UnixNano())
return true
}
// check if recently under load
return transport.rate.underLoadUntil.Load() > now.UnixNano()
}
func (transport *Transport) SetPrivateKey(sk types.NoisePrivateKey) {
// lock required resources
transport.staticIdentity.Lock()
defer transport.staticIdentity.Unlock()
if sk.Equals(transport.staticIdentity.privateKey) {
return
}
transport.peers.Lock()
defer transport.peers.Unlock()
lockedPeers := make([]*Peer, 0, len(transport.peers.keyMap))
for _, peer := range transport.peers.keyMap {
peer.handshake.mutex.RLock()
lockedPeers = append(lockedPeers, peer)
}
// remove peers with matching public keys
publicKey := sk.Public()
for key, peer := range transport.peers.keyMap {
if peer.handshake.remoteStatic.Equals(publicKey) {
peer.handshake.mutex.RUnlock()
removePeerLocked(transport, peer, key)
peer.handshake.mutex.RLock()
}
}
// update key material
transport.staticIdentity.privateKey = sk
transport.staticIdentity.publicKey = publicKey
transport.cookieChecker.Init(publicKey)
// do static-static DH pre-computations
expiredPeers := make([]*Peer, 0, len(transport.peers.keyMap))
for _, peer := range transport.peers.keyMap {
handshake := &peer.handshake
handshake.precomputedStaticStatic, _ = sharedSecret(transport.staticIdentity.privateKey, handshake.remoteStatic)
expiredPeers = append(expiredPeers, peer)
}
for _, peer := range lockedPeers {
peer.handshake.mutex.RUnlock()
}
for _, peer := range expiredPeers {
peer.ExpireCurrentKeypairs()
}
}
func NewTransport(ctx context.Context, logger *slog.Logger, nic network.Interface, bind conn.Bind, packetPool *network.PacketPool) (*Transport, error) {
ctx, cancel := context.WithCancel(ctx)
t := &Transport{
ctx: ctx,
cancel: cancel,
logger: logger,
closed: make(chan struct{}),
}
t.state.state.Store(uint32(transportStateDown))
t.net.bind = bind
t.peers.keyMap = make(map[types.NoisePublicKey]*Peer)
t.allowedips = triemap.New[*Peer]()
t.rate.limiter.Init()
t.indexTable.Init()
mtu, err := nic.MTU()
if err != nil {
return nil, fmt.Errorf("failed to get MTU: %w", err)
}
t.nic.nic = nic
t.nic.mtu.Store(int32(mtu))
// Create pools
t.pool.packets = packetPool
t.PopulatePools()
// create queues
t.queue.handshake = newHandshakeQueue()
t.queue.encryption = newOutboundQueue()
t.queue.decryption = newInboundQueue()
// start workers
cpus := runtime.NumCPU()
t.state.stopping.Wait()
t.queue.encryption.wg.Add(cpus) // One for each RoutineHandshake
for i := 0; i < cpus; i++ {
go t.RoutineEncryption(i + 1)
go t.RoutineDecryption(i + 1)
go t.RoutineHandshake(i + 1)
}
t.state.stopping.Add(1)
t.queue.encryption.wg.Add(1)
go t.RoutineReadFromNIC()
return t, nil
}
// BatchSize returns the BatchSize for the transport as a whole which is the max of
// the bind batch size and the sink batch size. The batch size reported by transport
// is the size used to construct memory pools, and is the allowed batch size for
// the lifetime of the transport.
func (transport *Transport) BatchSize() int {
size := transport.net.bind.BatchSize()
dSize := transport.nic.nic.BatchSize()
if size < dSize {
size = dSize
}
return size
}
func (transport *Transport) Peers() []types.NoisePublicKey {
transport.peers.RLock()
defer transport.peers.RUnlock()
keys := make([]types.NoisePublicKey, 0, len(transport.peers.keyMap))
for key := range transport.peers.keyMap {
keys = append(keys, key)
}
return keys
}
func (transport *Transport) LookupPeer(pk types.NoisePublicKey) *Peer {
transport.peers.RLock()
defer transport.peers.RUnlock()
return transport.peers.keyMap[pk]
}
// LookupPeerByAddress returns the peer associated with the given address.
func (transport *Transport) LookupPeerByAddress(addr netip.Addr) *Peer {
transport.peers.RLock()
defer transport.peers.RUnlock()
peer, _ := transport.allowedips.Get(addr)
return peer
}
func (transport *Transport) RemovePeer(pk types.NoisePublicKey) {
transport.peers.Lock()
defer transport.peers.Unlock()
// stop peer and remove from routing
peer, ok := transport.peers.keyMap[pk]
if ok {
removePeerLocked(transport, peer, pk)
}
}
func (transport *Transport) RemoveAllPeers() {
transport.peers.Lock()
defer transport.peers.Unlock()
for key, peer := range transport.peers.keyMap {
removePeerLocked(transport, peer, key)
}
transport.peers.keyMap = make(map[types.NoisePublicKey]*Peer)
}
func (transport *Transport) Close() error {
transport.state.Lock()
defer transport.state.Unlock()
if transport.isClosed() {
return nil
}
transport.state.state.Store(uint32(transportStateClosed))
transport.logger.Debug("Transport closing")
_ = transport.nic.nic.Close()
_ = transport.downLocked()
// Remove peers before closing queues,
// because peers assume that queues are active.
transport.RemoveAllPeers()
// We kept a reference to the encryption and decryption queues,
// in case we started any new peers that might write to them.
// No new peers are coming; we are done with these queues.
transport.queue.encryption.wg.Done()
transport.queue.decryption.wg.Done()
transport.queue.handshake.wg.Done()
transport.state.stopping.Wait()
if err := transport.rate.limiter.Close(); err != nil {
return fmt.Errorf("failed to close rate limiter: %w", err)
}
// Cancel the context to stop all workers.
transport.cancel()
transport.logger.Debug("Transport closed")
close(transport.closed)
return nil
}
func (transport *Transport) Wait() chan struct{} {
return transport.closed
}
func (transport *Transport) SendKeepalivesToPeersWithCurrentKeypair() {
if !transport.isUp() {
return
}
transport.peers.RLock()
for _, peer := range transport.peers.keyMap {
peer.keypairs.RLock()
sendKeepalive := peer.keypairs.current != nil && !peer.keypairs.current.created.Add(RejectAfterTime).Before(time.Now())
peer.keypairs.RUnlock()
if sendKeepalive {
if err := peer.SendKeepalive(); err != nil {
transport.logger.Error("Failed to send keepalive",
slog.String("peer", peer.String()), slog.Any("error", err))
}
}
}
transport.peers.RUnlock()
}
// closeBindLocked closes the transport's net.bind.
// The caller must hold the net mutex.
func closeBindLocked(transport *Transport) error {
var err error
netc := &transport.net
if netc.bind != nil {
err = netc.bind.Close()
}
netc.stopping.Wait()
return err
}
func (transport *Transport) Bind() conn.Bind {
transport.net.Lock()
defer transport.net.Unlock()
return transport.net.bind
}
func (transport *Transport) BindUpdate() error {
transport.net.Lock()
defer transport.net.Unlock()
// close existing sockets
if err := closeBindLocked(transport); err != nil {
return err
}
// open new sockets
if !transport.isUp() {
return nil
}
// bind to new port
var err error
var recvFns []conn.ReceiveFunc
netc := &transport.net
recvFns, netc.port, err = netc.bind.Open(netc.port)
if err != nil {
netc.port = 0
return err
}
// start receiving routines
transport.net.stopping.Add(len(recvFns))
transport.queue.decryption.wg.Add(len(recvFns)) // each RoutineReceiveIncoming goroutine writes to transport.queue.decryption
transport.queue.handshake.wg.Add(len(recvFns)) // each RoutineReceiveIncoming goroutine writes to transport.queue.handshake
batchSize := netc.bind.BatchSize()
for _, fn := range recvFns {
go transport.RoutineReceiveIncoming(batchSize, fn)
}
transport.logger.Debug("UDP bind has been updated")
return nil
}
func (transport *Transport) BindClose() error {
transport.net.Lock()
err := closeBindLocked(transport)
transport.net.Unlock()
return err
}
func (transport *Transport) UpdatePort(port uint16) error {
transport.net.Lock()
transport.net.port = port
transport.net.Unlock()
if err := transport.BindUpdate(); err != nil {
return fmt.Errorf("failed to update port: %w", err)
}
return nil
}
func (transport *Transport) GetPort() uint16 {
transport.net.RLock()
port := transport.net.port
transport.net.RUnlock()
return port
}