docs: improve & expand security documentation #317
Merged
Conversation
This file contains 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
Alternative to #311 (this patch includes a few miscellaneous documentation fixes from that PR as well). The previous documentation didn't sufficiently cover permissions issues and mixed all the security concerns into a single section. This patch separates things out into separate sections and hopefully makes all this easier to understand. This patch also documents the DOS mitigation introduced in #314. I've also removed the link to the OWASP documentation to avoid confusing users (their documentation is mostly concerned with low-level C and platform-specific temporary file creation functions).
|
P.S. I used your documentation as a point of reference today, as I was reviewing whether my usage of your crate was sane. I think I have to mention that it was immensely helpful from my perspective. I found the explanations in the sections "Denial of Service" and "Temporary File Cleaners" to be very, very good. I really liked the step-by-step Mitigations and the short explanations as to whether "this problem is likely to affect the developer in any capacity whatsoever". |
|
I'm glad it was helpful! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Alternative to #311 (this patch includes a few miscellaneous documentation fixes from that PR as well).
The previous documentation didn't sufficiently cover permissions issues and mixed all the security concerns into a single section. This patch separates things out into separate sections and hopefully makes all this easier to understand.
This patch also documents the DoS mitigation introduced in #314 (I stared writing this documentation first then decided that I'd rather just fix the DoS vector...).
I've also removed the link to the OWASP documentation to avoid confusing users (their documentation is mostly concerned with low-level C and platform-specific temporary file creation functions).