turn

Documentation

Overview

Package turn contains the STUN/TURN server.

Index

• func DecodeCampfireMessage(p []byte) (*v1.CampfireMessage, error)
• func EncodeCampfireMessage(msg *v1.CampfireMessage) ([]byte, error)
• func IsCampfireMessage(p []byte) bool
• func NewCampfireManager(pc net.PacketConn, log *slog.Logger) *campfireManager
• func ValidateCampfireMessage(msg *v1.CampfireMessage) error
• type CampfireAnswer
• type CampfireCandidate
• type CampfireClient
  • func NewCampfireClient(opts CampfireClientOptions) (*CampfireClient, error)
  • func (c *CampfireClient) Announce(ufrag, pwd string) error
  • func (c *CampfireClient) Answers() <-chan CampfireAnswer
  • func (c *CampfireClient) Candidates() <-chan CampfireCandidate
  • func (c *CampfireClient) Close() error
  • func (c *CampfireClient) Errors() <-chan error
  • func (c *CampfireClient) Offers() <-chan CampfireOffer
  • func (c *CampfireClient) SendAnswer(offerID, ufrag, pwd string, answer webrtc.SessionDescription) error
  • func (c *CampfireClient) SendCandidate(offerID, ufrag, pwd string, candidate *webrtc.ICECandidate) error
  • func (c *CampfireClient) SendOffer(ufrag, pwd string, offer webrtc.SessionDescription) error
• type CampfireClientOptions
• type CampfireOffer
• type Options
• type Server
  • func NewServer(o *Options) (*Server, error)
  • func (s *Server) Close() error
  • func (s *Server) ListenPort() int

Functions

func DecodeCampfireMessage

func DecodeCampfireMessage(p []byte) (*v1.CampfireMessage, error)

DecodeCampfireMessage decodes a campfire message.

func EncodeCampfireMessage

func EncodeCampfireMessage(msg *v1.CampfireMessage) ([]byte, error)

EncodeCampfireMessage encodes a campfire message.

func IsCampfireMessage

func IsCampfireMessage(p []byte) bool

IsCampfireMessage returns true if the given packet is a campfire message.

func NewCampfireManager

func NewCampfireManager(pc net.PacketConn, log *slog.Logger) *campfireManager

NewCampfireManager creates a new campfire manager.

func ValidateCampfireMessage

func ValidateCampfireMessage(msg *v1.CampfireMessage) error

ValidateCampfireMessage validates a campfire message.

Types

type CampfireAnswer

type CampfireAnswer struct {
	// ID contains the ID of the negotiation. This will always be the same as the client ID.
	ID string
	// Ufrag contains the username fragment of the peer that sent the answer.
	Ufrag string
	// Pwd contains the password of the peer that sent the answer.
	Pwd string
	// SDP contains the SDP of the answer.
	SDP webrtc.SessionDescription
}

CampfireAnswer represents an answer that was received from a peer.

type CampfireCandidate

type CampfireCandidate struct {
	// ID contains the ID of the peer that initiated the negotiation.
	ID string
	// Ufrag contains the username fragment of the peer that sent the candidate.
	Ufrag string
	// Pwd contains the password of the peer that sent the candidate.
	Pwd string
	// Cand contains the candidate.
	Cand webrtc.ICECandidateInit
}

CampfireCandidate represents a candidate that was received from a peer.

type CampfireClient

type CampfireClient struct {
	// contains filtered or unexported fields
}

CampfireClient represents a client that can communicate with a TURN server supporting campfire.

func NewCampfireClient

func NewCampfireClient(opts CampfireClientOptions) (*CampfireClient, error)

NewCampfireClient creates a new CampfireClient.

func (*CampfireClient) Announce

func (c *CampfireClient) Announce(ufrag, pwd string) error

Announce announces interest in offers containing the given ufrag and pwd.

func (*CampfireClient) Answers

func (c *CampfireClient) Answers() <-chan CampfireAnswer

Answers returns a channel of answers received from peers.

func (*CampfireClient) Candidates

func (c *CampfireClient) Candidates() <-chan CampfireCandidate

Candidates returns a channel of candidates received from peers.

func (*CampfireClient) Close

func (c *CampfireClient) Close() error

Close closes the client.

func (*CampfireClient) Errors

func (c *CampfireClient) Errors() <-chan error

Errors returns a channel of errors.

func (*CampfireClient) Offers

func (c *CampfireClient) Offers() <-chan CampfireOffer

Offers returns a channel of offers received from peers.

func (*CampfireClient) SendAnswer

func (c *CampfireClient) SendAnswer(offerID, ufrag, pwd string, answer webrtc.SessionDescription) error

SendAnswer sends an answer to the peer with the given ufrag and pwd.

func (*CampfireClient) SendCandidate

func (c *CampfireClient) SendCandidate(offerID, ufrag, pwd string, candidate *webrtc.ICECandidate) error

SendCandidate sends a candidate to the peer with the given ufrag and pwd. If offerID is empty, the local ID is used.

func (*CampfireClient) SendOffer

func (c *CampfireClient) SendOffer(ufrag, pwd string, offer webrtc.SessionDescription) error

SendOffer sends an offer to the peer with the given ufrag and pwd.

type CampfireClientOptions

type CampfireClientOptions struct {
	// ID is a unique identifier for the client. If left unset, a random ID will be
	// generated.
	ID string
	// Addr is the address of the STUN/TURN server.
	Addr string
	// Ufrag is the username fragment to use when communicating with the server.
	Ufrag string
	// Pwd is the password to use when communicating with the server.
	Pwd string
	// PSK is the pre-shared key used for encrypting/decrypting the data in sent/received
	// messages.
	PSK []byte
}

CampfireClientOptions represents options for a CampfireClient.

type CampfireOffer

type CampfireOffer struct {
	// ID contains the ID of the peer that sent the offer.
	ID string
	// Ufrag contains the username fragment of the peer that sent the offer.
	Ufrag string
	// Pwd contains the password of the peer that sent the offer.
	Pwd string
	// SDP contains the SDP of the offer.
	SDP webrtc.SessionDescription
}

CampfireOffer represents an offer that was received from a peer.

type Options

type Options struct {
	// PublicIP is the public IP address of the TURN server. This is used for relaying.
	PublicIP string
	// RelayAddressUDP is the binding address the TURN server uses for request handling and STUN relays.
	// Defaults to 0.0.0.0.
	RelayAddressUDP string
	// ListenUDP is the address the TURN server listens on for UDP requests.
	ListenUDP string
	// ListenTCP is the address the TURN server listens on for TCP requests.
	ListenTCP string
	// Realm is the realm used for authentication.
	Realm string
	// PortRange is the range of ports the TURN server will use for relaying.
	PortRange string
	// EnableCampfire enables relaying campfire packets.
	EnableCampfire bool
	// EnableCampfireWebsockets enables relaying campfire packets over websockets.
	// If ListenTCP is not set, ListenUDP will be used.
	EnableCampfireWebsockets bool
	// TLSCertFile is the path to the TLS certificate file when serving the TURN server over TLS.
	TLSCertFile string
	// TLSKeyFile is the path to the TLS key file when serving the TURN server over TLS.
	TLSKeyFile string
}

Options contains the options for the TURN server.

type Server

type Server struct {
	*turn.Server
	// contains filtered or unexported fields
}

Server is a TURN server.

func NewServer

func NewServer(o *Options) (*Server, error)

NewServer creates and starts a new TURN server.

func (*Server) Close

func (s *Server) Close() error

func (*Server) ListenPort

func (s *Server) ListenPort() int

ListenPort returns the UDP port the TURN server is listening on.