Skip to content

Commit 3d726a4

Browse files
committedJul 24, 2019
Add notes on security
1 parent fa0457b commit 3d726a4

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed
 

‎readme.md

+9
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,13 @@ For example, the following node:
171171
<i class="foo">bar</i>
172172
```
173173

174+
## Security
175+
176+
Use of `remark-html` is *unsafe* by default and opens you up to a
177+
[cross-site scripting (XSS)][xss] attack.
178+
Pass `sanitize: true` to prevent attacks.
179+
Settings `sanitize` to anything else may be unsafe.
180+
174181
## Contribute
175182

176183
See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways
@@ -256,3 +263,5 @@ abide by its terms.
256263
[commonmark]: https://commonmark.org
257264

258265
[integrations]: #integrations
266+
267+
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

0 commit comments

Comments
 (0)