provider

Documentation

Overview

Package provider implements protocols to detect public IP addresses.

Index

• func Name(p Provider) string
• type Provider
  • func MustNewCustom(rawURL string) Provider
  • func NewCloudflareDOH() Provider
  • func NewCloudflareTrace() Provider
  • func NewCustom(ppfmt pp.PP, rawURL string) (Provider, bool)
  • func NewIpify() Provider
  • func NewLocal() Provider

Functions

func Name

func Name(p Provider) string

Name gets the protocol name. It returns "none" for nil.

Types

type Provider

type Provider interface {
	Name() string

	ShouldWeCheck1111() bool

	GetIP(ctx context.Context, ppfmt pp.PP, ipNet ipnet.Type, use1001 bool) (netip.Addr, bool)
}

Provider is the abstraction of a protocol to detect public IP addresses.

func MustNewCustom

func MustNewCustom(rawURL string) Provider

MustNewCustom creates a HTTP provider and panics if it fails.

func NewCloudflareDOH

func NewCloudflareDOH() Provider

NewCloudflareDOH creates a new provider that queries whoami.cloudflare. via Cloudflare DNS over HTTPS. If use1001 is true, 1.0.0.1 is used instead of 1.1.1.1.

func NewCloudflareTrace

func NewCloudflareTrace() Provider

NewCloudflareTrace creates a specialized CloudflareTrace provider that parses https://1.1.1.1/cdn-cgi/trace. If use1001 is true, 1.0.0.1 is used instead of 1.1.1.1.

func NewCustom

func NewCustom(ppfmt pp.PP, rawURL string) (Provider, bool)

NewCustom creates a HTTP provider.

func NewIpify

func NewIpify() Provider

NewIpify creates a specialized HTTP provider that uses the ipify service.

func NewLocal

func NewLocal() Provider

NewLocal creates a specialized Local provider that uses Cloudflare as the remote server. (No actual UDP packets will be sent to Cloudflare.)