Merge pull request magento#150 from magento/issues/140

security-package/issues/140: Link "Read instructions on how to generate signature" in Store-Configuration is incorrect.

Author: lenaorobei

Securitytxt/Model/Config/Signature.php

@@ -3,18 +3,40 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 declare(strict_types=1);
 
 namespace Magento\Securitytxt\Model\Config;
 
 use Magento\Config\Model\Config\CommentInterface;
+use Magento\Framework\Escaper;
 
 /**
  * Signature field description
  */
 class Signature implements CommentInterface
 {
+ /**
+ * @var string
+ */
+ private $instructionLink;
+
+ /**
+ * @var Escaper
+ */
+ private $escaper;
+
+ /**
+ * @param Escaper $escaper
+ * @param string $instructionLink
+ */
+ public function __construct(
+ Escaper $escaper,
+ string $instructionLink = ''
+ ) {
+ $this->escaper = $escaper;
+ $this->instructionLink = $instructionLink;
+ }
+
  /**
  * Get comment for signature field of security txt extension.
  *
@@ -24,8 +46,13 @@ class Signature implements CommentInterface
  */
  public function getCommentText($elementValue): string
  {
- return "<a href='https://devdocs.magento.com/' target='_blank'>
- Read instructions on how to generate signature
- </a>";
+ if ($this->instructionLink === '') {
+ return '';
+ }
+ return sprintf(
+ "<a href='%s' target='_blank'>%s</a>",
+ $this->escaper->escapeUrl($this->instructionLink),
+ __('Read instructions on how to generate signature')
+ );
  }
 }

Securitytxt/etc/di.xml

@@ -22,4 +22,11 @@
  <argument name="resultPageFactory" xsi:type="object">securitytxtResultPageFactory</argument>
  </arguments>
  </type>
-</config>
+ <type name="Magento\Securitytxt\Model\Config\Signature">
+ <arguments>
+ <argument name="instructionLink" xsi:type="string">
+ https://github.com/magento/security-package/blob/1.0-develop/Securitytxt/README.md
+ </argument>
+ </arguments>
+ </type>
+</config>

Securitytxt/i18n/en_US.csv

@@ -26,4 +26,5 @@ Hiring,Hiring
 "Example: https://example.com/jobs.html","Example: https://example.com/jobs.html"
 Policy,Policy
 "Example: https://example.com/security-policy.html","Example: https://example.com/security-policy.html"
-Signature,Signature
+Signature,Signature
+"Read instructions on how to generate signature","Read instructions on how to generate signature"