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

How to prepare for a security review checklist #113

Open
montyly opened this issue May 18, 2022 · 1 comment
Open

How to prepare for a security review checklist #113

montyly opened this issue May 18, 2022 · 1 comment
Labels
help wanted Extra attention is needed

Comments

@montyly
Copy link
Member

montyly commented May 18, 2022

We can convert our blogpost to a checklist: https://blog.trailofbits.com/2018/04/06/how-to-prepare-for-a-security-audit/

And we can add a couple of blockchain-specific points

@montyly montyly added the help wanted Extra attention is needed label Dec 1, 2022
@damilolaedwards
Copy link
Contributor

damilolaedwards commented Dec 15, 2022

  • Enable and address all compiler/linter warnings
  • Increase unit and feature tests coverage
  • Remove dead code, unused variables, functions, libraries and other extraneous weights
  • Provide external documentation and past security reviews / bug findings (if any)
  • Use inline comments (preferably natspec for solidity)
  • Label and describe your tests
  • Document compilation and deployment process
  • For solidity code, ensure slither runs successfully (document any required intermediate setup process if any)
  • Ensure that the commit hash / branch/ release for the audit has been provided before the review commencement date
  • Ensure all engineers assigned to the audit review have been invited to all relevant repositories before commencement date

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants