openvpn

package

v1.14.4 Latest Latest Go to latest Published: Oct 23, 2026 License: GPL-2.0 Imports: 42 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sagernet/sing-box

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

func NewClientEndpoint(ctx context.Context, router adapter.Router, logger log.ContextLogger, ...) (adapter.Endpoint, error)
func NewDNSTransport(ctx context.Context, logger log.ContextLogger, tag string, ...) (adapter.DNSTransport, error)
func NewServerEndpoint(ctx context.Context, router adapter.Router, logger log.ContextLogger, ...) (adapter.Endpoint, error)
func RegisterDNSTransport(registry *boxDNS.TransportRegistry)
func RegisterEndpoint(registry *endpoint.Registry)
type ClientEndpoint
type DNSTransport
type ServerEndpoint

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewClientEndpoint ¶

func NewClientEndpoint(ctx context.Context, router adapter.Router, logger log.ContextLogger, tag string, options option.OpenVPNClientEndpointOptions) (adapter.Endpoint, error)

func NewDNSTransport ¶

func NewDNSTransport(ctx context.Context, logger log.ContextLogger, tag string, options option.OpenVPNDNSServerOptions) (adapter.DNSTransport, error)

func NewServerEndpoint ¶

func NewServerEndpoint(ctx context.Context, router adapter.Router, logger log.ContextLogger, tag string, options option.OpenVPNServerEndpointOptions) (adapter.Endpoint, error)

func RegisterDNSTransport ¶

func RegisterDNSTransport(registry *boxDNS.TransportRegistry)

func RegisterEndpoint ¶

func RegisterEndpoint(registry *endpoint.Registry)

Types ¶

type ClientEndpoint ¶

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

func (*ClientEndpoint) AttachReturn ¶

func (c *ClientEndpoint) AttachReturn(returnPath tun.Return) error

func (*ClientEndpoint) CancelChallenge ¶

func (c *ClientEndpoint) CancelChallenge(challengeID string) error

func (*ClientEndpoint) CompleteChallenge ¶

func (c *ClientEndpoint) CompleteChallenge(challengeID string, response adapter.OpenVPNChallengeResponse) error

func (*ClientEndpoint) DetachReturn ¶

func (c *ClientEndpoint) DetachReturn(returnPath tun.Return) error

func (*ClientEndpoint) DialContext ¶

func (c *ClientEndpoint) DialContext(ctx context.Context, network string, destination M.Socksaddr) (net.Conn, error)

func (*ClientEndpoint) InterfaceUpdated ¶

func (c *ClientEndpoint) InterfaceUpdated(ctx context.Context)

func (*ClientEndpoint) JudgeFlow ¶

func (c *ClientEndpoint) JudgeFlow(network uint8, source netip.AddrPort, destination netip.AddrPort, firstPacket []byte) tun.FlowVerdict

func (*ClientEndpoint) ListenPacket ¶

func (c *ClientEndpoint) ListenPacket(ctx context.Context, destination M.Socksaddr) (net.PacketConn, error)

func (*ClientEndpoint) ListenPacketWithDestination ¶

func (c *ClientEndpoint) ListenPacketWithDestination(ctx context.Context, destination M.Socksaddr) (net.PacketConn, netip.Addr, error)

func (*ClientEndpoint) NewConnectionEx ¶

func (c *ClientEndpoint) NewConnectionEx(ctx context.Context, conn net.Conn, source M.Socksaddr, destination M.Socksaddr, onClose N.CloseHandlerFunc)

func (*ClientEndpoint) NewDNSPacket ¶

func (c *ClientEndpoint) NewDNSPacket(payload []byte, source M.Socksaddr, destination M.Socksaddr, writer N.PacketWriter)

func (*ClientEndpoint) NewPacketConnectionEx ¶

func (c *ClientEndpoint) NewPacketConnectionEx(ctx context.Context, conn N.PacketConn, source M.Socksaddr, destination M.Socksaddr, onClose N.CloseHandlerFunc)

func (*ClientEndpoint) OpenVPNStatus ¶

func (c *ClientEndpoint) OpenVPNStatus() adapter.OpenVPNStatus

func (*ClientEndpoint) PortAddresses ¶

func (c *ClientEndpoint) PortAddresses() (netip.Addr, netip.Addr)

func (*ClientEndpoint) PortMTU ¶

func (c *ClientEndpoint) PortMTU() uint32

func (*ClientEndpoint) PreMatchFlow ¶

func (c *ClientEndpoint) PreMatchFlow(network string, destination netip.Addr) adapter.PreMatchAction

func (*ClientEndpoint) PreferredAddress ¶

func (c *ClientEndpoint) PreferredAddress(metadata *adapter.InboundContext, address netip.Addr) bool

func (*ClientEndpoint) PreferredDomain ¶

func (c *ClientEndpoint) PreferredDomain(metadata *adapter.InboundContext, domain string) bool

func (*ClientEndpoint) Start ¶

func (c *ClientEndpoint) Start(stage adapter.StartStage, scope *adapter.Scope) error

func (*ClientEndpoint) StatusUpdated ¶

func (c *ClientEndpoint) StatusUpdated() <-chan struct{}

func (*ClientEndpoint) WritePackets ¶

func (c *ClientEndpoint) WritePackets(packets [][]byte) error

type DNSTransport ¶

type DNSTransport struct {
	boxDNS.TransportAdapter
	// contains filtered or unexported fields
}

func (*DNSTransport) Exchange ¶

func (t *DNSTransport) Exchange(ctx context.Context, message *mDNS.Msg) (*mDNS.Msg, error)

func (*DNSTransport) ExchangeAsync ¶

func (t *DNSTransport) ExchangeAsync(ctx context.Context, message *mDNS.Msg, callback func(response *mDNS.Msg, err error))

func (*DNSTransport) PreferredDomain ¶

func (t *DNSTransport) PreferredDomain(domain string) bool

func (*DNSTransport) Raw ¶

func (t *DNSTransport) Raw() bool

func (*DNSTransport) Reset ¶

func (t *DNSTransport) Reset()

func (*DNSTransport) Start ¶

func (t *DNSTransport) Start(stage adapter.StartStage, scope *adapter.Scope) error

type ServerEndpoint ¶

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

func (*ServerEndpoint) AttachReturn ¶

func (s *ServerEndpoint) AttachReturn(returnPath tun.Return) error

func (*ServerEndpoint) DetachReturn ¶

func (s *ServerEndpoint) DetachReturn(returnPath tun.Return) error

func (*ServerEndpoint) DialContext ¶

func (s *ServerEndpoint) DialContext(ctx context.Context, network string, destination M.Socksaddr) (net.Conn, error)

func (*ServerEndpoint) JudgeFlow ¶

func (s *ServerEndpoint) JudgeFlow(network uint8, source netip.AddrPort, destination netip.AddrPort, firstPacket []byte) tun.FlowVerdict

func (*ServerEndpoint) ListenPacket ¶

func (s *ServerEndpoint) ListenPacket(ctx context.Context, destination M.Socksaddr) (net.PacketConn, error)

func (*ServerEndpoint) ListenPacketWithDestination ¶

func (s *ServerEndpoint) ListenPacketWithDestination(ctx context.Context, destination M.Socksaddr) (net.PacketConn, netip.Addr, error)

func (*ServerEndpoint) NewConnectionEx ¶

func (s *ServerEndpoint) NewConnectionEx(ctx context.Context, conn net.Conn, source M.Socksaddr, destination M.Socksaddr, onClose N.CloseHandlerFunc)

func (*ServerEndpoint) NewDNSPacket ¶

func (s *ServerEndpoint) NewDNSPacket(payload []byte, source M.Socksaddr, destination M.Socksaddr, writer N.PacketWriter)

func (*ServerEndpoint) NewPacketConnectionEx ¶

func (s *ServerEndpoint) NewPacketConnectionEx(ctx context.Context, conn N.PacketConn, source M.Socksaddr, destination M.Socksaddr, onClose N.CloseHandlerFunc)

func (*ServerEndpoint) PortAddresses ¶

func (s *ServerEndpoint) PortAddresses() (netip.Addr, netip.Addr)

func (*ServerEndpoint) PortMTU ¶

func (s *ServerEndpoint) PortMTU() uint32

func (*ServerEndpoint) PreMatchFlow ¶

func (s *ServerEndpoint) PreMatchFlow(network string, destination netip.Addr) adapter.PreMatchAction

func (*ServerEndpoint) Start ¶

func (s *ServerEndpoint) Start(stage adapter.StartStage, scope *adapter.Scope) error

func (*ServerEndpoint) WritePackets ¶

func (s *ServerEndpoint) WritePackets(packets [][]byte) error

Source Files ¶

View all Source files

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