fix Guzzle psr7 invalid header error (#20)

opencodeco · Sep 24, 2024 · de74ee4 · de74ee4
1 parent 3286019
commit de74ee4
Show file tree

Hide file tree

Showing 4 changed files with 83 additions and 2 deletions.
diff --git a/class_map/TextCodec.php b/class_map/TextCodec.php
@@ -2,6 +2,7 @@
 
 namespace Jaeger\Codec;
 
+use Hyperf\Tracer\Support\GuzzleHeaderValidate;
 use Hyperf\Tracer\Support\TextCodecOtel;
 use Exception;
 use Jaeger\SpanContext;
@@ -76,8 +77,12 @@ public function inject(SpanContext $spanContext, &$carrier)
             if ($this->urlEncoding) {
                 $encodedValue = urlencode($value);
             }
+            $headerName = $this->baggagePrefix . $key;
 
-            $carrier[$this->baggagePrefix . $key] = $encodedValue;
+            if (!GuzzleHeaderValidate::isValidHeader($headerName, $encodedValue)) {
+                continue;
+            }
+            $carrier[$headerName] = $encodedValue;
         }
     }
 

diff --git a/src/Support/GuzzleHeaderValidate.php b/src/Support/GuzzleHeaderValidate.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf + OpenCodeCo
+ *
+ * @link     https://opencodeco.dev
+ * @document https://hyperf.wiki
+ * @contact  leo@opencodeco.dev
+ * @license  https://github.com/opencodeco/hyperf-metric/blob/main/LICENSE
+ */
+
+namespace Hyperf\Tracer\Support;
+
+final class GuzzleHeaderValidate
+{
+    public static function isValidHeader(string $headerName, string $headerValue): bool
+    {
+        return self::isValidHeaderName($headerName) && self::isValidHeaderValue($headerValue);
+    }
+
+    /**
+     * caused by https://github.com/guzzle/psr7/blob/a70f5c95fb43bc83f07c9c948baa0dc1829bf201/src/MessageTrait.php#L229
+     */
+    public static function isValidHeaderName(string $headerName): bool
+    {
+        return (bool)preg_match('/^[a-zA-Z0-9\'`#$%&*+.^_|~!-]+$/D', $headerName);
+    }
+
+    /**
+     * caused by https://github.com/guzzle/psr7/blob/a70f5c95fb43bc83f07c9c948baa0dc1829bf201/src/MessageTrait.php#L259
+     */
+    public static function isValidHeaderValue(string $value): bool
+    {
+        return (bool)preg_match('/^[\x20\x09\x21-\x7E\x80-\xFF]*$/D', $value);
+    }
+}
diff --git a/src/Support/TextCodecOtel.php b/src/Support/TextCodecOtel.php
@@ -50,7 +50,11 @@ public function inject(SpanContext $spanContext, &$carrier)
         $baggageHeader = [];
 
         foreach ($baggage as $key => $value) {
-            $baggageHeader[] = $key . '=' . $value;
+            $value = $key . '=' . $value;
+            if (!GuzzleHeaderValidate::isValidHeaderValue($value)) {
+                continue;
+            }
+            $baggageHeader[] = $value;
         }
         $carrier[$this->traceStateHeader] = implode(',', $baggageHeader);
     }

diff --git a/tests/GuzzleHeaderValidateTest.php b/tests/GuzzleHeaderValidateTest.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf + OpenCodeCo
+ *
+ * @link     https://opencodeco.dev
+ * @document https://hyperf.wiki
+ * @contact  leo@opencodeco.dev
+ * @license  https://github.com/opencodeco/hyperf-metric/blob/main/LICENSE
+ */
+
+namespace HyperfTest\Tracer\Support;
+
+use Hyperf\Tracer\Support\GuzzleHeaderValidate;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ * @coversNothing
+ */
+final class JaegerDecoderTest extends TestCase
+{
+    public function testTraceIdDecoder(): void
+    {
+        self::assertFalse(GuzzleHeaderValidate::isValidHeader('uberctx-40247e74-4e8ccd0c@dt', '1234'));
+        self::assertTrue(GuzzleHeaderValidate::isValidHeader('uberctx-40247e74-4e8ccd0c', '1234'));
+    }
+
+    public function testSpanIdDecoder(): void
+    {
+        self::assertSame('255d1b261e0fcbc3', JaegerDecoder::spanIdDecoder('2692338002764483523'));
+        self::assertSame('21c2405de0e90c56', JaegerDecoder::spanIdDecoder('21c2405de0e90c56'));
+    }
+}