fireness

README

fireness

Network development helper.

Installation

go get -u github.com/coolstina/fireness

Features

DomainParse(DNS)

The IP address that is used to resolve the domain name to which it is mapped.

ClientIP

Get the http request X-Real-IP or X-Forwarded-For IP address.

IP detection

• IsIP: Check whether the IP address is real ip.
• IsIPv4: Check whether the IP address is IPv4.
• IsIPv6: Check whether the IP address is real ip.
• Localhost: Get localhost IP list.

IP conversion

• IPv4ToInt: Convert IPv4 address string to integer.
• IntToIPv4: Convert IP integer to IPv4 address string.

License

• Apache License.

Author

• @helloshaohua

Documentation

Index

• Variables
• func BigIntToIPv6(ipaddr *big.Int) net.IP
• func ClientIP(req *http.Request) (string, error)
• func IPv4ToInt(ip string) uint32
• func IPv6ToBigInt(ip net.IP) *big.Int
• func IntToIPv4(ip uint32) string
• func IsIP(addr string) bool
• func IsIPv4(addr string) bool
• func IsIPv6(addr string) bool
• type DomainParsed
  • func DomainParse(domain string) (*DomainParsed, error)
  • func NewDomainParsedWithOriginal(domain string) *DomainParsed
  • func (d *DomainParsed) FirstIP() string
  • func (d *DomainParsed) IPv4s() IPList
  • func (d *DomainParsed) IPv6s() IPList
  • func (d *DomainParsed) String() string
• type IPList
  • func (iplist IPList) IsEmpty() bool
  • func (iplist IPList) IsNil() bool
• type LocalhostList
  • func Localhost(options ...LocalhostOption) (LocalhostList, error)
  • func (list LocalhostList) First() string
• type LocalhostOption
  • func WithLocalhostExclude(excludes ...string) LocalhostOption
  • func WithLocalhostExcludeIPv4(exclude bool) LocalhostOption
  • func WithLocalhostExcludeIPv6(exclude bool) LocalhostOption
• type LocalhostOptionFunc

Variables

var ErrDomainParse = fmt.Errorf("domain parse failed")

var ErrNotfoundClientIP = fmt.Errorf("not found client ip")

Functions

func BigIntToIPv6

func BigIntToIPv6(ipaddr *big.Int) net.IP

BigIntToIPv6 Convert IP address of version 6 from big integer to net.IP.

func ClientIP

func ClientIP(req *http.Request) (string, error)

func IPv4ToInt

func IPv4ToInt(ip string) uint32

IPv4ToInt Convert IPv4 address string to integer.

func IPv6ToBigInt

func IPv6ToBigInt(ip net.IP) *big.Int

IPv6ToBigInt Convert IPv6 address string to integer.

func IntToIPv4

func IntToIPv4(ip uint32) string

IntToIPv4 Convert IP integer to IPv4 address string.

func IsIP

func IsIP(addr string) bool

IsIP Check whether the IP address is real ip.

func IsIPv4

func IsIPv4(addr string) bool

IsIPv4 Check whether the IP address is IPv4.

func IsIPv6

func IsIPv6(addr string) bool

IsIPv6 Check whether the IP address is IPv6.

Types

type DomainParsed

type DomainParsed struct {
	Original string `json:"original"`
	IPS      IPList `json:"ips"`
}

DomainParsed parsed domain result structure definition.

func DomainParse

func DomainParse(domain string) (*DomainParsed, error)

DomainParse parse domain to IP address.

func NewDomainParsedWithOriginal

func NewDomainParsedWithOriginal(domain string) *DomainParsed

NewDomainParsedWithOriginal returns a new DomainParsed instance with original domain string.

func (*DomainParsed) FirstIP

func (d *DomainParsed) FirstIP() string

FirstIP returns the IPS list first IP address.

func (*DomainParsed) IPv4s

func (d *DomainParsed) IPv4s() IPList

IPv4s returns an IPv4 list.

func (*DomainParsed) IPv6s

func (d *DomainParsed) IPv6s() IPList

IPv6s returns an IPv6 list.

func (*DomainParsed) String

func (d *DomainParsed) String() string

String implement Stringer interface.

type IPList

type IPList []string

IPList IP list structure definition.

func (IPList) IsEmpty

func (iplist IPList) IsEmpty() bool

IsEmpty detect IP list is empty.

func (IPList) IsNil

func (iplist IPList) IsNil() bool

IsNil detect IP list is nil.

type LocalhostList

type LocalhostList []string

LocalhostList localhost IP list structure definition.

func Localhost

func Localhost(options ...LocalhostOption) (LocalhostList, error)

Localhost Get localhost IP list.

func (LocalhostList) First

func (list LocalhostList) First() string

First returns localhost IP list first element.

type LocalhostOption

type LocalhostOption interface {
	// contains filtered or unexported methods
}

LocalhostOption implement Option model.

func WithLocalhostExclude

func WithLocalhostExclude(excludes ...string) LocalhostOption

WithLocalhostExclude Get IP list exclude specify IP.

func WithLocalhostExcludeIPv4

func WithLocalhostExcludeIPv4(exclude bool) LocalhostOption

WithLocalhostExcludeIPv4 Get IP list exclude IPv4 address.

func WithLocalhostExcludeIPv6

func WithLocalhostExcludeIPv6(exclude bool) LocalhostOption

WithLocalhostExcludeIPv6 Get IP list exclude IPv6 address.

type LocalhostOptionFunc

type LocalhostOptionFunc func(option *localhostOption)

LocalhostOptionFunc Options function structure.