-
Notifications
You must be signed in to change notification settings - Fork 5
add some docs regarding security #335
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
Conversation
xavierpinho
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the prompt discussion and clarifications!
Just a typo (double negation) I spotted:
nor should (not/it) cause
README.md
Outdated
|
|
||
| If you need to handle untrusted `.fg` files, then we recommend some form of sandboxing in order to limit the DoS impact. | ||
|
|
||
| If you do decide against our recommendation to write your own code to "sanity check" potentially malicious `.fg` files before attempting to deserialize them, then we'd be happy for your feedback and PRs. (also beware of potential parser differentials -- e.g. the manifest json can be reached either via the offset from the file header, or via `tail -n 1`, and these may very well be different manifests) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| If you do decide against our recommendation to write your own code to "sanity check" potentially malicious `.fg` files before attempting to deserialize them, then we'd be happy for your feedback and PRs. (also beware of potential parser differentials -- e.g. the manifest json can be reached either via the offset from the file header, or via `tail -n 1`, and these may very well be different manifests) | |
| You should always sanity check potentially malicious `.fg` files before attempting to deserialize them. If there's anything we can add in flatgraph's Deserializer, we'd be happy for your feedback and PRs. | |
| N.b. also beware of potential parser differentials -- e.g. the manifest json can be reached either via the offset from the file header, or via `tail -n 1`, and these may very well be different manifests. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No. Our recommendation is to not bother with sanity checks, and do sandboxing instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Your initial text says "our recommendation to write your own code to "sanity check" potentially malicious .fg files", which I interpret as 'we do recommend to write code to sanity check.
But yes, fair enough, will provide a new suggestion based on the current version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ah, you already updated that part - thanks!
Co-authored-by: Michael Pollmeier <[email protected]>
Co-authored-by: Michael Pollmeier <[email protected]>
Co-authored-by: Michael Pollmeier <[email protected]>
Co-authored-by: Michael Pollmeier <[email protected]>
This adds some clarifications regarding security goals. Big thanks to https://github.com/xavierpinho ❤️ for mentioning that here https://github.com/joernio/flatgraph/security/advisories/GHSA-jqmx-3x2p-69vh
Any improvement / rewording ideas?