derptun

Documentation

Index

• Constants
• Variables
• func DeriveClientBearerSecretForClaim(secret [32]byte, clientID [16]byte) [32]byte
• func EncodeClientCredential(cred ClientCredential) (string, error)
• func GenerateClientToken(opts ClientTokenOptions) (string, error)
• func GenerateServerToken(opts ServerTokenOptions) (string, error)
• func GenerateServerTokenFromEnvironment(opts ServerTokenOptions) (string, error)
• func HasClientTokenPrefix(value string) bool
• func HasServerTokenPrefix(value string) bool
• func VerifyClientCredential(secret [32]byte, client ClientCredential, now time.Time) error
• type ClientCredential
  • func DecodeClientToken(encoded string, now time.Time) (ClientCredential, error)
  • func (cred ClientCredential) SessionToken() (sessiontoken.Token, error)
• type ClientTokenOptions
• type ForwardSpec
• type Mux
  • func NewMux(cfg MuxConfig) *Mux
  • func (m *Mux) Accept(ctx context.Context) (net.Conn, error)
  • func (m *Mux) ActiveStreamCount() int
  • func (m *Mux) Close() error
  • func (m *Mux) LastPeerActivity() time.Time
  • func (m *Mux) OpenStream(ctx context.Context) (net.Conn, error)
  • func (m *Mux) Ping(ctx context.Context, timeout time.Duration) error
  • func (m *Mux) ReplaceCarrier(carrier io.ReadWriteCloser)
• type MuxConfig
• type MuxRole
• type ServerCredential
  • func DecodeServerToken(encoded string, now time.Time) (ServerCredential, error)
  • func (cred ServerCredential) DERPKey() (key.NodePrivate, error)
  • func (cred ServerCredential) QUICPrivateKey() (ed25519.PrivateKey, error)
  • func (cred ServerCredential) SessionToken() (sessiontoken.Token, error)
• type ServerTokenOptions

Constants

const (
	ServerTokenPrefix       = "dts1_"
	CustomServerTokenPrefix = "dts2_"
	ClientTokenPrefix       = "DT1"
	CustomClientTokenPrefix = "DT2"
	TokenVersion            = 1
	CustomTokenVersion      = 2
	DefaultServerDays       = 180
	DefaultClientDays       = 90
	ProtocolTCP             = "tcp"
	ProtocolUDP             = "udp"
)

Variables

var (
	ErrExpired      = errors.New("derptun token expired")
	ErrInvalidToken = errors.New("invalid derptun token")
)

Functions

func DeriveClientBearerSecretForClaim

func DeriveClientBearerSecretForClaim(secret [32]byte, clientID [16]byte) [32]byte

func EncodeClientCredential

func EncodeClientCredential(cred ClientCredential) (string, error)

func GenerateClientToken

func GenerateClientToken(opts ClientTokenOptions) (string, error)

func GenerateServerToken

func GenerateServerToken(opts ServerTokenOptions) (string, error)

func GenerateServerTokenFromEnvironment

func GenerateServerTokenFromEnvironment(opts ServerTokenOptions) (string, error)

func HasClientTokenPrefix

func HasClientTokenPrefix(value string) bool

func HasServerTokenPrefix

func HasServerTokenPrefix(value string) bool

func VerifyClientCredential

func VerifyClientCredential(secret [32]byte, client ClientCredential, now time.Time) error

Types

type ClientCredential

type ClientCredential struct {
	Version      int      `json:"version"`
	SessionID    [16]byte `json:"session_id"`
	ClientID     [16]byte `json:"client_id"`
	TokenID      [16]byte `json:"token_id"`
	ClientName   string   `json:"client_name"`
	ExpiresUnix  int64    `json:"expires_unix"`
	DERPPublic   [32]byte `json:"derp_public"`
	QUICPublic   [32]byte `json:"quic_public"`
	BearerSecret [32]byte `json:"bearer_secret"`
	ProofMAC     string   `json:"proof_mac"`
	DERPRoute    *derpbind.Route
}

func DecodeClientToken

func DecodeClientToken(encoded string, now time.Time) (ClientCredential, error)

func (ClientCredential) SessionToken

func (cred ClientCredential) SessionToken() (sessiontoken.Token, error)

type ClientTokenOptions

type ClientTokenOptions struct {
	Now         time.Time
	ServerToken string
	Days        int
	Expires     time.Time
}

type ForwardSpec

type ForwardSpec struct {
	Protocol           string `json:"protocol"`
	ListenAddr         string `json:"listen_addr,omitempty"`
	TargetAddr         string `json:"target_addr,omitempty"`
	IdleTimeoutSeconds int    `json:"idle_timeout_seconds,omitempty"`
}

type Mux

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

func NewMux

func NewMux(cfg MuxConfig) *Mux

func (*Mux) Accept

func (m *Mux) Accept(ctx context.Context) (net.Conn, error)

func (*Mux) ActiveStreamCount

func (m *Mux) ActiveStreamCount() int

func (*Mux) Close

func (m *Mux) Close() error

func (*Mux) LastPeerActivity

func (m *Mux) LastPeerActivity() time.Time

func (*Mux) OpenStream

func (m *Mux) OpenStream(ctx context.Context) (net.Conn, error)

func (*Mux) Ping

func (m *Mux) Ping(ctx context.Context, timeout time.Duration) error

func (*Mux) ReplaceCarrier

func (m *Mux) ReplaceCarrier(carrier io.ReadWriteCloser)

type MuxConfig

type MuxConfig struct {
	Role             MuxRole
	ReconnectTimeout time.Duration
}

type MuxRole

type MuxRole string

const (
	MuxRoleClient MuxRole = "client"
	MuxRoleServer MuxRole = "server"
)

type ServerCredential

type ServerCredential struct {
	Version       int             `json:"version"`
	SessionID     [16]byte        `json:"session_id"`
	ExpiresUnix   int64           `json:"expires_unix"`
	DERPPrivate   string          `json:"derp_private"`
	QUICPrivate   []byte          `json:"quic_private"`
	SigningSecret [32]byte        `json:"signing_secret"`
	Forwards      []ForwardSpec   `json:"forwards,omitempty"`
	DERPRoute     *derpbind.Route `json:"derp_route,omitempty"`
}

func DecodeServerToken

func DecodeServerToken(encoded string, now time.Time) (ServerCredential, error)

func (ServerCredential) DERPKey

func (cred ServerCredential) DERPKey() (key.NodePrivate, error)

func (ServerCredential) QUICPrivateKey

func (cred ServerCredential) QUICPrivateKey() (ed25519.PrivateKey, error)

func (ServerCredential) SessionToken

func (cred ServerCredential) SessionToken() (sessiontoken.Token, error)

type ServerTokenOptions

type ServerTokenOptions struct {
	Now       time.Time
	Days      int
	Expires   time.Time
	DERPRoute derpbind.Route
}