mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -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 = ['.*']
```
463 lines
12 KiB
Go
463 lines
12 KiB
Go
// Copyright 2020 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 asciidocext converts AsciiDoc to HTML using Asciidoctor
|
|
// external binary. The `asciidoc` module is reserved for a future golang
|
|
// implementation.
|
|
|
|
package asciidocext
|
|
|
|
import (
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/gohugoio/hugo/common/hexec"
|
|
"github.com/gohugoio/hugo/common/loggers"
|
|
"github.com/gohugoio/hugo/config"
|
|
"github.com/gohugoio/hugo/config/security"
|
|
"github.com/gohugoio/hugo/markup/converter"
|
|
"github.com/gohugoio/hugo/markup/markup_config"
|
|
"github.com/gohugoio/hugo/markup/tableofcontents"
|
|
|
|
qt "github.com/frankban/quicktest"
|
|
)
|
|
|
|
func TestAsciidoctorDefaultArgs(t *testing.T) {
|
|
c := qt.New(t)
|
|
cfg := config.New()
|
|
mconf := markup_config.Default
|
|
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
Cfg: cfg,
|
|
MarkupConfig: mconf,
|
|
Logger: loggers.NewErrorLogger(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*asciidocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args := ac.parseArgs(converter.DocumentContext{})
|
|
expected := []string{"--no-header-footer"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
|
|
func TestAsciidoctorNonDefaultArgs(t *testing.T) {
|
|
c := qt.New(t)
|
|
cfg := config.New()
|
|
mconf := markup_config.Default
|
|
mconf.AsciidocExt.Backend = "manpage"
|
|
mconf.AsciidocExt.NoHeaderOrFooter = false
|
|
mconf.AsciidocExt.SafeMode = "safe"
|
|
mconf.AsciidocExt.SectionNumbers = true
|
|
mconf.AsciidocExt.Verbose = true
|
|
mconf.AsciidocExt.Trace = false
|
|
mconf.AsciidocExt.FailureLevel = "warn"
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
Cfg: cfg,
|
|
MarkupConfig: mconf,
|
|
Logger: loggers.NewErrorLogger(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*asciidocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args := ac.parseArgs(converter.DocumentContext{})
|
|
expected := []string{"-b", "manpage", "--section-numbers", "--verbose", "--failure-level", "warn", "--safe-mode", "safe"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
|
|
func TestAsciidoctorDisallowedArgs(t *testing.T) {
|
|
c := qt.New(t)
|
|
cfg := config.New()
|
|
mconf := markup_config.Default
|
|
mconf.AsciidocExt.Backend = "disallowed-backend"
|
|
mconf.AsciidocExt.Extensions = []string{"./disallowed-extension"}
|
|
mconf.AsciidocExt.Attributes = map[string]string{"outdir": "disallowed-attribute"}
|
|
mconf.AsciidocExt.SafeMode = "disallowed-safemode"
|
|
mconf.AsciidocExt.FailureLevel = "disallowed-failurelevel"
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
Cfg: cfg,
|
|
MarkupConfig: mconf,
|
|
Logger: loggers.NewErrorLogger(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*asciidocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args := ac.parseArgs(converter.DocumentContext{})
|
|
expected := []string{"--no-header-footer"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
|
|
func TestAsciidoctorArbitraryExtension(t *testing.T) {
|
|
c := qt.New(t)
|
|
cfg := config.New()
|
|
mconf := markup_config.Default
|
|
mconf.AsciidocExt.Extensions = []string{"arbitrary-extension"}
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
Cfg: cfg,
|
|
MarkupConfig: mconf,
|
|
Logger: loggers.NewErrorLogger(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*asciidocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args := ac.parseArgs(converter.DocumentContext{})
|
|
expected := []string{"-r", "arbitrary-extension", "--no-header-footer"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
|
|
func TestAsciidoctorDisallowedExtension(t *testing.T) {
|
|
c := qt.New(t)
|
|
cfg := config.New()
|
|
for _, disallowedExtension := range []string{
|
|
`foo-bar//`,
|
|
`foo-bar\\ `,
|
|
`../../foo-bar`,
|
|
`/foo-bar`,
|
|
`C:\foo-bar`,
|
|
`foo-bar.rb`,
|
|
`foo.bar`,
|
|
} {
|
|
mconf := markup_config.Default
|
|
mconf.AsciidocExt.Extensions = []string{disallowedExtension}
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
Cfg: cfg,
|
|
MarkupConfig: mconf,
|
|
Logger: loggers.NewErrorLogger(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*asciidocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args := ac.parseArgs(converter.DocumentContext{})
|
|
expected := []string{"--no-header-footer"}
|
|
c.Assert(args, qt.DeepEquals, expected)
|
|
}
|
|
}
|
|
|
|
func TestAsciidoctorWorkingFolderCurrent(t *testing.T) {
|
|
c := qt.New(t)
|
|
cfg := config.New()
|
|
mconf := markup_config.Default
|
|
mconf.AsciidocExt.WorkingFolderCurrent = true
|
|
mconf.AsciidocExt.Trace = false
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
Cfg: cfg,
|
|
MarkupConfig: mconf,
|
|
Logger: loggers.NewErrorLogger(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ctx := converter.DocumentContext{Filename: "/tmp/hugo_asciidoc_ddd/docs/chapter2/index.adoc", DocumentName: "chapter2/index.adoc"}
|
|
conv, err := p.New(ctx)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*asciidocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args := ac.parseArgs(ctx)
|
|
c.Assert(len(args), qt.Equals, 5)
|
|
c.Assert(args[0], qt.Equals, "--base-dir")
|
|
c.Assert(filepath.ToSlash(args[1]), qt.Matches, "/tmp/hugo_asciidoc_ddd/docs/chapter2")
|
|
c.Assert(args[2], qt.Equals, "-a")
|
|
c.Assert(args[3], qt.Matches, `outdir=.*[/\\]{1,2}asciidocext[/\\]{1,2}chapter2`)
|
|
c.Assert(args[4], qt.Equals, "--no-header-footer")
|
|
}
|
|
|
|
func TestAsciidoctorWorkingFolderCurrentAndExtensions(t *testing.T) {
|
|
c := qt.New(t)
|
|
cfg := config.New()
|
|
mconf := markup_config.Default
|
|
mconf.AsciidocExt.NoHeaderOrFooter = true
|
|
mconf.AsciidocExt.Extensions = []string{"asciidoctor-html5s", "asciidoctor-diagram"}
|
|
mconf.AsciidocExt.Backend = "html5s"
|
|
mconf.AsciidocExt.WorkingFolderCurrent = true
|
|
mconf.AsciidocExt.Trace = false
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
Cfg: cfg,
|
|
MarkupConfig: mconf,
|
|
Logger: loggers.NewErrorLogger(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*asciidocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
args := ac.parseArgs(converter.DocumentContext{})
|
|
c.Assert(len(args), qt.Equals, 11)
|
|
c.Assert(args[0], qt.Equals, "-b")
|
|
c.Assert(args[1], qt.Equals, "html5s")
|
|
c.Assert(args[2], qt.Equals, "-r")
|
|
c.Assert(args[3], qt.Equals, "asciidoctor-html5s")
|
|
c.Assert(args[4], qt.Equals, "-r")
|
|
c.Assert(args[5], qt.Equals, "asciidoctor-diagram")
|
|
c.Assert(args[6], qt.Equals, "--base-dir")
|
|
c.Assert(args[7], qt.Equals, ".")
|
|
c.Assert(args[8], qt.Equals, "-a")
|
|
c.Assert(args[9], qt.Contains, "outdir=")
|
|
c.Assert(args[10], qt.Equals, "--no-header-footer")
|
|
}
|
|
|
|
func TestAsciidoctorAttributes(t *testing.T) {
|
|
c := qt.New(t)
|
|
cfg := config.New()
|
|
mconf := markup_config.Default
|
|
mconf.AsciidocExt.Attributes = map[string]string{"my-base-url": "https://gohugo.io/", "my-attribute-name": "my value"}
|
|
mconf.AsciidocExt.Trace = false
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
Cfg: cfg,
|
|
MarkupConfig: mconf,
|
|
Logger: loggers.NewErrorLogger(),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
ac := conv.(*asciidocConverter)
|
|
c.Assert(ac, qt.Not(qt.IsNil))
|
|
|
|
expectedValues := map[string]bool{
|
|
"my-base-url=https://gohugo.io/": true,
|
|
"my-attribute-name=my value": true,
|
|
}
|
|
|
|
args := ac.parseArgs(converter.DocumentContext{})
|
|
c.Assert(len(args), qt.Equals, 5)
|
|
c.Assert(args[0], qt.Equals, "-a")
|
|
c.Assert(expectedValues[args[1]], qt.Equals, true)
|
|
c.Assert(args[2], qt.Equals, "-a")
|
|
c.Assert(expectedValues[args[3]], qt.Equals, true)
|
|
c.Assert(args[4], qt.Equals, "--no-header-footer")
|
|
}
|
|
|
|
func getProvider(c *qt.C, mconf markup_config.Config) converter.Provider {
|
|
sc := security.DefaultConfig
|
|
sc.Exec.Allow = security.NewWhitelist("asciidoctor")
|
|
|
|
p, err := Provider.New(
|
|
converter.ProviderConfig{
|
|
MarkupConfig: mconf,
|
|
Logger: loggers.NewErrorLogger(),
|
|
Exec: hexec.New(sc),
|
|
},
|
|
)
|
|
c.Assert(err, qt.IsNil)
|
|
return p
|
|
}
|
|
|
|
func TestConvert(t *testing.T) {
|
|
if !Supports() {
|
|
t.Skip("asciidoctor not installed")
|
|
}
|
|
c := qt.New(t)
|
|
|
|
p := getProvider(c, markup_config.Default)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
|
|
b, err := conv.Convert(converter.RenderContext{Src: []byte("testContent")})
|
|
c.Assert(err, qt.IsNil)
|
|
c.Assert(string(b.Bytes()), qt.Equals, "<div class=\"paragraph\">\n<p>testContent</p>\n</div>\n")
|
|
}
|
|
|
|
func TestTableOfContents(t *testing.T) {
|
|
if !Supports() {
|
|
t.Skip("asciidoctor not installed")
|
|
}
|
|
c := qt.New(t)
|
|
p := getProvider(c, markup_config.Default)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
r, err := conv.Convert(converter.RenderContext{Src: []byte(`:toc: macro
|
|
:toclevels: 4
|
|
toc::[]
|
|
|
|
=== Introduction
|
|
|
|
== Section 1
|
|
|
|
=== Section 1.1
|
|
|
|
==== Section 1.1.1
|
|
|
|
=== Section 1.2
|
|
|
|
testContent
|
|
|
|
== Section 2
|
|
`)})
|
|
c.Assert(err, qt.IsNil)
|
|
toc, ok := r.(converter.TableOfContentsProvider)
|
|
c.Assert(ok, qt.Equals, true)
|
|
expected := tableofcontents.Root{
|
|
Headings: tableofcontents.Headings{
|
|
{
|
|
ID: "",
|
|
Text: "",
|
|
Headings: tableofcontents.Headings{
|
|
{
|
|
ID: "_introduction",
|
|
Text: "Introduction",
|
|
Headings: nil,
|
|
},
|
|
{
|
|
ID: "_section_1",
|
|
Text: "Section 1",
|
|
Headings: tableofcontents.Headings{
|
|
{
|
|
ID: "_section_1_1",
|
|
Text: "Section 1.1",
|
|
Headings: tableofcontents.Headings{
|
|
{
|
|
ID: "_section_1_1_1",
|
|
Text: "Section 1.1.1",
|
|
Headings: nil,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
ID: "_section_1_2",
|
|
Text: "Section 1.2",
|
|
Headings: nil,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
ID: "_section_2",
|
|
Text: "Section 2",
|
|
Headings: nil,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
c.Assert(toc.TableOfContents(), qt.DeepEquals, expected)
|
|
c.Assert(string(r.Bytes()), qt.Not(qt.Contains), "<div id=\"toc\" class=\"toc\">")
|
|
}
|
|
|
|
func TestTableOfContentsWithCode(t *testing.T) {
|
|
if !Supports() {
|
|
t.Skip("asciidoctor not installed")
|
|
}
|
|
c := qt.New(t)
|
|
p := getProvider(c, markup_config.Default)
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
r, err := conv.Convert(converter.RenderContext{Src: []byte(`:toc: auto
|
|
|
|
== Some ` + "`code`" + ` in the title
|
|
`)})
|
|
c.Assert(err, qt.IsNil)
|
|
toc, ok := r.(converter.TableOfContentsProvider)
|
|
c.Assert(ok, qt.Equals, true)
|
|
expected := tableofcontents.Root{
|
|
Headings: tableofcontents.Headings{
|
|
{
|
|
ID: "",
|
|
Text: "",
|
|
Headings: tableofcontents.Headings{
|
|
{
|
|
ID: "_some_code_in_the_title",
|
|
Text: "Some <code>code</code> in the title",
|
|
Headings: nil,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
c.Assert(toc.TableOfContents(), qt.DeepEquals, expected)
|
|
c.Assert(string(r.Bytes()), qt.Not(qt.Contains), "<div id=\"toc\" class=\"toc\">")
|
|
}
|
|
|
|
func TestTableOfContentsPreserveTOC(t *testing.T) {
|
|
if !Supports() {
|
|
t.Skip("asciidoctor not installed")
|
|
}
|
|
c := qt.New(t)
|
|
mconf := markup_config.Default
|
|
mconf.AsciidocExt.PreserveTOC = true
|
|
p := getProvider(c, mconf)
|
|
|
|
conv, err := p.New(converter.DocumentContext{})
|
|
c.Assert(err, qt.IsNil)
|
|
r, err := conv.Convert(converter.RenderContext{Src: []byte(`:toc:
|
|
:idprefix:
|
|
:idseparator: -
|
|
|
|
== Some title
|
|
`)})
|
|
c.Assert(err, qt.IsNil)
|
|
toc, ok := r.(converter.TableOfContentsProvider)
|
|
c.Assert(ok, qt.Equals, true)
|
|
expected := tableofcontents.Root{
|
|
Headings: tableofcontents.Headings{
|
|
{
|
|
ID: "",
|
|
Text: "",
|
|
Headings: tableofcontents.Headings{
|
|
{
|
|
ID: "some-title",
|
|
Text: "Some title",
|
|
Headings: nil,
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
c.Assert(toc.TableOfContents(), qt.DeepEquals, expected)
|
|
c.Assert(string(r.Bytes()), qt.Contains, "<div id=\"toc\" class=\"toc\">")
|
|
}
|