traefik/docs/content/middlewares/ipwhitelist.md

IPWhiteList

Limiting Clients to Specific IPs {: .subtitle }

IPWhitelist accepts / refuses requests based on the client IP.

Configuration Examples

??? example "File -- Accepts request from defined IP"

```toml
[Middlewares]
  [Middlewares.test-ipwhitelist.ipWhiteList]
    sourceRange = ["127.0.0.1/32", "192.168.1.7"]
```

??? example "Docker -- Accepts request from defined IP"

```yml
 a-container:
    image: a-container-image 
        labels:
            - "traefik.Middlewares.Middleware9.IPWhiteList.SourceRange=127.0.0.1/32, 192.168.1.7"
```

Configuration Options

sourceRange

The sourceRange option sets the allowed IPs (or ranges of allowed IPs).

ipStrategy

The ipStrategy option defines two parameters that sets how Traefik will determine the client IP: depth, and excludedIPs.

ipStrategy.depth

The depth option tells Traefik to use the X-Forwarded-For header and take the IP located at the depth position (starting from the right).

!!! note "Examples of Depth & X-Forwaded-For"

If `depth` was equal to 2, and the request `X-Forwarded-For` header was `"10.0.0.1,11.0.0.1,12.0.0.1,13.0.0.1"` then the "real" client IP would be `"10.0.0.1"` (at depth 4) but the IP used for the whitelisting would be `"12.0.0.1"` (`depth=2`).

??? note "More examples"

    | `X-Forwarded-For`                       | `depth` | clientIP     |
    |-----------------------------------------|---------|--------------|
    | `"10.0.0.1,11.0.0.1,12.0.0.1,13.0.0.1"` | `1`     | `"13.0.0.1"` |
    | `"10.0.0.1,11.0.0.1,12.0.0.1,13.0.0.1"` | `3`     | `"11.0.0.1"` |
    | `"10.0.0.1,11.0.0.1,12.0.0.1,13.0.0.1"` | `5`     | `""`         |

??? example "File -- Whitelisting Based on X-Forwarded-For with depth=2"

```toml
[Middlewares]
  [Middlewares.test-ipwhitelist.ipWhiteList]
    sourceRange = ["127.0.0.1/32", "192.168.1.7"]
    [Middlewares.test-ipwhitelist.ipWhiteList.ipStrategy]
        depth = 2
```

??? example "Docker -- Whitelisting Based on X-Forwarded-For with depth=2"

```yml
 a-container:
    image: a-container-image 
        labels:
            - "traefik.Middlewares.testIPwhitelist.ipWhiteList.SourceRange=127.0.0.1/32, 192.168.1.7"
            - "traefik.middlewares.testIPwhitelist.ipwhitelist.ipstrategy.depth=2"
```

!!! note

- If `depth` is greater than the total number of IPs in `X-Forwarded-For`, then the client IP will be empty.
- `depth` is ignored if its value is is lesser than or equal to 0.

ipStrategy.excludedIPs

excludedIPs tells Traefik to scan the X-Forwarded-For header and pick the first IP not in the list.

!!! note "Examples of ExcludedIPs & X-Forwaded-For"

| `X-Forwarded-For`                       | `excludedIPs`         | clientIP     |
|-----------------------------------------|-----------------------|--------------|
| `"10.0.0.1,11.0.0.1,12.0.0.1,13.0.0.1"` | `"12.0.0.1,13.0.0.1"` | `"11.0.0.1"` |
| `"10.0.0.1,11.0.0.1,12.0.0.1,13.0.0.1"` | `"15.0.0.1,13.0.0.1"` | `"12.0.0.1"` |
| `"10.0.0.1,11.0.0.1,12.0.0.1,13.0.0.1"` | `"10.0.0.1,13.0.0.1"` | `"12.0.0.1"` |
| `"10.0.0.1,11.0.0.1,12.0.0.1,13.0.0.1"` | `"15.0.0.1,16.0.0.1"` | `"13.0.0.1"` |
| `"10.0.0.1,11.0.0.1"`                   | `"10.0.0.1,11.0.0.1"` | `""`         |

!!! important If depth is specified, excludedIPs is ignored.

??? example "File -- Exclude from X-Forwarded-For"

```toml
[Middlewares]
  [Middlewares.test-ipwhitelist.ipWhiteList]
    [Middlewares.test-ipwhitelist.ipWhiteList.ipStrategy]
      excludedIPs = ["127.0.0.1/32", "192.168.1.7"]
```

??? example "Docker -- Exclude from X-Forwarded-For"

```yml
 a-container:
    image: a-container-image 
        labels:
            - "traefik.middlewares.testIPwhitelist.ipwhitelist.ipstrategy.excludedIPs=127.0.0.1/32, 192.168.1.7"
```