Skip to content

[SECURITY] Add more guidelines for security disclosures#592

Merged
fxamacker merged 5 commits intomainfrom
fxamacker/add-more-guidelines-for-security-reports
Dec 16, 2025
Merged

[SECURITY] Add more guidelines for security disclosures#592
fxamacker merged 5 commits intomainfrom
fxamacker/add-more-guidelines-for-security-reports

Conversation

@fxamacker
Copy link
Member

@fxamacker fxamacker commented Oct 24, 2025

Updates onflow/flow-go#8042

Expanded and clarified additional guidelines to include more info in the security reports:

Guidelines For Responsible Disclosure

We ask that all researchers adhere to these guidelines here.

Additionally, please include the following in the security report:

  • the name and version of the AI, scanner, etc. that detected the issue (this can help us handle reports generated by buggy tools more efficiently)

  • list of affected 32-bit or 64-bit architectures (currently, Atree is officially supported on 64-bit)

  • version of Flow Emulator used to check the reported issue (issue might be prevented by Flow components that set or enforce limits on Atree)

Before submitting a security report, please review your source code included in the report. For example, please make sure the reported panic isn't caused by an overlooked mistake in the report's test code.


  • Targeted PR against main branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

Added: "Before submitting a security report, please review your source code included in the report. For example, please check if function calls return any errors and avoid calling a function on a `nil` object."
@fxamacker fxamacker self-assigned this Oct 24, 2025
@fxamacker fxamacker requested a review from turbolent as a code owner October 24, 2025 15:41
@fxamacker fxamacker added the documentation Improvements or additions to documentation label Oct 24, 2025
@fxamacker
Copy link
Member Author

@turbolent PTAL 🙏

If security reports contain obvious bugs that can be spotted at a quick glance, then I think there is a chance that some reviewer in the future might not examine the report's other content as thoroughly as they should.

Update to clarify and expand the additional guidelines to mention Flow Emulator, etc.:

# **Guidelines For Responsible Disclosure**

We ask that all researchers adhere to these guidelines [here](https://flow.com/flow-responsible-disclosure).

Additionally, please include the following in the security report:

- the name and version of the AI, scanner, etc. that detected the issue (this can help us handle reports generated by buggy tools more efficiently)

- list of affected 32-bit or 64-bit architectures (currently, Atree is officially supported on 64-bit platforms)

- version of [Flow Emulator](https://github.com/onflow/flow-emulator) used to check if the reported issue (issue might be prevented by Flow components that set or enforce limits on Atree)

Before submitting a security report, please review your source code included in the report. For example, please make sure the reported panic isn't caused by an overlooked mistake in the report's test code.
@fxamacker
Copy link
Member Author

@turbolent I reviewed several security reports in the past 2-week sprint cycle and updated the guidelines to request a bit more info that can save time in future security reports:

Guidelines For Responsible Disclosure

We ask that all researchers adhere to these guidelines here.

Additionally, please include the following in the security report:

  • the name and version of the AI, scanner, etc. that detected the issue (this can help us handle reports generated by buggy tools more efficiently)

  • list of affected 32-bit or 64-bit architectures (currently, Atree is officially supported on 64-bit platforms)

  • version of Flow Emulator used to check the reported issue (issue might be prevented by Flow components that set or enforce limits on Atree)

Before submitting a security report, please review your source code included in the report. For example, please make sure the reported panic isn't caused by an overlooked mistake in the report's test code.

Copy link
Member

@turbolent turbolent left a comment

Choose a reason for hiding this comment

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

Nice!

SECURITY.md Outdated
Please include the name and version of the tool that detected the issue (if applicable). This can help us identify buggy or noisy vulnerability detectors, and identify duplicate reports more efficiently.
- the name and version of the AI, scanner, etc. that detected the issue (this can help us handle reports generated by buggy tools more efficiently)

- list of affected 32-bit or 64-bit architectures (currently, Atree is officially supported on 64-bit)
Copy link
Member

Choose a reason for hiding this comment

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

Good idea to ask for the architecure. AFAIK none of the projects we maintain (atree, Cadence, flow-go, etc.) has official 32-bit support, so maybe just state it:

Suggested change
- list of affected 32-bit or 64-bit architectures (currently, Atree is officially supported on 64-bit)
- list of affected architectures (Atree is only officially supported on 64-bit)

@fxamacker fxamacker merged commit eae5f6f into main Dec 16, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants