webproxy

package

Go to main page

Versions in this module

v0

v0.6.8

Sep 30, 2026

Changes in this version

+ func ValidateBasePath(basePath string) error

type Capability

+ func DeriveCapabilityForPath(hostname, basePath string, secret []byte) (Capability, error)

type HTTPServerConfig

+ BasePath string

type Profile

+ func DeriveProfilesForPath(name, hostname, basePath string, baseSecret []byte) ([2]Profile, error)

v0.6.7

Sep 23, 2026

v0.6.6

Sep 23, 2026

Changes in this version

+ type BridgeFailure struct

+ BridgeID uint64

+ BufferedBytes uint64

+ Carrier CarrierMode

+ CloseCode uint16

+ Delivery string

+ ElapsedMS uint64

+ Error string

+ HTTPStatus uint16

+ LaneID uint32

+ OperationMS uint64

+ QueuedBytes uint64

+ QueuedItems uint32

+ ReadyState uint8

+ Reason string

+ Suppressed uint64

+ User string

+ WasClean bool

+ func (f BridgeFailure) IsLaneClosure() bool

type HTTPServerConfig

+ OnBridgeFailure func(BridgeFailure)

+ OnWebSocketClose func(WebSocketClose)

type ManagerConfig

+ DebugDiagnostics bool

+ type WebSocketClose struct

+ AgeMS int64

+ BridgeID uint64

+ Carrier CarrierMode

+ CloseCode uint16

+ ErrorCategory string

+ LaneID uint32

+ PeerCloseCode uint16

+ Reason string

+ ReceivedBytes uint64

+ SentBytes uint64

+ StreamOrigin string

+ Suppressed uint64

+ User string

v0.6.5

Sep 16, 2026

v0.6.4

Sep 12, 2026

v0.6.3

Sep 12, 2026

v0.6.2

Sep 7, 2026

v0.6.1

Sep 6, 2026

Changes in this version

+ func ValidateLocalBackend(address string) error

+ type Backend interface

+ Close func() error

+ TryRead func([]byte) (int, error)

+ TryWrite func([]byte) (int, error)

+ type BackendBudget struct

+ Release func(bytes, items int)

+ Reserve func(bytes, items int) bool

+ type BackendFactory func(BackendOpenOptions) (Backend, error)

+ func GnetBackendFactory(dial BackendDialContextFunc) BackendFactory

+ type BackendOpenOptions struct

+ Address string

+ ClientIP string

+ Context context.Context

+ InputBudget BackendBudget

+ MaxInputBytes int

+ MaxInputItems int

+ MaxOutputBytes int

+ MaxOutputItems int

+ Network string

+ Notify func()

+ OnClosed func(error)

+ OnOpened func(error)

+ OutputBudget BackendBudget

+ Owner gnet.EventLoop

type ManagerConfig

+ BackendFactory BackendFactory

v0.6.0

Aug 31, 2026

v0.5.4

Aug 27, 2026

v0.5.3

Aug 26, 2026

Changes in this version

type CarrierMode

+ const CarrierWebSocket

+ const CarrierWebSocketLanes

type RuntimeStats

+ WebSocketsActive int64

type Session

+ func (s *Session) AcquireWebSocket() bool

+ func (s *Session) AcquireWebSocketLane(laneID uint32) *WebSocketLaneLease

+ type WebSocketLaneLease struct

+ func (l *WebSocketLaneLease) Poll(ctx context.Context, cursor uint64) ([]byte, uint64, bool, error)

+ func (l *WebSocketLaneLease) PollCarrier(ctx context.Context, cursor uint64) ([]byte, uint64, bool, *PollLease, error)

+ func (l *WebSocketLaneLease) ProcessUp(sequence uint64, body []byte) (uint64, error)

+ func (l *WebSocketLaneLease) Release()

v0.5.2

Aug 26, 2026

Changes in this version

type BridgePage

+ func RenderBridgeForCarrier(hostname string, bootstrapToken string, batchBytes int, carrier CarrierMode) (BridgePage, error)

+ type CarrierMode string

+ const CarrierHTTPS

+ const CarrierHTTPSLanes

+ func ParseCarrierMode(value string) (CarrierMode, error)

type Manager

+ func (m *Manager) CarrierMode() CarrierMode

+ func (m *Manager) RuntimeStats() RuntimeStats

type ManagerConfig

+ Carrier CarrierMode

+ type RuntimeCounter struct

+ Label string

+ Total uint64

+ type RuntimeStats struct

+ Backpressure []RuntimeCounter

+ Capacity Capacity

+ CarrierRetries []RuntimeCounter

+ SessionsClosed []RuntimeCounter

+ SessionsCreated uint64

type Session

+ func (s *Session) CarrierMode() CarrierMode

+ func (s *Session) PollCarrierLane(ctx context.Context, laneID uint32, cursor uint64) ([]byte, uint64, bool, *PollLease, error)

+ func (s *Session) PollLane(ctx context.Context, laneID uint32, cursor uint64) ([]byte, uint64, bool, error)

+ func (s *Session) ProcessUpLane(laneID uint32, sequence uint64, body []byte) (uint64, error)

v0.5.1

Aug 25, 2026

v0.5.0

Aug 24, 2026

Changes in this version

+ const FallbackClassificationHeader

+ const FallbackOrdinarySite

+ const FallbackSanitizedPublic

+ const FrameHeaderSize

+ const InitialStreamWindow

+ const MaxBatchFrames

+ const MaxFramePayload

+ const MaxStreamID

+ const NginxPassthroughFallback

+ const NginxSanitizedFallback

+ const PermissionsPolicy

+ const RelayDataChunk

+ var ErrAuthentication = errors.New("WEB authentication failed")

+ var ErrBackpressure = errors.New("WEB temporary backpressure")

+ var ErrClosed = errors.New("WEB session closed")

+ var ErrEmptyFrameBatch = errors.New("empty WEB frame batch")

+ var ErrHTTPServerStarted = errors.New("WEB HTTP server already started")

+ var ErrIncompleteFrame = errors.New("incomplete WEB frame")

+ var ErrInvalidCapability = errors.New("invalid WEB proxy capability")

+ var ErrInvalidFrame = errors.New("invalid WEB frame")

+ var ErrInvalidHTTPServerConfig = errors.New("invalid WEB HTTP server configuration")

+ var ErrInvalidHostname = errors.New("invalid WEB proxy hostname")

+ var ErrInvalidManagerConfig = errors.New("invalid WEB session manager configuration")

+ var ErrInvalidSecret = errors.New("invalid WEB proxy secret")

+ var ErrLimit = errors.New("WEB resource limit reached")

+ var ErrPayloadTooLarge = errors.New("WEB frame payload exceeds limit")

+ var ErrProtocol = errors.New("WEB protocol error")

+ var ErrTooManyFrames = errors.New("WEB frame batch contains too many frames")

+ func AppendFrame(dst []byte, frame Frame) ([]byte, error)

+ func EncodeFrame(frame Frame) ([]byte, error)

+ func ParseHello(input []byte) error

+ func ValidateClientFrame(frame Frame) error

+ func ValidateFrame(frame Frame, direction Direction) error

+ func ValidateHostname(hostname string) error

+ func WindowDelta(payload []byte) (uint32, error)

+ func WindowPayload(delta uint32) ([]byte, error)

+ type BackendDialContextFunc func(ctx context.Context, network, address, clientIP string) (net.Conn, error)

+ type BootstrapAuthorization struct

+ func (*BootstrapAuthorization) GoString() string

+ func (*BootstrapAuthorization) String() string

+ func (a *BootstrapAuthorization) Create(clientIP string, body []byte) (CreateResult, error)

+ type BridgePage struct

+ Body []byte

+ CSP string

+ Nonce string

+ func RenderBridge(hostname, bootstrapToken string, batchBytes int) (BridgePage, error)

+ type Capability [sha256.Size]byte

+ func DeriveCapability(hostname string, secret []byte) (Capability, error)

+ func ParseCapability(value string) (Capability, error)

+ func (c Capability) Equal(other Capability) bool

+ func (c Capability) String() string

+ type Capacity struct

+ BackendDials int

+ Bootstraps int

+ ClosedTokens int

+ PendingBytes int64

+ PendingItems int64

+ Sessions int

+ Streams int

+ type CreateResult struct

+ Session *Session

+ Token string

+ Welcome []byte

+ type DialContextFunc func(ctx context.Context, network, address string) (net.Conn, error)

+ type Direction uint8

+ const ClientToRelay

+ const RelayToClient

+ type Frame struct

+ Payload []byte

+ StreamID uint32

+ Type FrameType

+ func ParseBatch(input []byte) ([]Frame, error)

+ type FrameType uint8

+ const FrameBye

+ const FrameClose

+ const FrameData

+ const FrameHello

+ const FrameOpen

+ const FramePing

+ const FramePong

+ const FrameWelcome

+ const FrameWindow

+ type HTTPServer struct

+ func NewHTTPServer(config HTTPServerConfig) (*HTTPServer, error)

+ func (s *HTTPServer) Errors() <-chan error

+ func (s *HTTPServer) Start(ctx context.Context) error

+ func (s *HTTPServer) Stop(ctx context.Context) error

+ type HTTPServerConfig struct

+ Bind string

+ BodyTimeout time.Duration

+ HeaderTimeout time.Duration

+ Hostname string

+ IdleTimeout time.Duration

+ LockOSThread bool

+ Manager *Manager

+ Multicore bool

+ NumEventLoop int

+ PassthroughStatus int

+ ReusePort bool

+ SanitizedFallbackStatus int

+ SocketSendBuffer int

+ TrustedProxyCIDRs []string

+ WriteTimeout time.Duration

+ type Limits struct

+ CarrierBatchBytes int

+ MaxBackendDialsInFlight int

+ MaxBodyBytes int

+ MaxBootstraps int

+ MaxClosedStreamIDs int

+ MaxClosedTokens int

+ MaxPendingGlobal int

+ MaxPendingItemsGlobal int

+ MaxPendingItemsPerSession int

+ MaxPendingPerSession int

+ MaxSessions int

+ MaxStreams int

+ MaxStreamsPerSession int

+ func DefaultLimits() Limits

+ type Manager struct

+ func NewManager(config ManagerConfig) (*Manager, error)

+ func (m *Manager) AuthenticateBootstrap(token string) (*BootstrapAuthorization, error)

+ func (m *Manager) Capacity() Capacity

+ func (m *Manager) Close(token string) error

+ func (m *Manager) Create(token, clientIP string, body []byte) (CreateResult, error)

+ func (m *Manager) Get(token string) (*Session, error)

+ func (m *Manager) IssueBootstrap(capability Capability, clientIP string) (string, error)

+ func (m *Manager) MatchCapability(capability Capability) (Profile, bool)

+ func (m *Manager) Shutdown(ctx context.Context) error

+ type ManagerConfig struct

+ Backend string

+ BackendDialContext BackendDialContextFunc

+ DialContext DialContextFunc

+ Limits Limits

+ Profiles []Profile

+ Timeouts Timeouts

+ func DefaultManagerConfig(profiles []Profile, backend string) ManagerConfig

+ type PollLease struct

+ func (l *PollLease) Release()

+ func (l *PollLease) Superseded() bool

+ type Profile struct

+ func DeriveProfiles(name, hostname string, baseSecret []byte) ([2]Profile, error)

+ func (p Profile) Capability() Capability

+ func (p Profile) Mode() SecretMode

+ func (p Profile) Name() string

+ func (p Profile) SecretBytes() []byte

+ func (p Profile) SecretHex() string

+ type SecretMode uint8

+ const SecretDD

+ const SecretPlain

+ func (m SecretMode) String() string

+ type Session struct

+ func (s *Session) Close()

+ func (s *Session) LastActivity() time.Time

+ func (s *Session) Poll(ctx context.Context, cursor uint64) ([]byte, uint64, error)

+ func (s *Session) PollCarrier(ctx context.Context, cursor uint64) ([]byte, uint64, *PollLease, error)

+ func (s *Session) ProcessUp(sequence uint64, body []byte) (uint64, error)

+ func (s *Session) Profile() Profile

+ type Timeouts struct

+ BackendDial time.Duration

+ BootstrapLifetime time.Duration

+ LongPoll time.Duration

+ ReconnectGrace time.Duration

+ func DefaultTimeouts() Timeouts

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