Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JS: React-relay useFragment support #18858

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+231 −1
Open

JS: React-relay useFragment support #18858

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1e3b862
Added a test case where useFragment from react-relay should be marked…
Napalys Feb 25, 2025
1443f31
Added react-relay useFragment as threat model source.
Napalys Feb 25, 2025
0166e76
Add change note
Napalys Feb 25, 2025
89040d0
Added missing `response` and `request` MaD source kinds.
Napalys Feb 25, 2025
5a1991b
Added test cases for `react-relay` functions that retrieve data
Napalys Mar 6, 2025
c12c12c
Added modeling for `react-relay` functions that retrieve data.
Napalys Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions javascript/ql/lib/change-notes/2025-02-25-react-relay.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
category: minorAnalysis
---
* Added support for the `react-relay` library.
15 changes: 15 additions & 0 deletions javascript/ql/lib/ext/react-relay-threat.model.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
extensions:
- addsTo:
pack: codeql/javascript-all
extensible: sourceModel
data:
- ["react-relay", "Member[useFragment].ReturnValue", "response"]
- ["react-relay", "Member[useLazyLoadQuery].ReturnValue", "response"]
- ["react-relay", "Member[usePreloadedQuery].ReturnValue", "response"]
- ["react-relay", "Member[useClientQuery].ReturnValue", "response"]
- ["react-relay", "Member[useRefetchableFragment].ReturnValue", "response"]
- ["react-relay", "Member[usePaginationFragment].ReturnValue", "response"]
- ["react-relay", "Member[useMutation].ReturnValue.Member[0].Argument[0].Member[onCompleted].Argument[0]", "response"]
- ["react-relay", "Member[useSubscription].Argument[0].Member[onNext].Argument[0]", "response"]
- ["react-relay", "Member[fetchQuery].ReturnValue.Member[subscribe].Argument[0].Member[next].Argument[0]", "response"]
- ["relay-runtime", "Member[readFragment].ReturnValue", "response"]
74 changes: 74 additions & 0 deletions javascript/ql/test/query-tests/Security/CWE-079/DomBasedXssWithResponseThreat/Xss.expected
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
#select
| test.jsx:27:29:27:32 | data | test.jsx:5:28:5:63 | fetch(" ... ntent") | test.jsx:27:29:27:32 | data | Cross-site scripting vulnerability due to $@. | test.jsx:5:28:5:63 | fetch(" ... ntent") | user-provided value |
| testReactRelay.tsx:7:43:7:58 | commentData.text | testReactRelay.tsx:5:23:5:52 | useFrag ... entRef) | testReactRelay.tsx:7:43:7:58 | commentData.text | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:5:23:5:52 | useFrag ... entRef) | user-provided value |
| testReactRelay.tsx:18:48:18:68 | data.co ... 0].text | testReactRelay.tsx:17:16:17:42 | useLazy ... ry, {}) | testReactRelay.tsx:18:48:18:68 | data.co ... 0].text | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:17:16:17:42 | useLazy ... ry, {}) | user-provided value |
| testReactRelay.tsx:28:17:28:67 | usePrel ... r?.name | testReactRelay.tsx:28:17:28:56 | usePrel ... erence) | testReactRelay.tsx:28:17:28:67 | usePrel ... r?.name | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:28:17:28:56 | usePrel ... erence) | user-provided value |
| testReactRelay.tsx:38:49:38:52 | data | testReactRelay.tsx:37:16:37:40 | useClie ... ry, {}) | testReactRelay.tsx:38:49:38:52 | data | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:37:16:37:40 | useClie ... ry, {}) | user-provided value |
| testReactRelay.tsx:47:46:47:49 | data | testReactRelay.tsx:44:27:44:70 | useRefe ... omment) | testReactRelay.tsx:47:46:47:49 | data | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:44:27:44:70 | useRefe ... omment) | user-provided value |
| testReactRelay.tsx:70:49:70:52 | data | testReactRelay.tsx:69:7:69:38 | usePagi ... ry, {}) | testReactRelay.tsx:70:49:70:52 | data | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:69:7:69:38 | usePagi ... ry, {}) | user-provided value |
| testReactRelay.tsx:87:50:87:61 | feedbackText | testReactRelay.tsx:82:17:82:20 | data | testReactRelay.tsx:87:50:87:61 | feedbackText | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:82:17:82:20 | data | user-provided value |
| testReactRelay.tsx:112:48:112:58 | fragmentRef | testReactRelay.tsx:99:14:99:16 | res | testReactRelay.tsx:112:48:112:58 | fragmentRef | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:99:14:99:16 | res | user-provided value |
| testReactRelay.tsx:126:35:126:43 | data.user | testReactRelay.tsx:123:12:123:15 | data | testReactRelay.tsx:126:35:126:43 | data.user | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:123:12:123:15 | data | user-provided value |
| testReactRelay.tsx:136:50:136:53 | data | testReactRelay.tsx:135:16:135:39 | readFra ... y, key) | testReactRelay.tsx:136:50:136:53 | data | Cross-site scripting vulnerability due to $@. | testReactRelay.tsx:135:16:135:39 | readFra ... y, key) | user-provided value |
edges
| test.jsx:5:11:5:63 | response | test.jsx:6:24:6:31 | response | provenance | |
| test.jsx:5:22:5:63 | await f ... ntent") | test.jsx:5:11:5:63 | response | provenance | |
@@ -10,6 +20,33 @@ edges
| test.jsx:6:24:6:38 | response.json() | test.jsx:6:18:6:38 | await r ... .json() | provenance | |
| test.jsx:7:12:7:15 | data | test.jsx:15:11:17:5 | data | provenance | |
| test.jsx:15:11:17:5 | data | test.jsx:27:29:27:32 | data | provenance | |
| testReactRelay.tsx:5:9:5:52 | commentData | testReactRelay.tsx:7:43:7:53 | commentData | provenance | |
| testReactRelay.tsx:5:23:5:52 | useFrag ... entRef) | testReactRelay.tsx:5:9:5:52 | commentData | provenance | |
| testReactRelay.tsx:7:43:7:53 | commentData | testReactRelay.tsx:7:43:7:58 | commentData.text | provenance | |
| testReactRelay.tsx:17:9:17:42 | data | testReactRelay.tsx:18:48:18:51 | data | provenance | |
| testReactRelay.tsx:17:16:17:42 | useLazy ... ry, {}) | testReactRelay.tsx:17:9:17:42 | data | provenance | |
| testReactRelay.tsx:18:48:18:51 | data | testReactRelay.tsx:18:48:18:68 | data.co ... 0].text | provenance | |
| testReactRelay.tsx:28:17:28:56 | usePrel ... erence) | testReactRelay.tsx:28:17:28:67 | usePrel ... r?.name | provenance | |
| testReactRelay.tsx:37:9:37:40 | data | testReactRelay.tsx:38:49:38:52 | data | provenance | |
| testReactRelay.tsx:37:16:37:40 | useClie ... ry, {}) | testReactRelay.tsx:37:9:37:40 | data | provenance | |
| testReactRelay.tsx:44:9:44:23 | [data, refetch] | testReactRelay.tsx:44:9:44:70 | data | provenance | |
| testReactRelay.tsx:44:9:44:70 | data | testReactRelay.tsx:47:46:47:49 | data | provenance | |
| testReactRelay.tsx:44:27:44:70 | useRefe ... omment) | testReactRelay.tsx:44:9:44:23 | [data, refetch] | provenance | |
| testReactRelay.tsx:60:9:69:3 | {\\n d ... ch,\\n } | testReactRelay.tsx:60:9:69:38 | data | provenance | |
| testReactRelay.tsx:60:9:69:38 | data | testReactRelay.tsx:70:49:70:52 | data | provenance | |
| testReactRelay.tsx:69:7:69:38 | usePagi ... ry, {}) | testReactRelay.tsx:60:9:69:3 | {\\n d ... ch,\\n } | provenance | |
| testReactRelay.tsx:79:9:79:54 | feedbackText | testReactRelay.tsx:87:50:87:61 | feedbackText | provenance | |
| testReactRelay.tsx:79:10:79:21 | feedbackText | testReactRelay.tsx:79:9:79:54 | feedbackText | provenance | |
| testReactRelay.tsx:82:17:82:20 | data | testReactRelay.tsx:83:23:83:26 | data | provenance | |
| testReactRelay.tsx:83:23:83:26 | data | testReactRelay.tsx:79:10:79:21 | feedbackText | provenance | |
| testReactRelay.tsx:94:9:94:50 | fragmentRef | testReactRelay.tsx:112:48:112:58 | fragmentRef | provenance | |
| testReactRelay.tsx:94:10:94:20 | fragmentRef | testReactRelay.tsx:94:9:94:50 | fragmentRef | provenance | |
| testReactRelay.tsx:99:14:99:16 | res | testReactRelay.tsx:100:22:100:24 | res | provenance | |
| testReactRelay.tsx:100:22:100:24 | res | testReactRelay.tsx:94:10:94:20 | fragmentRef | provenance | |
| testReactRelay.tsx:123:12:123:15 | data | testReactRelay.tsx:126:35:126:38 | data | provenance | |
| testReactRelay.tsx:126:35:126:38 | data | testReactRelay.tsx:126:35:126:43 | data.user | provenance | |
| testReactRelay.tsx:135:9:135:39 | data | testReactRelay.tsx:136:50:136:53 | data | provenance | |
| testReactRelay.tsx:135:16:135:39 | readFra ... y, key) | testReactRelay.tsx:135:9:135:39 | data | provenance | |
nodes
| test.jsx:5:11:5:63 | response | semmle.label | response |
| test.jsx:5:22:5:63 | await f ... ntent") | semmle.label | await f ... ntent") |
@@ -21,4 +58,41 @@ nodes
| test.jsx:7:12:7:15 | data | semmle.label | data |
| test.jsx:15:11:17:5 | data | semmle.label | data |
| test.jsx:27:29:27:32 | data | semmle.label | data |
| testReactRelay.tsx:5:9:5:52 | commentData | semmle.label | commentData |
| testReactRelay.tsx:5:23:5:52 | useFrag ... entRef) | semmle.label | useFrag ... entRef) |
| testReactRelay.tsx:7:43:7:53 | commentData | semmle.label | commentData |
| testReactRelay.tsx:7:43:7:58 | commentData.text | semmle.label | commentData.text |
| testReactRelay.tsx:17:9:17:42 | data | semmle.label | data |
| testReactRelay.tsx:17:16:17:42 | useLazy ... ry, {}) | semmle.label | useLazy ... ry, {}) |
| testReactRelay.tsx:18:48:18:51 | data | semmle.label | data |
| testReactRelay.tsx:18:48:18:68 | data.co ... 0].text | semmle.label | data.co ... 0].text |
| testReactRelay.tsx:28:17:28:56 | usePrel ... erence) | semmle.label | usePrel ... erence) |
| testReactRelay.tsx:28:17:28:67 | usePrel ... r?.name | semmle.label | usePrel ... r?.name |
| testReactRelay.tsx:37:9:37:40 | data | semmle.label | data |
| testReactRelay.tsx:37:16:37:40 | useClie ... ry, {}) | semmle.label | useClie ... ry, {}) |
| testReactRelay.tsx:38:49:38:52 | data | semmle.label | data |
| testReactRelay.tsx:44:9:44:23 | [data, refetch] | semmle.label | [data, refetch] |
| testReactRelay.tsx:44:9:44:70 | data | semmle.label | data |
| testReactRelay.tsx:44:27:44:70 | useRefe ... omment) | semmle.label | useRefe ... omment) |
| testReactRelay.tsx:47:46:47:49 | data | semmle.label | data |
| testReactRelay.tsx:60:9:69:3 | {\\n d ... ch,\\n } | semmle.label | {\\n d ... ch,\\n } |
| testReactRelay.tsx:60:9:69:38 | data | semmle.label | data |
| testReactRelay.tsx:69:7:69:38 | usePagi ... ry, {}) | semmle.label | usePagi ... ry, {}) |
| testReactRelay.tsx:70:49:70:52 | data | semmle.label | data |
| testReactRelay.tsx:79:9:79:54 | feedbackText | semmle.label | feedbackText |
| testReactRelay.tsx:79:10:79:21 | feedbackText | semmle.label | feedbackText |
| testReactRelay.tsx:82:17:82:20 | data | semmle.label | data |
| testReactRelay.tsx:83:23:83:26 | data | semmle.label | data |
| testReactRelay.tsx:87:50:87:61 | feedbackText | semmle.label | feedbackText |
| testReactRelay.tsx:94:9:94:50 | fragmentRef | semmle.label | fragmentRef |
| testReactRelay.tsx:94:10:94:20 | fragmentRef | semmle.label | fragmentRef |
| testReactRelay.tsx:99:14:99:16 | res | semmle.label | res |
| testReactRelay.tsx:100:22:100:24 | res | semmle.label | res |
| testReactRelay.tsx:112:48:112:58 | fragmentRef | semmle.label | fragmentRef |
| testReactRelay.tsx:123:12:123:15 | data | semmle.label | data |
| testReactRelay.tsx:126:35:126:38 | data | semmle.label | data |
| testReactRelay.tsx:126:35:126:43 | data.user | semmle.label | data.user |
| testReactRelay.tsx:135:9:135:39 | data | semmle.label | data |
| testReactRelay.tsx:135:16:135:39 | readFra ... y, key) | semmle.label | readFra ... y, key) |
| testReactRelay.tsx:136:50:136:53 | data | semmle.label | data |
subpaths
137 changes: 137 additions & 0 deletions ...ipt/ql/test/query-tests/Security/CWE-079/DomBasedXssWithResponseThreat/testReactRelay.tsx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
import React, { useState } from "react";
import { useFragment } from 'react-relay';

const func1 = ({ commentRef, query }) => {
const commentData = useFragment(query, commentRef); // $ Source=[js/xss]
return (
<p dangerouslySetInnerHTML={{ __html: commentData.text }}> // $ Alert=[js/xss]
{" "}
{commentData.text}
</p>
);
};

import { useLazyLoadQuery } from "react-relay";

function func2({ query }) {
const data = useLazyLoadQuery(query, {}); // $ Source
return <p dangerouslySetInnerHTML={{ __html: data.comments[0].text }} />; // $ Alert
}

import { useQueryLoader, usePreloadedQuery } from "react-relay";

function func3({ initialQueryRef, query }) {
const [queryReference, loadQuery] = useQueryLoader(query, initialQueryRef);
return (
<h1
dangerouslySetInnerHTML={{
__html: usePreloadedQuery(query, queryReference).user?.name, // $ Alert
}}
/>
);
}

import { useClientQuery } from "react-relay";

function func4({ query }) {
const data = useClientQuery(query, {}); // $ Source
return <h1 dangerouslySetInnerHTML={{ __html: data }} />; // $ Alert
}

import { useRefetchableFragment } from "react-relay";

function func5({ query, props }) {
const [data, refetch] = useRefetchableFragment(query, props.comment); // $ Source
return (
<>
<h1 dangerouslySetInnerHTML={{ __html: data }} /> // $ Alert
<Button
onClick={() => {
refetch({ lang: "SPANISH" }, { fetchPolicy: "store-or-network" });
}}
></Button>
</>
);
}

import { usePaginationFragment } from "react-relay";

function func6({ query }) {
const {
data,
loadNext,
loadPrevious,
hasNext,
hasPrevious,
isLoadingNext,
isLoadingPrevious,
refetch,
} = usePaginationFragment(query, {}); // $ Source
return <h1 dangerouslySetInnerHTML={{ __html: data }} />; // $ Alert
}


import { useMutation } from 'react-relay';
import type { FeedbackLikeMutation } from './FeedbackLikeMutation.graphql';

function func7(query) {
const [commit, inFlight] = useMutation<FeedbackLikeMutation>(query);
const [feedbackText, setFeedbackText] = useState('');

commit({
onCompleted(data) { // $ Source
setFeedbackText(data);
},
});

return (<div dangerouslySetInnerHTML={{__html: feedbackText, }}/>); // $ Alert
}

import { useSubscription } from 'react-relay';
import { useMemo } from 'react';

function func8({GroupLessonsSubscription}) {
const [fragmentRef, setFragmentRef] = useState();

const groupLessonConfig = useMemo(() => ({
subscription: GroupLessonsSubscription,
variables: {},
onNext: (res) => { // $ Source
setFragmentRef(res);
},
onError: (err) => {
console.error('Error with subscription:', err);
},
onCompleted: () => {
console.log('Subscription completed');
},
}), []);

useSubscription(groupLessonConfig);

return (<div dangerouslySetInnerHTML={{__html: fragmentRef, }}/>); // $ Alert
}


import { fetchQuery } from 'react-relay'

function func9({query, environment}) {
fetchQuery(environment, query,{id: 4},).subscribe({
start: () => {},
complete: () => {},
error: (error) => {},
next: (data) => { // $ Source
const outputElement = document.getElementById('output');
if (outputElement) {
outputElement.innerHTML = data.user; // $ Alert
}
}
});
}

import { readFragment } from "relay-runtime";

function func10({ query, key }) {
const data = readFragment(query, key); // $ Source
return (<h1 dangerouslySetInnerHTML={{ __html: data }} />); // $ Alert
}
2 changes: 1 addition & 1 deletion shared/mad/codeql/mad/ModelValidation.qll
View file
Original file line number Diff line number Diff line change
@@ -125,7 +125,7 @@ module KindValidation<KindValidationConfigSig Config> {
// C#
"file-write", "windows-registry",
// JavaScript
"database-access-result"
"database-access-result", "response", "request"
]
or
this.matches([