[Mime] Fix missing sprintf in DkimSigner

alamirault · fabpot · commit 52ceda78e48d · 2021-12-28T15:16:49.000+01:00
diff --git a/src/Symfony/Component/Mime/Crypto/DkimSigner.php b/src/Symfony/Component/Mime/Crypto/DkimSigner.php
@@ -65,7 +65,7 @@ public function sign(Message $message, array $options = []): Message
     {
         $options += $this->defaultOptions;
         if (!\in_array($options['algorithm'], [self::ALGO_SHA256, self::ALGO_ED25519], true)) {
-            throw new InvalidArgumentException('Invalid DKIM signing algorithm "%s".', $options['algorithm']);
+            throw new InvalidArgumentException(sprintf('Invalid DKIM signing algorithm "%s".', $options['algorithm']));
         }
         $headersToIgnore['return-path'] = true;
         $headersToIgnore['x-transport'] = true;
@@ -205,7 +205,7 @@ private function hashBody(AbstractPart $body, string $bodyCanon, int $maxLength)
         }
 
         // Add trailing Line return if last line is non empty
-        if (\strlen($currentLine) > 0) {
+        if ('' !== $currentLine) {
             hash_update($hash, "\r\n");
             $length += \strlen("\r\n");
         }
diff --git a/src/Symfony/Component/Mime/Tests/Crypto/DkimSignerTest.php b/src/Symfony/Component/Mime/Tests/Crypto/DkimSignerTest.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Crypto\DkimSigner;
 use Symfony\Component\Mime\Email;
+use Symfony\Component\Mime\Message;
 
 /**
  * @group time-sensitive
@@ -90,6 +91,21 @@ public function getSignData()
         ];
     }
 
+    public function testSignWithUnsupportedAlgorithm()
+    {
+        $message = $this->createMock(Message::class);
+
+        $signer = new DkimSigner(self::$pk, 'testdkim.symfony.net', 'sf', [
+            'algorithm' => 'unsupported-value',
+        ]);
+
+        $this->expectExceptionObject(
+            new \LogicException('Invalid DKIM signing algorithm "unsupported-value".')
+        );
+
+        $signer->sign($message, []);
+    }
+
     /**
      * @dataProvider getCanonicalizeHeaderData
      */

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function sign(Message $message, array $options = []): Message`
`65`	`65`	`{`
`66`	`66`	`$options += $this->defaultOptions;`
`67`	`67`	`if (!\in_array($options['algorithm'], [self::ALGO_SHA256, self::ALGO_ED25519], true)) {`
`68`		`- throw new InvalidArgumentException('Invalid DKIM signing algorithm "%s".', $options['algorithm']);`
	`68`	`+ throw new InvalidArgumentException(sprintf('Invalid DKIM signing algorithm "%s".', $options['algorithm']));`
`69`	`69`	`}`
`70`	`70`	`$headersToIgnore['return-path'] = true;`
`71`	`71`	`$headersToIgnore['x-transport'] = true;`
`@@ -205,7 +205,7 @@ private function hashBody(AbstractPart $body, string $bodyCanon, int $maxLength)`
`205`	`205`	`}`
`206`	`206`
`207`	`207`	`// Add trailing Line return if last line is non empty`
`208`		`- if (\strlen($currentLine) > 0) {`
	`208`	`+ if ('' !== $currentLine) {`
`209`	`209`	`hash_update($hash, "\r\n");`
`210`	`210`	`$length += \strlen("\r\n");`
`211`	`211`	`}`