zannotate

type Annotator interface {
	Initialize() error
	Annotate(ip net.IP) interface{}
	GetFieldName() string
	Close() error
}

type AnnotatorFactory interface {
	Initialize(c *GlobalConf) error
	AddFlags(flags *flag.FlagSet)
	GetWorkers() int
	IsEnabled() bool
	MakeAnnotator(i int) Annotator
	Close() error
}

type BasePluginConf struct {
	Threads int
	Enabled bool
}

type GeoIP2Annotator struct {
	Factory *GeoIP2AnnotatorFactory
	Reader  *geoip2.Reader
	Id      int
}

type GeoIP2AnnotatorFactory struct {
	BasePluginConf
	Path       string
	Mode       string
	Language   string
	RawInclude string

	Conf *GlobalConf
	// what data to include
	IncludeCity               bool
	IncludeCountry            bool
	IncludeContinent          bool
	IncludePostal             bool
	IncludeLatLong            bool
	IncludeTraits             bool
	IncludeSubdivisions       bool
	IncludeRepresentedCountry bool
	IncludeRegisteredCountry  bool
}

type GeoIP2City struct {
	Name      string `json:"name,omitempty"`
	GeoNameId uint   `json:"id,omitempty"`
}

type GeoIP2Country struct {
	Name      string `json:"name,omitempty"`
	Code      string `json:"code,omitempty"`
	GeoNameId uint   `json:"id,omitempty"`
}

type GeoIP2LatLong struct {
	AccuracyRadius uint16  `json:"accuracy_radius,omitempty"`
	Latitude       float64 `json:"latitude,omitempty"`
	Longitude      float64 `json:"longitude,omitempty"`
	MetroCode      uint    `json:"metro_code,omitempty"`
	TimeZone       string  `json:"time_zone,omitempty"`
}

type GeoIP2Output struct {
	City               *GeoIP2City    `json:"city,omitempty"`
	Country            *GeoIP2Country `json:"country,omitempty"`
	Continent          *GeoIP2Country `json:"continent,omitempty"`
	Postal             *GeoIP2Postal  `json:"postal,omitempty"`
	LatLong            *GeoIP2LatLong `json:"latlong,omitempty"`
	RepresentedCountry *GeoIP2Country `json:"represented_country,omitempty"`
	RegisteredCountry  *GeoIP2Country `json:"registered_country,omitempty"`
	Traits             *GeoIP2Traits  `json:"metadata,omitempty"`
}

type GeoIP2Postal struct {
	Code string `json:"code,omitempty"`
}

type GeoIP2Traits struct {
	IsAnonymousProxy    bool `json:"is_anonymous_proxy,omitempty"`
	IsSatelliteProvider bool `json:"is_satellite_provider,omitempty"`
}

type GeoIPASNAnnotator struct {
	Factory *GeoIPASNAnnotatorFactory
	Reader  *geoip2.Reader
	Id      int
}

type GeoIPASNAnnotatorFactory struct {
	BasePluginConf
	Path string
	Mode string
}

type GeoIPASNOutput struct {
	ASN    uint   `json:"asn,omitempty"`
	ASNOrg string `json:"org,omitempty"`
}

type GlobalConf struct {
	InputFilePath           string
	InputFileType           string
	OutputFilePath          string
	MetadataFilePath        string
	LogFilePath             string
	Verbosity               int
	Threads                 int
	JSONIPFieldName         string
	JSONAnnotationFieldName string
	InputDecodeThreads      int
	OutputEncodeThreads     int
}

type IPInfoAnnotator struct {
	Factory *IPInfoAnnotatorFactory
	Id      int
}

type IPInfoAnnotatorFactory struct {
	BasePluginConf
	DatabaseFilePath string
	// contains filtered or unexported fields
}

type IPInfoMMDBOutput struct {
	City              string `maxminddb:"city"`
	Region            string `maxminddb:"region"`
	RegionCode        string `maxminddb:"region_code"`
	Country           string `maxminddb:"country"`
	CountryCode       string `maxminddb:"country_code"`
	Continent         string `maxminddb:"continent"`
	ContinentCode     string `maxminddb:"continent_code"`
	Latitude          string `maxminddb:"latitude"`
	Longitude         string `maxminddb:"longitude"`
	Timezone          string `maxminddb:"timezone"`
	PostalCode        string `maxminddb:"postal_code"`
	DMACode           string `maxminddb:"dma_code"`
	GeonameID         string `maxminddb:"geoname_id"`  // GeoNames database identifier (if available).
	Radius            string `maxminddb:"radius"`      // Accuracy radius in kilometers (if available).
	GeoChanged        string `maxminddb:"geo_changed"` // Timestamp or flag indicating when the geolocation last changed (if available).
	ASN               string `maxminddb:"asn"`
	ASName            string `maxminddb:"as_name"`
	ASDomain          string `maxminddb:"as_domain"`
	ASType            string `maxminddb:"as_type"`
	ASChanged         string `maxminddb:"as_changed"`
	CarrierName       string `maxminddb:"carrier_name"` // Name of the mobile carrier (if available).
	MobileCountryCode string `maxminddb:"mcc"`
	MobileNetworkCode string `maxminddb:"mnc"`
	PrivacyName       string `maxminddb:"privacy_name"` // Specific name of the privacy or anonymization service detected (e.g., “NordVPN”).
	IsProxy           string `maxminddb:"is_proxy"`
	IsRelay           string `maxminddb:"is_relay"`     // Boolean flag indicating use of a general relay service
	IsTOR             string `maxminddb:"is_tor"`       // Whether the IP is a known TOR exit node.
	IsVPN             string `maxminddb:"is_vpn"`       // Flag indicating use of a VPN Service
	IsAnonymous       string `maxminddb:"is_anonymous"` // True if the IP is associated with VPN, proxy, Tor, or a relay service.
	IsAnycast         string `maxminddb:"is_anycast"`   // Whether the IP is using anycast routing.
	IsHosting         string `maxminddb:"is_hosting"`   // True if the IP address is an internet service hosting IP address
	IsMobile          string `maxminddb:"is_mobile"`    // True if the IP address is associated with a mobile network or carrier.
	IsSatellite       string `maxminddb:"is_satellite"` // True if the IP address is associated with a satellite connection
}

type IPInfoModuleOutput struct {
	City              string  `json:"city,omitempty"`
	Region            string  `json:"region,omitempty"`
	RegionCode        string  `json:"region_code,omitempty"`
	Country           string  `json:"country,omitempty"`
	CountryCode       string  `json:"country_code,omitempty"`
	Continent         string  `json:"continent,omitempty"`
	ContinentCode     string  `json:"continent_code,omitempty"`
	Latitude          float64 `json:"latitude,omitempty"`
	Longitude         float64 `json:"longitude,omitempty"`
	Timezone          string  `json:"timezone,omitempty"`
	PostalCode        string  `json:"postal_code,omitempty"`
	DMACode           string  `json:"dma_code,omitempty"`    // Nielsen Designated Market Area code (if available).
	GeonameID         uint64  `json:"geoname_id,omitempty"`  // GeoNames database identifier (if available).
	Radius            uint64  `json:"radius,omitempty"`      // Accuracy radius in kilometers (if available).
	GeoChanged        string  `json:"geo_changed,omitempty"` // Timestamp or flag indicating when the geolocation last changed (if available).
	ASN               string  `json:"asn,omitempty"`
	ASName            string  `json:"as_name,omitempty"`
	ASDomain          string  `json:"as_domain,omitempty"`
	ASType            string  `json:"as_type,omitempty"`
	ASChanged         string  `json:"as_changed,omitempty"`
	CarrierName       string  `json:"carrier_name,omitempty"` // Name of the mobile carrier (if available).
	MobileCountryCode string  `json:"mobile_country_code,omitempty"`
	MobileNetworkCode string  `json:"mobile_network_code,omitempty"`
	PrivacyName       string  `json:"privacy_name,omitempty"` // Specific name of the privacy or anonymization service detected (e.g., “NordVPN”).
	IsProxy           *bool   `json:"is_proxy,omitempty"`
	IsRelay           *bool   `json:"is_relay,omitempty"`     // Boolean flag indicating use of a general relay service
	IsTOR             *bool   `json:"is_tor,omitempty"`       // Whether the IP is a known TOR exit node.
	IsVPN             *bool   `json:"is_vpn,omitempty"`       // Flag indicating use of a VPN Service
	IsAnonymous       *bool   `json:"is_anonymous,omitempty"` // True if the IP is associated with VPN, proxy, Tor, or a relay service.
	IsAnycast         *bool   `json:"is_anycast,omitempty"`   // Whether the IP is using anycast routing.
	IsHosting         *bool   `json:"is_hosting,omitempty"`   // True if the IP address is an internet service hosting IP address
	IsMobile          *bool   `json:"is_mobile,omitempty"`    // True if the IP address is associated with a mobile network or carrier.
	IsSatellite       *bool   `json:"is_satellite,omitempty"` // True if the IP address is associated with a satellite connection
}

type RDNSAnnotator struct {
	Factory *RDNSAnnotatorFactory
	Id      int
	// contains filtered or unexported fields
}

type RDNSAnnotatorFactory struct {
	BasePluginConf
	RawResolvers string
	// contains filtered or unexported fields
}

type RDNSOutput struct {
	DomainNames []string `json:"domain_names,omitempty"`
}

type RoutingAnnotator struct {
	Factory *RoutingAnnotatorFactory

	Id int
	// contains filtered or unexported fields
}

type RoutingAnnotatorFactory struct {
	BasePluginConf
	RoutingTablePath string
	ASNamesPath      string
	ASDataPath       string
	// contains filtered or unexported fields
}