Redact API key in RequestOpts debug info

stripe · Oct 18, 2019 · a46b670 · a46b670
1 parent 96c5974
commit a46b670
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/lib/Util/RequestOptions.php b/lib/Util/RequestOptions.php
@@ -25,6 +25,21 @@ public function __construct($key = null, $headers = [], $base = null)
         $this->apiBase = $base;
     }
 
+    public function __debugInfo()
+    {
+        $redactedApiKey = strlen($this->apiKey) >= 12
+            ? (substr($this->apiKey, 0, 8)
+                . str_repeat('*', strlen($this->apiKey) - 12)
+                . substr($this->apiKey, -4))
+            : $this->apiKey;
+
+        return [
+            'apiKey' => $redactedApiKey,
+            'headers' => $this->headers,
+            'apiBase' => $this->apiBase,
+        ];
+    }
+
     /**
      * Unpacks an options array and merges it into the existing RequestOptions
      * object.

diff --git a/tests/Stripe/Util/RequestOptionsTest.php b/tests/Stripe/Util/RequestOptionsTest.php
@@ -78,4 +78,11 @@ public function testDiscardNonPersistentHeaders()
         $opts->discardNonPersistentHeaders();
         $this->assertSame(['Stripe-Account' => 'foo'], $opts->headers);
     }
+
+    public function testDebugInfo()
+    {
+        $opts = Util\RequestOptions::parse(['api_key' => 'sk_test_1234567890abcdefghijklmn']);
+        $debugInfo = print_r($opts, true);
+        $this->assertContains("sk_test_********************klmn", $debugInfo);
+    }
 }