Allow kbd tags (#9245)

jolheiser · techknowlogick · commit 9a33adcdd322 · 2019-12-03T14:02:41.000-05:00
* Allow kbd tags

Signed-off-by: jolheiser &lt;john.olheiser@gmail.com&gt;

* Add test

Signed-off-by: jolheiser &lt;john.olheiser@gmail.com&gt;
diff --git a/modules/markup/sanitizer.go b/modules/markup/sanitizer.go
@@ -47,6 +47,9 @@ func ReplaceSanitizer() {
 
 	// Allow keyword markup
 	sanitizer.policy.AllowAttrs("class").Matching(regexp.MustCompile(`^` + keywordClass + `$`)).OnElements("span")
+
+	// Allow <kbd> tags for keyboard shortcut styling
+	sanitizer.policy.AllowElements("kbd")
 }
 
 // Sanitize takes a string that contains a HTML fragment or document and applies policy whitelist.
diff --git a/modules/markup/sanitizer_test.go b/modules/markup/sanitizer_test.go
@@ -35,6 +35,9 @@ func Test_Sanitizer(t *testing.T) {
 <code class="language-lol&#32;ui&#32;container&#32;input&#32;massive&#32;basic&#32;segment">Hello there! Something has gone wrong, we are working on it.</code>
 <code class="language-lol&#32;ui&#32;container&#32;input&#32;huge&#32;basic&#32;segment">In the meantime, play a game with us at&nbsp;<a href="http://example.com/">example.com</a>.</code>
 </code>`, "<code>\n<code>\u00a0</code>\n<img src=\"https://try.gogs.io/img/favicon.png\" width=\"200\" height=\"200\">\n<code>Hello there! Something has gone wrong, we are working on it.</code>\n<code>In the meantime, play a game with us at\u00a0<a href=\"http://example.com/\" rel=\"nofollow\">example.com</a>.</code>\n</code>",
+
+		// <kbd> tags
+		`<kbd>Ctrl + C</kbd>`, `<kbd>Ctrl + C</kbd>`,
 	}
 
 	for i := 0; i < len(testCases); i += 2 {

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,9 @@ func ReplaceSanitizer() {`
`47`	`47`
`48`	`48`	`// Allow keyword markup`
`49`	`49`	sanitizer.policy.AllowAttrs("class").Matching(regexp.MustCompile(`^` + keywordClass + `$`)).OnElements("span")
	`50`	`+`
	`51`	`+ // Allow <kbd> tags for keyboard shortcut styling`
	`52`	`+ sanitizer.policy.AllowElements("kbd")`
`50`	`53`	`}`
`51`	`54`
`52`	`55`	`// Sanitize takes a string that contains a HTML fragment or document and applies policy whitelist.`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,9 @@ func Test_Sanitizer(t *testing.T) {`
`35`	`35`	`<code class="language-lol ui container input massive basic segment">Hello there! Something has gone wrong, we are working on it.</code>`
`36`	`36`	`<code class="language-lol ui container input huge basic segment">In the meantime, play a game with us at <a href="http://example.com/">example.com</a>.</code>`
`37`	`37`	</code>`, "<code>\n<code>\u00a0</code>\n<img src=\"https://try.gogs.io/img/favicon.png\" width=\"200\" height=\"200\">\n<code>Hello there! Something has gone wrong, we are working on it.</code>\n<code>In the meantime, play a game with us at\u00a0<a href=\"http://example.com/\" rel=\"nofollow\">example.com</a>.</code>\n</code>",
	`38`	`+`
	`39`	`+ // <kbd> tags`
	`40`	+ `<kbd>Ctrl + C</kbd>`, `<kbd>Ctrl + C</kbd>`,
`38`	`41`	`}`
`39`	`42`
`40`	`43`	`for i := 0; i < len(testCases); i += 2 {`