Clarify security assumptions for email as an authentication channel#1979
Clarify security assumptions for email as an authentication channel#1979jeremyrayjewell wants to merge 4 commits intoOWASP:masterfrom
Conversation
jmanico
left a comment
There was a problem hiding this comment.
I would prefer to split out email security into a different cheatsheet, are you open to that? The AuthN cheatsheet is just too damn big.
Yes, I’m very open to that. I actually agree that email security is its own surface area and probably deserves a dedicated cheat sheet rather than being embedded inside AuthN. Would you prefer this to become a new “Email Authentication Security Cheat Sheet,” or something broader like “Email Security Cheat Sheet” that covers SPF, DKIM, DMARC, and identity workflows together? Once I understand the intended scope and naming, I’m happy to restructure the PR accordingly. |
|
I vote just "email security cheatsheet" and you can talk about AuthN issues there. Then link to this CS from the AuthN one. Smaller cheatsheets win the day. Does that work for you? |
|
That works for me. I’ve moved the email security content into a separate cheat sheet and replaced the section here with a link to it. I’ll flesh out the new Email Security Cheat Sheet next. |
|
It looks like the required GitHub Actions checks are currently blocked with “3 workflows awaiting approval.” |
|
Great contribution! This will be helpful for the community. 🔥 |
|
small lint error: cheatsheets/Email_Security_Cheat_Sheet.md:8 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Email messages are delivered..."] |
|
The markdown lint issue has been fixed and CI is now green. |
|
Since this is a new cheatsheet we need several other reviewers. I am just the first gate. And I want to set expectations this may take a little time. Please hold tight we are on it! |
|
Please carefully add your new cheatsheet here in this PR. https://github.com/OWASP/CheatSheetSeries/blob/master/Index.md |
|
The new Email Security Cheat Sheet has now been added to Index.md under section E, per your request. Ready for further review. Thank you! |
|
@jmanico I am not convinced if this needs a separate cheatsheet. This PR is not following our Contributing Guide IMO we should close PR and open issue to discuss what we want to achieve here |
|
I am a fan of this cheatsheet because email is such a hard type of data to validate, it requires special validation and verification. But I agree as-is this cheatsheet is weak. I am ok to drop for now it but I really do what to see this kind of cheatsheet talk about email validation and email verification flows since its often a part of identity. Dev's need to stay far from the RFC on email to get this right. |
|
Thank you for the feedback. I agree the scope needs clearer definition and stronger alignment with the Contributing Guide. I am happy to close this PR and open an issue to refine scope first. Based on the discussion, a more focused cheat sheet around email validation and verification in identity systems may be more appropriate. I will draft an issue proposal outlining scope and structure for discussion before resubmitting. Appreciate the guidance. |
|
Thank you for working with us! I'm a fan of the direction you are going in |
|
Closing this PR in favor of opening a scoped proposal issue as discussed. I will draft that shortly. |
Thank you for submitting a Pull Request (PR) to the Cheat Sheet Series.
Please make sure that for your contribution:
[TEXT](URL)If your PR is related to an issue, please finish your PR text with the following line:
This PR fixes issue #
<REPLACE WITH ISSUE NUMBER>.AI Tool Usage Disclosure (required for all PRs)
Please select one of the following options:
the contents and I affirm the results. The LLM used is
[llm name and version]and the prompt used is
[your prompt here]. [Feel free to add more details if needed]Thank you again for your contribution 😃