Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

transport

package

Go to main page

Versions in this module

v0

v0.5.0

Feb 26, 2024

v0.4.2

Feb 26, 2024

v0.4.1

Feb 26, 2024

v0.4.0

Feb 26, 2024

Changes in this version

+ const NoiseLabelCookie

+ const NoiseLabelMAC1

v0.3.0

Feb 25, 2024

Changes in this version

+ const CookieRefreshTime

+ const DefaultMTU

+ const HandshakeInitationRate

+ const KeepaliveTimeout

+ const MaxContentSize

+ const MaxMessageSize

+ const MaxPeers

+ const MaxSegmentSize

+ const MaxTimerHandshakes

+ const MessageCookieReplySize

+ const MessageCookieReplyType

+ const MessageHandshakeSize

+ const MessageInitiationSize

+ const MessageInitiationType

+ const MessageKeepaliveSize

+ const MessageResponseSize

+ const MessageResponseType

+ const MessageTransportHeaderSize

+ const MessageTransportOffsetContent

+ const MessageTransportOffsetCounter

+ const MessageTransportOffsetReceiver

+ const MessageTransportSize

+ const MessageTransportType

+ const MinMessageSize

+ const NoiseConstruction

+ const NoiseIdentifier

+ const NoisePresharedKeySize

+ const NoisePrivateKeySize

+ const NoisePublicKeySize

+ const PaddingMultiple

+ const PreallocatedBuffersPerPool

+ const QueueHandshakeSize

+ const QueueInboundSize

+ const QueueOutboundSize

+ const QueueStagedSize

+ const RejectAfterMessages

+ const RejectAfterTime

+ const RekeyAfterMessages

+ const RekeyAfterTime

+ const RekeyAttemptTime

+ const RekeyTimeout

+ const RekeyTimeoutJitterMaxMs

+ const UnderLoadAfterTime

+ const WGLabelCookie

+ const WGLabelMAC1

+ var InitialChainKey [blake2s.Size]byte

+ var InitialHash [blake2s.Size]byte

+ var ZeroNonce [chacha20poly1305.NonceSize]byte

+ func HMAC1(sum *[blake2s.Size]byte, key, in0 []byte)

+ func HMAC2(sum *[blake2s.Size]byte, key, in0, in1 []byte)

+ func KDF1(t0 *[blake2s.Size]byte, key, input []byte)

+ func KDF2(t0, t1 *[blake2s.Size]byte, key, input []byte)

+ func KDF3(t0, t1, t2 *[blake2s.Size]byte, key, input []byte)

+ type CookieChecker struct

+ func (st *CookieChecker) CheckMAC1(msg []byte) bool

+ func (st *CookieChecker) CheckMAC2(msg, src []byte) bool

+ func (st *CookieChecker) CreateReply(msg []byte, recv uint32, src []byte) (*MessageCookieReply, error)

+ func (st *CookieChecker) Init(pk NoisePublicKey)

+ type CookieGenerator struct

+ func (st *CookieGenerator) AddMacs(msg []byte)

+ func (st *CookieGenerator) ConsumeReply(msg *MessageCookieReply) bool

+ func (st *CookieGenerator) Init(pk NoisePublicKey)

+ type Handshake struct

+ func (h *Handshake) Clear()

+ type IndexTable struct

+ func (table *IndexTable) Delete(index uint32)

+ func (table *IndexTable) Init()

+ func (table *IndexTable) Lookup(id uint32) IndexTableEntry

+ func (table *IndexTable) NewIndexForHandshake(peer *Peer, handshake *Handshake) (uint32, error)

+ func (table *IndexTable) SwapIndexForKeypair(index uint32, keypair *Keypair)

+ type IndexTableEntry struct

+ type Keypair struct

+ type Keypairs struct

+ func (kp *Keypairs) Current() *Keypair

+ type MessageCookieReply struct

+ Cookie [blake2s.Size128 + poly1305.TagSize]byte

+ Nonce [chacha20poly1305.NonceSizeX]byte

+ Receiver uint32

+ Type uint32

+ type MessageInitiation struct

+ Ephemeral NoisePublicKey

+ MAC1 [blake2s.Size128]byte

+ MAC2 [blake2s.Size128]byte

+ Sender uint32

+ Static [NoisePublicKeySize + poly1305.TagSize]byte

+ Timestamp [tai64n.TimestampSize + poly1305.TagSize]byte

+ Type uint32

+ type MessageResponse struct

+ Empty [poly1305.TagSize]byte

+ Ephemeral NoisePublicKey

+ MAC1 [blake2s.Size128]byte

+ MAC2 [blake2s.Size128]byte

+ Receiver uint32

+ Sender uint32

+ Type uint32

+ type MessageTransport struct

+ Content []byte

+ Counter uint64

+ Receiver uint32

+ Type uint32

+ type NoiseNonce uint64

+ type NoisePresharedKey [NoisePresharedKeySize]byte

+ type NoisePrivateKey [NoisePrivateKeySize]byte

+ func NewPrivateKey() (sk NoisePrivateKey, err error)

+ func (key *NoisePrivateKey) FromString(src string) error

+ func (key NoisePrivateKey) Equals(tar NoisePrivateKey) bool

+ func (key NoisePrivateKey) IsZero() bool

+ func (key NoisePrivateKey) String() string

+ func (sk *NoisePrivateKey) PublicKey() (pk NoisePublicKey)

+ type NoisePublicKey [NoisePublicKeySize]byte

+ func (key *NoisePublicKey) FromString(src string) error

+ func (key NoisePublicKey) Equals(tar NoisePublicKey) bool

+ func (key NoisePublicKey) IsZero() bool

+ func (key NoisePublicKey) String() string

+ type Peer struct

+ func (peer *Peer) BeginSymmetricSession() error

+ func (peer *Peer) ExpireCurrentKeypairs()

+ func (peer *Peer) FlushStagedPackets()

+ func (peer *Peer) NewTimer(expirationFunction func(*Peer)) *Timer

+ func (peer *Peer) ReceivedWithKeypair(receivedKeypair *Keypair) bool

+ func (peer *Peer) RoutineSequentialReceiver(maxBatchSize int)

+ func (peer *Peer) RoutineSequentialSender(maxBatchSize int)

+ func (peer *Peer) SendBuffers(buffers [][]byte) error

+ func (peer *Peer) SendHandshakeInitiation(isRetry bool) error

+ func (peer *Peer) SendHandshakeResponse() error

+ func (peer *Peer) SendKeepalive() error

+ func (peer *Peer) SendStagedPackets() error

+ func (peer *Peer) SetEndpointFromPacket(endpoint conn.Endpoint)

+ func (peer *Peer) SetPresharedKey(psk NoisePresharedKey)

+ func (peer *Peer) StagePackets(elems *QueueOutboundElementsContainer)

+ func (peer *Peer) Start()

+ func (peer *Peer) Stop()

+ func (peer *Peer) String() string

+ func (peer *Peer) ZeroAndFlushAll()

+ type QueueHandshakeElement struct

+ type QueueInboundElement struct

+ type QueueInboundElementsContainer struct

+ type QueueOutboundElement struct

+ type QueueOutboundElementsContainer struct

+ type SourceSink interface

+ BatchSize func() int

+ Read func(bufs [][]byte, sizes []int, destinations []NoisePublicKey, offset int) (int, error)

+ Write func(bufs [][]byte, sources []NoisePublicKey, offset int) (int, error)

+ type Timer struct

+ func (timer *Timer) Del()

+ func (timer *Timer) DelSync()

+ func (timer *Timer) IsPending() bool

+ func (timer *Timer) Mod(d time.Duration)

+ type Transport struct

+ func NewTransport(sourceSink SourceSink, bind conn.Bind, logger *slog.Logger) *Transport

+ func (transport *Transport) BatchSize() int

+ func (transport *Transport) Bind() conn.Bind

+ func (transport *Transport) BindClose() error

+ func (transport *Transport) BindUpdate() error

+ func (transport *Transport) Close() error

+ func (transport *Transport) ConsumeMessageInitiation(msg *MessageInitiation) *Peer

+ func (transport *Transport) ConsumeMessageResponse(msg *MessageResponse) *Peer

+ func (transport *Transport) CreateMessageInitiation(peer *Peer) (*MessageInitiation, error)

+ func (transport *Transport) CreateMessageResponse(peer *Peer) (*MessageResponse, error)

+ func (transport *Transport) DeleteKeypair(key *Keypair)

+ func (transport *Transport) Down() error

+ func (transport *Transport) GetInboundElement() *QueueInboundElement

+ func (transport *Transport) GetInboundElementsContainer() *QueueInboundElementsContainer

+ func (transport *Transport) GetMessageBuffer() *[MaxMessageSize]byte

+ func (transport *Transport) GetOutboundElement() *QueueOutboundElement

+ func (transport *Transport) GetOutboundElementsContainer() *QueueOutboundElementsContainer

+ func (transport *Transport) IsUnderLoad() bool

+ func (transport *Transport) LookupPeer(pk NoisePublicKey) *Peer

+ func (transport *Transport) NewOutboundElement() *QueueOutboundElement

+ func (transport *Transport) NewPeer(pk NoisePublicKey) (*Peer, error)

+ func (transport *Transport) PopulatePools()

+ func (transport *Transport) PutInboundElement(elem *QueueInboundElement)

+ func (transport *Transport) PutInboundElementsContainer(c *QueueInboundElementsContainer)

+ func (transport *Transport) PutMessageBuffer(msg *[MaxMessageSize]byte)

+ func (transport *Transport) PutOutboundElement(elem *QueueOutboundElement)

+ func (transport *Transport) PutOutboundElementsContainer(c *QueueOutboundElementsContainer)

+ func (transport *Transport) RemoveAllPeers()

+ func (transport *Transport) RemovePeer(key NoisePublicKey)

+ func (transport *Transport) RoutineDecryption(id int)

+ func (transport *Transport) RoutineEncryption(id int)

+ func (transport *Transport) RoutineHandshake(id int)

+ func (transport *Transport) RoutineReadFromSourceSink()

+ func (transport *Transport) RoutineReceiveIncoming(maxBatchSize int, recv conn.ReceiveFunc)

+ func (transport *Transport) SendHandshakeCookie(initiatingElem *QueueHandshakeElement) error

+ func (transport *Transport) SendKeepalivesToPeersWithCurrentKeypair()

+ func (transport *Transport) SetPrivateKey(sk NoisePrivateKey)

+ func (transport *Transport) Up() error

+ func (transport *Transport) UpdatePort(port uint16) error

+ func (transport *Transport) Wait() chan struct{}

+ type WaitPool struct

+ func NewWaitPool(max uint32, new func() any) *WaitPool

+ func (p *WaitPool) Get() any

+ func (p *WaitPool) Put(x any)