certusone
/
wormhole
mirror of https://github.com/certusone/wormhole.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
wormhole/SECURITY.md

6.0 KiB
Raw Blame History

Security

Bug Bounty Program

The Wormhole project operates two bug bounty programs to financially incentivize independent researchers for finding and responsibly disclosing security issues.

If you find a security issue in Wormhole, please report the issue immediately.

3rd Party Security Audits

The Wormhole project engages 3rd party firms to conduct independent security audits of Wormhole. At any given time, multiple audit streams are likely in progress.

As these 3rd party audits are completed and issues are sufficiently addressed, we make those audit reports public.

  • January 10, 2022 - Neodyme
    • Scopes: Ethereum Contracts, Solana Contracts, Terra Contracts, Guardian, and Solitaire
  • July 1, 2022 - Kudelski
    • Scopes: Ethereum Contracts, Solana Contracts, Terra Contracts, and Guardian
  • August 16, 2022 - Kudelski
    • Scope: Algorand Contracts
  • Q3 2022 - OtterSec (DRAFT)
    • Scope: NEAR Contracts
  • Q3 2022 - Halborn (DRAFT)
    • Scope: Wormchain and Accounting
  • Q3 2022 - Certik (DRAFT)
    • Scope: Ethereum Contracts, Solana Contracts, Terra Contracts, Guardian, and Solitaire
  • Q3 2022 - Trail of Bits (TESTING)
    • Scope: Ethereum Contracts and Solana Contracts
  • Q3 2022 - Coinspect (SCHEDULED)
    • Scope: Algorand Contracts

White-Hat Hacking on Wormhole

The Wormhole project wants to lower the bar for White-hat hackers to find security bugs in Wormhole. Why? The easier this process, the more likely it will be for white-hats to find bugs in Wormhole and responsibly disclose them, helping to secure the network.

Here's a list of strategies that are helpful for getting started on Wormhole:

  • Review the existing unit and integration testing (found in CONTRIBUTING.md) and see what is already being testing for.
    • Check out places where there might be missing test coverage entirely. This could be a ripe spot to look for something we missed.
    • Check out places where there are unit/integration tests, but they lack sufficient negative test coverage.
  • Review different smart contract implementations (eg. Solana, EVM, CosmWasm, Move) and attempt to understand how and why they are different.
    • Does one chain have a safety check that another chain doesn't?
    • Does one chain have a specific set of nuances / gotchas that that were missed on another chain?
  • Consider going beyond the source code
    • Review the deployed contracts on chain. Is something odd that may have been missed?

This section will continue iterating on white-hat bootstrap strategies as lessons are learned hacking on Wormhole and from community members.

It's important to remember this is an iterative process and to stay positive. If you spend the time coming up with a new test case, but didn't actually find a bug, please send a pull request with additional positive and negative test cases. This process has shown repeatedly to improve your ability to understand Wormhole, and will increase your odds of finding future bugs.

Guidance to Chain Integrators

As the list of chains connected to Wormhole increases, so does the risk that a given connected could introduce risks to the Wormhole network. As a result, Wormhole does have built-in safety features (e.g.: Governor white-paper) to reduce the "blast radius" of such case. That said, a defense in depth strategy is required to do as much as possible to secure the network. As part of this methodology, the Wormhole project recommends that all connected chains current and future implement robust security programs of their own to do their part in managing chain compromise risk to the wormhole network.

Here are a few ways in which connected chains can maintain high security standards:

For source code ensure relevant bits are:

  • All open source
  • Audited by an independent third party with public audit reports
  • Included in a public bug bounty program. The bounty rewards should be sufficiently large to incentivize white-hat mindshare in finding security bugs and responsibly disclosing them
  • Version control systems contain adequate access controls and mandatory code review (e.g.: In github, use of branch protection and a minimum of one independent reviewer to merge code)
  • Maintaining a SECURITY.md in the root of the repository (like this one) to offer guidance and transparency on security relevant topics
  • Includes sufficient unit and integration test coverage (including negative tests), which are run on every commit via continuous integration. Ensure that the results of those test runs are visible to the public

Additionally, ensure:

  • The Wormhole team has sufficient contact information and an associated call or page tree to reach you in the event of a security incident.
  • That Wormhole has the full upgrade authority on relevant bridge contracts to act quickly in the case of a security incident.
  • You have an established incident response program in place, with established patterns and playbooks to ensure deterministic outcomes for containment.
  • When security issues do occur, please make sure that the chain makes every attempt to inform affected parties and leads with transparency.