-
Notifications
You must be signed in to change notification settings - Fork 2.1k
JS: Add models-as-data for openapi-backend #22715
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.
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
Open
anttiviljami
wants to merge
2
commits into
github:main
Choose a base branch
from
anttiviljami:js/openapi-backend
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+130
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| --- | ||
| category: minorAnalysis | ||
| --- | ||
| * Added support for the `openapi-backend` package. In particular, `context.request` in operation handlers, security handlers, lifecycle handlers and `validate` predicates is now seen as a source of untrusted user input. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| extensions: | ||
| - addsTo: | ||
| pack: codeql/javascript-all | ||
| extensible: typeModel | ||
| data: | ||
| # OpenAPIBackend instances: `new OpenAPIBackend(...)` and `await api.init()` | ||
| - ["openapi-backend.OpenAPIBackend", "openapi-backend", "Member[OpenAPIBackend,default].Instance"] | ||
| - ["openapi-backend.OpenAPIBackend", "openapi-backend.OpenAPIBackend", "Member[init].ReturnValue.Awaited"] | ||
| # Handler functions registered in the constructor | ||
| - ["openapi-backend.Handler", "openapi-backend", "Member[OpenAPIBackend,default].Argument[0].Member[handlers,securityHandlers].AnyMember"] | ||
| - ["openapi-backend.Handler", "openapi-backend", "Member[OpenAPIBackend,default].Argument[0].Member[validate]"] | ||
| # Handler functions registered after construction | ||
| - ["openapi-backend.Handler", "openapi-backend.OpenAPIBackend", "Member[register,registerHandler,registerSecurityHandler].Argument[1]"] | ||
|
anttiviljami marked this conversation as resolved.
|
||
| - ["openapi-backend.Handler", "openapi-backend.OpenAPIBackend", "Member[register].Argument[0].AnyMember"] | ||
| # The handler context, including TypeScript-annotated `(c: Context) => ...` | ||
| - ["openapi-backend.Context", "openapi-backend.Handler", "Parameter[0]"] | ||
|
|
||
| - addsTo: | ||
| pack: codeql/javascript-all | ||
| extensible: sourceModel | ||
| data: | ||
| - ["openapi-backend.Context", "Member[request]", "remote"] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
javascript/ql/test/query-tests/Security/CWE-089/untyped/openapi-backend-typed.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import OpenAPIBackend, { Context } from 'openapi-backend'; | ||
| import { Pool } from 'pg'; | ||
|
|
||
| const db = new Pool(); | ||
|
|
||
| const getOwner = async (c: Context) => db.query(`SELECT * FROM owners WHERE id = ${c.request.params.id}`); // $ Alert | ||
|
|
||
| export const api = new OpenAPIBackend({ definition: './openapi.yml', handlers: { getOwner } }); |
44 changes: 44 additions & 0 deletions
44
javascript/ql/test/query-tests/Security/CWE-089/untyped/openapi-backend.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| const { OpenAPIBackend } = require('openapi-backend'); | ||
| const OpenAPIBackendDefault = require('openapi-backend').default; | ||
| const { Pool } = require('pg'); | ||
|
|
||
| const db = new Pool(); | ||
|
|
||
| const api = new OpenAPIBackend({ | ||
| definition: './openapi.yml', | ||
| handlers: { | ||
| getPet: (c) => db.query(`SELECT * FROM pets WHERE id = ${c.request.params.id}`), // $ Alert | ||
| getPetSafe: (c) => db.query('SELECT * FROM pets WHERE id = $1', [c.request.params.id]), | ||
| }, | ||
| securityHandlers: { | ||
| apiKey: (c) => db.query(`SELECT * FROM keys WHERE key = '${c.request.headers['x-api-key']}'`), // $ Alert | ||
| }, | ||
| }); | ||
|
|
||
| api.register('findPets', async (c) => { | ||
| const { name } = c.request.query; // $ Source | ||
| return db.query(`SELECT * FROM pets WHERE name = '${name}'`); // $ Alert | ||
| }); | ||
|
|
||
| api.register({ | ||
| createPet: (c) => db.query(`INSERT INTO pets (name) VALUES ('${c.request.requestBody.name}')`), // $ Alert | ||
| }); | ||
|
|
||
| api.registerSecurityHandler('session', (c) => | ||
| db.query(`SELECT * FROM sessions WHERE id = '${c.request.cookies.sid}'`), // $ Alert | ||
| ); | ||
|
|
||
| async function main() { | ||
| const initialized = await new OpenAPIBackendDefault({ definition: './openapi.yml' }).init(); | ||
| initialized.register('deletePet', (c) => db.query(`DELETE FROM pets WHERE id = ${c.request.params.id}`)); // $ Alert | ||
| } | ||
|
|
||
| api.registerHandler('updatePet', (c) => db.query(`UPDATE pets SET name = 'x' WHERE id = ${c.request.params.id}`)); // $ Alert | ||
|
|
||
| const audited = new OpenAPIBackend({ | ||
| definition: './openapi.yml', | ||
| validate: (c) => { | ||
| db.query(`INSERT INTO audit (path) VALUES ('${c.request.path}')`); // $ Alert | ||
| return true; | ||
| }, | ||
| }); |
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.
Uh oh!
There was an error while loading. Please reload this page.