Description

This control ensures that every public repository in the organization contains a SECURITY.md file. The file defines the repository’s security policy, including how to report vulnerabilities and which versions are supported with security updates.

Rationale

Without a published security policy, external researchers and users may not know how to report vulnerabilities responsibly and may disclose them publicly instead. A SECURITY.md file provides a clear, private reporting channel, enabling the organization to receive, triage, and fix vulnerabilities before they are exploited.

Impact

  • Each public repository must contain and maintain a SECURITY.md file.

  • A link to the security policy appears on the repository’s Security tab and when users create a new issue.

  • The organization must monitor the reporting channel defined in the policy.

  • Supports responsible disclosure and vulnerability management requirements.

Default Value

  • Not present by default. Repository maintainers must add a SECURITY.md file to each repository, or an organization owner must add a default security policy to the organization’s .github repository.

Remediation

Test Plan
  1. Sign in to GitHub with access to the target organization.

  2. Navigate to the organization and list its public repositories (Repositories tab, filter Type → Public).

  3. For each public repository, open the Security tab and verify that the security policy is shown as enabled.

  1. If no security policy is present, follow the Implementation Steps to remediate the issue and repeat the test.

Implementation Steps
  1. Sign in to GitHub with write access to the target repository.

  2. Navigate to the target repository.

  3. Select the Security tab.

  4. In the sidebar, select Policy, then click Start setup.

  1. In the new SECURITY.md file, describe the supported versions and how to report a vulnerability (e.g., a security contact email address or GitHub private vulnerability reporting).

  2. Click Commit changes, add a commit message, and commit the file to the default branch (or open a pull request if branch protection requires it).

  1. To apply a default policy to all repositories that do not have their own, add a SECURITY.md file to the organization’s public repository named .github.

Backout Plan
  1. Sign in to GitHub with write access to the target repository.

  2. Navigate to the target repository.

  3. Open the SECURITY.md file and select Delete file from the file menu.

  4. Commit the change to the default branch (or open a pull request if branch protection requires it).

  5. Verify that the security policy is no longer shown on the repository’s Security tab.

References