This repository has been archived by the owner on Sep 20, 2023. It is now read-only.
Update dependency graphiql to v1 [SECURITY] #4633
Open
+103
−49
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^0.17.0
->^1.0.0
GitHub Vulnerability Alerts
CVE-2021-41248
This is a security advisory for an XSS vulnerability in
graphiql
.A similar vulnerability affects
graphql-playground
, a fork ofgraphiql
. There is a correspondinggraphql-playground
advisory and Apollo Server advisory.1. Impact
All versions of
graphiql
older thangraphiql@1.4.7
are vulnerable to compromised HTTP schema introspection responses orschema
prop values with malicious GraphQL type names, exposing a dynamic XSS attack surface that can allow code injection on operation autocomplete.In order for the attack to take place, the user must load a vulnerable schema in
graphiql
. There are a number of ways that can occur.By default, the schema URL is not attacker-controllable in
graphiql
or in its suggested implementations or examples, leaving only very complex attack vectors.If a custom implementation of
graphiql
'sfetcher
allows the schema URL to be set dynamically, such as a URL query parameter like?endpoint=
ingraphql-playground
, or a database provided value, then this customgraphiql
implementation is vulnerable to phishing attacks, and thus much more readily available, low or no privelege level xss attacks. The URLs could look like any generic looking graphql schema URL.Because this exposes an XSS attack surface, it would be possible for a threat actor to exfiltrate user credentials, data, etc. using arbitrary malicious scripts, without it being known to the user.
2. Scope
This advisory describes the impact on the
graphiql
package. The vulnerability also affects other projects forked fromgraphiql
such asgraphql-playground
and thegraphql-playground
fork distributed by Apollo Server. The impact is more severe in thegraphql-playground
implementations; see thegraphql-playground
advisory and Apollo Server advisory for details.This vulnerability does not impact
codemirror-graphql
,monaco-graphql
or other dependents, as it exists inonHasCompletion.ts
ingraphiql
. It does impact all forks ofgraphiql
, and every released version ofgraphiql
.It should be noted that desktop clients such as Altair, Insomnia, Postwoman, do not appear to be impacted by this.
3. Patches
graphiql@1.4.7
addresses this issue via defense in depth.HTML-escaping text that should be treated as text rather than HTML. In most of the app, this happens automatically because React escapes all interpolated text by default. However, one vulnerable component uses the unsafe
innerHTML
API and interpolated type names directly into HTML. We now properly escape that type name, which fixes the known vulnerability.Validates the schema upon receiving the introspection response or schema changes. Schemas with names that violate the GraphQL spec will no longer be loaded. (This includes preventing the Doc Explorer from loading.) This change is also sufficient to fix the known vulnerability. You can disable this validation by setting
dangerouslyAssumeSchemaIsValid={true}
, which means you are relying only on escaping values to protect you from this attack.Ensuring that user-generated HTML is safe. Schemas can contain Markdown in
description
anddeprecationReason
fields, and the web app renders them to HTML using themarkdown-it
library. As part of the development ofgraphiql@1.4.7
, we verified that our use ofmarkdown-it
prevents the inclusion of arbitrary HTML. We usemarkdown-it
without settinghtml: true
, so we are comfortable relying onmarkdown-it
's HTML escaping here. We considered running a second level of sanitization over all rendered Markdown using a library such asdompurify
but believe that is unnecessary asmarkdown-it
's sanitization appears to be adequate.graphiql@1.4.7
does update to the latest version ofmarkdown-it
(v12, from v10) so that any security fixes in v11 and v12 will take effect.3.1 CDN bundle implementations may be automatically patched
Note that if your implementation is depending on a CDN version of
graphiql
, and is pointed to thelatest
tag (usually the default for most cdns if no version is specified) then this issue is already mitigated, in case you were vulnerable to it before.4. Workarounds for Older Versions
If you cannot use
graphiql@1.4.7
or laterAlways use a static URL to a trusted server that is serving a trusted GraphQL schema.
If you have a custom implementation that allows using user-provided schema URLs via a query parameter, database value, etc, you must either disable this customization, or only allow trusted URLs.
5. How to Re-create the Exploit
You can see an example on codesandbox. These are both fixed to the last
graphiql
release1.4.6
which is the last vulnerable release; however it would work with any previous release ofgraphiql
.Both of these examples are meant to demonstrate the phishing attack surface, so they are customized to accept a
url
parameter. To demonstrate the phishing attack, add?url=https://graphql-xss-schema.netlify.app/graphql
to the in-codesandbox browser.Erase the contents of the given query and type
{u
. You will see an alert window open, showing that attacker-controlled code was executed.Note that when React is in development mode, a validation exception is thrown visibly; however that exception is usually buried in the browser console in a production build of
graphiql
. This validation exception comes fromgetDiagnostics
, which invokesgraphql
validate()
which in turn willassertValidSchema()
, asapollo-server-core
does on executing each operation. This validation does not prevent the exploit from being successful.Note that something like the
url
parameter is not required for the attack to happen ifgraphiql
'sfetcher
is configured in a different way to communicate with a compromised GraphQL server.6. Credit
This vulnerability was discovered by @Ry0taK, thank you! 🥇
Others who contributed:
7. References
The vulnerability has always been present
In the first commit
And later moved to onHasCompletion.js in 2016 (now
.ts
after the typescript migration)8. For more information
If you have any questions or comments about this advisory:
Release Notes
graphql/graphiql
v1.4.7
Patch Changes
130ddad6
Thanks @acao! - CRITICAL SECURITY PATCH for the GraphiQL introspection schema template injection attackv1.4.6
Patch Changes
d3a88283
#1934 Thanks @tonyfromundefined! - add react 17, 18 in peerDependenciesafaa36c1
#1883 Thanks @Sweetabix1! - Updating font colors for line numbers, comments & brackets from #999 to #666 for accessibility purposes. #666 passes AA accessibility standards for small text, with a contrast ratio of over 5:1.75dbb0b1
#1777 Thanks @dwwoelfel! - adopt block string parsing for variables in language parserUpdated dependencies [
0e2c1a02
,75dbb0b1
]:v1.4.5
Patch Changes
86795d5f
Thanks @acao! - Remove bad type definition fromsubscriptions-transport-ws
#1992 closes #1989Updated dependencies [
86795d5f
]:v1.4.4
Patch Changes
62e786b5
#1990 Thanks @acao! - Remove type definition fromsubscriptions-transport-ws
Updated dependencies [
62e786b5
]:v1.4.3
Patch Changes
6a459f4c
#1968 Thanks @acao! - RemoveoptionalDependencies
entirely, removesubscriptions-transport-ws
which introduces vulnerabilities, upgrade@n1ru4l/push-pull-async-iterable-iterator
to 3.0.0, upgradegraphql-ws
several minor versions - thegraphql-ws@5.x
upgrade will come in a later minor release.eb2d91fa
#1914 Thanks @harshithpabbati! - fix: history can now be saved even when query history panel is not openedfeat: create a new maxHistoryLength prop to allow more than 20 queries in history panel
04fad79c
#1889 Thanks @henryqdineen! - feat: export ToolbarSelectOption and ToolbarMenuItemcd685435
#1923 Thanks @cgarnier! - Fix result window themeUpdated dependencies [
6a459f4c
,2fd5bf72
]:v1.4.2
Patch Changes
5b8a057d
#1838 Thanks @acao! - Set all cross-runtime build targets to es6v1.3.2
Compare Source
Note: Version bump only for package graphiql
v1.3.1
Compare Source
Note: Version bump only for package graphiql
v1.3.0
Compare Source
Chores
v1.2.2
Compare Source
Chores
v1.2.1
Compare Source
Patch Changes
858907d2
#2045 Thanks @acao! - fix graphql-js peer dependencies - #2044Updated dependencies [
858907d2
]:v1.2.0
Compare Source
Minor Changes
d0c22c4f
#2035 Thanks @imolorhe! - Added Codemirror 6 legacy supportPatch Changes
b79bf304
#2037 Thanks @acao! - Resolves #1944, replaces graphql-language-service-utils with graphql-language-service in codemirror-graphqlv1.1.0
Compare Source
Minor Changes
716cf786
#2010 Thanks @acao! - upgrade tographql@16.0.0-experimental-stream-defer.5
. thanks @saihaj!Patch Changes
8869c4b1
,716cf786
]:v1.0.6
Compare Source
Bug Fixes
v1.0.5
Compare Source
Note: Version bump only for package graphiql
v1.0.4
Compare Source
Bug Fixes
v1.0.3
Compare Source
Patch Changes
75dbb0b1
#1777 Thanks @dwwoelfel! - adopt block string parsing for variables in language parserUpdated dependencies [
75dbb0b1
]:v1.0.2
Compare Source
Patch Changes
5b8a057d
#1838 Thanks @acao! - Set all cross-runtime build targets to es6v1.0.1
Compare Source
Bug Fixes
v1.0.0
Compare Source
Bug Fixes
Configuration
📅 Schedule: "" (UTC).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.