Skip to content

Commit

Permalink
Add notes on security
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Jul 18, 2019
1 parent b58546e commit 8fdb8a4
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,14 @@ Take the following examples:
This occurs if the tag name is not included in the list of [block][] tag
names.

## Security

Improper use of `rehype-raw` can open you up to a
[cross-site scripting (XSS)][xss] attack.

Either do not combine this plugin with user content or use
[`rehype-sanitize`][sanitize].

## Contribute

See [`contributing.md`][contributing] in [`rehypejs/.github`][health] for ways
Expand Down Expand Up @@ -222,3 +230,7 @@ abide by its terms.
[remark-rehype]: https://github.com/remarkjs/remark-rehype

[block]: https://github.com/remarkjs/remark/blob/master/packages/remark-parse/lib/block-elements.js

[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

[sanitize]: https://github.com/rehypejs/rehype-sanitize

0 comments on commit 8fdb8a4

Please sign in to comment.