af92e38566
From-SVN: r183540
187 lines
5.8 KiB
Go
187 lines
5.8 KiB
Go
// Copyright 2011 The Go Authors. All rights reserved.
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
/*
|
|
Package template (html/template) is a specialization of package text/template
|
|
that automates the construction of HTML output that is safe against code
|
|
injection.
|
|
|
|
|
|
Introduction
|
|
|
|
This package wraps package template so you can use the standard template API
|
|
to parse and execute templates.
|
|
|
|
set, err := new(template.Set).Parse(...)
|
|
// Error checking elided
|
|
err = set.Execute(out, "Foo", data)
|
|
|
|
If successful, set will now be injection-safe. Otherwise, err is an error
|
|
defined in the docs for ErrorCode.
|
|
|
|
HTML templates treat data values as plain text which should be encoded so they
|
|
can be safely embedded in an HTML document. The escaping is contextual, so
|
|
actions can appear within JavaScript, CSS, and URI contexts.
|
|
|
|
The security model used by this package assumes that template authors are
|
|
trusted, while Execute's data parameter is not. More details are provided below.
|
|
|
|
Example
|
|
|
|
import "text/template"
|
|
...
|
|
t, err := template.New("foo").Parse(`{{define "T"}}Hello, {{.}}!{{end}}`)
|
|
err = t.ExecuteTemplate(out, "T", "<script>alert('you have been pwned')</script>")
|
|
|
|
produces
|
|
|
|
Hello, <script>alert('you have been pwned')</script>!
|
|
|
|
but with contextual autoescaping,
|
|
|
|
import "html/template"
|
|
...
|
|
t, err := template.New("foo").Parse(`{{define "T"}}Hello, {{.}}!{{end}}`)
|
|
err = t.ExecuteTemplate(out, "T", "<script>alert('you have been pwned')</script>")
|
|
|
|
produces safe, escaped HTML output
|
|
|
|
Hello, <script>alert('you have been pwned')</script>!
|
|
|
|
|
|
Contexts
|
|
|
|
This package understands HTML, CSS, JavaScript, and URIs. It adds sanitizing
|
|
functions to each simple action pipeline, so given the excerpt
|
|
|
|
<a href="/search?q={{.}}">{{.}}</a>
|
|
|
|
At parse time each {{.}} is overwritten to add escaping functions as necessary.
|
|
In this case it becomes
|
|
|
|
<a href="/search?q={{. | urlquery}}">{{. | html}}</a>
|
|
|
|
|
|
Errors
|
|
|
|
See the documentation of ErrorCode for details.
|
|
|
|
|
|
A fuller picture
|
|
|
|
The rest of this package comment may be skipped on first reading; it includes
|
|
details necessary to understand escaping contexts and error messages. Most users
|
|
will not need to understand these details.
|
|
|
|
|
|
Contexts
|
|
|
|
Assuming {{.}} is `O'Reilly: How are <i>you</i>?`, the table below shows
|
|
how {{.}} appears when used in the context to the left.
|
|
|
|
Context {{.}} After
|
|
{{.}} O'Reilly: How are <i>you</i>?
|
|
<a title='{{.}}'> O'Reilly: How are you?
|
|
<a href="/{{.}}"> O'Reilly: How are %3ci%3eyou%3c/i%3e?
|
|
<a href="?q={{.}}"> O'Reilly%3a%20How%20are%3ci%3e...%3f
|
|
<a onx='f("{{.}}")'> O\x27Reilly: How are \x3ci\x3eyou...?
|
|
<a onx='f({{.}})'> "O\x27Reilly: How are \x3ci\x3eyou...?"
|
|
<a onx='pattern = /{{.}}/;'> O\x27Reilly: How are \x3ci\x3eyou...\x3f
|
|
|
|
If used in an unsafe context, then the value might be filtered out:
|
|
|
|
Context {{.}} After
|
|
<a href="{{.}}"> #ZgotmplZ
|
|
|
|
since "O'Reilly:" is not an allowed protocol like "http:".
|
|
|
|
|
|
If {{.}} is the innocuous word, `left`, then it can appear more widely,
|
|
|
|
Context {{.}} After
|
|
{{.}} left
|
|
<a title='{{.}}'> left
|
|
<a href='{{.}}'> left
|
|
<a href='/{{.}}'> left
|
|
<a href='?dir={{.}}'> left
|
|
<a style="border-{{.}}: 4px"> left
|
|
<a style="align: {{.}}"> left
|
|
<a style="background: '{{.}}'> left
|
|
<a style="background: url('{{.}}')> left
|
|
<style>p.{{.}} {color:red}</style> left
|
|
|
|
Non-string values can be used in JavaScript contexts.
|
|
If {{.}} is
|
|
|
|
[]struct{A,B string}{ "foo", "bar" }
|
|
|
|
in the escaped template
|
|
|
|
<script>var pair = {{.}};</script>
|
|
|
|
then the template output is
|
|
|
|
<script>var pair = {"A": "foo", "B": "bar"};</script>
|
|
|
|
See package json to understand how non-string content is marshalled for
|
|
embedding in JavaScript contexts.
|
|
|
|
|
|
Typed Strings
|
|
|
|
By default, this package assumes that all pipelines produce a plain text string.
|
|
It adds escaping pipeline stages necessary to correctly and safely embed that
|
|
plain text string in the appropriate context.
|
|
|
|
When a data value is not plain text, you can make sure it is not over-escaped
|
|
by marking it with its type.
|
|
|
|
Types HTML, JS, URL, and others from content.go can carry safe content that is
|
|
exempted from escaping.
|
|
|
|
The template
|
|
|
|
Hello, {{.}}!
|
|
|
|
can be invoked with
|
|
|
|
tmpl.Execute(out, HTML(`<b>World</b>`))
|
|
|
|
to produce
|
|
|
|
Hello, <b>World</b>!
|
|
|
|
instead of the
|
|
|
|
Hello, <b>World<b>!
|
|
|
|
that would have been produced if {{.}} was a regular string.
|
|
|
|
|
|
Security Model
|
|
|
|
http://js-quasis-libraries-and-repl.googlecode.com/svn/trunk/safetemplate.html#problem_definition defines "safe" as used by this package.
|
|
|
|
This package assumes that template authors are trusted, that Execute's data
|
|
parameter is not, and seeks to preserve the properties below in the face
|
|
of untrusted data:
|
|
|
|
Structure Preservation Property
|
|
"... when a template author writes an HTML tag in a safe templating language,
|
|
the browser will interpret the corresponding portion of the output as a tag
|
|
regardless of the values of untrusted data, and similarly for other structures
|
|
such as attribute boundaries and JS and CSS string boundaries."
|
|
|
|
Code Effect Property
|
|
"... only code specified by the template author should run as a result of
|
|
injecting the template output into a page and all code specified by the
|
|
template author should run as a result of the same."
|
|
|
|
Least Surprise Property
|
|
"A developer (or code reviewer) familiar with HTML, CSS, and JavaScript, who
|
|
knows that contextual autoescaping happens should be able to look at a {{.}}
|
|
and correctly infer what sanitization happens."
|
|
*/
|
|
package template
|