cipherstream

Apr 27, 2026

Changes in this version

type CipherStream

+ func (cs *CipherStream) WriteTo(w io.Writer) (n int64, err error)

type Header

+ func (h *Header) IsICMPProto() bool

Dec 5, 2024

Changes in this version

type CipherStream

+ func (cs *CipherStream) RandomWritePing() error

type FrameIter

+ func (fi *FrameIter) Iter() iter.Seq[*Frame]

Dec 13, 2023

Changes in this version

type CipherStream

+ func (cs *CipherStream) MarkConnUnusable() bool

Dec 8, 2023

Changes in this version

+ const FlagDNS

type Header

+ func (h *Header) IsDNSProto() bool

May 12, 2023

Changes in this version

+ const FlagACK

+ const FlagDefault

+ const FlagFIN

+ const FlagICMP

+ const FlagNeedACK

+ const FlagPad

+ const FlagTCP

+ const FlagUDP

+ const Http2HeaderLen

+ const MaxPaddingSize

+ const MinPaddingSize

+ const PaddingSize

+ var ErrPingHook = errors.New("ping hook error")

type CipherStream

+ func (cs *CipherStream) Close() error

+ func (cs *CipherStream) ReadFrame() (*Frame, error)

+ func (cs *CipherStream) WriteFrame(f *Frame) error

+ type Frame struct

+ func NewFrame(ft FrameType, payload []byte, flag uint8, cipher AEADCipher) *Frame

+ func (f *Frame) EncodeWithCipher(buf []byte) ([]byte, error)

+ func (f *Frame) Release()

+ type FrameIter struct

+ func NewFrameIter(r io.Reader, cipher AEADCipher) *FrameIter

+ func (fi *FrameIter) Error() error

+ func (fi *FrameIter) Next() *Frame

+ func (fi *FrameIter) Release()

+ type FrameType uint8

+ const FrameTypeData

+ const FrameTypePing

+ const FrameTypeRST

+ const FrameTypeUnknown

+ func ParseFrameTypeFrom(i uint8) FrameType

+ func (ft FrameType) String() string

+ func (ft FrameType) ToUint8() uint8

+ type Header struct

+ func (h *Header) FrameType() FrameType

+ func (h *Header) HasPad() bool

+ func (h *Header) IsDataFrame() bool

+ func (h *Header) IsNeedACK() bool

+ func (h *Header) IsPingFrame() bool

+ func (h *Header) IsRSTACKFrame() bool

+ func (h *Header) IsRSTFINFrame() bool

+ func (h *Header) IsTCPProto() bool

+ func (h *Header) IsUDPProto() bool

+ func (h *Header) PayloadLen() int

+ type Payload struct

+ func (p *Payload) FramePayload() []byte

+ func (p *Payload) Pad() []byte

+ func (p *Payload) PadSize() byte

+ func (p *Payload) RawDataPayload() []byte

Mar 14, 2023

Changes in this version

type CipherStream

+ func (cs *CipherStream) CloseWrite() error

Feb 12, 2023

Changes in this version

+ const MaxCipherRelaySize

+ const MaxPayloadSize

+ const MethodAes256GCM

+ const MethodChaCha20Poly1305

+ var ErrACKRSTStream = errors.New("receive ACK_RST_STREAM frame")

+ var ErrDecrypt = errors.New("decrypt data error")

+ var ErrEncrypt = errors.New("encrypt data error")

+ var ErrFINRSTStream = errors.New("receive FIN_RST_STREAM frame")

+ var ErrPayloadSize = errors.New("payload size is invalid")

+ var ErrReadCipher = errors.New("read cipher data from reader error")

+ var ErrReadPlaintxt = errors.New("read plaintext data from reader error")

+ var ErrTimeout = errors.New("net: io timeout error")

+ var ErrWriteCipher = errors.New("write cipher data to writer error")

+ func ACKRSTStreamErr(err error) bool

+ func DecryptErr(err error) bool

+ func EncryptErr(err error) bool

+ func FINRSTStreamErr(err error) bool

+ func New(stream net.Conn, password, method string, frameType util.FrameType, ...) (net.Conn, error)

+ func PayloadSizeErr(err error) bool

+ func ReadCipherErr(err error) bool

+ func ReadPlaintxtErr(err error) bool

+ func TimeoutErr(err error) bool

+ func WriteCipherErr(err error) bool

+ type AEADCipher interface

+ Decrypt func(ciphertext []byte) (plaintext []byte, err error)

+ Encrypt func(plaintext []byte) (ciphertext []byte, err error)

+ NonceSize func() int

+ Overhead func() int

+ func NewAes256GCM(password []byte) (AEADCipher, error)

+ func NewChaCha20Poly1305(password []byte) (AEADCipher, error)

+ type AEADCipherImpl struct

+ func (aci *AEADCipherImpl) Decrypt(ciphertext []byte) (plaintext []byte, err error)

+ func (aci *AEADCipherImpl) Encrypt(plaintext []byte) (ciphertext []byte, err error)

+ func (aci *AEADCipherImpl) NonceSize() int

+ func (aci *AEADCipherImpl) Overhead() int

+ type CipherStream struct

+ func (cs *CipherStream) Read(b []byte) (int, error)

+ func (cs *CipherStream) ReadFrom(r io.Reader) (n int64, err error)

+ func (cs *CipherStream) ReadHeaderAndPayload() ([]byte, []byte, error)

+ func (cs *CipherStream) ReadPing() (payload []byte, err error)

+ func (cs *CipherStream) Release()

+ func (cs *CipherStream) Write(b []byte) (int, error)

+ func (cs *CipherStream) WritePing(b []byte, flag uint8) error

+ func (cs *CipherStream) WriteRST(flag uint8) error