sing-box/option/outbound.go

package option

import (
	E "github.com/sagernet/sing/common/exceptions"
	M "github.com/sagernet/sing/common/metadata"

	C "github.com/sagernet/sing-box/constant"

	"github.com/goccy/go-json"
)

type _Outbound struct {
	Type               string                     `json:"type"`
	Tag                string                     `json:"tag,omitempty"`
	DirectOptions      DirectOutboundOptions      `json:"-"`
	SocksOptions       SocksOutboundOptions       `json:"-"`
	HTTPOptions        HTTPOutboundOptions        `json:"-"`
	ShadowsocksOptions ShadowsocksOutboundOptions `json:"-"`
}

type Outbound _Outbound

func (h Outbound) MarshalJSON() ([]byte, error) {
	var v any
	switch h.Type {
	case C.TypeDirect:
		v = h.DirectOptions
	case C.TypeSocks:
		v = h.SocksOptions
	case C.TypeHTTP:
		v = h.HTTPOptions
	case C.TypeShadowsocks:
		v = h.ShadowsocksOptions
	case C.TypeBlock:
		v = nil
	default:
		return nil, E.New("unknown outbound type: ", h.Type)
	}
	return MarshallObjects((_Outbound)(h), v)
}

func (h *Outbound) UnmarshalJSON(bytes []byte) error {
	err := json.Unmarshal(bytes, (*_Outbound)(h))
	if err != nil {
		return err
	}
	var v any
	switch h.Type {
	case C.TypeDirect:
		v = &h.DirectOptions
	case C.TypeSocks:
		v = &h.SocksOptions
	case C.TypeHTTP:
		v = &h.HTTPOptions
	case C.TypeShadowsocks:
		v = &h.ShadowsocksOptions
	case C.TypeBlock:
		v = nil
	default:
		return nil
	}
	err = UnmarshallExcluded(bytes, (*_Outbound)(h), v)
	if err != nil {
		return E.Cause(err, "outbound options")
	}
	return nil
}

type DialerOptions struct {
	Detour          string                 `json:"detour,omitempty"`
	BindInterface   string                 `json:"bind_interface,omitempty"`
	ProtectPath     string                 `json:"protect_path,omitempty"`
	RoutingMark     int                    `json:"routing_mark,omitempty"`
	ReuseAddr       bool                   `json:"reuse_addr,omitempty"`
	ConnectTimeout  int                    `json:"connect_timeout,omitempty"`
	TCPFastOpen     bool                   `json:"tcp_fast_open,omitempty"`
	OverrideOptions *OverrideStreamOptions `json:"override,omitempty"`
	DomainStrategy  DomainStrategy         `json:"domain_strategy,omitempty"`
}

type OverrideStreamOptions struct {
	TLS           bool   `json:"tls,omitempty"`
	TLSServerName string `json:"tls_servername,omitempty"`
	TLSInsecure   bool   `json:"tls_insecure,omitempty"`
	UDPOverTCP    bool   `json:"udp_over_tcp,omitempty"`
}

func (o *OverrideStreamOptions) IsValid() bool {
	return o != nil && (o.TLS || o.UDPOverTCP)
}

type ServerOptions struct {
	Server     string `json:"server"`
	ServerPort uint16 `json:"server_port"`
}

func (o ServerOptions) Build() M.Socksaddr {
	return M.ParseSocksaddrHostPort(o.Server, o.ServerPort)
}

type DirectOutboundOptions struct {
	DialerOptions
	OverrideAddress string `json:"override_address,omitempty"`
	OverridePort    uint16 `json:"override_port,omitempty"`
}

type SocksOutboundOptions struct {
	DialerOptions
	ServerOptions
	Version  string      `json:"version,omitempty"`
	Username string      `json:"username,omitempty"`
	Password string      `json:"password,omitempty"`
	Network  NetworkList `json:"network,omitempty"`
}

type HTTPOutboundOptions struct {
	DialerOptions
	ServerOptions
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

type ShadowsocksOutboundOptions struct {
	DialerOptions
	ServerOptions
	Method   string      `json:"method"`
	Password string      `json:"password"`
	Network  NetworkList `json:"network,omitempty"`
}