Files
gluetun/internal/publicip/api/api.go
Quentin McGaw a61302f135 feat(publicip): resilient public ip fetcher (#2518)
- `PUBLICIP_API` accepts a comma separated list of ip data sources, where the first one is the base default one, and sources after it are backup sources used if we are rate limited.
- `PUBLICIP_API` defaults to `ipinfo,ifconfigco,ip2location,cloudflare` such that it now has `ifconfigco,ip2location,cloudflare` as backup ip data sources.
- `PUBLICIP_API_TOKEN` accepts a comma separated list of ip data source tokens, each corresponding by position to the APIs listed in `PUBLICIP_API`.
- logs ip data source when logging public ip information
- assume a rate limiting error is for 30 days (no persistence)
- ready for future live settings updates
  - consider an ip data source no longer banned if the token changes
  - keeps track of ban times when updating the list of fetchers
2024-10-19 15:21:14 +02:00

66 lines
1.4 KiB
Go

package api
import (
"errors"
"fmt"
"net/http"
"strings"
)
type Provider string
const (
Cloudflare Provider = "cloudflare"
IfConfigCo Provider = "ifconfigco"
IPInfo Provider = "ipinfo"
IP2Location Provider = "ip2location"
)
type NameToken struct {
Name string
Token string
}
func New(nameTokenPairs []NameToken, client *http.Client) (
fetchers []Fetcher, err error,
) {
fetchers = make([]Fetcher, len(nameTokenPairs))
for i, nameTokenPair := range nameTokenPairs {
provider, err := ParseProvider(nameTokenPair.Name)
if err != nil {
return nil, fmt.Errorf("parsing API name: %w", err)
}
switch provider {
case Cloudflare:
fetchers[i] = newCloudflare(client)
case IfConfigCo:
fetchers[i] = newIfConfigCo(client)
case IPInfo:
fetchers[i] = newIPInfo(client, nameTokenPair.Token)
case IP2Location:
fetchers[i] = newIP2Location(client, nameTokenPair.Token)
default:
panic("provider not valid: " + provider)
}
}
return fetchers, nil
}
var ErrProviderNotValid = errors.New("API name is not valid")
func ParseProvider(s string) (provider Provider, err error) {
switch strings.ToLower(s) {
case "cloudflare":
return Cloudflare, nil
case string(IfConfigCo):
return IfConfigCo, nil
case "ipinfo":
return IPInfo, nil
case "ip2location":
return IP2Location, nil
default:
return "", fmt.Errorf(`%w: %q can only be "cloudflare", "ifconfigco", "ip2location" or "ipinfo"`,
ErrProviderNotValid, s)
}
}