fastdialer

Documentation

Overview

fastdialer is a dialer package containing a dns/tls cache layer

Index

• Constants
• Variables
• func AsTLSConfig(ztlsConfig *ztls.Config) (*tls.Config, error)
• func AsZTLSConfig(tlsConfig *tls.Config) (*ztls.Config, error)
• func HandleResolverLine(raw string) (ip string)
• func IsTLS13(config interface{}) bool
• type CacheType
• type ContextOption
• type Dialer
  • func NewDialer(options Options) (*Dialer, error)
  • func (d *Dialer) Close()
  • func (d *Dialer) Dial(ctx context.Context, network, address string) (conn net.Conn, err error)
  • func (d *Dialer) DialTLS(ctx context.Context, network, address string) (conn net.Conn, err error)
  • func (d *Dialer) DialTLSWithConfig(ctx context.Context, network, address string, config *tls.Config) (conn net.Conn, err error)
  • func (d *Dialer) DialTLSWithConfigImpersonate(ctx context.Context, network, address string, config *tls.Config, ...) (conn net.Conn, err error)
  • func (d *Dialer) DialZTLS(ctx context.Context, network, address string) (conn net.Conn, err error)
  • func (d *Dialer) DialZTLSWithConfig(ctx context.Context, network, address string, config *ztls.Config) (conn net.Conn, err error)
  • func (d *Dialer) GetDNSData(hostname string) (*retryabledns.DNSData, error)
  • func (d *Dialer) GetDNSDataFromCache(hostname string) (*retryabledns.DNSData, error)
  • func (d *Dialer) GetDialedIP(hostname string) string
  • func (d *Dialer) GetTLSData(hostname string) (*cryptoutil.TLSData, error)
• type DiskDBType
• type Options

Constants

const ResolverFilePath = "/etc/resolv.conf"

ResolverFilePath in unix file os

Variables

var (
	MaxDNSCacheSize  int64
	MaxDNSItems      = 1024
	MaxDialCacheSize = 10000
)

option to disable ztls fallback in case of handshake error reads from env variable DISABLE_ZTLS_FALLBACK

var (
	CouldNotConnectError  = errkit.New("could not connect to any address found for host").SetKind(errkit.ErrKindNetworkPermanent)
	NoAddressFoundError   = errkit.New("no address found for host").SetKind(errkit.ErrKindNetworkPermanent)
	NoAddressAllowedError = errkit.New("denied address found for host").SetKind(errkit.ErrKindNetworkPermanent)
	NoPortSpecifiedError  = errkit.New("port was not specified").SetKind(errkit.ErrKindNetworkPermanent)
	MalformedIP6Error     = errkit.New("malformed IPv6 address").SetKind(errkit.ErrKindNetworkPermanent)
	ResolveHostError      = errkit.New("could not resolve host").SetKind(errkit.ErrKindNetworkPermanent)
	NoTLSHistoryError     = errkit.New("no tls data history available")
	NoTLSDataError        = errkit.New("no tls data found for the key")
	NoDNSDataError        = errkit.New("no data found")
	AsciiConversionError  = errkit.New("could not convert hostname to ASCII")
	ErrDialTimeout        = errkit.New("dial timeout").SetKind(errkit.ErrKindNetworkTemporary)
)

var DefaultOptions = Options{
	BaseResolvers:   DefaultResolvers,
	MaxRetries:      5,
	HostsFile:       true,
	ResolversFile:   true,
	CacheType:       Disk,
	DialerTimeout:   10 * time.Second,
	DialerKeepAlive: 10 * time.Second,
}

DefaultOptions of the cache

var DefaultResolvers = []string{
	"1.1.1.1:53",
	"1.0.0.1:53",
	"8.8.8.8:53",
	"8.8.4.4:53",
}

DefaultResolvers trusted

var (
	MaxResolverEntries = 4096
)

Functions

func AsTLSConfig

func AsTLSConfig(ztlsConfig *ztls.Config) (*tls.Config, error)

func AsZTLSConfig

func AsZTLSConfig(tlsConfig *tls.Config) (*ztls.Config, error)

func HandleResolverLine

func HandleResolverLine(raw string) (ip string)

HandleLine a resolver file line

func IsTLS13

func IsTLS13(config interface{}) bool

Types

type CacheType

type CacheType uint8

const (
	Memory CacheType = iota
	Disk
	Hybrid
)

type ContextOption

type ContextOption string

const (
	// SniName to use in tls connection
	SniName ContextOption = "sni-name"
	IP      ContextOption = "ip"
)

type Dialer

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

Dialer structure containing data information

func NewDialer

func NewDialer(options Options) (*Dialer, error)

NewDialer instance

func (*Dialer) Close

func (d *Dialer) Close()

Close instance and cleanups

func (*Dialer) Dial

func (d *Dialer) Dial(ctx context.Context, network, address string) (conn net.Conn, err error)

Dial function compatible with net/http

func (*Dialer) DialTLS

func (d *Dialer) DialTLS(ctx context.Context, network, address string) (conn net.Conn, err error)

DialTLS with encrypted connection

func (*Dialer) DialTLSWithConfig

func (d *Dialer) DialTLSWithConfig(ctx context.Context, network, address string, config *tls.Config) (conn net.Conn, err error)

DialTLS with encrypted connection

func (*Dialer) DialTLSWithConfigImpersonate

func (d *Dialer) DialTLSWithConfigImpersonate(ctx context.Context, network, address string, config *tls.Config, impersonate impersonate.Strategy, identity *impersonate.Identity) (conn net.Conn, err error)

DialTLSWithConfigImpersonate dials tls with impersonation

func (*Dialer) DialZTLS

func (d *Dialer) DialZTLS(ctx context.Context, network, address string) (conn net.Conn, err error)

DialZTLS with encrypted connection using ztls

func (*Dialer) DialZTLSWithConfig

func (d *Dialer) DialZTLSWithConfig(ctx context.Context, network, address string, config *ztls.Config) (conn net.Conn, err error)

DialZTLSWithConfig dials ztls with config

func (*Dialer) GetDNSData

func (d *Dialer) GetDNSData(hostname string) (*retryabledns.DNSData, error)

GetDNSData for the given hostname

func (*Dialer) GetDNSDataFromCache

func (d *Dialer) GetDNSDataFromCache(hostname string) (*retryabledns.DNSData, error)

GetDNSDataFromCache cached by the resolver

func (*Dialer) GetDialedIP

func (d *Dialer) GetDialedIP(hostname string) string

GetDialedIP returns the ip dialed by the HTTP client

func (*Dialer) GetTLSData

func (d *Dialer) GetTLSData(hostname string) (*cryptoutil.TLSData, error)

GetTLSData returns the tls data for a hostname

type DiskDBType

type DiskDBType uint8

const (
	LevelDB DiskDBType = iota
	Pogreb
)

type Options

type Options struct {
	BaseResolvers            []string
	MaxRetries               int
	HostsFile                bool
	ResolversFile            bool
	EnableFallback           bool
	Allow                    []string
	Deny                     []string
	AllowSchemeList          []string
	DenySchemeList           []string
	AllowPortList            []int
	DenyPortList             []int
	CacheType                CacheType
	CacheMemoryMaxItems      int // used by Memory cache type
	DiskDbType               DiskDBType
	WithDialerHistory        bool
	WithCleanup              bool
	WithTLSData              bool
	DialerTimeout            time.Duration
	DialerKeepAlive          time.Duration
	Dialer                   *net.Dialer
	ProxyDialer              *proxy.Dialer
	WithZTLS                 bool
	SNIName                  string
	OnBeforeDial             func(hostname, IP, port string)
	OnInvalidTarget          func(hostname, IP, port string)
	OnDialCallback           func(hostname, IP string)
	DisableZtlsFallback      bool
	WithNetworkPolicyOptions *networkpolicy.Options
	Logger                   *log.Logger // optional logger to log errors(like hostfile init error)
}