Enum iota_types::traffic_control::ClientIdSource

pub enum ClientIdSource {
    SocketAddr,
    XForwardedFor(usize),
}

The source that should be used to identify the client’s IP address. To be used to configure cases where a node has infra running in front of the node that is separate from the protocol, such as a load balancer. Note that this is not the same as the client type (e.g a direct client vs a proxy client, as in the case of a fullnode driving requests from many clients).

For x-forwarded-for, the usize parameter is the number of forwarding hops between the client and the node for requests going your infra or infra provider. Example:

    (client) -> { (global proxy) -> (regional proxy) -> (node) }

where

    { <server>, ... }

are controlled by the Node operator / their cloud provider. In this case, we set:

policy-config:
   client-id-source:
     x-forwarded-for: 2
   ...

NOTE: x-forwarded-for: 0 is a special case value that can be used by Node operators to discover the number of hops that should be configured. To use:

1. Set x-forwarded-for: 0 for the client-id-source in the config.
2. Run the node and query any endpoint (AuthorityServer for validator, or json rpc for rpc node) from a known IP address.
3. Search for lines containing x-forwarded-for in the logs. The log lines should contain the contents of the x-forwarded-for header, if present, or a corresponding error if not.
4. The value for number of hops is derived from any such log line that contains your known IP address, and is defined as 1 + the number of IP addresses in the x-forwarded-for that occur after the known client IP address. Example:

    [<known client IP>] <--- number of hops is 1
    ["1.2.3.4", <known client IP>, "5.6.7.8", "9.10.11.12"] <--- number of hops is 3

Variants

SocketAddr

XForwardedFor(usize)

Trait Implementations

impl Clone for ClientIdSource

fn clone(&self) -> ClientIdSource

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientIdSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClientIdSource

fn default() -> ClientIdSource

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientIdSource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ClientIdSource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.