This documentation regards version 10.1, however the current version is 10.7.0.
extractClientIP
Description
Provides the value of X-Forwarded-For
, Remote-Address
, or X-Real-IP
headers as an instance of RemoteAddress
. When the value is an invalid IP address in the header first seen, then this extractor will return RemoteAddress.Unknown
.
The akka-http server engine adds the Remote-Address
header to every request automatically if the respective setting akka.http.server.remote-address-header
is set to on
. Per default it is set to off
.
Warning
Clients can send any values in these headers. If the client is not a trusted upstream, the IP address can be malicious and by pass your security rules.
Example
- Scala
-
source
val route = extractClientIP { ip => complete("Client's ip is " + ip.toOption.map(_.getHostAddress).getOrElse("unknown")) } // tests: Get("/").withHeaders(`Remote-Address`(RemoteAddress(InetAddress.getByName("192.168.3.12")))) ~> route ~> check { responseAs[String] shouldEqual "Client's ip is 192.168.3.12" }
- Java