Boost | Shardeum: Ancillaries

Submit a Bug

Live

22d: 16h remaining
Max Bounty
$200,000
Rewards Pool
$200,000
Vault TVL
To be determined
Started
08 July 2024
Ends
14 August 2024
Rewards Token
USDC
Triaged by Immunefi
Yes
KYC Required
No
nSLOC
55,472

This Boost Is Live!

$200,000 USD is available in rewards for finding bugs in Shardeum's codebase of about 55000 nSLOC. There is no KYC required.

Shardeum team will respond within 24 hours on weekdays to all bug reports. Any technical questions and support requests can be asked directly to Shardeum or Immunefi in the Shardeum Boost Discord channel.

In this contest bug fixes may be applied mid-contest. Further details are in the 'Assets In Scope' section.

When the Boost has ended Immunefi will publish an event-specific leaderboard and bug reports from the event.

Started
08 July 2024 06:00 UTC
Ends
14 August 2024 06:00 UTC

Program Overview

Shardeum is an EVM-based, linearly scalable network offering low gas fees forever, while maintaining true decentralization and (hopefully) solid security. Shardeum is a large project and as such, will be split over two concurrent boosts. This boost, called Ancillaries, will cover the Web2 aspects of the project. This will cover seven components: Validator Gui, Validator CLI, Archiver, Explorer, Distrubutor/Collector libraries, RPC, and Shardus-Net networking code.

The Validator GUI is the website that optionally runs on each node. This allows the node operator to interact with their node. Despite our best efforts, the community likes to have this webpage available on the internet. The Validator CLI is the command line tool used to administer the node. The GUI calls commands in the CLI, or the operator can enter the commands manually. The Archive Server’s primary role is to hold the historical state of the network and accounts.Once the network has consensed on a state change, that information is saved to archive servers. The Explorer serves a similar function to https://etherscan.io/. The relayer consists of two parts: collector and distributor. These two components work together to shuffle data between ancillaries, namely the archiver servers, RPC servers, and explorer. The RPC server acts as an API, allowing users to interact with the network and inject transactions. It is designed to be as compliant as possible with Ethereum’s RPC specification, though some differences exist. Finally, lib-net is the bottom level networking library for the Shardeum network. It is written in a mix of Rust and TypeScript.

For more information about Shardeum, please visit https://shardeum.org/.

Shardeum provides rewards in USDC, denominated in USD.

Rewards by Threat Level

The following reward terms are a summary, for the full details read our Shardeum | Ancillaries Reward Distribution Terms.

The reward pool will be distributed among participants. The size depends on the bugs found:

  • If no High or Critical severity bugs are found the reward pool will be $100,000 USD
  • If one or more High severity bugs are found the reward pool will be $120,000 USD
  • If 1 Critical severity bug is found the reward pool will be $160,000 USD
  • If 2 Critical severity bugs are found the reward pool will be $180,000 USD
  • If 4 or more Critical severity bugs are found the reward pool will be $200,000 USD

For this Boost, duplicates and private known issues are valid for a reward.

Private known issues will unlock higher reward pools according to their severity level without any downgrade. For example, a Critical severity bug which was a private known issue would unlock the reward pool conditional on a Critical severity bug being found.

Rewards are distributed according to the impact of the vulnerability based on the Immunefi Vulnerability Severity Classification System V2.3.

Reward Payment Terms

Payouts are handled by the Shardeum team directly and are denominated in USD. However, payments are done in USDC.

Rewards will be distributed all at once based on Immunefi’s distribution formula after the event has concluded and the final bug reports have been resolved.

Insight Rewards Payment Terms

Insight Rewards: Portion of the Rewards Pool

The "Insight" severity was introduced on Boost & Attackathon programs to recognize contributions that extend beyond identifying immediate vulnerabilities. Currently, it's not an option to select the Insight severity when submitting a report. However, our team or program will designate it accordingly if applicable. "Insights" underscores our commitment to valuing all types of contributions that contribute to a more secure environment and will always be rewarded. View more information about Insights.

Websites and Applications

Critical
Level
Portion of the Reward Pool
Payout
PoC Required
High
Level
Portion of the Reward Pool
Payout
PoC Required
Medium
Level
Portion of the Reward Pool
Payout
PoC Required
Low
Level
Portion of the Reward Pool
Payout
PoC Required

All categories *

Insight
Level
Portion of the Reward Pool
Payout

Assets in scope

Shardeum’s up to date codebase can be found at https://github.com/shardeum/.

Mid-Contest Code Updates

In this contest bug fixes may be applied mid-contest. This is required for Shardeum to test changes on their beta networks in preparation for an imminent mainnet launch.

The project is to keep changes private as far as possible. When changes need to be made public, then the changelog will be updated here & in the Shardeum Boost Discord channel. Publicly fixed bugs are invalid and the scope is updated to the new code.

All bug reports before the fix was public will earn a reward. All bug reports after are invalid. If a new bug is introduced by their fix then it is valid for a reward.

Mid-Contest Changelog

Currently none.

POCs should be tested against the most recent changes on the /tree/dev github repo.

Asset Accuracy Assurance

Bugs found on assets incorrectly listed in-scope will be considered valid and be rewarded.

Private Known Issues Reward Policy

Private known issues, meaning known issues that were not publicly disclosed, are valid for a reward equal to that of a bug one severity lower.

Known Issue Assurance

Shardeum commits to providing Known Issue Assurance to bug submissions through their program. This means that Shardeum will either disclose known issues publicly, or at the very least, privately via a self-reported bug submission.

In a potential scenario of a mediation, this allows for a more objective and streamlined process, in order to prove that an issue is known. Otherwise, assuming the bug report is valid, it would result in the report being considered as in-scope, and due a reward.

Primacy of Impact vs Primacy of Rules

Shardeum adheres to the Primacy of Impact for all impacts.

Primacy of Impact means that the impact is prioritized rather than a specific asset. This encourages security researchers to report on all bugs with an in-scope impact, even if the affected assets are not in scope. For more information, please see Best Practices: Primacy of Impact.

When submitting a report on Immunefi’s dashboard, the security researcher should select the Primacy of Impact asset placeholder. If the team behind this project has multiple programs, those other programs are not covered under Primacy of Impact for this program. Instead, check if those other projects have a bug bounty program on Immunefi.

If the project has any testnet and/or mock files, those will not be covered under Primacy of Impact.

All other impacts are considered under the Primacy of Rules, which means that they are bound by the terms and conditions set within this program.

Eligibility Criteria

Security researchers who wish to participate must adhere to the rules of engagement set forth in this program and cannot be:

  • On OFACs SDN list
  • Official contributor, both past or present
  • Employees and/or individuals closely associated with the project
  • Security auditors that directly or indirectly participated in the audit review

Responsible Publication

Whitehats may publish their bug reports after they have been fixed & paid, or closed as invalid, with the following exceptions:

  • Bug reports in mediation may not be published until mediation has concluded and the bug report is resolved.

Immunefi may publish bug reports submitted to this boosted bug bounty and a leaderboard of the participants and their earnings.

Feasibility Limitations

The project may be receiving reports that are valid (the bug and attack vector are real) and cite assets and impacts that are in scope, but there may be obstacles or barriers to executing the attack in the real world. In other words, there is a question about how feasible the attack really is. Conversely, there may also be mitigation measures that projects can take to prevent the impact of the bug, which are not feasible or would require unconventional action and hence, should not be used as reasons for downgrading a bug's severity.

Therefore, Immunefi has developed a set of feasibility limitation standards which by default states what security researchers, as well as projects, can or cannot cite when reviewing a bug report.

Immunefi Standard Badge

By adhering to Immunefi’s best practice recommendations, Shardeum has satisfied the requirements for the Immunefi Standard Badge.

Impacts in scope

Only the following impacts are accepted within this bug bounty program. All other impacts are not considered as in-scope, even if they affect something in the assets in scope table.

Websites and Applications

  • Execute arbitrary system commands
    Critical
    Impact
  • Retrieve sensitive data/files from a running server, such as: /etc/shadow, database passwords, blockchain keys (this does not include non-sensitive environment variables, open source code, or usernames)
    Critical
    Impact
  • Taking state-modifying authenticated actions (with or without blockchain state interaction) on behalf of other users without any interaction by that user, such as: Changing registration information, Commenting, Voting, Making trades, Withdrawals, etc.
    Critical
    Impact
  • Direct theft of user funds
    Critical
    Impact
  • Malicious interactions with an already-connected wallet, such as: Modifying transaction arguments or parameters, Substituting contract addresses, Submitting malicious transactions
    Critical
    Impact
  • Taking down the application/website
    High
    Impact
  • Injection of malicious HTML or XSS through metadata
    Medium
    Impact
  • Injecting/modifying the static content on the target application without JavaScript (persistent), such as: HTML injection without JavaScript, Replacing existing text with arbitrary text, Arbitrary file uploads, etc
    Medium
    Impact
  • Changing sensitive details of other users (including modifying browser local storage) without already-connected wallet interaction and with up to one click of user interaction, such as: Email, Password of the victim etc.
    Medium
    Impact
  • Redirecting users to malicious websites (open redirect)
    Medium
    Impact
  • Improperly disclosing confidential user information, such as: Email address, Phone number, Physical address, etc.
    Low
    Impact
  • Changing non-sensitive details of other users (including modifying browser local storage) without already-connected wallet interaction and with up to one click of user interaction, e.g: Changing the first/last name of user, Enabling/disabling notifications
    Low
    Impact
  • Injecting/modifying the static content on the target application without JavaScript (reflected), such as: Reflected HTML injection, Loading external site data
    Low
    Impact
  • Changing details of other users (including modifying browser local storage) without already-connected wallet interaction and with significant user interaction, such as: Iframing leading to modifying the backend/browser state (must have a PoC)
    Low
    Impact
  • Taking over broken or expired outgoing links, such as: Social media handles, etc.
    Low
    Impact
  • Temporarily disabling user to access target site, such as: Locking up the victim from login, Cookie bombing, etc.
    Low
    Impact

Proof of Concept (PoC) Requirements

POCs should be tested against the most recent changes on the /tree/dev github repo.

A PoC, demonstrating the bug's impact, is required for this program and has to comply with the Immunefi PoC Guidelines and Rules.

Whitehat Educational Resources & Technical Info Architecture documents: https://docs.shardeum.org/docs/architecture/high-level-architecture

Is this an upgrade of an existing system? If so, which? And what are the main differences?

No

Where do you suspect there may be bugs? Useful aspects of this question are:

  • Which parts of the code are you most concerned about? RPC server, Archive server, and GUI
  • What attack vectors are you most concerned about? Highly concerned with the Validator GUI. At the time of writing and likely at the time of launch, the GUI will be homogenous for most of the nodes in the network. A critical bug here can quickly destroy the network as it will instantly impact every node.
  • Which part(s) of the system do you want whitehats to attempt to break the most? All of it
  • Are there any assumed invariants that you want whitehats to attempt to break? No

What external dependencies are there?

Just the packages listed in the package.json of each repo.

Where might whitehats confuse out-of-scope code to be in-scope?

Since we are doing two concurrent boosts with repositories that interact with each other, the specific boundaries of which vulnerability belongs to which boost may become confusing. A vulnerability may exist in the communication between an archive server and a validator for example. We would like to assure researchers that regardless of the final decision of which boost a particular vulnerability belongs to, the researcher will get paid. We may have final say over where a vuln belongs but the researcher will get their bounty pending the other eligibility factors.

Are there any unusual points about your protocol that may confuse whitehats?

The role of archivers in the Shardeum network is a little different from similar components in other networks. Archivers have no role in a node joining or leaving the network. Archivers have no role in consensus or syncing. They are merely an archive of the history of the network.

Weak subjectivity solutions do not apply to the Shardeum network because long range attacks are not relevant. Shardeum does not have probabilistic finality so there is no risk of a competing chain becoming valid.

What is the test suite setup information?

The simple network test suite: https://github.com/shardeum/simple-network-test Larger test suite setup: https://github.com/shardeum/json-rpc-server/tree/localtest/src/tests/integration

Public Disclosure of Known Issues

Bug reports covering previously-discovered bugs are not eligible for a reward within this program. This includes known issues that the project is aware of but has consciously decided not to “fix”, necessary code changes, or any implemented operational mitigating procedures that can lessen potential risk.

List of Shardeum’s Known Issues.

Previous Audits

Shardeum’s completed audit reports can be found here: Arcadia (draft), HashCloack. Any unfixed vulnerabilities mentioned in these reports are not eligible for a reward.

Out of Scope & Rules

These impacts are out of scope for this bug bounty program.

All Categories:

  • Impacts requiring attacks that the reporter has already exploited themselves, leading to damage
  • Impacts caused by attacks requiring access to leaked keys/credentials
  • Impacts caused by attacks requiring access to privileged addresses (governance, strategist) except in such cases where the contracts are intended to have no privileged access to functions that make the attack possible
  • Impacts relying on attacks involving the depegging of an external stablecoin where the attacker does not directly cause the depegging due to a bug in code
  • Mentions of secrets, access tokens, API keys, private keys, etc. in Github will be considered out of scope without proof that they are in-use in production
  • Best practice recommendations
  • Feature requests
  • Impacts on test files and configuration files unless stated otherwise in the bug bounty program

Websites and Apps

  • Theoretical impacts without any proof or demonstration
  • Impacts involving attacks requiring physical access to the victim device
  • Impacts involving attacks requiring access to the local network of the victim
  • Reflected plain text injection (e.g. url parameters, path, etc.)
  • This does not exclude reflected HTML injection with or without JavaScript
  • This does not exclude persistent plain text injection
  • Any impacts involving self-XSS
  • Captcha bypass using OCR without impact demonstration
  • CSRF with no state modifying security impact (e.g. logout CSRF)
  • Impacts related to missing HTTP Security Headers (such as X-FRAME-OPTIONS) or cookie security flags (such as “httponly”) without demonstration of impact
  • Server-side non-confidential information disclosure, such as IPs, server names, and most stack traces
  • Impacts causing only the enumeration or confirmation of the existence of users or tenants
  • Impacts caused by vulnerabilities requiring un-prompted, in-app user actions that are not part of the normal app workflows
  • Lack of SSL/TLS best practices
  • Impacts that only require DDoS
  • UX and UI impacts that do not materially disrupt use of the platform
  • Impacts primarily caused by browser/plugin defects
  • Leakage of non sensitive API keys (e.g. Etherscan, Infura, Alchemy, etc.)
  • Any vulnerability exploit requiring browser bugs for exploitation (e.g. CSP bypass)
  • SPF/DMARC misconfigured records)
  • Missing HTTP Headers without demonstrated impact
  • Automated scanner reports without demonstrated impact
  • UI/UX best practice recommendations
  • Non-future-proof NFT rendering

Prohibited Activities:

  • Any testing on mainnet or public testnet deployed code; all testing should be done on local-forks of either public testnet or mainnet
  • Any testing with pricing oracles or third-party smart contracts
  • Attempting phishing or other social engineering attacks against our employees and/or customers
  • Any testing with third-party systems and applications (e.g. browser extensions) as well as websites (e.g. SSO providers, advertising networks)
  • Any denial of service attacks that are executed against project assets
  • Automated testing of services that generates significant amounts of traffic
  • Public disclosure of an unpatched vulnerability in an embargoed bounty