pt_hysteria

README

A pluggable transport implementation based on Hysteria

Hysteria

Hysteria uses a custom version of QUIC protocol (RFC 9000 - QUIC: A UDP-Based Multiplexed and Secure Transport):

• a custom congestion control (RFC 9002 - QUIC Loss Detection and Congestion Control)
• tweaked QUIC parameters
• an obfuscation layer
• non-standard transports (e.g. faketcp)

Usage

Implementation

The implementation uses Pluggable Transport Specification v3.0 - Go Transport API

Documentation

Overview

Package pt_hysteria provides a PT 3.0 Go API wrapper around the connections used by hysteria

Index

• type HysteriaClient
  • func NewHysteriaClient(serverAddress string) *HysteriaClient
• type HysteriaListener
  • func NewHysteriaServer(address string, obfs string, cert string, key string, mode string, ...) *HysteriaListener
  • func (hl *HysteriaListener) Accept() (sc net.Conn, e error)
  • func (hl *HysteriaListener) Addr() net.Addr
  • func (hl *HysteriaListener) Close() error
  • func (hl *HysteriaListener) Listen() (net.Listener, error)
• type HysteriaServer
• type StreamConn
  • func (sc StreamConn) Close() error
  • func (sc StreamConn) LocalAddr() net.Addr
  • func (sc StreamConn) Read(b []byte) (n int, err error)
  • func (sc StreamConn) RemoteAddr() net.Addr
  • func (sc StreamConn) SetDeadline(t time.Time) error
  • func (sc StreamConn) SetReadDeadline(t time.Time) error
  • func (sc StreamConn) SetWriteDeadline(t time.Time) error
  • func (sc StreamConn) Write(b []byte) (n int, err error)

Types

type HysteriaClient

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

func NewHysteriaClient

func NewHysteriaClient(serverAddress string) *HysteriaClient

type HysteriaListener

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

func NewHysteriaServer

func NewHysteriaServer(address string, obfs string, cert string, key string, mode string, password string) *HysteriaListener

func (*HysteriaListener) Accept

func (hl *HysteriaListener) Accept() (sc net.Conn, e error)

func (*HysteriaListener) Addr

func (hl *HysteriaListener) Addr() net.Addr

Addr returns the listener's network address.

func (*HysteriaListener) Close

func (hl *HysteriaListener) Close() error

Close closes the listener. Any blocked Accept operations will be unblocked and return errors.

func (*HysteriaListener) Listen

func (hl *HysteriaListener) Listen() (net.Listener, error)

type HysteriaServer

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

type StreamConn

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

func (StreamConn) Close

func (sc StreamConn) Close() error

func (StreamConn) LocalAddr

func (sc StreamConn) LocalAddr() net.Addr

LocalAddr returns the local network address. needed to fulfill the net.Conn interface

func (StreamConn) Read

func (sc StreamConn) Read(b []byte) (n int, err error)

func (StreamConn) RemoteAddr

func (sc StreamConn) RemoteAddr() net.Addr

RemoteAddr returns the remote network address.

func (StreamConn) SetDeadline

func (sc StreamConn) SetDeadline(t time.Time) error

func (StreamConn) SetReadDeadline

func (sc StreamConn) SetReadDeadline(t time.Time) error

func (StreamConn) SetWriteDeadline

func (sc StreamConn) SetWriteDeadline(t time.Time) error

func (StreamConn) Write

func (sc StreamConn) Write(b []byte) (n int, err error)