sessions

package
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 14, 2026 License: MPL-2.0 Imports: 12 Imported by: 0

README

Logical sessions

The registry atomically reserves shared per-user TCP/UDP connections and active IPs. Authentication labels bind credentials and inbound configuration epochs. registry.go owns admission/release and current limit projections; accounting.go keeps a separate native-handler lifetime and period counter after logical release.

AcquireTracked/Finish bracket actual Xray dispatch. Period changes retain previous counters until all native handlers and sampling finish. Quiesce adds a temporary admission fence and returns its release after handlers drain. Cached valid_until deadlines deny new sessions immediately and close established sessions on the next one-second control tick.

Rates use actual elapsed seconds and payload bytes. Configured normal/burst Mbps remain a separate policy projection. Connection and source-IP snapshots are transient. Hosted cases cover quota races, expiry, counters and quiescence.

period_barrier.go finishes revoked period handlers without closing renewed streams. period_barrier_test.go covers late old bytes, active-period rejection and renewal continuity in hosted CI.

Documentation

Overview

Package sessions owns user admission and the lifecycle of logical proxy sessions.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CanonicalIP

func CanonicalIP(raw string) (string, error)

func IPBlockKey

func IPBlockKey(user int, ip string) string

Types

type AccountingCounter added in v1.0.2

type AccountingCounter struct {
	UserID           int
	Period           string
	Upload, Download uint64
}

type ActiveIP

type ActiveIP struct {
	UserID      int    `json:"user_id"`
	SourceIP    string `json:"source_ip"`
	Connections int    `json:"connections"`
}

type AdmissionEvent

type AdmissionEvent struct {
	UserID   int    `json:"user_id"`
	Limited  bool   `json:"limited"`
	Reason   string `json:"reason"`
	Scope    string `json:"scope"`
	SourceIP string `json:"source_ip,omitempty"`
}

type Connection

type Connection struct {
	ID              string    `json:"id"`
	UserID          int       `json:"user_id"`
	InboundTag      string    `json:"inbound_tag"`
	SourceIP        string    `json:"source_ip"`
	Destination     string    `json:"destination"`
	DestinationPort int       `json:"destination_port"`
	Network         string    `json:"network"`
	Started         time.Time `json:"started"`
}

type Lease

type Lease struct {
	Info Connection
	// contains filtered or unexported fields
}

func (*Lease) Account

func (l *Lease) Account(upload bool, n uint64)

func (*Lease) Close

func (l *Lease) Close()

func (*Lease) Finish added in v1.0.2

func (l *Lease) Finish()

Finish is called when the native outbound handler has completed all payload copying.

func (*Lease) Wait

func (l *Lease) Wait(ctx context.Context, n int) error

type LimitStatus

type LimitStatus struct {
	UserID  int    `json:"user_id"`
	Limited bool   `json:"limited"`
	Reason  string `json:"reason,omitempty"`
	Scope   string `json:"scope"`
}

type Registry

type Registry struct {
	OnBan    func(int, time.Time)
	OnReject func(AdmissionEvent)
	// contains filtered or unexported fields
}

func New

func New() *Registry

func (*Registry) AccountingCounters added in v1.0.2

func (r *Registry) AccountingCounters() []AccountingCounter

AccountingCounters keeps old-period counters reachable until their leases and sampler finish.

func (*Registry) Acquire

func (r *Registry) Acquire(ctx context.Context, id int, identity, tag, ip, destination, network string, port int, cancel func()) (*Lease, error)

func (*Registry) AcquireTracked added in v1.0.2

func (r *Registry) AcquireTracked(ctx context.Context, id int, identity, tag, ip, destination, network string, port int, cancel func()) (*Lease, error)

AcquireTracked keeps a separate completion barrier after admission slots are released.

func (*Registry) ActiveIPs

func (r *Registry) ActiveIPs(user int) []ActiveIP

func (*Registry) Ban

func (r *Registry) Ban(id int, until time.Time)

func (*Registry) CloseAll

func (r *Registry) CloseAll()

func (*Registry) CloseConnection

func (r *Registry) CloseConnection(id string) bool

func (*Registry) CloseUser

func (r *Registry) CloseUser(id int, tag string)

func (*Registry) CloseUserInbound

func (r *Registry) CloseUserInbound(tag string)

func (*Registry) Counters

func (r *Registry) Counters() state.Traffic

func (*Registry) DropIP

func (r *Registry) DropIP(ip string, user int) int

func (*Registry) ExpireBans

func (r *Registry) ExpireBans(now time.Time) []int

func (*Registry) ExpireIPBlocks

func (r *Registry) ExpireIPBlocks(now time.Time) []string

func (*Registry) ExpireUsers added in v1.0.2

func (r *Registry) ExpireUsers(now time.Time)

func (*Registry) List

func (r *Registry) List(after string, limit int) []Connection

func (*Registry) Pause

func (r *Registry) Pause(v bool)

func (*Registry) PruneAccounting added in v1.0.2

func (r *Registry) PruneAccounting()

func (*Registry) PruneCounters

func (r *Registry) PruneCounters()

func (*Registry) Quiesce added in v1.0.2

func (r *Registry) Quiesce(ctx context.Context, id int) (func(), error)

Quiesce requires an admission fence, closes streams, and waits for their native handlers. The returned release function must run after the actor seals its traffic barrier.

func (*Registry) QuiescePeriod added in v1.0.2

func (r *Registry) QuiescePeriod(ctx context.Context, id int, period string) (func(), error)

QuiescePeriod finishes only an old accounting period. The member's new term remains admitted, so reconnecting journals cannot interrupt renewed access.

func (*Registry) RestoreBans

func (r *Registry) RestoreBans(bans map[int]time.Time)

func (*Registry) RestoreIPBlocks

func (r *Registry) RestoreIPBlocks(blocks map[string]protocol.IPBlock)

func (*Registry) SetIPBlock

func (r *Registry) SetIPBlock(key string, block protocol.IPBlock)

func (*Registry) SetInboundEpochs

func (r *Registry) SetInboundEpochs(epochs map[string]string)

func (*Registry) SetPorts

func (r *Registry) SetPorts(ports []protocol.PortRange)

func (*Registry) SetRates added in v1.0.2

func (r *Registry) SetRates(delta protocol.Traffic, elapsed float64)

func (*Registry) SetReportIPs

func (r *Registry) SetReportIPs(enabled bool)

func (*Registry) SetUsers

func (r *Registry) SetUsers(users []protocol.User)

func (*Registry) Summary

func (r *Registry) Summary() Summary

type SpeedStatus

type SpeedStatus struct {
	NormalMbps int  `json:"normal_mbps"`
	BurstMbps  int  `json:"burst_mbps"`
	Limited    bool `json:"limited"`
	ActiveMbps int  `json:"active_mbps"`
}

type Summary

type Summary struct {
	Connections map[int]int               `json:"connections"`
	ActiveIPs   map[int][]string          `json:"active_ips,omitempty"`
	Rejections  map[string]uint64         `json:"rejections"`
	Status      map[int]LimitStatus       `json:"status"`
	Speed       map[int]SpeedStatus       `json:"speed"`
	Rates       map[int]protocol.UserRate `json:"rates,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL