mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 00:42:08 -05:00
f4389e48ce
This ommmit contains some security hardening measures for the Hugo build runtime.
There are some rarely used features in Hugo that would be good to have disabled by default. One example would be the "external helpers".
For `asciidoctor` and some others we use Go's `os/exec` package to start a new process.
These are a predefined set of binary names, all loaded from `PATH` and with a predefined set of arguments. Still, if you don't use `asciidoctor` in your project, you might as well have it turned off.
You can configure your own in the new `security` configuration section, but the defaults are configured to create a minimal amount of site breakage. And if that do happen, you will get clear instructions in the loa about what to do.
The default configuration is listed below. Note that almost all of these options are regular expression _whitelists_ (a string or a slice); the value `none` will block all.
```toml
[security]
enableInlineShortcodes = false
[security.exec]
allow = ['^dart-sass-embedded$', '^go$', '^npx$', '^postcss$']
osEnv = ['(?i)^(PATH|PATHEXT|APPDATA|TMP|TEMP|TERM)$']
[security.funcs]
getenv = ['^HUGO_']
[security.http]
methods = ['(?i)GET|POST']
urls = ['.*']
```
282 lines
8.7 KiB
Go
282 lines
8.7 KiB
Go
// Copyright 2019 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package helpers
|
|
|
|
import (
|
|
"bytes"
|
|
"html/template"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/spf13/afero"
|
|
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
|
|
qt "github.com/frankban/quicktest"
|
|
)
|
|
|
|
const tstHTMLContent = "<!DOCTYPE html><html><head><script src=\"http://two/foobar.js\"></script></head><body><nav><ul><li hugo-nav=\"section_0\"></li><li hugo-nav=\"section_1\"></li></ul></nav><article>content <a href=\"http://two/foobar\">foobar</a>. Follow up</article><p>This is some text.<br>And some more.</p></body></html>"
|
|
|
|
func TestTrimShortHTML(t *testing.T) {
|
|
tests := []struct {
|
|
input, output []byte
|
|
}{
|
|
{[]byte(""), []byte("")},
|
|
{[]byte("Plain text"), []byte("Plain text")},
|
|
{[]byte(" \t\n Whitespace text\n\n"), []byte("Whitespace text")},
|
|
{[]byte("<p>Simple paragraph</p>"), []byte("Simple paragraph")},
|
|
{[]byte("\n \n \t <p> \t Whitespace\nHTML \n\t </p>\n\t"), []byte("Whitespace\nHTML")},
|
|
{[]byte("<p>Multiple</p><p>paragraphs</p>"), []byte("<p>Multiple</p><p>paragraphs</p>")},
|
|
{[]byte("<p>Nested<p>paragraphs</p></p>"), []byte("<p>Nested<p>paragraphs</p></p>")},
|
|
{[]byte("<p>Hello</p>\n<ul>\n<li>list1</li>\n<li>list2</li>\n</ul>"), []byte("<p>Hello</p>\n<ul>\n<li>list1</li>\n<li>list2</li>\n</ul>")},
|
|
}
|
|
|
|
c := newTestContentSpec()
|
|
for i, test := range tests {
|
|
output := c.TrimShortHTML(test.input)
|
|
if !bytes.Equal(test.output, output) {
|
|
t.Errorf("Test %d failed. Expected %q got %q", i, test.output, output)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestStripHTML(t *testing.T) {
|
|
type test struct {
|
|
input, expected string
|
|
}
|
|
data := []test{
|
|
{"<h1>strip h1 tag <h1>", "strip h1 tag "},
|
|
{"<p> strip p tag </p>", " strip p tag "},
|
|
{"</br> strip br<br>", " strip br\n"},
|
|
{"</br> strip br2<br />", " strip br2\n"},
|
|
{"This <strong>is</strong> a\nnewline", "This is a newline"},
|
|
{"No Tags", "No Tags"},
|
|
{`<p>Summary Next Line.
|
|
<figure >
|
|
|
|
<img src="/not/real" />
|
|
|
|
|
|
</figure>
|
|
.
|
|
More text here.</p>
|
|
|
|
<p>Some more text</p>`, "Summary Next Line. . More text here.\nSome more text\n"},
|
|
}
|
|
for i, d := range data {
|
|
output := StripHTML(d.input)
|
|
if d.expected != output {
|
|
t.Errorf("Test %d failed. Expected %q got %q", i, d.expected, output)
|
|
}
|
|
}
|
|
}
|
|
|
|
func BenchmarkStripHTML(b *testing.B) {
|
|
b.ResetTimer()
|
|
for i := 0; i < b.N; i++ {
|
|
StripHTML(tstHTMLContent)
|
|
}
|
|
}
|
|
|
|
func TestStripEmptyNav(t *testing.T) {
|
|
c := qt.New(t)
|
|
cleaned := stripEmptyNav([]byte("do<nav>\n</nav>\n\nbedobedo"))
|
|
c.Assert(cleaned, qt.DeepEquals, []byte("dobedobedo"))
|
|
}
|
|
|
|
func TestBytesToHTML(t *testing.T) {
|
|
c := qt.New(t)
|
|
c.Assert(BytesToHTML([]byte("dobedobedo")), qt.Equals, template.HTML("dobedobedo"))
|
|
}
|
|
|
|
func TestNewContentSpec(t *testing.T) {
|
|
cfg := config.New()
|
|
c := qt.New(t)
|
|
|
|
cfg.Set("summaryLength", 32)
|
|
cfg.Set("buildFuture", true)
|
|
cfg.Set("buildExpired", true)
|
|
cfg.Set("buildDrafts", true)
|
|
|
|
spec, err := NewContentSpec(cfg, loggers.NewErrorLogger(), afero.NewMemMapFs(), nil)
|
|
|
|
c.Assert(err, qt.IsNil)
|
|
c.Assert(spec.summaryLength, qt.Equals, 32)
|
|
c.Assert(spec.BuildFuture, qt.Equals, true)
|
|
c.Assert(spec.BuildExpired, qt.Equals, true)
|
|
c.Assert(spec.BuildDrafts, qt.Equals, true)
|
|
}
|
|
|
|
var benchmarkTruncateString = strings.Repeat("This is a sentence about nothing.", 20)
|
|
|
|
func BenchmarkTestTruncateWordsToWholeSentence(b *testing.B) {
|
|
c := newTestContentSpec()
|
|
b.ResetTimer()
|
|
for i := 0; i < b.N; i++ {
|
|
c.TruncateWordsToWholeSentence(benchmarkTruncateString)
|
|
}
|
|
}
|
|
|
|
func BenchmarkTestTruncateWordsToWholeSentenceOld(b *testing.B) {
|
|
c := newTestContentSpec()
|
|
b.ResetTimer()
|
|
for i := 0; i < b.N; i++ {
|
|
c.truncateWordsToWholeSentenceOld(benchmarkTruncateString)
|
|
}
|
|
}
|
|
|
|
func TestTruncateWordsToWholeSentence(t *testing.T) {
|
|
c := newTestContentSpec()
|
|
type test struct {
|
|
input, expected string
|
|
max int
|
|
truncated bool
|
|
}
|
|
data := []test{
|
|
{"a b c", "a b c", 12, false},
|
|
{"a b c", "a b c", 3, false},
|
|
{"a", "a", 1, false},
|
|
{"This is a sentence.", "This is a sentence.", 5, false},
|
|
{"This is also a sentence!", "This is also a sentence!", 1, false},
|
|
{"To be. Or not to be. That's the question.", "To be.", 1, true},
|
|
{" \nThis is not a sentence\nAnd this is another", "This is not a sentence", 4, true},
|
|
{"", "", 10, false},
|
|
{"This... is a more difficult test?", "This... is a more difficult test?", 1, false},
|
|
}
|
|
for i, d := range data {
|
|
c.summaryLength = d.max
|
|
output, truncated := c.TruncateWordsToWholeSentence(d.input)
|
|
if d.expected != output {
|
|
t.Errorf("Test %d failed. Expected %q got %q", i, d.expected, output)
|
|
}
|
|
|
|
if d.truncated != truncated {
|
|
t.Errorf("Test %d failed. Expected truncated=%t got %t", i, d.truncated, truncated)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestTruncateWordsByRune(t *testing.T) {
|
|
c := newTestContentSpec()
|
|
type test struct {
|
|
input, expected string
|
|
max int
|
|
truncated bool
|
|
}
|
|
data := []test{
|
|
{"", "", 1, false},
|
|
{"a b c", "a b c", 12, false},
|
|
{"a b c", "a b c", 3, false},
|
|
{"a", "a", 1, false},
|
|
{"Hello 中国", "", 0, true},
|
|
{"这是中文，全中文。", "这是中文，", 5, true},
|
|
{"Hello 中国", "Hello 中", 2, true},
|
|
{"Hello 中国", "Hello 中国", 3, false},
|
|
{"Hello中国 Good 好的", "Hello中国 Good 好", 9, true},
|
|
{"This is a sentence.", "This is", 2, true},
|
|
{"This is also a sentence!", "This", 1, true},
|
|
{"To be. Or not to be. That's the question.", "To be. Or not", 4, true},
|
|
{" \nThis is not a sentence\n ", "This is not", 3, true},
|
|
}
|
|
for i, d := range data {
|
|
c.summaryLength = d.max
|
|
output, truncated := c.TruncateWordsByRune(strings.Fields(d.input))
|
|
if d.expected != output {
|
|
t.Errorf("Test %d failed. Expected %q got %q", i, d.expected, output)
|
|
}
|
|
|
|
if d.truncated != truncated {
|
|
t.Errorf("Test %d failed. Expected truncated=%t got %t", i, d.truncated, truncated)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestExtractTOCNormalContent(t *testing.T) {
|
|
content := []byte("<nav>\n<ul>\nTOC<li><a href=\"#")
|
|
|
|
actualTocLessContent, actualToc := ExtractTOC(content)
|
|
expectedTocLess := []byte("TOC<li><a href=\"#")
|
|
expectedToc := []byte("<nav id=\"TableOfContents\">\n<ul>\n")
|
|
|
|
if !bytes.Equal(actualTocLessContent, expectedTocLess) {
|
|
t.Errorf("Actual tocless (%s) did not equal expected (%s) tocless content", actualTocLessContent, expectedTocLess)
|
|
}
|
|
|
|
if !bytes.Equal(actualToc, expectedToc) {
|
|
t.Errorf("Actual toc (%s) did not equal expected (%s) toc content", actualToc, expectedToc)
|
|
}
|
|
}
|
|
|
|
func TestExtractTOCGreaterThanSeventy(t *testing.T) {
|
|
content := []byte("<nav>\n<ul>\nTOC This is a very long content which will definitely be greater than seventy, I promise you that.<li><a href=\"#")
|
|
|
|
actualTocLessContent, actualToc := ExtractTOC(content)
|
|
// Because the start of Toc is greater than 70+startpoint of <li> content and empty TOC will be returned
|
|
expectedToc := []byte("")
|
|
|
|
if !bytes.Equal(actualTocLessContent, content) {
|
|
t.Errorf("Actual tocless (%s) did not equal expected (%s) tocless content", actualTocLessContent, content)
|
|
}
|
|
|
|
if !bytes.Equal(actualToc, expectedToc) {
|
|
t.Errorf("Actual toc (%s) did not equal expected (%s) toc content", actualToc, expectedToc)
|
|
}
|
|
}
|
|
|
|
func TestExtractNoTOC(t *testing.T) {
|
|
content := []byte("TOC")
|
|
|
|
actualTocLessContent, actualToc := ExtractTOC(content)
|
|
expectedToc := []byte("")
|
|
|
|
if !bytes.Equal(actualTocLessContent, content) {
|
|
t.Errorf("Actual tocless (%s) did not equal expected (%s) tocless content", actualTocLessContent, content)
|
|
}
|
|
|
|
if !bytes.Equal(actualToc, expectedToc) {
|
|
t.Errorf("Actual toc (%s) did not equal expected (%s) toc content", actualToc, expectedToc)
|
|
}
|
|
}
|
|
|
|
var totalWordsBenchmarkString = strings.Repeat("Hugo Rocks ", 200)
|
|
|
|
func TestTotalWords(t *testing.T) {
|
|
for i, this := range []struct {
|
|
s string
|
|
words int
|
|
}{
|
|
{"Two, Words!", 2},
|
|
{"Word", 1},
|
|
{"", 0},
|
|
{"One, Two, Three", 3},
|
|
{totalWordsBenchmarkString, 400},
|
|
} {
|
|
actualWordCount := TotalWords(this.s)
|
|
|
|
if actualWordCount != this.words {
|
|
t.Errorf("[%d] Actual word count (%d) for test string (%s) did not match %d", i, actualWordCount, this.s, this.words)
|
|
}
|
|
}
|
|
}
|
|
|
|
func BenchmarkTotalWords(b *testing.B) {
|
|
b.ResetTimer()
|
|
for i := 0; i < b.N; i++ {
|
|
wordCount := TotalWords(totalWordsBenchmarkString)
|
|
if wordCount != 400 {
|
|
b.Fatal("Wordcount error")
|
|
}
|
|
}
|
|
}
|