Merge pull request #77 from mdrost/issue-76

Fix chunk header to be case-insensitive and allow leading zeros for end chunk

Author: WyriHaximus

src/ChunkedStreamDecoder.php

@@ -87,14 +87,6 @@ protected function iterateBuffer()
         }
 
         if ($this->nextChunkIsLength) {
-            if (substr($this->buffer, 0, 3) === "0\r\n") {
-                // We've reached the end of the stream
-                $this->reachedEnd = true;
-                $this->emit('end');
-                $this->close();
-                return false;
-            }
-
             $crlfPosition = strpos($this->buffer, static::CRLF);
             if ($crlfPosition === false && strlen($this->buffer) > 1024) {
                 $this->emit('error', [
@@ -106,18 +98,22 @@ protected function iterateBuffer()
             if ($crlfPosition === false) {
                 return false; // Chunk header hasn't completely come in yet
             }
-            $this->nextChunkIsLength = false;
             $lengthChunk = substr($this->buffer, 0, $crlfPosition);
             if (strpos($lengthChunk, ';') !== false) {
                 list($lengthChunk) = explode(';', $lengthChunk, 2);
             }
             if ($lengthChunk !== '') {
                 $lengthChunk = ltrim($lengthChunk, "0");
                 if ($lengthChunk === '') {
-                    $lengthChunk = "0";
+                    // We've reached the end of the stream
+                    $this->reachedEnd = true;
+                    $this->emit('end');
+                    $this->close();
+                    return false;
                 }
             }
-            if (dechex(hexdec($lengthChunk)) !== $lengthChunk) {
+            $this->nextChunkIsLength = false;
+            if (dechex(hexdec($lengthChunk)) !== strtolower($lengthChunk)) {
                 $this->emit('error', [
                     new Exception('Unable to validate "' . $lengthChunk . '" as chunk length header'),
                 ]);

tests/DecodeChunkedStreamTest.php

@@ -73,6 +73,9 @@ public function provideChunkedEncoding()
             ],
             'end-chunk-zero-check-3' => [
                 ["00004\r\nWiki\r\n005\r\npedia\r\ne\r\n in\r\n\r\nchunks.\r\n0000\r\n\r\n"]
+            ],
+            'uppercase-chunk' => [
+                ["4\r\nWiki\r\n5\r\npedia\r\nE\r\n in\r\n\r\nchunks.\r\n0\r\n\r\n"],
             ]
         ];
     }
@@ -130,7 +133,19 @@ public function testInvalidChunkedEncoding(array $strings)
         }
     }
 
-    public function testHandleEnd()
+    public function provideZeroChunk()
+    {
+        return [
+            ['1-zero' => "0\r\n\r\n"],
+            ['random-zero' => str_repeat("0", rand(2, 10))."\r\n\r\n"]
+        ];
+    }
+
+    /**
+     * @test
+     * @dataProvider provideZeroChunk
+     */
+    public function testHandleEnd($zeroChunk)
     {
         $ended = false;
         $stream = new ThroughStream();
@@ -142,7 +157,7 @@ public function testHandleEnd()
             $ended = true;
         });
 
-        $stream->write("4\r\nWiki\r\n0\r\n\r\n");
+        $stream->write("4\r\nWiki\r\n".$zeroChunk);
 
         $this->assertTrue($ended);
     }
@@ -178,7 +193,11 @@ public function testHandleEndTrailers()
         $this->assertTrue($ended);
     }
 
-    public function testHandleEndEnsureNoError()
+    /**
+     * @test
+     * @dataProvider provideZeroChunk
+     */
+    public function testHandleEndEnsureNoError($zeroChunk)
     {
         $ended = false;
         $stream = new ThroughStream();
@@ -191,7 +210,7 @@ public function testHandleEndEnsureNoError()
         });
 
         $stream->write("4\r\nWiki\r\n");
-        $stream->write("0\r\n\r\n");
+        $stream->write($zeroChunk);
         $stream->end();
 
         $this->assertTrue($ended);