annotated

Documentation

Index

• Constants
• func LoadAnnotatedIPPrefixesFromPaths(paths []string, prefixesWithAnnotations PrefixesWithAnnotations) error
• func LoadFilePrefixesWithAnnotationsFromPath(path string, prefixesWithAnnotations map[netip.Prefix][]annotation) error
• func NewProviderClient(c session.Session) (providers.ProviderClient, error)
• func ReadAnnotatedPrefixesFromFile(l *slog.Logger, path string, ...) error
• type Annotated
• type HostSearchResult
• type PrefixesWithAnnotations
• type ProviderClient
  • func (c *ProviderClient) CreateTable(data []byte) (*table.Writer, error)
  • func (c *ProviderClient) Enabled() bool
  • func (c *ProviderClient) ExtractThreatIndicators(findRes []byte) (*providers.ThreatIndicators, error)
  • func (c *ProviderClient) FindHost() ([]byte, error)
  • func (c *ProviderClient) GetConfig() *session.Session
  • func (c *ProviderClient) Initialise() error
  • func (c *ProviderClient) Priority() *int32
  • func (c *ProviderClient) RateHostData(findRes []byte, ratingConfigJSON []byte) (providers.RateResult, error)
• type Repository
• type VersionedAnnotatedDoc
• type YamlPrefixAnnotationsRecords

Constants

const (
	ProviderName = "annotated"
	CacheTTL     = 5 * time.Minute
)

Functions

func LoadAnnotatedIPPrefixesFromPaths

func LoadAnnotatedIPPrefixesFromPaths(paths []string, prefixesWithAnnotations PrefixesWithAnnotations) error

func LoadFilePrefixesWithAnnotationsFromPath

func LoadFilePrefixesWithAnnotationsFromPath(path string, prefixesWithAnnotations map[netip.Prefix][]annotation) error

func NewProviderClient

func NewProviderClient(c session.Session) (providers.ProviderClient, error)

func ReadAnnotatedPrefixesFromFile

func ReadAnnotatedPrefixesFromFile(l *slog.Logger, path string, prefixesWithAnnotations map[netip.Prefix][]annotation) error

Types

type Annotated

type Annotated struct {
	Client *retryablehttp.Client
	Root   string
	Paths  []string
}

type HostSearchResult

type HostSearchResult map[netip.Prefix][]annotation

type PrefixesWithAnnotations

type PrefixesWithAnnotations map[netip.Prefix][]annotation

type ProviderClient

type ProviderClient struct {
	session.Session
}

func (*ProviderClient) CreateTable

func (c *ProviderClient) CreateTable(data []byte) (*table.Writer, error)

func (*ProviderClient) Enabled

func (c *ProviderClient) Enabled() bool

func (*ProviderClient) ExtractThreatIndicators

func (c *ProviderClient) ExtractThreatIndicators(findRes []byte) (*providers.ThreatIndicators, error)

func (*ProviderClient) FindHost

func (c *ProviderClient) FindHost() ([]byte, error)

func (*ProviderClient) GetConfig

func (c *ProviderClient) GetConfig() *session.Session

func (*ProviderClient) Initialise

func (c *ProviderClient) Initialise() error

func (*ProviderClient) Priority

func (c *ProviderClient) Priority() *int32

func (*ProviderClient) RateHostData

func (c *ProviderClient) RateHostData(findRes []byte, ratingConfigJSON []byte) (providers.RateResult, error)

type Repository

type Repository struct {
	URL         string   `toml:"url"`
	GitHubUser  string   `toml:"github_user"`
	GitHubToken string   `toml:"github_token"`
	Paths       []string `toml:"paths"`
	Patterns    []string `toml:"patterns"`
}

type VersionedAnnotatedDoc

type VersionedAnnotatedDoc struct {
	LastFetchedFromSource time.Time
	LastFetchededFromDB   time.Time
	Doc                   PrefixesWithAnnotations
}

type YamlPrefixAnnotationsRecords

type YamlPrefixAnnotationsRecords struct {
	Prefixes    []string         `yaml:"prefixes"`
	Annotations []yamlAnnotation `yaml:"annotations"`
}