MaxMind Geolocation Provider (proto)

This extension has the qualified name envoy.geoip_providers.maxmind

Note

This extension is work-in-progress. Functionality is incomplete and it is not intended for production use.

This extension has an unknown security posture and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

• envoy.geoip_providers

This extension must be configured with one of the following type URLs:

• type.googleapis.com/envoy.extensions.geoip_providers.maxmind.v3.MaxMindConfig

Warning

This API feature is currently work-in-progress. API features marked as work-in-progress are not considered stable, are not covered by the threat model, are not supported by the security team, and are subject to breaking changes. Do not use this feature without understanding each of the previous points.

MaxMind geolocation provider configuration overview. At least one geolocation database path city_db_path, isp_db_path or anon_db_path must be configured.

extensions.geoip_providers.maxmind.v3.MaxMindConfig

[extensions.geoip_providers.maxmind.v3.MaxMindConfig proto]

{
  "city_db_path": ...,
  "isp_db_path": ...,
  "anon_db_path": ...,
  "common_provider_config": {...}
}

city_db_path

(string) Full file path to the Maxmind city database, e.g. /etc/GeoLite2-City.mmdb. Database file is expected to have .mmdb extension.

isp_db_path

(string) Full file path to the Maxmind ASN database, e.g. /etc/GeoLite2-ASN.mmdb. Database file is expected to have .mmdb extension.

anon_db_path

(string) Full file path to the Maxmind anonymous IP database, e.g. /etc/GeoIP2-Anonymous-IP.mmdb. Database file is expected to have .mmdb extension.

common_provider_config

(extensions.geoip_providers.common.v3.CommonGeoipProviderConfig, REQUIRED) Common provider configuration that specifies which geolocation headers will be populated with geolocation data.