-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0cbdb28
commit a921ff0
Showing
10 changed files
with
313 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,299 @@ | ||
| package ipapi | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "github.com/hashicorp/go-retryablehttp" | ||
| "log/slog" | ||
| "net/netip" | ||
| "os" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/jonhadfield/ipscout/providers" | ||
|
|
||
| "github.com/jedib0t/go-pretty/v6/table" | ||
| "github.com/jonhadfield/ipscout/cache" | ||
| "github.com/jonhadfield/ipscout/session" | ||
| ) | ||
|
|
||
| const ( | ||
| ProviderName = "ipapi" | ||
| MaxColumnWidth = 120 | ||
| IndentPipeHyphens = " |-----" | ||
| portLastModifiedFormat = "2006-01-02T15:04:05+07:00" | ||
| ResultTTL = 1 * time.Hour | ||
| apiDomain = "https://ipapi.co" | ||
| ) | ||
|
|
||
| type Client struct { | ||
| session.Session | ||
| } | ||
|
|
||
| type Config struct { | ||
| _ struct{} | ||
| session.Session | ||
| Host netip.Addr | ||
| APIKey string | ||
| } | ||
|
|
||
| func NewProviderClient(c session.Session) (providers.ProviderClient, error) { | ||
| c.Logger.Debug("creating ipapi client") | ||
|
|
||
| tc := Client{ | ||
| c, | ||
| } | ||
|
|
||
| return &tc, nil | ||
| } | ||
|
|
||
| type Provider interface { | ||
| LoadData() ([]byte, error) | ||
| CreateTable([]byte) (*table.Writer, error) | ||
| } | ||
|
|
||
| func (c *Client) Enabled() bool { | ||
| return c.Session.Providers.IPAPI.Enabled | ||
| } | ||
|
|
||
| func (c *Client) GetConfig() *session.Session { | ||
| return &c.Session | ||
| } | ||
|
|
||
| func (c *Client) Initialise() error { | ||
| if c.Session.Cache == nil { | ||
| return errors.New("cache not set") | ||
| } | ||
|
|
||
| start := time.Now() | ||
| defer func() { | ||
| c.Session.Stats.Mu.Lock() | ||
| c.Session.Stats.InitialiseDuration[ProviderName] = time.Since(start) | ||
| c.Session.Stats.Mu.Unlock() | ||
| }() | ||
|
|
||
| c.Session.Logger.Debug("initialising ipapi client") | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func (c *Client) FindHost() ([]byte, error) { | ||
| start := time.Now() | ||
| defer func() { | ||
| c.Session.Stats.Mu.Lock() | ||
| c.Session.Stats.FindHostDuration[ProviderName] = time.Since(start) | ||
| c.Session.Stats.Mu.Unlock() | ||
| }() | ||
|
|
||
| result, err := fetchData(c.Session) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| c.Session.Logger.Debug("ipapi host match data", "size", len(result.Raw)) | ||
|
|
||
| return result.Raw, nil | ||
| } | ||
|
|
||
| func (c *Client) CreateTable(data []byte) (*table.Writer, error) { | ||
| start := time.Now() | ||
| defer func() { | ||
| c.Session.Stats.Mu.Lock() | ||
| c.Session.Stats.CreateTableDuration[ProviderName] = time.Since(start) | ||
| c.Session.Stats.Mu.Unlock() | ||
| }() | ||
|
|
||
| var findHostData HostSearchResult | ||
| if err := json.Unmarshal(data, &findHostData); err != nil { | ||
| return nil, fmt.Errorf("error unmarshalling ipapi data: %w", err) | ||
| } | ||
|
|
||
| tw := table.NewWriter() | ||
|
|
||
| tw.AppendRow(table.Row{"Organisation", providers.DashIfEmpty(findHostData.Org)}) | ||
| tw.AppendRow(table.Row{"Hostname", providers.DashIfEmpty(findHostData.Hostname)}) | ||
| tw.AppendRow(table.Row{"Country", providers.DashIfEmpty(findHostData.CountryName)}) | ||
| tw.AppendRow(table.Row{"Region", providers.DashIfEmpty(findHostData.Region)}) | ||
| tw.AppendRow(table.Row{"City", providers.DashIfEmpty(findHostData.City)}) | ||
| tw.AppendRow(table.Row{"Postal", providers.DashIfEmpty(findHostData.Postal)}) | ||
| tw.AppendRow(table.Row{"ASN", providers.DashIfEmpty(findHostData.Asn)}) | ||
|
|
||
| tw.SetColumnConfigs([]table.ColumnConfig{ | ||
| {Number: 2, AutoMerge: false, WidthMax: MaxColumnWidth, WidthMin: 50}, | ||
| {Number: 1, AutoMerge: true}, | ||
| }) | ||
|
|
||
| tw.SetColumnConfigs([]table.ColumnConfig{ | ||
| {Number: 2, AutoMerge: true, WidthMax: MaxColumnWidth, WidthMin: 50}, | ||
| }) | ||
| tw.SetAutoIndex(false) | ||
| // tw.SetStyle(table.StyleColoredDark) | ||
| // tw.Style().Options.DrawBorder = true | ||
| tw.SetTitle("IPAPI | Host: %s", c.Session.Host.String()) | ||
|
|
||
| if c.UseTestData { | ||
| tw.SetTitle("IPAPI | Host: 8.8.4.4") | ||
| } | ||
|
|
||
| c.Session.Logger.Debug("ipapi table created", "host", c.Session.Host.String()) | ||
|
|
||
| return &tw, nil | ||
| } | ||
|
|
||
| type ipapiResp struct { | ||
| IP string `json:"ip"` | ||
| Version string `json:"version"` | ||
| City string `json:"city"` | ||
| Region string `json:"region"` | ||
| RegionCode string `json:"region_code"` | ||
| CountryCode string `json:"country_code"` | ||
| CountryCodeIso3 string `json:"country_code_iso3"` | ||
| CountryName string `json:"country_name"` | ||
| CountryCapital string `json:"country_capital"` | ||
| CountryTld string `json:"country_tld"` | ||
| ContinentCode string `json:"continent_code"` | ||
| InEu bool `json:"in_eu"` | ||
| Postal string `json:"postal"` | ||
| Latitude float64 `json:"latitude"` | ||
| Longitude float64 `json:"longitude"` | ||
| Timezone string `json:"timezone"` | ||
| UtcOffset string `json:"utc_offset"` | ||
| CountryCallingCode string `json:"country_calling_code"` | ||
| Currency string `json:"currency"` | ||
| CurrencyName string `json:"currency_name"` | ||
| Languages string `json:"languages"` | ||
| CountryArea float64 `json:"country_area"` | ||
| CountryPopulation int `json:"country_population"` | ||
| Asn string `json:"asn"` | ||
| Org string `json:"org"` | ||
| Hostname string `json:"hostname"` | ||
| } | ||
|
|
||
| func loadResponse(c session.Session) (res *HostSearchResult, err error) { | ||
| res = &HostSearchResult{} | ||
|
|
||
| req, err := retryablehttp.NewRequest("GET", fmt.Sprintf("%s/%s/json", apiDomain, c.Host.String()), nil) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error creating ipapi request: %w", err) | ||
| } | ||
|
|
||
| req.Header.Set("User-Agent", providers.DefaultUA) | ||
|
|
||
| resp, err := c.HTTPClient.Do(req) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error sending ipapi request: %w", err) | ||
| } | ||
|
|
||
| defer resp.Body.Close() | ||
|
|
||
| var apiResp ipapiResp | ||
|
|
||
| if err = json.NewDecoder(resp.Body).Decode(&apiResp); err != nil { | ||
| return nil, fmt.Errorf("error decoding ipapi response: %w", err) | ||
| } | ||
|
|
||
| raw, err := json.Marshal(apiResp) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error marshalling ipapi response: %w", err) | ||
| } | ||
|
|
||
| res.Raw = raw | ||
|
|
||
| return res, nil | ||
| } | ||
|
|
||
| func loadResultsFile(path string) (res *HostSearchResult, err error) { | ||
| jf, err := os.Open(path) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error opening ipapi file: %w", err) | ||
| } | ||
|
|
||
| defer jf.Close() | ||
|
|
||
| decoder := json.NewDecoder(jf) | ||
|
|
||
| err = decoder.Decode(&res) | ||
| if err != nil { | ||
| return res, fmt.Errorf("error decoding ipapi file: %w", err) | ||
| } | ||
|
|
||
| return res, nil | ||
| } | ||
|
|
||
| func loadTestData(l *slog.Logger) (*HostSearchResult, error) { | ||
| tdf, err := loadResultsFile("providers/ipapi/testdata/ipapi_8_8_4_4_report.json") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| raw, err := json.Marshal(tdf) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error marshalling ipapi test data: %w", err) | ||
| } | ||
|
|
||
| tdf.Raw = raw | ||
|
|
||
| l.Info("ipapi match returned from test data", "host", "8.8.4.4") | ||
|
|
||
| return tdf, nil | ||
| } | ||
|
|
||
| func fetchData(c session.Session) (*HostSearchResult, error) { | ||
| var result *HostSearchResult | ||
|
|
||
| var err error | ||
|
|
||
| if c.UseTestData { | ||
| result, err = loadTestData(c.Logger) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error loading ipapi test data: %w", err) | ||
| } | ||
|
|
||
| return result, nil | ||
| } | ||
|
|
||
| // load data from cache | ||
| cacheKey := fmt.Sprintf("ipapi_%s_report.json", strings.ReplaceAll(c.Host.String(), ".", "_")) | ||
|
|
||
| var item *cache.Item | ||
| if item, err = cache.Read(c.Logger, c.Cache, cacheKey); err == nil { | ||
| if item.Value != nil && len(item.Value) > 0 { | ||
| err = json.Unmarshal(item.Value, &result) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("error unmarshalling cached ipapi response: %w", err) | ||
| } | ||
|
|
||
| c.Logger.Info("ipapi response found in cache", "host", c.Host.String()) | ||
|
|
||
| result.Raw = item.Value | ||
|
|
||
| c.Stats.Mu.Lock() | ||
| c.Stats.FindHostUsedCache[ProviderName] = true | ||
| c.Stats.Mu.Unlock() | ||
|
|
||
| return result, nil | ||
| } | ||
| } | ||
|
|
||
| result, err = loadResponse(c) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("loading ipapi api response: %w", err) | ||
| } | ||
|
|
||
| if err = cache.UpsertWithTTL(c.Logger, c.Cache, cache.Item{ | ||
| AppVersion: c.App.Version, | ||
| Key: cacheKey, | ||
| Value: result.Raw, | ||
| Created: time.Now(), | ||
| }, ResultTTL); err != nil { | ||
| return nil, fmt.Errorf("error caching ipapi response: %w", err) | ||
| } | ||
|
|
||
| return result, nil | ||
| } | ||
|
|
||
| type HostSearchResult struct { | ||
| Raw json.RawMessage `json:"raw,omitempty"` | ||
| ipapiResp | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"ip":"8.8.4.4","version":"IPv4","city":"Mountain View","region":"California","region_code":"CA","country_code":"US","country_code_iso3":"USA","country_name":"United States","country_capital":"Washington","country_tld":".us","continent_code":"NA","in_eu":false,"postal":"94043","latitude":37.4043,"longitude":-122.0748,"timezone":"America/Los_Angeles","utc_offset":"-0700","country_calling_code":"+1","currency":"USD","currency_name":"Dollar","languages":"en-US,es-US,haw,fr","country_area":9629091,"country_population":327167434,"asn":"AS15169","org":"GOOGLE","hostname":""} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.