Prefix filenames with file:// if necessary, or openssl will fail

simplesamlphp · Sep 1, 2024 · a168043 · a168043
1 parent 546a3f0
commit a168043
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/src/Key/PrivateKey.php b/src/Key/PrivateKey.php
@@ -10,6 +10,8 @@
 
 use function openssl_pkey_export;
 use function openssl_pkey_get_private;
+use function preg_filter;
+use function preg_match;
 
 /**
  * A class modeling private keys for their use in asymmetric algorithms.
@@ -52,6 +54,10 @@ public static function fromFile(
         #[\SensitiveParameter]
         string $passphrase = '',
     ): static {
+        if (preg_match('/^(file:\/\/)/i', $file) < 1) {
+            $file = preg_filter('/^/', 'file://', $file);
+        }
+
         if (($key = openssl_pkey_get_private($file, $passphrase)) === false) {
             throw new OpenSSLException('Failed to read key');
         }

diff --git a/tests/Key/PrivateKeyTest.php b/tests/Key/PrivateKeyTest.php
@@ -56,4 +56,15 @@ public function testFromFile(): void
         $keyDetails = openssl_pkey_get_details(openssl_pkey_get_private($k->getMaterial()));
         $this->assertEquals(self::$privKey['key'], $keyDetails['key']);
     }
+
+
+    /**
+     * Test creation from a file without file:// prefix succeeds.
+     */
+    public function testFromFileNoPrefix(): void
+    {
+        $k = PrivateKey::fromFile('./resources/keys/privkey.pem');
+        $keyDetails = openssl_pkey_get_details(openssl_pkey_get_private($k->getMaterial()));
+        $this->assertEquals(self::$privKey['key'], $keyDetails['key']);
+    }
 }