Redact API key in RequestOpts debug info

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

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/lib/Util/RequestOptions.php b/lib/Util/RequestOptions.php
@@ -25,6 +25,15 @@ public function __construct($key = null, $headers = [], $base = null)
         $this->apiBase = $base;
     }
 
+    public function __debugInfo()
+    {
+        return [
+            'apiKey' => $this->redactedApiKey(),
+            'headers' => $this->headers,
+            'apiBase' => $this->apiBase,
+        ];
+    }
+
     /**
      * Unpacks an options array and merges it into the existing RequestOptions
      * object.
@@ -105,4 +114,15 @@ public static function parse($options)
            . 'a global apiKey by "Stripe::setApiKey(<apiKey>)")';
         throw new Exception\InvalidArgumentException($message);
     }
+
+    private function redactedApiKey()
+    {
+        $pieces = explode('_', $this->apiKey, 3);
+        $last = array_pop($pieces);
+        $redactedLast = strlen($last) > 4
+            ? (str_repeat('*', strlen($last) - 4) . substr($last, -4))
+            : $last;
+        array_push($pieces, $redactedLast);
+        return implode('_', $pieces);
+    }
 }
diff --git a/tests/Stripe/Util/RequestOptionsTest.php b/tests/Stripe/Util/RequestOptionsTest.php
@@ -78,4 +78,19 @@ 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("[apiKey] => sk_test_********************klmn", $debugInfo);
+
+        $opts = Util\RequestOptions::parse(['api_key' => 'sk_1234567890abcdefghijklmn']);
+        $debugInfo = print_r($opts, true);
+        $this->assertContains("[apiKey] => sk_********************klmn", $debugInfo);
+
+        $opts = Util\RequestOptions::parse(['api_key' => '1234567890abcdefghijklmn']);
+        $debugInfo = print_r($opts, true);
+        $this->assertContains("[apiKey] => ********************klmn", $debugInfo);
+    }
 }