.. _envoy_v3_api_file_envoy/extensions/filters/http/geoip/v3/geoip.proto:

Geoip (proto)
=============

.. _extension_envoy.filters.http.geoip:

This extension has the qualified name ``envoy.filters.http.geoip``


.. 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:


  - :ref:`envoy.filters.http <extension_category_envoy.filters.http>`



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



  - :ref:`type.googleapis.com/envoy.extensions.filters.http.geoip.v3.Geoip <envoy_v3_api_msg_extensions.filters.http.geoip.v3.Geoip>`



.. 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 :ref:`threat model <arch_overview_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.



Geoip :ref:`configuration overview <config_http_filters_geoip>`.




.. _envoy_v3_api_msg_extensions.filters.http.geoip.v3.Geoip:

extensions.filters.http.geoip.v3.Geoip
--------------------------------------


:repo:`[extensions.filters.http.geoip.v3.Geoip proto] <api/envoy/extensions/filters/http/geoip/v3/geoip.proto#L22>`




.. code-block:: json
  :force:

  {
    "xff_config": {...},
    "provider": {...}
  }

.. _envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.xff_config:


xff_config
  (:ref:`extensions.filters.http.geoip.v3.Geoip.XffConfig <envoy_v3_api_msg_extensions.filters.http.geoip.v3.Geoip.XffConfig>`) If set, the :ref:`xff_num_trusted_hops <envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops>` field will be used to determine
  trusted client address from ``x-forwarded-for`` header.
  Otherwise, the immediate downstream connection source address will be used.


.. _envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.provider:


provider
  (:ref:`config.core.v3.TypedExtensionConfig <envoy_v3_api_msg_config.core.v3.TypedExtensionConfig>`, *REQUIRED*) Geoip driver specific configuration which depends on the driver being instantiated.
  See the geoip drivers for examples:

  - :ref:`MaxMindConfig <envoy_v3_api_msg_extensions.geoip_providers.maxmind.v3.MaxMindConfig>`


  .. _extension_category_envoy.geoip_providers:

  .. tip::

    This extension category has the following known extensions:


    - :ref:`envoy.geoip_providers.maxmind <extension_envoy.geoip_providers.maxmind>`





.. _envoy_v3_api_msg_extensions.filters.http.geoip.v3.Geoip.XffConfig:

extensions.filters.http.geoip.v3.Geoip.XffConfig
------------------------------------------------


:repo:`[extensions.filters.http.geoip.v3.Geoip.XffConfig proto] <api/envoy/extensions/filters/http/geoip/v3/geoip.proto#L23>`




.. code-block:: json
  :force:

  {
    "xff_num_trusted_hops": ...
  }

.. _envoy_v3_api_field_extensions.filters.http.geoip.v3.Geoip.XffConfig.xff_num_trusted_hops:


xff_num_trusted_hops
  (`uint32 <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The number of additional ingress proxy hops from the right side of the
  :ref:`config_http_conn_man_headers_x-forwarded-for` HTTP header to trust when
  determining the origin client's IP address. The default is zero if this option
  is not specified. See the documentation for
  :ref:`config_http_conn_man_headers_x-forwarded-for` for more information.