aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/google/safehtml/README.md
diff options
context:
space:
mode:
authorTaras Madan <tarasmadan@google.com>2023-02-22 22:16:50 +0100
committerTaras Madan <tarasmadan@google.com>2023-02-24 12:47:23 +0100
commit4165372ec8fd142475a4e35fd0cf4f8042132208 (patch)
tree21cd62211b4dd80bee469054c5b65db77342333c /vendor/github.com/google/safehtml/README.md
parent2b3ed821a493b8936c8bacfa6f8b4f1c90a00855 (diff)
dependencies: update
set go min requirements to 1.19 update dependencies update vendor
Diffstat (limited to 'vendor/github.com/google/safehtml/README.md')
-rw-r--r--vendor/github.com/google/safehtml/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/vendor/github.com/google/safehtml/README.md b/vendor/github.com/google/safehtml/README.md
new file mode 100644
index 000000000..d3c9676d1
--- /dev/null
+++ b/vendor/github.com/google/safehtml/README.md
@@ -0,0 +1,17 @@
+# Safe HTML for Go
+
+`safehtml` provides immutable string-like types that wrap web types such as
+HTML, JavaScript and CSS. These wrappers are safe by construction against XSS
+and similar web vulnerabilities, and they can only be interpolated in safe ways.
+You can read more about our approach to web security in our
+[whitepaper](https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/42934.pdf),
+or this [OWASP talk](https://www.youtube.com/watch?v=ccfEu-Jj0as).
+
+Additional subpackages provide APIs for managing exceptions to the
+safety rules, and a template engine with a syntax and interface that closely
+matches [`html/template`](https://golang.org/pkg/html/template/). You can refer
+to the [godoc](https://pkg.go.dev/github.com/google/safehtml?tab=doc)
+for each (sub)package for the API documentation and code examples.
+More end-to-end demos are available in `example_test.go`.
+
+This is not an officially supported Google product.