ipisp

README

ipisp

ipisp provides a Go client for Team Cymru's IP-ASN mapping service. Basically, this library allows you to query an IP address' ISP and allocation information.

go get github.com/ammario/ipisp/v2

Features

• 0 external dependencies
• Bulk and single lookups
• Query ISP name, ASN, country, registry and CIDR range

Basic usage

Running

resp, err := ipisp.LookupIP(context.Background(), net.ParseIP("4.2.2.2"))
if err != nil {
    log.Fatalf("lookup: %v", err)
}
fmt.Printf("ISP: %s\n", resp.ISPName)

displays

ISP: LEVEL3, US

Documentation

Index

• Variables
• type ASN
  • func ParseASN(asn string) (ASN, error)
  • func (a ASN) String() string
• type BulkClient
  • func DialBulkClient(ctx context.Context) (*BulkClient, error)
  • func (c *BulkClient) Close() error
  • func (c *BulkClient) LookupASNs(asns ...ASN) ([]Response, error)
  • func (c *BulkClient) LookupIPs(ips ...net.IP) ([]Response, error)
• type Response
  • func LookupASN(ctx context.Context, asn ASN) (*Response, error)
  • func LookupIP(ctx context.Context, ip net.IP) (*Response, error)

Variables

var (
	ErrUnexpectedTokens = errors.New("an unexpect token was received while reading response")
)

Types

type ASN

type ASN int

ASN represents an Autonomous Systems Number. See https://en.wikipedia.org/wiki/Autonomous_system_(Internet).

func ParseASN

func ParseASN(asn string) (ASN, error)

ParseASN parses a string like `AS2341` into ASN `2341`.

func (ASN) String

func (a ASN) String() string

String represents an ASN like `5544“ as `AS5544`.`

type BulkClient

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

BulkClient uses the WHOIS service to conduct bulk lookups.

func DialBulkClient

func DialBulkClient(ctx context.Context) (*BulkClient, error)

DialBulkClient returns a connected WHOIS client. This client should be used for bulk lookups.

func (*BulkClient) Close

func (c *BulkClient) Close() error

func (*BulkClient) LookupASNs

func (c *BulkClient) LookupASNs(asns ...ASN) ([]Response, error)

LookupASNs looks up ASNs. Response IP and Range fields are zeroed

func (*BulkClient) LookupIPs

func (c *BulkClient) LookupIPs(ips ...net.IP) ([]Response, error)

type Response

type Response struct {
	IP          net.IP
	ASN         ASN
	ISPName     string
	Country     string
	Registry    string
	Range       *net.IPNet
	AllocatedAt time.Time
}

Response contains a response from Cymru.

func LookupASN

func LookupASN(ctx context.Context, asn ASN) (*Response, error)

func LookupIP

func LookupIP(ctx context.Context, ip net.IP) (*Response, error)

LookupIP looks up a single IP with the API. The service recommends that bulk lookups use the BulkClient out of respect for their server load.