Skip to content

chore: update security policy #250

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

Open
80avin wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −1
Open

chore: update security policy #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,11 @@ npm run browser-test

- Visit [http://localhost:8082/test/](http://localhost:8082/test/).


## Security

Please see [SECURITY.md](./SECURITY.md) for important security considerations and instructions on how to report vulnerabilities.

## License

[MIT License](https://opensource.org/license/mit/).
20 changes: 19 additions & 1 deletion SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,28 @@
# Security Policy

## Security Considerations

### Query Injection

JSONPath-Plus evaluates JSONPath expressions provided by the caller. While the default `"eval": "safe"` option prevents arbitrary code execution, it **cannot prevent data exposure if the JSONPath query itself is compromised**.

If untrusted input is incorporated into a JSONPath expression, an attacker may be able to alter the query structure by adding additional patterns. This can change how the remaining query is interpreted and may result in **unexpected or broader data being returned** than intended.

**Important notes:**
- This does **not** enable random code execution when using `"eval": "safe"` (the default).
- The primary risk is **data leakage**, not execution of attacker-controlled code.

**Mitigations:**
1. **Do not interpolate unsanitized user input into JSONPath queries.**
2. If user-controlled input must be included in a query, ensure the target JSON object contains **only non-confidential data**.

As a general rule, treat JSONPath expressions as code and avoid constructing them dynamically from untrusted sources.

## Reporting a Vulnerability

**Please do not report security vulnerabilities through public GitHub issues.**

If you believe you’ve found a security vulnerability, please send it to us by emailing [brettz9@yahoo.com](mailto:brettz9@yahoo.com). Please include the following details with your report:
If you believe you’ve found a security vulnerability, please send it to us by emailing [iamavinashthakur.at@gmail.com](mailto:iamavinashthakur.at@gmail.com) or [brettz9@yahoo.com](mailto:brettz9@yahoo.com). Please include the following details with your report:

1. Description of the location and potential impact of the vulnerability

Expand Down