hibp

Documentation

Index

• type Breach
  • func (br *Breach) BreachDate() (time.Time, error)
• type Settings
  • func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings
  • func (sett *Settings) HasSince() bool
  • func (sett *Settings) SinceDate() (time.Time, error)
• type Status
  • func NewStatus(acct string, breaches []Breach) *Status
  • func (stat *Status) HasBeenCompromised() bool
  • func (stat *Status) Len() int
• type Widget
  • func NewWidget(tviewApp *tview.Application, redrawChan chan bool, settings *Settings) *Widget
  • func (widget *Widget) Fetch(accounts []string) ([]*Status, error)
  • func (widget *Widget) Refresh()

Types

type Breach

type Breach struct {
	Date string `json:"BreachDate"`
	Name string `json:"Name"`
}

Breach represents a breach in the HIBP system

func (*Breach) BreachDate

func (br *Breach) BreachDate() (time.Time, error)

BreachDate returns the date of the breach

type Settings

type Settings struct {
	*cfg.Common
	// contains filtered or unexported fields
}

Settings defines the configuration properties for this module

func NewSettingsFromYAML

func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings

NewSettingsFromYAML creates a new settings instance from a YAML config block

func (*Settings) HasSince

func (sett *Settings) HasSince() bool

HasSince returns TRUE if there's a valid "since" value setting, FALSE if there is not

func (*Settings) SinceDate

func (sett *Settings) SinceDate() (time.Time, error)

SinceDate returns the "since" settings as a proper Time instance

type Status

type Status struct {
	Account  string
	Breaches []Breach
}

Status represents the status of an account in the HIBP system

func NewStatus

func NewStatus(acct string, breaches []Breach) *Status

NewStatus creates and returns an instance of Status

func (*Status) HasBeenCompromised

func (stat *Status) HasBeenCompromised() bool

HasBeenCompromised returns TRUE if the specified account has any breaches associated with it, FALSE if no breaches are associated with it

func (*Status) Len

func (stat *Status) Len() int

Len returns the number of breaches found for the specified account

type Widget

type Widget struct {
	view.TextWidget
	// contains filtered or unexported fields
}

Widget is the container for hibp data

func NewWidget

func NewWidget(tviewApp *tview.Application, redrawChan chan bool, settings *Settings) *Widget

NewWidget creates a new instance of a widget

func (*Widget) Fetch

func (widget *Widget) Fetch(accounts []string) ([]*Status, error)

Fetch retrieves HIBP data from the HIBP API

func (*Widget) Refresh

func (widget *Widget) Refresh()

Refresh updates the data for this widget and displays it onscreen