Merge pull request #1 from php-istio/fix/add-header-prefix

vuongxuongminh · web-flow · commit acc459e0084d · 2021-10-30T13:17:20.000+07:00
Fix/add header prefix
diff --git a/src/AbstractExtractor.php b/src/AbstractExtractor.php
@@ -24,10 +24,13 @@ abstract class AbstractExtractor implements ExtractorInterface
 
     private string $issuer;
 
+    private ?string $prefix;
+
     public function __construct(
         string $issuer,
         string $in,
-        string $item
+        string $item,
+        string $prefix = null
     ) {
         if ('' === $issuer) {
             throw new \LogicException('Issuer can not be blank!');
@@ -40,6 +43,7 @@ public function __construct(
         $this->issuer = $issuer;
         $this->in = $in;
         $this->item = $item;
+        $this->prefix = $prefix;
     }
 
     final public function extract(ServerRequestInterface $request): ?array
@@ -53,6 +57,14 @@ final public function extract(ServerRequestInterface $request): ?array
             return null;
         }
 
+        if (null !== $this->prefix) {
+            if (!str_starts_with($value, $this->prefix)) {
+                return null;
+            }
+
+            $value = substr($value, strlen($this->prefix));
+        }
+
         $payload = $this->extractFromValue($value);
 
         if (null === $payload || $this->issuer !== ($payload['iss'] ?? null)) {
diff --git a/src/ExtractorFactory.php b/src/ExtractorFactory.php
@@ -17,9 +17,9 @@ public static function fromBase64Header(string $issuer, string $header): Extract
         return new Base64HeaderExtractor($issuer, $header);
     }
 
-    public static function fromOriginTokenHeader(string $issuer, string $header): ExtractorInterface
+    public static function fromOriginTokenHeader(string $issuer, string $header = 'Authorization', string $prefix = 'Bearer '): ExtractorInterface
     {
-        return new OriginTokenExtractor($issuer, AbstractExtractor::IN_HEADER, $header);
+        return new OriginTokenExtractor($issuer, AbstractExtractor::IN_HEADER, $header, $prefix);
     }
 
     public static function fromOriginTokenQueryParam(string $issuer, string $queryParam): ExtractorInterface
diff --git a/tests/Base64HeaderExtractorTest.php b/tests/Base64HeaderExtractorTest.php
@@ -14,24 +14,24 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ServerRequestInterface;
 
-class Base64HeaderExtractorTest extends TestCase
+final class Base64HeaderExtractorTest extends TestCase
 {
-    use RequestDataProviderTrait;
+    use RequestCreatorTrait;
 
     public function testInitWithBlankIssuer(): void
     {
         $this->expectException(\LogicException::class);
         $this->expectExceptionMessageMatches('~can not be blank!~');
 
-        new Base64HeaderExtractor('', 'authorization');
+        new Base64HeaderExtractor('', 'x-istio-jwt-payload');
     }
 
     /**
      * @dataProvider invalidRequests
      */
     public function testExtractFromInvalidRequests(ServerRequestInterface $inHeader)
     {
-        $extractor = new Base64HeaderExtractor('valid', 'authorization');
+        $extractor = new Base64HeaderExtractor('valid', 'x-istio-jwt-payload');
         $payloadFromHeader = $extractor->extract($inHeader);
 
         $this->assertNull($payloadFromHeader);
@@ -42,20 +42,37 @@ public function testExtractFromInvalidRequests(ServerRequestInterface $inHeader)
      */
     public function testExtractFromValidRequests(ServerRequestInterface $inHeader)
     {
-        $extractor = new Base64HeaderExtractor('valid', 'authorization');
+        $extractor = new Base64HeaderExtractor('valid', 'x-istio-jwt-payload');
         $payloadFromHeader = $extractor->extract($inHeader);
 
         $this->assertIsArray($payloadFromHeader);
         $this->assertSame('valid', $payloadFromHeader['iss']);
     }
 
-    protected function getValidToken(): string
+    public function invalidRequests(): array
     {
-        return base64_encode(json_encode(['iss' => 'valid']));
+        return [
+            [
+                $this->createRequest(),
+            ],
+            [
+                $this->createRequest(headers: ['invalid_name' => '']),
+            ],
+            [
+                $this->createRequest(headers: ['x-istio-jwt-payload' => 'invalid header']),
+            ],
+            [
+                $this->createRequest(headers: ['x-istio-jwt-payload' => 'Bearer ' . base64_encode(json_encode(['iss' => 'invalid']))]),
+            ],
+        ];
     }
 
-    protected function getInvalidToken(): string
+    public function validRequests(): array
     {
-        return base64_encode(json_encode(['iss' => 'invalid']));
+        return [
+            [
+                $this->createRequest(headers: ['x-istio-jwt-payload' => base64_encode(json_encode(['iss' => 'valid']))]),
+            ],
+        ];
     }
 }
diff --git a/tests/CompositeExtractorTest.php b/tests/CompositeExtractorTest.php
@@ -15,7 +15,7 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ServerRequestInterface;
 
-class CompositeExtractorTest extends TestCase
+final class CompositeExtractorTest extends TestCase
 {
     use RequestCreatorTrait;
 
@@ -56,8 +56,8 @@ public function testExtractFromInvalidRequests(ServerRequestInterface $request):
     public function validRequests(): array
     {
         return [
-            [$this->createRequest(headers: ['x-jwt-payload' => $this->getValidBase64Payload()])],
-            [$this->createRequest(headers: ['authorization' => $this->getValidOriginToken()])],
+            [$this->createRequest(headers: ['x-istio-jwt-payload' => $this->getValidBase64Payload()])],
+            [$this->createRequest(headers: ['authorization' => 'Bearer ' . $this->getValidOriginToken()])],
             [$this->createRequest(queryParams: ['token' => $this->getValidOriginToken()])],
         ];
     }
@@ -66,21 +66,23 @@ public function invalidRequests(): array
     {
         return [
             [$this->createRequest()],
-            [$this->createRequest(headers: ['x-jwt-payload' => ''])],
+            [$this->createRequest(headers: ['x-istio-jwt-payload' => ''])],
             [$this->createRequest(headers: ['authorization' => ''])],
             [$this->createRequest(queryParams: ['token' => ''])],
-            [$this->createRequest(headers: ['x-jwt-payload' => $this->getValidOriginToken()])],
+            [$this->createRequest(headers: ['x-istio-jwt-payload' => $this->getValidOriginToken()])],
             [$this->createRequest(headers: ['authorization' => $this->getValidBase64Payload()])],
-            [$this->createRequest(headers: ['x-jwt-payload' => $this->getInvalidBase64Payload()])],
+            [$this->createRequest(headers: ['x-istio-jwt-payload' => $this->getInvalidBase64Payload()])],
             [$this->createRequest(headers: ['authorization' => $this->getInvalidOriginToken()])],
             [$this->createRequest(queryParams: ['token' => $this->getInvalidOriginToken()])],
+            [$this->createRequest(headers: ['authorization' => 'Bearer=' . $this->getValidOriginToken()])],
+            [$this->createRequest(headers: ['authorization' => 'BearEr ' . $this->getValidOriginToken()])],
         ];
     }
 
     private function getExtractor(): ExtractorInterface
     {
         return ExtractorFactory::fromExtractors(
-            ExtractorFactory::fromBase64Header('valid', 'x-jwt-payload'),
+            ExtractorFactory::fromBase64Header('valid', 'x-istio-jwt-payload'),
             ExtractorFactory::fromOriginTokenHeader('valid', 'authorization'),
             ExtractorFactory::fromOriginTokenQueryParam('valid', 'token'),
         );
diff --git a/tests/OriginTokenExtractorTest.php b/tests/OriginTokenExtractorTest.php
@@ -15,9 +15,9 @@
 use PHPUnit\Framework\TestCase;
 use Psr\Http\Message\ServerRequestInterface;
 
-class OriginTokenExtractorTest extends TestCase
+final class OriginTokenExtractorTest extends TestCase
 {
-    use RequestDataProviderTrait;
+    use RequestCreatorTrait;
 
     public function testInitWithBlankIssuer(): void
     {
@@ -50,6 +50,36 @@ public function testExtractFromInvalidRequests(
         $this->assertNull($payloadFromQueryParam);
     }
 
+    public function invalidRequests(): array
+    {
+        return [
+            [
+                $this->createRequest(),
+                $this->createRequest(),
+            ],
+            [
+                $this->createRequest(headers: ['invalid_name' => '']),
+                $this->createRequest(queryParams: ['invalid_name' => '']),
+            ],
+            [
+                $this->createRequest(headers: ['authorization' => '']),
+                $this->createRequest(queryParams: ['token' => '']),
+            ],
+            [
+                $this->createRequest(headers: ['authorization' => 'Bearer invalid header']),
+                $this->createRequest(queryParams: ['token' => 'invalid query params']),
+            ],
+            [
+                $this->createRequest(headers: ['authorization' => 'Bearer=' . $this->getValidToken()]),
+                $this->createRequest(queryParams: ['token' => 'Bearer..' . $this->getInvalidToken()]),
+            ],
+            [
+                $this->createRequest(headers: ['authorization' => 'Bearer ' . $this->getInvalidToken()]),
+                $this->createRequest(queryParams: ['token' => $this->getInvalidToken()]),
+            ],
+        ];
+    }
+
     /**
      * @dataProvider validRequests
      */
@@ -63,9 +93,19 @@ public function testExtractFromValidRequests(ServerRequestInterface $inHeader, S
         $this->assertSame('valid', $payloadFromQueryParam['iss']);
     }
 
+    public function validRequests(): array
+    {
+        return [
+            [
+                $this->createRequest(headers: ['authorization' => 'Bearer ' . $this->getValidToken()]),
+                $this->createRequest(queryParams: ['token' => $this->getValidToken()]),
+            ],
+        ];
+    }
+
     private function extractRequests(ServerRequestInterface $inHeader, ServerRequestInterface $inQueryParam): array
     {
-        $headerExtractor = new OriginTokenExtractor('valid', AbstractExtractor::IN_HEADER, 'authorization');
+        $headerExtractor = new OriginTokenExtractor('valid', AbstractExtractor::IN_HEADER, 'authorization', 'Bearer ');
         $queryParamExtractor = new OriginTokenExtractor('valid', AbstractExtractor::IN_QUERY_PARAM, 'token');
 
         return [$headerExtractor->extract($inHeader), $queryParamExtractor->extract($inQueryParam)];
diff --git a/tests/RequestDataProviderTrait.php b/tests/RequestDataProviderTrait.php

Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,9 @@ public static function fromBase64Header(string $issuer, string $header): Extract`
`17`	`17`	`return new Base64HeaderExtractor($issuer, $header);`
`18`	`18`	`}`
`19`	`19`
`20`		`- public static function fromOriginTokenHeader(string $issuer, string $header): ExtractorInterface`
	`20`	`+ public static function fromOriginTokenHeader(string $issuer, string $header = 'Authorization', string $prefix = 'Bearer '): ExtractorInterface`
`21`	`21`	`{`
`22`		`- return new OriginTokenExtractor($issuer, AbstractExtractor::IN_HEADER, $header);`
	`22`	`+ return new OriginTokenExtractor($issuer, AbstractExtractor::IN_HEADER, $header, $prefix);`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`public static function fromOriginTokenQueryParam(string $issuer, string $queryParam): ExtractorInterface`