-
-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
387 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| namespace Amp\Http\Server\Middleware; | ||
|
|
||
| use Amp\Socket\InternetAddress; | ||
|
|
||
| final class Forwarded | ||
| { | ||
| /** | ||
| * @param array<non-empty-string, string|null> $fields | ||
| */ | ||
| public function __construct( | ||
| private readonly InternetAddress $for, | ||
| private readonly array $fields, | ||
| ) { | ||
| } | ||
|
|
||
| public function getFor(): InternetAddress | ||
| { | ||
| return $this->for; | ||
| } | ||
|
|
||
| public function getField(string $name): ?string | ||
| { | ||
| return $this->fields[$name] ?? null; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| namespace Amp\Http\Server\Middleware; | ||
|
|
||
| enum ForwardedHeaderType | ||
| { | ||
| case Forwarded; | ||
| case XForwardedFor; | ||
|
|
||
| /** | ||
| * @return non-empty-string | ||
| */ | ||
| public function getHeaderName(): string | ||
| { | ||
| return match ($this) { | ||
| self::Forwarded => 'forwarded', | ||
| self::XForwardedFor => 'x-forwarded-for', | ||
| }; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| namespace Amp\Http\Server\Middleware; | ||
|
|
||
| use Amp\Cache\LocalCache; | ||
| use Amp\Http; | ||
| use Amp\Http\Server\Middleware; | ||
| use Amp\Http\Server\Request; | ||
| use Amp\Http\Server\RequestHandler; | ||
| use Amp\Http\Server\Response; | ||
| use Amp\Socket\CidrMatcher; | ||
| use Amp\Socket\InternetAddress; | ||
|
|
||
| final class ForwardedMiddleware implements Middleware | ||
| { | ||
| /** @var list<CidrMatcher> */ | ||
| private readonly array $trustedProxies; | ||
|
|
||
| /** @var LocalCache<bool> */ | ||
| private readonly LocalCache $trustedIps; | ||
|
|
||
| /** | ||
| * @param array<non-empty-string> $trustedProxies Array of IPv4 or IPv6 addresses with an optional subnet mask. | ||
| * e.g., '172.18.0.0/24' | ||
| * @param positive-int $cacheSize | ||
| */ | ||
| public function __construct( | ||
| private readonly ForwardedHeaderType $headerType, | ||
| array $trustedProxies, | ||
| int $cacheSize = 1000, | ||
| ) { | ||
| $this->trustedProxies = \array_map( | ||
| static fn (string $ip) => new CidrMatcher($ip), | ||
| \array_values($trustedProxies), | ||
| ); | ||
|
|
||
| $this->trustedIps = new LocalCache($cacheSize); | ||
| } | ||
|
|
||
| public function handleRequest(Request $request, RequestHandler $requestHandler): Response | ||
| { | ||
| $clientAddress = $request->getClient()->getRemoteAddress(); | ||
|
|
||
| if ($clientAddress instanceof InternetAddress && $this->isTrustedProxy($clientAddress)) { | ||
| $request->setAttribute(Forwarded::class, match ($this->headerType) { | ||
| ForwardedHeaderType::Forwarded => $this->getForwarded($request), | ||
| ForwardedHeaderType::XForwardedFor => $this->getForwardedFor($request), | ||
| }); | ||
| } | ||
|
|
||
| return $requestHandler->handleRequest($request); | ||
| } | ||
|
|
||
| private function isTrustedProxy(InternetAddress $address): bool | ||
| { | ||
| $ip = $address->getAddress(); | ||
| $trusted = $this->trustedIps->get($ip); | ||
| if ($trusted !== null) { | ||
| return $trusted; | ||
| } | ||
|
|
||
| $trusted = false; | ||
| foreach ($this->trustedProxies as $matcher) { | ||
| if ($matcher->match($ip)) { | ||
| $trusted = true; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| $this->trustedIps->set($ip, $trusted); | ||
|
|
||
| return $trusted; | ||
| } | ||
|
|
||
| private function getForwarded(Request $request): ?Forwarded | ||
| { | ||
| $headers = Http\parseMultipleHeaderFields($request, 'forwarded'); | ||
| if (!$headers) { | ||
| return null; | ||
| } | ||
|
|
||
| foreach (\array_reverse($headers) as $header) { | ||
| $for = $header['for'] ?? null; | ||
| if ($for === null) { | ||
| continue; | ||
| } | ||
|
|
||
| $address = InternetAddress::tryFromString($this->addPortIfMissing($for)); | ||
| if (!$address || $this->isTrustedProxy($address)) { | ||
| continue; | ||
| } | ||
|
|
||
| return new Forwarded($address, $header); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| private function addPortIfMissing(string $address): string | ||
| { | ||
| if (!\str_contains($address, ':') || \str_ends_with($address, ']')) { | ||
| $address .= ':0'; | ||
| } | ||
|
|
||
| return $address; | ||
| } | ||
|
|
||
| private function getForwardedFor(Request $request): ?Forwarded | ||
| { | ||
| $forwardedFor = Http\splitHeader($request, 'x-forwarded-for'); | ||
| if (!$forwardedFor) { | ||
| return null; | ||
| } | ||
|
|
||
| $forwardedFor = \array_map(static function (string $ip): string { | ||
| if (\str_contains($ip, ':')) { | ||
| return '[' . \trim($ip, '[]') . ']:0'; | ||
| } | ||
|
|
||
| return $ip . ':0'; | ||
| }, $forwardedFor); | ||
|
|
||
| /** @var InternetAddress[] $forwardedFor */ | ||
| $forwardedFor = \array_filter(\array_map(InternetAddress::tryFromString(...), $forwardedFor)); | ||
| foreach (\array_reverse($forwardedFor) as $for) { | ||
| if (!$this->isTrustedProxy($for)) { | ||
| return new Forwarded($for, [ | ||
| 'for' => $for->getAddress(), | ||
| 'host' => $request->getHeader('x-forwarded-host'), | ||
| 'proto' => $request->getHeader('x-forwarded-proto'), | ||
| ]); | ||
| } | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.