protocol

package

Go to main page

Versions in this module

v0

v0.2.15

May 31, 2026

v0.2.14

May 29, 2026

v0.2.13

May 28, 2026

v0.2.12

May 20, 2026

v0.2.11

May 16, 2026

v0.2.10

May 3, 2026

v0.2.9

Apr 28, 2026

v0.2.8

Apr 27, 2026

v0.2.7

Apr 26, 2026

v0.2.6

Apr 26, 2026

v0.2.5

Apr 26, 2026

v0.2.4

Apr 24, 2026

v0.2.3

Apr 22, 2026

v0.2.2

Apr 21, 2026

v0.2.1

Apr 17, 2026

v0.2.0

Apr 16, 2026

Changes in this version

+ func JoinNetErrors(a, b error) (err error)

type Addr

+ func AddrFromNetIPAddrPort(addrPort netip.AddrPort, network ...string) Addr

type Socks5UDPClient

+ ReadFromUDPAddrPort func(b []byte) (n int, addr netip.AddrPort, err error)

+ ReadMsgUDP func(b, oob []byte) (n, oobn, flags int, addr *net.UDPAddr, err error)

+ ReadMsgUDPAddrPort func(b, oob []byte) (n, oobn, flags int, addr netip.AddrPort, err error)

+ WriteMsgUDP func(b, oob []byte, addr *net.UDPAddr) (n, oobn int, err error)

+ WriteMsgUDPAddrPort func(b, oob []byte, addr netip.AddrPort) (n, oobn int, err error)

+ WriteToUDPAddrPort func(b []byte, addr netip.AddrPort) (int, error)

type Socks5UDPClientAssoc

+ func (uc *Socks5UDPClientAssoc) ReadFromUDPAddrPort(b []byte) (n int, addr netip.AddrPort, err error)

+ func (uc *Socks5UDPClientAssoc) ReadMsgUDP(b, oob []byte) (n, oobn, flags int, addr *net.UDPAddr, err error)

+ func (uc *Socks5UDPClientAssoc) ReadMsgUDPAddrPort(b, oob []byte) (n, oobn, flags int, addr netip.AddrPort, err error)

+ func (uc *Socks5UDPClientAssoc) WriteMsgUDP(b, oob []byte, addr *net.UDPAddr) (n, oobn int, err error)

+ func (uc *Socks5UDPClientAssoc) WriteMsgUDPAddrPort(b, oob []byte, addr netip.AddrPort) (n, oobn int, err error)

+ func (uc *Socks5UDPClientAssoc) WriteToUDPAddrPort(b []byte, addr netip.AddrPort) (int, error)

type Socks5UDPClientTUN

+ func (uc *Socks5UDPClientTUN) ReadFromUDPAddrPort(b []byte) (n int, addr netip.AddrPort, err error)

+ func (uc *Socks5UDPClientTUN) ReadMsgUDP(b, oob []byte) (n, oobn, flags int, addr *net.UDPAddr, err error)

+ func (uc *Socks5UDPClientTUN) ReadMsgUDPAddrPort(b, oob []byte) (n, oobn, flags int, addr netip.AddrPort, err error)

+ func (uc *Socks5UDPClientTUN) WriteMsgUDP(b, oob []byte, addr *net.UDPAddr) (n, oobn int, err error)

+ func (uc *Socks5UDPClientTUN) WriteMsgUDPAddrPort(b, oob []byte, addr netip.AddrPort) (n, oobn int, err error)

+ func (uc *Socks5UDPClientTUN) WriteToUDPAddrPort(b []byte, addr netip.AddrPort) (int, error)

v0.1.0

Mar 18, 2026

Changes in this version

+ const GOST_UDP_FRAG_FLAG

+ const MAX_AUTH_METHODS_COUNT

+ const MAX_HEADER_STR_LENGTH

+ const MAX_SOCKS_TCP_HEADER_LEN

+ const MAX_SOCKS_UDP_HEADER_LEN

+ var DefaultMethodSelectionMsg = []byte

+ var ErrNoAcceptableAuthMethods = errors.New("no acceptable socks auth methods")

+ var ErrTooLongHost = errors.New("socks host name is too long")

+ var ErrTooLongUser = errors.New("socks user name is too long")

+ var ErrUDPAssocTimeout = errors.New("socks udp assoc timeout")

+ func AppendSocks5UDPHeader(buf []byte, rsv uint16, addr Addr) []byte

+ func BuildSocks4TCPReply(stat ReplyStatus, addr Addr, pool bufpool.Pool) (request []byte)

+ func BuildSocks5TCPReply(stat ReplyStatus, addr Addr, pool bufpool.Pool) (reply []byte, err error)

+ func BuildSocks5TCPRequest(cmd Cmd, addr Addr, pool bufpool.Pool) (request []byte, err error)

+ func BuildSocsk4TCPRequest(cmd Cmd, addr Addr, user string, pool bufpool.Pool) (request []byte, err error)

+ func GetAuthParam[T any](info AuthInfo, key string) (ok bool, val T)

+ func PipeConn(inc, out net.Conn) (err error)

+ func ProxySocks5UDPAssoc(assoc, proxy PacketConn, ctrl net.Conn, binded bool, defaultAddr *Addr, ...) (err error)

+ func ProxySocks5UDPTun(tun net.Conn, proxy PacketConn, binded bool, defaultAddr *Addr, ...) (err error)

+ func ReadSocks4TCPReply(reader io.Reader) (stat ReplyStatus, addr Addr, err error)

+ func ReadSocks4TCPRequest(reader io.Reader, pool bufpool.Pool) (cmd Cmd, addr Addr, user string, err error)

+ func ReadSocks5TCPReply(reader io.Reader, pool bufpool.Pool) (stat ReplyStatus, addr Addr, err error)

+ func ReadSocks5TCPRequest(reader io.Reader, pool bufpool.Pool) (cmd Cmd, addr Addr, err error)

+ func Reject(ver string, conn net.Conn, stat ReplyStatus, pool bufpool.Pool)

+ func Reply(ver string, conn net.Conn, stat ReplyStatus, addr Addr, pool bufpool.Pool) (err error)

+ func WriteSocks5TUNUDPPacket(pool bufpool.Pool, conn net.Conn, addr Addr, data []byte) (n int, err error)

+ func WriteSocksAssoc5UDPPacket(pool bufpool.Pool, conn PacketConn, peerAddr net.Addr, addr Addr, data []byte) (n int, err error)

+ func WriteToAddrUDP(conn PacketConn, addr Addr, b []byte) (err error)

+ type Addr struct

+ Host []byte

+ NetTyp string

+ Port uint16

+ Type AddrType

+ func AddrFromFQDN(fqdn string, port uint16, net string) Addr

+ func AddrFromFQDNNoDot(fqdn string, port uint16, net string) Addr

+ func AddrFromHostPort(hostport, network string) Addr

+ func AddrFromIP(ip net.IP, port uint16, net string) Addr

+ func AddrFromNetAddr(addr net.Addr) Addr

+ func AddrFromString(host string, port uint16, network string) Addr

+ func AddrFromTCPAddr(t *net.TCPAddr) Addr

+ func AddrFromUDPAddr(u *net.UDPAddr) Addr

+ func ReadSocks5AssocUDPPacket(pool bufpool.Pool, conn net.PacketConn, p []byte, skipAddr bool, ...) (n int, addr Addr, incAddr net.Addr, err error)

+ func ReadSocks5TunUDPPacket(pool bufpool.Pool, conn net.Conn, p []byte, skipAddr bool) (n int, addr Addr, err error)

+ func (a Addr) Copy() Addr

+ func (a Addr) IpNetwork() string

+ func (a Addr) IsUnspecified() bool

+ func (a Addr) Len() int

+ func (a Addr) Network() string

+ func (a Addr) PortStr() string

+ func (a Addr) ResolveToIP4(ctx context.Context, ...) *Addr

+ func (a Addr) String() string

+ func (a Addr) ToFQDN() string

+ func (a Addr) ToHostPort() string

+ func (a Addr) ToIP() net.IP

+ func (a Addr) ToTCP() *net.TCPAddr

+ func (a Addr) ToUDP() *net.UDPAddr

+ func (a Addr) ToUnspecified() Addr

+ func (a Addr) WithDefaultAddr(def *Addr) Addr

+ func (a Addr) WithDefaultHost(host string) Addr

+ func (a Addr) WithNetTyp(nt string) Addr

+ type AddrType uint8

+ const FQDNAddr

+ const IP4Addr

+ const IP6Addr

+ func (a AddrType) String() string

+ type AuthHandler interface

+ Code func() AuthMethodCode

+ HandleAuth func(conn net.Conn, pool bufpool.Pool) (net.Conn, AuthInfo, error)

+ Name func() string

+ type AuthHandlers struct

+ func (m *AuthHandlers) Add(handler AuthHandler) *AuthHandlers

+ func (m *AuthHandlers) CheckSocks4User(user string) (accept bool)

+ func (m *AuthHandlers) Get(code AuthMethodCode) AuthHandler

+ type AuthInfo struct

+ Code AuthMethodCode

+ Info map[string]any

+ Name string

+ func HandleAuth(conn net.Conn, pool bufpool.Pool, handlers *AuthHandlers) (c net.Conn, i AuthInfo, err error)

+ func RunAuth(conn net.Conn, pool bufpool.Pool, methods *AuthMethods) (c net.Conn, i AuthInfo, err error)

+ func (a AuthInfo) GetName() string

+ func (a AuthInfo) String() string

+ type AuthMethod interface

+ Code func() AuthMethodCode

+ Name func() string

+ RunAuth func(conn net.Conn, pool bufpool.Pool) (net.Conn, AuthInfo, error)

+ type AuthMethodCode uint8

+ const GSSAuthCode

+ const NoAccAuthCode

+ const NoAuthCode

+ const PassAuthCode

+ func (a AuthMethodCode) String() string

+ type AuthMethods struct

+ func (m *AuthMethods) Add(method AuthMethod) *AuthMethods

+ func (m *AuthMethods) Clone() *AuthMethods

+ func (m *AuthMethods) Get(code AuthMethodCode) AuthMethod

+ func (m *AuthMethods) GetMsg() []byte

+ func (m *AuthMethods) Rebuild()

+ func (m *AuthMethods) User() string

+ type Cmd uint8

+ const CmdBind

+ const CmdConnect

+ const CmdGostMuxBind

+ const CmdGostUDPTun

+ const CmdTorResolve

+ const CmdTorResolvePtr

+ const CmdUDPAssoc

+ func (cmd Cmd) String() string

+ type GSSAPIClient interface

+ DeleteSecContext func() error

+ InitSecContext func(targetName string, token []byte) (outputToken []byte, needContinue bool, err error)

+ type GSSAPIServer interface

+ AcceptSecContext func(token []byte) (outputToken []byte, srcName string, needContinue bool, err error)

+ DeleteSecContext func() error

+ type GSSAuthHandler struct

+ Server GSSAPIServer

+ func (h *GSSAuthHandler) Code() AuthMethodCode

+ func (h *GSSAuthHandler) HandleAuth(conn net.Conn, pool bufpool.Pool) (net.Conn, AuthInfo, error)

+ func (h *GSSAuthHandler) Name() string

+ type GSSAuthMethod struct

+ Client GSSAPIClient

+ TargetName string

+ func (m *GSSAuthMethod) Code() AuthMethodCode

+ func (m *GSSAuthMethod) Name() string

+ func (m *GSSAuthMethod) RunAuth(conn net.Conn, pool bufpool.Pool) (net.Conn, AuthInfo, error)

+ type NoAuthHandler struct

+ func (m *NoAuthHandler) Code() AuthMethodCode

+ func (m *NoAuthHandler) HandleAuth(conn net.Conn, pool bufpool.Pool) (net.Conn, AuthInfo, error)

+ func (m *NoAuthHandler) Name() string

+ type PacketConn interface

+ type PassAuthHandler struct

+ VerifyFn func(user, pass string) bool

+ func (m *PassAuthHandler) Code() AuthMethodCode

+ func (m *PassAuthHandler) HandleAuth(conn net.Conn, pool bufpool.Pool) (net.Conn, AuthInfo, error)

+ func (m *PassAuthHandler) Name() string

+ type PassAuthMethod struct

+ Pass string

+ User string

+ func (m *PassAuthMethod) Code() AuthMethodCode

+ func (m *PassAuthMethod) Name() string

+ func (m *PassAuthMethod) RunAuth(conn net.Conn, pool bufpool.Pool) (net.Conn, AuthInfo, error)

+ type ReplyStatus uint8

+ const AddrNotSuppReply

+ const CmdNotSuppReply

+ const ConnRefusedReply

+ const DisallowReply

+ const FailReply

+ const Granted

+ const HostUnreachReply

+ const IdentFailed

+ const IdentRequired

+ const NetUnreachReply

+ const Rejected

+ const SuccReply

+ const TTLExpiredReply

+ const TorDescInvalid

+ const TorDescNotFound

+ const TorIntroFail

+ const TorIntroTimeOut

+ const TorInvalidAddr

+ const TorMissAuth

+ const TorRendFailed

+ const TorWrongAuth

+ func (r ReplyStatus) Ok() bool

+ func (r ReplyStatus) String() string

+ func (r ReplyStatus) To4() ReplyStatus

+ func (r ReplyStatus) To5() ReplyStatus

+ type Socks5UDPClient interface

+ ReadFromUDP func(b []byte) (n int, addr *net.UDPAddr, err error)

+ WriteToIpPort func(p []byte, ip net.IP, port uint16) (n int, err error)

+ WriteToUDP func(b []byte, addr *net.UDPAddr) (int, error)

+ type Socks5UDPClientAssoc struct

+ DefaultHeader []byte

+ OnClose func()

+ Pool bufpool.Pool

+ Raddr net.Addr

+ func NewSocks5UDPClientAssoc(conn PacketConn, addr *Addr, pool bufpool.Pool, onc func()) *Socks5UDPClientAssoc

+ func (uc *Socks5UDPClientAssoc) Close() error

+ func (uc *Socks5UDPClientAssoc) Read(b []byte) (n int, err error)

+ func (uc *Socks5UDPClientAssoc) ReadFrom(p []byte) (n int, addr net.Addr, err error)

+ func (uc *Socks5UDPClientAssoc) ReadFromUDP(b []byte) (n int, addr *net.UDPAddr, err error)

+ func (uc *Socks5UDPClientAssoc) RemoteAddr() net.Addr

+ func (uc *Socks5UDPClientAssoc) Write(b []byte) (n int, err error)

+ func (uc *Socks5UDPClientAssoc) WriteTo(p []byte, addr net.Addr) (n int, err error)

+ func (uc *Socks5UDPClientAssoc) WriteToIpPort(p []byte, ip net.IP, port uint16) (n int, err error)

+ func (uc *Socks5UDPClientAssoc) WriteToUDP(b []byte, addr *net.UDPAddr) (int, error)

+ type Socks5UDPClientTUN struct

+ DefaultHeader []byte

+ Laddr net.Addr

+ OnClose func()

+ Pool bufpool.Pool

+ Raddr net.Addr

+ func NewSocks5UDPClientTUN(conn net.Conn, laddr Addr, raddr *Addr, pool bufpool.Pool) *Socks5UDPClientTUN

+ func (uc *Socks5UDPClientTUN) Close() error

+ func (uc *Socks5UDPClientTUN) LocalAddr() net.Addr

+ func (uc *Socks5UDPClientTUN) Read(b []byte) (n int, err error)

+ func (uc *Socks5UDPClientTUN) ReadFrom(p []byte) (n int, addr net.Addr, err error)

+ func (uc *Socks5UDPClientTUN) ReadFromUDP(b []byte) (n int, addr *net.UDPAddr, err error)

+ func (uc *Socks5UDPClientTUN) RemoteAddr() net.Addr

+ func (uc *Socks5UDPClientTUN) Write(b []byte) (n int, err error)

+ func (uc *Socks5UDPClientTUN) WriteTo(p []byte, addr net.Addr) (n int, err error)

+ func (uc *Socks5UDPClientTUN) WriteToIpPort(p []byte, ip net.IP, port uint16) (n int, err error)

+ func (uc *Socks5UDPClientTUN) WriteToUDP(b []byte, addr *net.UDPAddr) (int, error)

+ type UnknownAddrTypeError struct

+ Type AddrType

+ func (e UnknownAddrTypeError) Error() string

+ type UnknownAuthVerError struct

+ Version int

+ func (e UnknownAuthVerError) Error() string

+ type UnsupportedAuthMethodError struct

+ Method AuthMethodCode

+ func (e UnsupportedAuthMethodError) Error() string

+ type Wrong4ReplyVerError struct

+ Version int

+ func (e Wrong4ReplyVerError) Error() string

+ type WrongProtocolVerError struct

+ Version int

+ func (e WrongProtocolVerError) Error() string

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