Skip to content

JS: support hana db client #19118

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

Merged
Napalys merged 14 commits into from
Mar 31, 2025
Merged

JS: support hana db client #19118

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
032cfc1
Added test cases for `hana` clients.
Napalys Mar 25, 2025
9229962
Add sink model for SQL injection detection in `exec` clients.
Napalys Mar 25, 2025
d28af95
Added sink models for `hana`'s client `prepare` function.
Napalys Mar 25, 2025
e595def
Modeled `execute` as potential `hana`'s sink.
Napalys Mar 25, 2025
0285cb6
Added `@sap/hdbext.loadProccedure` as sql sink.
Napalys Mar 25, 2025
7cc0634
Added `createProcStatement` as potential sql sink.
Napalys Mar 25, 2025
4cdc40d
Added SQL injection detection for `exec` method embeded Express clien…
Napalys Mar 25, 2025
62ab7f5
Added change note.
Napalys Mar 26, 2025
e69929e
Update javascript/ql/lib/change-notes/2025-03-26-hana-db-client.md
Napalys Mar 27, 2025
f7264d8
Merge branch 'main' into js/hana_db_client
Napalys Mar 28, 2025
f3af23e
Refactored hana's DB client to use `GuardedRouteHandler`, improving p…
Napalys Mar 28, 2025
d0e2aa8
Added sources from `hana` db as `MaD`.
Napalys Mar 28, 2025
45c8ec9
Added test cases for `hana` db additional sources.
Napalys Mar 28, 2025
32d6ac8
Add test case to ensure `exec` calls without middleware injection int…
Napalys Mar 30, 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
1 change: 1 addition & 0 deletions javascript/ql/lib/ext/hana-db-client.model.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ extensions:
- ["hdb", "Member[createClient].ReturnValue.Member[exec,prepare,execute].Argument[0]", "sql-injection"]
- ["@sap/hdbext", "Member[loadProcedure].Argument[2]", "sql-injection"]
- ["@sap/hana-client/extension/Stream", "Member[createProcStatement].Argument[1]", "sql-injection"]
- ["express", "ReturnValue.Member[get].Argument[1].Parameter[0].Member[db].Member[exec].Argument[0]", "sql-injection"]
3 changes: 3 additions & 0 deletions javascript/ql/test/query-tests/Security/CWE-089/untyped/SqlInjection.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
| hana.js:17:35:17:100 | `SELECT ... usInput | hana.js:16:32:16:39 | req.body | hana.js:17:35:17:100 | `SELECT ... usInput | This query string depends on a $@. | hana.js:16:32:16:39 | req.body | user-provided value |
| hana.js:24:33:24:96 | `INSERT ... usInput | hana.js:23:32:23:39 | req.body | hana.js:24:33:24:96 | `INSERT ... usInput | This query string depends on a $@. | hana.js:23:32:23:39 | req.body | user-provided value |
| hana.js:31:31:31:97 | "SELECT ... usInput | hana.js:30:30:30:37 | req.body | hana.js:31:31:31:97 | "SELECT ... usInput | This query string depends on a $@. | hana.js:30:30:30:37 | req.body | user-provided value |
| hana.js:48:15:48:52 | 'SELECT ... usInput | hana.js:47:24:47:31 | req.body | hana.js:48:15:48:52 | 'SELECT ... usInput | This query string depends on a $@. | hana.js:47:24:47:31 | req.body | user-provided value |
| hana.js:50:40:50:89 | 'CALL P ... usInput | hana.js:47:24:47:31 | req.body | hana.js:50:40:50:89 | 'CALL P ... usInput | This query string depends on a $@. | hana.js:47:24:47:31 | req.body | user-provided value |
| hana.js:54:38:54:66 | 'PROC_D ... usInput | hana.js:47:24:47:31 | req.body | hana.js:54:38:54:66 | 'PROC_D ... usInput | This query string depends on a $@. | hana.js:47:24:47:31 | req.body | user-provided value |
| hana.js:71:44:71:99 | "INSERT ... usInput | hana.js:68:24:68:31 | req.body | hana.js:71:44:71:99 | "INSERT ... usInput | This query string depends on a $@. | hana.js:68:24:68:31 | req.body | user-provided value |
Expand Down Expand Up @@ -181,6 +182,7 @@ edges
| hana.js:47:7:47:36 | maliciousInput | hana.js:50:76:50:89 | maliciousInput | provenance | |
| hana.js:47:7:47:36 | maliciousInput | hana.js:54:53:54:66 | maliciousInput | provenance | |
| hana.js:47:24:47:31 | req.body | hana.js:47:7:47:36 | maliciousInput | provenance | |
| hana.js:48:39:48:52 | maliciousInput | hana.js:48:15:48:52 | 'SELECT ... usInput | provenance | |
| hana.js:48:39:48:52 | maliciousInput | hana.js:50:76:50:89 | maliciousInput | provenance | |
| hana.js:50:76:50:89 | maliciousInput | hana.js:50:40:50:89 | 'CALL P ... usInput | provenance | |
| hana.js:50:76:50:89 | maliciousInput | hana.js:54:53:54:66 | maliciousInput | provenance | |
Expand Down Expand Up @@ -569,6 +571,7 @@ nodes
| hana.js:31:84:31:97 | maliciousInput | semmle.label | maliciousInput |
| hana.js:47:7:47:36 | maliciousInput | semmle.label | maliciousInput |
| hana.js:47:24:47:31 | req.body | semmle.label | req.body |
| hana.js:48:15:48:52 | 'SELECT ... usInput | semmle.label | 'SELECT ... usInput |
| hana.js:48:39:48:52 | maliciousInput | semmle.label | maliciousInput |
| hana.js:50:40:50:89 | 'CALL P ... usInput | semmle.label | 'CALL P ... usInput |
| hana.js:50:76:50:89 | maliciousInput | semmle.label | maliciousInput |
Expand Down
2 changes: 1 addition & 1 deletion javascript/ql/test/query-tests/Security/CWE-089/untyped/hana.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ app1.use(hdbext.middleware(hanaConfig));
app1.get('/execute-query', function (req, res) {
var client = req.db;
let maliciousInput = req.body.data; // $ Source
client.exec('SELECT * FROM DUMMY' + maliciousInput, function (err, rs) {}); // $ MISSING: Alert
client.exec('SELECT * FROM DUMMY' + maliciousInput, function (err, rs) {}); // $ Alert
Copy link
Copy Markdown
Contributor

@erik-krogh erik-krogh Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would have been nice to restrict this sink to only the cases where we've detected the app1.use(hdbext.middleware(hanaConfig)); call.
But we can't express that with MaD.

So this will support all databases that attach themselves to the req.db property (and have an exec(..) method).
I think that's fine, but I would like a second opinion @asgerf.

Copy link
Copy Markdown
Contributor Author

@Napalys Napalys Mar 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'm definitely not proud of the way I wrote this SQL sink, but I couldn't think of a way to express that in Model as Data. 🙈 The odds seem to be very low that there would exist path like this unrelated to hdbext.middleware(hanaConfig).

Copy link
Copy Markdown
Contributor

@asgerf asgerf Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to go the extra mile here in order to make this work properly, because it's quite common to extend request/response objects from middlewares.

I'll aim to put up a PR that adds support for a new access path component called GuardedRouteHandler which should do what we need here. The idea is that it goes from the middleware object to all the route handlers guarded by it.

We should then be able to write the model like this:

Screenshot 2025-03-27 at 13 39 21

I have a working proof of concept locally just need to polish it up a bit.

You can either

  • leave this PR open and wait for GuardedRouteHandler support, or
  • remove the express line from the model and mark the alerts as MISSING and merge as it is. I'll add it back when adding GuardedRouteHandler support.

Copy link
Copy Markdown
Contributor

@asgerf asgerf Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#19132

Copy link
Copy Markdown
Contributor Author

@Napalys Napalys Mar 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll leave this PR open and wait for GuardedRouteHandler support.

Copy link
Copy Markdown
Contributor Author

@Napalys Napalys Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed f3af23e


dbStream.createProcStatement(client, 'CALL PROC_DUMMY (?, ?, ?, ?, ?)' + maliciousInput, function (err, stmt) { // $ Alert
stmt.exec({ A: maliciousInput, B: 4 }, function (err, params, dummyRows, tablesRows) {}); // maliciousInput is treated as a parameter
Expand Down