check

Documentation

Overview

Package check checks an IP address using various public services.

Index

• Variables
• func GetConfigValue(key string) (string, error)
• func Na(s string) string
• func NonEmpty(strings ...string) []string
• func UpdateFile(file, url string, compressFmt string) error
• type Check
• type EmptyInfo
  • func (EmptyInfo) JsonString() (string, error)
  • func (EmptyInfo) String() string
• type Error
  • func NewError(err error) *Error
  • func (e *Error) Error() string
• type HttpClient
  • func (c HttpClient) Get(apiUrl string, headers map[string]string, queryParams map[string]string) ([]byte, error)
  • func (c HttpClient) GetJson(apiUrl string, headers map[string]string, queryParams map[string]string, ...) error
• type Info
• type Result
• type Type

Variables

var DefaultHttpClient = HttpClient{/* contains filtered or unexported fields */}

Functions

func GetConfigValue

func GetConfigValue(key string) (string, error)

GetConfigValue tries to get value for key first from an environment variable then from a configuration file at $HOME/.checkip.yaml

func Na

func Na(s string) string

func NonEmpty

func NonEmpty(strings ...string) []string

func UpdateFile

func UpdateFile(file, url string, compressFmt string) error

UpdateFile updates file from url if the file is older than a week. If file does not exist it downloads and creates it. compressFmt is the compression format of the file to download; gz or tgz. Empty string means no compression.

Types

type Check

type Check func(ipaddr net.IP) (Result, error)

type EmptyInfo

type EmptyInfo struct {
}

func (EmptyInfo) JsonString

func (EmptyInfo) JsonString() (string, error)

func (EmptyInfo) String

func (EmptyInfo) String() string

type Error

type Error struct {
	ErrString string `json:"error"`
	// contains filtered or unexported fields
}

func NewError

func NewError(err error) *Error

func (*Error) Error

func (e *Error) Error() string

type HttpClient

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

func (HttpClient) Get

func (c HttpClient) Get(apiUrl string, headers map[string]string, queryParams map[string]string) ([]byte, error)

func (HttpClient) GetJson

func (c HttpClient) GetJson(apiUrl string, headers map[string]string, queryParams map[string]string, response interface{}) error

type Info

type Info interface {
	String() string
	JsonString() (string, error)
}

type Result

type Result struct {
	Name            string
	Type            Type
	IPaddrMalicious bool
	Info            Info
}

type Type

type Type string

const (
	TypeInfo    Type = "Info" // provides some useful information about the IP address
	TypeSec     Type = "Sec"  // says whether the IP address is considered malicious
	TypeInfoSec Type = "InfoSec"
)