check

Documentation

Overview

Package check defines how to check an IP address. It provides types and functions that are useful when writing checks.

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 */}

DefaultHttpClient is reused by checks that make HTTP requests.

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

Na returns "n/a" if s is empty.

func NonEmpty

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

NonEmpty returns strings that are not empty.

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)

Check checks an IP address providing generic and/or security information.

type EmptyInfo

type EmptyInfo struct {
}

EmptyInfo is returned by checks that don't provide generic information about an IP address.

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
}

Error is an error returned by a check.

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)
}

Info is some generic information provided by an Info check.

type Result

type Result struct {
	Name            string // check name
	Type            Type   // check type
	Info            Info   // provided by Info check
	IPaddrMalicious bool   // provided by Sec check
}

Result is the results of a check.

type Type

type Type string

Type is the type of a check.

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