Skip to content
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

Create a Security Policy #1856

Merged
merged 5 commits into from
May 3, 2024
Merged

Conversation

joycebrum
Copy link
Contributor

Public Suffix List (PSL) Pull Request (PR) Template

Each PSL PR needs to have a description, rationale, indication of DNS validation and syntax checking, as well as a number of acknowledgements from the submitter. This template must be included with each PR, and the submitting party MUST provide responses to all of the elements in order to be considered.

Checklist of required steps

  • Description of Organization: N/A
  • Robust Reason for PSL Inclusion: N/A
  • DNS verification via dig: N/A
  • Run Syntax Checker (make test): N/A
  • Each domain listed in the PRIVATE section has and shall maintain at least two years remaining on registration, and we shall keep the _PSL txt record in place in the respective zone(s) in the affected section : N/A

Submitter affirms the following:

  • We are listing any third-party limits that we seek to work around in our rationale such as those between IOS 14.5+ and Facebook (see Issue #1245 as a well-documented example)

  • This request was not submitted with the objective of working around other third-party limits

  • The Guidelines were carefully read and understood, and this request conforms

  • The submission follows the guidelines on formatting and sorting


For Private section requests that are submitting entries for domains that match their organization website's primary domain, please understand that this can have impacts that may not match the desired outcome and take a long time to rollback, if at all.

To ensure that requested changes are entirely intentional, make sure that you read the affectation and propagation expectations, that you understand them, and confirm this understanding.

PR Rollbacks have lower priority, and the volunteers are unable to control when or if browsers or other parties using the PSL will refresh or update.

(Link: about propagation/expectations)

  • Yes, I understand. I could break my organization's website cookies etc. and the rollback timing, etc is acceptable. Proceed.

Description

It is important to have a Security Policy in order to show users how to report their findings safely. I've opted for using the report through GitHub Security Advisories (mentioned in the Issue #1855 ) but it is also possible to ask for them to be reported through a given email. If that's what you prefer, let me know or feel free to edit the policy directly.

Closes #1855

Signed-off-by: Joyce <[email protected]>
Copy link
Member

@dnsguru dnsguru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on line 11, can you add a sentence:

Reports are limited to repo matters. Any vulnerability reports related to the addition or removal of PSL entries in the .dat file shall be rejected and referred to filing pull requests that should make mention the alleged urgency.

@dnsguru
Copy link
Member

dnsguru commented Sep 15, 2023

I appreciate you're doing this, as it is one of dozens of "debts" that have gone un-resourced due to there being scant resourcing here on this project.

Signed-off-by: Joyce <[email protected]>
@joycebrum
Copy link
Contributor Author

Done!

SECURITY.md Outdated Show resolved Hide resolved
Signed-off-by: Joyce <[email protected]>
@mozfreddyb
Copy link
Contributor

I can take this review further. I want to suggest two changes:

I believe the sentence Reports are limited to repo matters. Any vulnerability reports related to the addition or removal of PSL entries in the .dat file shall be rejected and referred to filing pull requests that should make mention the alleged urgency. should come a lot earlier. Burying the lede will only cause annoying busy work for everyone involved.

Secondly, if @dnsguru agrees I would like to add [email protected] as a notification email address to inform after filing a new advisory here. This will reach people who are watching diligently at all times, of which 2 already have repository access. I think this would be beneficial - the notification characteristics would ensure that all important information remains in this repository and it will help expedite the handling of important changes when needed.

Signed-off-by: Joyce <[email protected]>
@joycebrum
Copy link
Contributor Author

joycebrum commented Nov 6, 2023

Hi, I've followed the suggestion to move the sentence for the beginning of the section. Let me know if it is better now.

Besides, I've looked for the option for configuring the security advisories notifications to go to a different email, but I wasn't able to find such configuration. This is what I've found: https://docs.github.com/en/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository#configuring-notifications-for-private-vulnerability-reporting

Although I agreed this would be an interesting feature to have.

I could, instead, add a sentence asking the reporters to also notify for the given email linking to the opened report.

@dnsguru
Copy link
Member

dnsguru commented Nov 6, 2023 via email

Copy link
Contributor

@mozfreddyb mozfreddyb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks better, thanks for taking my feedback.

I think to @dnsguru's point, it sounds like a great idea to preface the Reporting section with a section on What we consider to be a vulnerability that we are interested in at all (and what we are not). I think this will help set expectations and reduce false positives.

SECURITY.md Outdated
@@ -4,9 +4,9 @@ Security updates are applied only to the repository itself.

## Reporting a Vulnerability

Reports are limited to repo matters. Any vulnerability reports related to the addition or removal of PSL entries in the .dat file shall be rejected and referred to filing pull requests that should make mention the alleged urgency.

If you have discovered a security vulnerability in this project, please report it privately. **Do not disclose it as a public issue.** This gives us time to work with you to fix the issue before public exposure, reducing the chance that the exploit will be used before a patch is released.
Please disclose it at [security advisory](https://github.com/publicsuffix/list/security/advisories/new).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please disclose it at security advisory and send an email with the link to the newly filed issue to [email protected] to expedite the review on our end.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Signed-off-by: Joyce <[email protected]>
@simon-friedberger
Copy link
Contributor

This looks good to me now. I would suggest merging.

@mozfreddyb mozfreddyb self-requested a review May 3, 2024 07:52
Copy link
Contributor

@mozfreddyb mozfreddyb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, this is good to go :)

@simon-friedberger simon-friedberger merged commit 0c0a279 into publicsuffix:master May 3, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done or Won't
Development

Successfully merging this pull request may close these issues.

Create a Security Policy
4 participants