Skip to content

Commit

Permalink
[Fix] jsx-no-target-blank: improve error messages
Browse files Browse the repository at this point in the history
Show different error messages depending on whether referrer is allowed; clarify about `noreferrer` only being necessary in older browsers.

Closes #3044.
  • Loading branch information
cutiful authored and ljharb committed Sep 29, 2021
1 parent 8785c16 commit 7844d8e
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 7 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Expand Up @@ -8,10 +8,12 @@ This change log adheres to standards from [Keep a CHANGELOG](http://keepachangel
### Fixed
* [`no-namespace`]: fix crash on non-string React.createElement name ([#3082] @ljharb)
* [`no-namespace`]: avoid crash on non-string createElement values ([#3085] @ljharb)
* [`jsx-no-target-blank`]: improve error messages ([#3088] @cutiful)

### Changed
* [Docs] [`jsx-max-props-per-line`]: fix options example ([#3083] @MrRaiter)

[#3088]: https://github.com/yannickcr/eslint-plugin-react/pull/3088
[#3085]: https://github.com/yannickcr/eslint-plugin-react/issue/3085
[#3083]: https://github.com/yannickcr/eslint-plugin-react/pull/3083
[#3082]: https://github.com/yannickcr/eslint-plugin-react/pull/3082
Expand Down
6 changes: 4 additions & 2 deletions docs/rules/jsx-no-target-blank.md
Expand Up @@ -20,8 +20,8 @@ This rule aims to prevent user generated link hrefs and form actions from creati
...
```

* `allowReferrer`: optional boolean. If `true` does not require `noreferrer`. Defaults to `false`.
* `enabled`: for enabling the rule. 0=off, 1=warn, 2=error. Defaults to 0.
* `allowReferrer`: optional boolean. If `true` does not require `noreferrer` (i. e. `noopener` alone is enough, this leaves IE vulnerable). Defaults to `false`.
* `enabled`: for enabling the rule.
* `enforceDynamicLinks`: optional string, 'always' or 'never'
* `warnOnSpreadAttributes`: optional boolean. Defaults to `false`.
* `enforceDynamicLinks` - enforce: optional string, 'always' or 'never'
Expand Down Expand Up @@ -125,6 +125,8 @@ This rule supports the ability to use custom components for forms. To enable thi

For links to a trusted host (e.g. internal links to your own site, or links to a another host you control, where you can be certain this security vulnerability does not exist), you may want to keep the HTTP Referer header for analytics purposes.

If you do not support Internet Explorer (any version), Chrome < 49, Opera < 36, Firefox < 52, desktop Safari < 10.1 or iOS Safari < 10.3, you may set `allowReferrer` to `true`, keep the HTTP Referer header and only add `rel="noopener"` to your links.

## When Not To Use It

If you do not have any external links or forms, you can disable this rule.
9 changes: 6 additions & 3 deletions lib/rules/jsx-no-target-blank.js
Expand Up @@ -97,7 +97,8 @@ function hasSecureRel(node, allowReferrer, warnOnSpreadAttributes, spreadAttribu
}

const messages = {
noTargetBlank: 'Using target="_blank" without rel="noreferrer" is a security risk: see https://html.spec.whatwg.org/multipage/links.html#link-type-noopener'
noTargetBlankWithoutNoreferrer: 'Using target="_blank" without rel="noreferrer" (which implies rel="noopener") is a security risk in older browsers: see https://mathiasbynens.github.io/rel-noopener/#recommendations',
noTargetBlankWithoutNoopener: 'Using target="_blank" without rel="noreferrer" or rel="noopener" (the former implies the latter and is preferred due to wider support) is a security risk: see https://mathiasbynens.github.io/rel-noopener/#recommendations'
};

module.exports = {
Expand Down Expand Up @@ -173,7 +174,8 @@ module.exports = {
const hasDangerousLink = hasExternalLink(node, linkAttribute, warnOnSpreadAttributes, spreadAttributeIndex)
|| (enforceDynamicLinks === 'always' && hasDynamicLink(node, linkAttribute));
if (hasDangerousLink && !hasSecureRel(node, allowReferrer, warnOnSpreadAttributes, spreadAttributeIndex)) {
report(context, messages.noTargetBlank, 'noTargetBlank', {
const messageId = allowReferrer ? 'noTargetBlankWithoutNoopener' : 'noTargetBlankWithoutNoreferrer';
report(context, messages[messageId], messageId, {
node,
fix(fixer) {
// eslint 5 uses `node.attributes`; eslint 6+ uses `node.parent.attributes`
Expand Down Expand Up @@ -244,7 +246,8 @@ module.exports = {
hasExternalLink(node, formAttribute)
|| (enforceDynamicLinks === 'always' && hasDynamicLink(node, formAttribute))
) {
report(context, messages.noTargetBlank, 'noTargetBlank', {
const messageId = allowReferrer ? 'noTargetBlankWithoutNoopener' : 'noTargetBlankWithoutNoreferrer';
report(context, messages[messageId], messageId, {
node
});
}
Expand Down
4 changes: 2 additions & 2 deletions tests/lib/rules/jsx-no-target-blank.js
Expand Up @@ -25,7 +25,7 @@ const parserOptions = {
// ------------------------------------------------------------------------------

const ruleTester = new RuleTester({parserOptions});
const defaultErrors = [{messageId: 'noTargetBlank'}];
const defaultErrors = [{messageId: 'noTargetBlankWithoutNoreferrer'}];

ruleTester.run('jsx-no-target-blank', rule, {
valid: [
Expand Down Expand Up @@ -249,7 +249,7 @@ ruleTester.run('jsx-no-target-blank', rule, {
code: '<a href="http://example.com/20" target="_blank"></a>',
output: '<a href="http://example.com/20" target="_blank" rel="noreferrer"></a>',
options: [{allowReferrer: true}],
errors: defaultErrors
errors: [{messageId: 'noTargetBlankWithoutNoopener'}]
},
{
code: '<a target="_blank" href={ dynamicLink }></a>',
Expand Down

0 comments on commit 7844d8e

Please sign in to comment.