Documentation ¶
Overview ¶
Package dns is an implementation of core.DNS feature.
Index ¶
- Constants
- Variables
- func Fqdn(domain string) string
- type ClassicNameServer
- type Client
- type Config
- func (*Config) Descriptor() ([]byte, []int)deprecated
- func (x *Config) GetClientIp() []byte
- func (x *Config) GetDisableCache() bool
- func (x *Config) GetDisableFallback() bool
- func (x *Config) GetDisableFallbackIfMatch() bool
- func (x *Config) GetHosts() map[string]*net.IPOrDomaindeprecated
- func (x *Config) GetNameServer() []*NameServer
- func (x *Config) GetNameServers() []*net.Endpointdeprecated
- func (x *Config) GetQueryStrategy() QueryStrategy
- func (x *Config) GetStaticHosts() []*Config_HostMapping
- func (x *Config) GetTag() string
- func (*Config) ProtoMessage()
- func (x *Config) ProtoReflect() protoreflect.Message
- func (x *Config) Reset()
- func (x *Config) String() string
- type Config_HostMapping
- func (*Config_HostMapping) Descriptor() ([]byte, []int)deprecated
- func (x *Config_HostMapping) GetDomain() string
- func (x *Config_HostMapping) GetIp() [][]byte
- func (x *Config_HostMapping) GetProxiedDomain() string
- func (x *Config_HostMapping) GetType() DomainMatchingType
- func (*Config_HostMapping) ProtoMessage()
- func (x *Config_HostMapping) ProtoReflect() protoreflect.Message
- func (x *Config_HostMapping) Reset()
- func (x *Config_HostMapping) String() string
- type DNS
- func (s *DNS) Close() error
- func (s *DNS) GetIPOption() *dns.IPOption
- func (s *DNS) IsOwnLink(ctx context.Context) bool
- func (s *DNS) LookupHosts(domain string) *net.Address
- func (s *DNS) LookupIP(domain string, option dns.IPOption) ([]net.IP, error)
- func (s *DNS) SetFakeDNSOption(isFakeEnable bool)
- func (s *DNS) SetQueryOption(isIPv4Enable, isIPv6Enable bool)
- func (s *DNS) Start() error
- func (*DNS) Type() interface{}
- type DoHNameServer
- type DomainMatcherInfo
- type DomainMatchingType
- func (DomainMatchingType) Descriptor() protoreflect.EnumDescriptor
- func (x DomainMatchingType) Enum() *DomainMatchingType
- func (DomainMatchingType) EnumDescriptor() ([]byte, []int)deprecated
- func (x DomainMatchingType) Number() protoreflect.EnumNumber
- func (x DomainMatchingType) String() string
- func (DomainMatchingType) Type() protoreflect.EnumType
- type FakeDNSServer
- type IPRecord
- type LocalNameServer
- type NameServer
- func (*NameServer) Descriptor() ([]byte, []int)deprecated
- func (x *NameServer) GetAddress() *net.Endpoint
- func (x *NameServer) GetClientIp() []byte
- func (x *NameServer) GetGeoip() []*router.GeoIP
- func (x *NameServer) GetOriginalRules() []*NameServer_OriginalRule
- func (x *NameServer) GetPrioritizedDomain() []*NameServer_PriorityDomain
- func (x *NameServer) GetSkipFallback() bool
- func (*NameServer) ProtoMessage()
- func (x *NameServer) ProtoReflect() protoreflect.Message
- func (x *NameServer) Reset()
- func (x *NameServer) String() string
- type NameServer_OriginalRule
- func (*NameServer_OriginalRule) Descriptor() ([]byte, []int)deprecated
- func (x *NameServer_OriginalRule) GetRule() string
- func (x *NameServer_OriginalRule) GetSize() uint32
- func (*NameServer_OriginalRule) ProtoMessage()
- func (x *NameServer_OriginalRule) ProtoReflect() protoreflect.Message
- func (x *NameServer_OriginalRule) Reset()
- func (x *NameServer_OriginalRule) String() string
- type NameServer_PriorityDomain
- func (*NameServer_PriorityDomain) Descriptor() ([]byte, []int)deprecated
- func (x *NameServer_PriorityDomain) GetDomain() string
- func (x *NameServer_PriorityDomain) GetType() DomainMatchingType
- func (*NameServer_PriorityDomain) ProtoMessage()
- func (x *NameServer_PriorityDomain) ProtoReflect() protoreflect.Message
- func (x *NameServer_PriorityDomain) Reset()
- func (x *NameServer_PriorityDomain) String() string
- type QUICNameServer
- type QueryStrategy
- func (QueryStrategy) Descriptor() protoreflect.EnumDescriptor
- func (x QueryStrategy) Enum() *QueryStrategy
- func (QueryStrategy) EnumDescriptor() ([]byte, []int)deprecated
- func (x QueryStrategy) Number() protoreflect.EnumNumber
- func (x QueryStrategy) String() string
- func (QueryStrategy) Type() protoreflect.EnumType
- type Server
- type StaticHosts
- type TCPNameServer
Constants ¶
const NextProtoDQ = "doq-i00"
NextProtoDQ - During connection establishment, DNS/QUIC support is indicated by selecting the ALPN token "dq" in the crypto handshake.
Variables ¶
var ( DomainMatchingType_name = map[int32]string{ 0: "Full", 1: "Subdomain", 2: "Keyword", 3: "Regex", } DomainMatchingType_value = map[string]int32{ "Full": 0, "Subdomain": 1, "Keyword": 2, "Regex": 3, } )
Enum value maps for DomainMatchingType.
var ( QueryStrategy_name = map[int32]string{ 0: "USE_IP", 1: "USE_IP4", 2: "USE_IP6", } QueryStrategy_value = map[string]int32{ "USE_IP": 0, "USE_IP4": 1, "USE_IP6": 2, } )
Enum value maps for QueryStrategy.
var File_app_dns_config_proto protoreflect.FileDescriptor
Functions ¶
Types ¶
type ClassicNameServer ¶
ClassicNameServer implemented traditional UDP DNS.
func NewClassicNameServer ¶
func NewClassicNameServer(address net.Destination, dispatcher routing.Dispatcher) *ClassicNameServer
NewClassicNameServer creates udp server object for remote resolving.
func (*ClassicNameServer) Cleanup ¶
func (s *ClassicNameServer) Cleanup() error
Cleanup clears expired items from cache
func (*ClassicNameServer) HandleResponse ¶
func (s *ClassicNameServer) HandleResponse(ctx context.Context, packet *udp_proto.Packet)
HandleResponse handles udp response packet from remote DNS server.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the interface for DNS client.
func NewClient ¶
func NewClient(ctx context.Context, ns *NameServer, clientIP net.IP, container router.GeoIPMatcherContainer, matcherInfos *[]*DomainMatcherInfo, updateDomainRule func(strmatcher.Matcher, int, []*DomainMatcherInfo) error) (*Client, error)
NewClient creates a DNS client managing a name server with client IP, domain rules and expected IPs.
func NewLocalDNSClient ¶
func NewLocalDNSClient() *Client
NewLocalDNSClient creates localdns client object for directly lookup in system DNS.
func NewSimpleClient ¶
NewSimpleClient creates a DNS client with a simple destination.
func (*Client) MatchExpectedIPs ¶
MatchExpectedIPs matches queried domain IPs with expected IPs and returns matched ones.
type Config ¶
type Config struct { // Nameservers used by this DNS. Only traditional UDP servers are support at // the moment. A special value 'localhost' as a domain address can be set to // use DNS on local system. // // Deprecated: Do not use. NameServers []*net.Endpoint `protobuf:"bytes,1,rep,name=NameServers,proto3" json:"NameServers,omitempty"` // NameServer list used by this DNS client. NameServer []*NameServer `protobuf:"bytes,5,rep,name=name_server,json=nameServer,proto3" json:"name_server,omitempty"` // Static hosts. Domain to IP. // Deprecated. Use static_hosts. // // Deprecated: Do not use. Hosts map[string]*net.IPOrDomain `` /* 151-byte string literal not displayed */ // Client IP for EDNS client subnet. Must be 4 bytes (IPv4) or 16 bytes // (IPv6). ClientIp []byte `protobuf:"bytes,3,opt,name=client_ip,json=clientIp,proto3" json:"client_ip,omitempty"` StaticHosts []*Config_HostMapping `protobuf:"bytes,4,rep,name=static_hosts,json=staticHosts,proto3" json:"static_hosts,omitempty"` // Tag is the inbound tag of DNS client. Tag string `protobuf:"bytes,6,opt,name=tag,proto3" json:"tag,omitempty"` // DisableCache disables DNS cache DisableCache bool `protobuf:"varint,8,opt,name=disableCache,proto3" json:"disableCache,omitempty"` QueryStrategy QueryStrategy `` /* 133-byte string literal not displayed */ DisableFallback bool `protobuf:"varint,10,opt,name=disableFallback,proto3" json:"disableFallback,omitempty"` DisableFallbackIfMatch bool `protobuf:"varint,11,opt,name=disableFallbackIfMatch,proto3" json:"disableFallbackIfMatch,omitempty"` // contains filtered or unexported fields }
func (*Config) Descriptor
deprecated
func (*Config) GetClientIp ¶
func (*Config) GetDisableCache ¶
func (*Config) GetDisableFallback ¶
func (*Config) GetDisableFallbackIfMatch ¶
func (*Config) GetHosts
deprecated
func (x *Config) GetHosts() map[string]*net.IPOrDomain
Deprecated: Do not use.
func (*Config) GetNameServer ¶
func (x *Config) GetNameServer() []*NameServer
func (*Config) GetNameServers
deprecated
func (*Config) GetQueryStrategy ¶
func (x *Config) GetQueryStrategy() QueryStrategy
func (*Config) GetStaticHosts ¶
func (x *Config) GetStaticHosts() []*Config_HostMapping
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) ProtoReflect ¶
func (x *Config) ProtoReflect() protoreflect.Message
type Config_HostMapping ¶
type Config_HostMapping struct { Type DomainMatchingType `protobuf:"varint,1,opt,name=type,proto3,enum=xray.app.dns.DomainMatchingType" json:"type,omitempty"` Domain string `protobuf:"bytes,2,opt,name=domain,proto3" json:"domain,omitempty"` Ip [][]byte `protobuf:"bytes,3,rep,name=ip,proto3" json:"ip,omitempty"` // ProxiedDomain indicates the mapped domain has the same IP address on this // domain. Xray will use this domain for IP queries. ProxiedDomain string `protobuf:"bytes,4,opt,name=proxied_domain,json=proxiedDomain,proto3" json:"proxied_domain,omitempty"` // contains filtered or unexported fields }
func (*Config_HostMapping) Descriptor
deprecated
func (*Config_HostMapping) Descriptor() ([]byte, []int)
Deprecated: Use Config_HostMapping.ProtoReflect.Descriptor instead.
func (*Config_HostMapping) GetDomain ¶
func (x *Config_HostMapping) GetDomain() string
func (*Config_HostMapping) GetIp ¶
func (x *Config_HostMapping) GetIp() [][]byte
func (*Config_HostMapping) GetProxiedDomain ¶
func (x *Config_HostMapping) GetProxiedDomain() string
func (*Config_HostMapping) GetType ¶
func (x *Config_HostMapping) GetType() DomainMatchingType
func (*Config_HostMapping) ProtoMessage ¶
func (*Config_HostMapping) ProtoMessage()
func (*Config_HostMapping) ProtoReflect ¶
func (x *Config_HostMapping) ProtoReflect() protoreflect.Message
func (*Config_HostMapping) Reset ¶
func (x *Config_HostMapping) Reset()
func (*Config_HostMapping) String ¶
func (x *Config_HostMapping) String() string
type DNS ¶
DNS is a DNS rely server.
func (*DNS) GetIPOption ¶
GetIPOption implements ClientWithIPOption.
func (*DNS) LookupHosts ¶
LookupHosts implements dns.HostsLookup.
func (*DNS) SetFakeDNSOption ¶
SetFakeDNSOption implements ClientWithIPOption.
func (*DNS) SetQueryOption ¶
SetQueryOption implements ClientWithIPOption.
type DoHNameServer ¶
DoHNameServer implemented DNS over HTTPS (RFC8484) Wire Format, which is compatible with traditional dns over udp(RFC1035), thus most of the DOH implementation is copied from udpns.go
func NewDoHLocalNameServer ¶
func NewDoHLocalNameServer(url *url.URL) *DoHNameServer
NewDoHLocalNameServer creates DOH client object for local resolving
func NewDoHNameServer ¶
func NewDoHNameServer(url *url.URL, dispatcher routing.Dispatcher) (*DoHNameServer, error)
NewDoHNameServer creates DOH server object for remote resolving.
func (*DoHNameServer) Cleanup ¶
func (s *DoHNameServer) Cleanup() error
Cleanup clears expired items from cache
type DomainMatcherInfo ¶
type DomainMatcherInfo struct {
// contains filtered or unexported fields
}
DomainMatcherInfo contains information attached to index returned by Server.domainMatcher
type DomainMatchingType ¶
type DomainMatchingType int32
const ( DomainMatchingType_Full DomainMatchingType = 0 DomainMatchingType_Subdomain DomainMatchingType = 1 DomainMatchingType_Keyword DomainMatchingType = 2 DomainMatchingType_Regex DomainMatchingType = 3 )
func (DomainMatchingType) Descriptor ¶
func (DomainMatchingType) Descriptor() protoreflect.EnumDescriptor
func (DomainMatchingType) Enum ¶
func (x DomainMatchingType) Enum() *DomainMatchingType
func (DomainMatchingType) EnumDescriptor
deprecated
func (DomainMatchingType) EnumDescriptor() ([]byte, []int)
Deprecated: Use DomainMatchingType.Descriptor instead.
func (DomainMatchingType) Number ¶
func (x DomainMatchingType) Number() protoreflect.EnumNumber
func (DomainMatchingType) String ¶
func (x DomainMatchingType) String() string
func (DomainMatchingType) Type ¶
func (DomainMatchingType) Type() protoreflect.EnumType
type FakeDNSServer ¶
type FakeDNSServer struct {
// contains filtered or unexported fields
}
func NewFakeDNSServer ¶
func NewFakeDNSServer() *FakeDNSServer
func (FakeDNSServer) Name ¶
func (FakeDNSServer) Name() string
type LocalNameServer ¶
type LocalNameServer struct {
// contains filtered or unexported fields
}
LocalNameServer is an wrapper over local DNS feature.
func NewLocalNameServer ¶
func NewLocalNameServer() *LocalNameServer
NewLocalNameServer creates localdns server object for directly lookup in system DNS.
type NameServer ¶
type NameServer struct { Address *net.Endpoint `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"` ClientIp []byte `protobuf:"bytes,5,opt,name=client_ip,json=clientIp,proto3" json:"client_ip,omitempty"` SkipFallback bool `protobuf:"varint,6,opt,name=skipFallback,proto3" json:"skipFallback,omitempty"` PrioritizedDomain []*NameServer_PriorityDomain `protobuf:"bytes,2,rep,name=prioritized_domain,json=prioritizedDomain,proto3" json:"prioritized_domain,omitempty"` Geoip []*router.GeoIP `protobuf:"bytes,3,rep,name=geoip,proto3" json:"geoip,omitempty"` OriginalRules []*NameServer_OriginalRule `protobuf:"bytes,4,rep,name=original_rules,json=originalRules,proto3" json:"original_rules,omitempty"` // contains filtered or unexported fields }
func (*NameServer) Descriptor
deprecated
func (*NameServer) Descriptor() ([]byte, []int)
Deprecated: Use NameServer.ProtoReflect.Descriptor instead.
func (*NameServer) GetAddress ¶
func (x *NameServer) GetAddress() *net.Endpoint
func (*NameServer) GetClientIp ¶
func (x *NameServer) GetClientIp() []byte
func (*NameServer) GetGeoip ¶
func (x *NameServer) GetGeoip() []*router.GeoIP
func (*NameServer) GetOriginalRules ¶
func (x *NameServer) GetOriginalRules() []*NameServer_OriginalRule
func (*NameServer) GetPrioritizedDomain ¶
func (x *NameServer) GetPrioritizedDomain() []*NameServer_PriorityDomain
func (*NameServer) GetSkipFallback ¶
func (x *NameServer) GetSkipFallback() bool
func (*NameServer) ProtoMessage ¶
func (*NameServer) ProtoMessage()
func (*NameServer) ProtoReflect ¶
func (x *NameServer) ProtoReflect() protoreflect.Message
func (*NameServer) Reset ¶
func (x *NameServer) Reset()
func (*NameServer) String ¶
func (x *NameServer) String() string
type NameServer_OriginalRule ¶
type NameServer_OriginalRule struct { Rule string `protobuf:"bytes,1,opt,name=rule,proto3" json:"rule,omitempty"` Size uint32 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"` // contains filtered or unexported fields }
func (*NameServer_OriginalRule) Descriptor
deprecated
func (*NameServer_OriginalRule) Descriptor() ([]byte, []int)
Deprecated: Use NameServer_OriginalRule.ProtoReflect.Descriptor instead.
func (*NameServer_OriginalRule) GetRule ¶
func (x *NameServer_OriginalRule) GetRule() string
func (*NameServer_OriginalRule) GetSize ¶
func (x *NameServer_OriginalRule) GetSize() uint32
func (*NameServer_OriginalRule) ProtoMessage ¶
func (*NameServer_OriginalRule) ProtoMessage()
func (*NameServer_OriginalRule) ProtoReflect ¶
func (x *NameServer_OriginalRule) ProtoReflect() protoreflect.Message
func (*NameServer_OriginalRule) Reset ¶
func (x *NameServer_OriginalRule) Reset()
func (*NameServer_OriginalRule) String ¶
func (x *NameServer_OriginalRule) String() string
type NameServer_PriorityDomain ¶
type NameServer_PriorityDomain struct { Type DomainMatchingType `protobuf:"varint,1,opt,name=type,proto3,enum=xray.app.dns.DomainMatchingType" json:"type,omitempty"` Domain string `protobuf:"bytes,2,opt,name=domain,proto3" json:"domain,omitempty"` // contains filtered or unexported fields }
func (*NameServer_PriorityDomain) Descriptor
deprecated
func (*NameServer_PriorityDomain) Descriptor() ([]byte, []int)
Deprecated: Use NameServer_PriorityDomain.ProtoReflect.Descriptor instead.
func (*NameServer_PriorityDomain) GetDomain ¶
func (x *NameServer_PriorityDomain) GetDomain() string
func (*NameServer_PriorityDomain) GetType ¶
func (x *NameServer_PriorityDomain) GetType() DomainMatchingType
func (*NameServer_PriorityDomain) ProtoMessage ¶
func (*NameServer_PriorityDomain) ProtoMessage()
func (*NameServer_PriorityDomain) ProtoReflect ¶
func (x *NameServer_PriorityDomain) ProtoReflect() protoreflect.Message
func (*NameServer_PriorityDomain) Reset ¶
func (x *NameServer_PriorityDomain) Reset()
func (*NameServer_PriorityDomain) String ¶
func (x *NameServer_PriorityDomain) String() string
type QUICNameServer ¶
QUICNameServer implemented DNS over QUIC
func NewQUICNameServer ¶
func NewQUICNameServer(url *url.URL) (*QUICNameServer, error)
NewQUICNameServer creates DNS-over-QUIC client object for local resolving
func (*QUICNameServer) Cleanup ¶
func (s *QUICNameServer) Cleanup() error
Cleanup clears expired items from cache
type QueryStrategy ¶
type QueryStrategy int32
const ( QueryStrategy_USE_IP QueryStrategy = 0 QueryStrategy_USE_IP4 QueryStrategy = 1 QueryStrategy_USE_IP6 QueryStrategy = 2 )
func (QueryStrategy) Descriptor ¶
func (QueryStrategy) Descriptor() protoreflect.EnumDescriptor
func (QueryStrategy) Enum ¶
func (x QueryStrategy) Enum() *QueryStrategy
func (QueryStrategy) EnumDescriptor
deprecated
func (QueryStrategy) EnumDescriptor() ([]byte, []int)
Deprecated: Use QueryStrategy.Descriptor instead.
func (QueryStrategy) Number ¶
func (x QueryStrategy) Number() protoreflect.EnumNumber
func (QueryStrategy) String ¶
func (x QueryStrategy) String() string
func (QueryStrategy) Type ¶
func (QueryStrategy) Type() protoreflect.EnumType
type Server ¶
type Server interface { // Name of the Client. Name() string // QueryIP sends IP queries to its configured server. QueryIP(ctx context.Context, domain string, clientIP net.IP, option dns.IPOption, disableCache bool) ([]net.IP, error) }
Server is the interface for Name Server.
func NewServer ¶
func NewServer(dest net.Destination, dispatcher routing.Dispatcher) (Server, error)
NewServer creates a name server object according to the network destination url.
type StaticHosts ¶
type StaticHosts struct {
// contains filtered or unexported fields
}
StaticHosts represents static domain-ip mapping in DNS server.
func NewStaticHosts ¶
func NewStaticHosts(hosts []*Config_HostMapping, legacy map[string]*net.IPOrDomain) (*StaticHosts, error)
NewStaticHosts creates a new StaticHosts instance.
type TCPNameServer ¶
TCPNameServer implemented DNS over TCP (RFC7766).
func NewTCPLocalNameServer ¶
func NewTCPLocalNameServer(url *url.URL) (*TCPNameServer, error)
NewTCPLocalNameServer creates DNS over TCP client object for local resolving
func NewTCPNameServer ¶
func NewTCPNameServer(url *url.URL, dispatcher routing.Dispatcher) (*TCPNameServer, error)
NewTCPNameServer creates DNS over TCP server object for remote resolving.
func (*TCPNameServer) Cleanup ¶
func (s *TCPNameServer) Cleanup() error
Cleanup clears expired items from cache