This documentation is restricted to authorised members of the SWSS Developer Community. Access is granted exclusively through SWSS DevHub, after KYB and SWSS Foundation approval.
All SwssChain GitHub repositories are private. Significant updates are currently deploying across the full SWSS Ecosystem. SDK and API specifications are subject to change at any time in accordance with security requirements and SwssChain Foundation governance decisions.
SWSS SDK v2.1 is deploying across the ecosystem. API signatures may change during this period. Ensure your integration uses the latest schema from SWSS DevHub.
Reporting Vulnerabilities
The SwssChain development team operates a responsible disclosure programme for security vulnerabilities. Researchers who discover potential vulnerabilities in the SwssChain protocol, its smart contracts, or the SWSS ecosystem applications are encouraged to report them privately before public disclosure, allowing the team to develop and deploy a remediation.
Scope
The following systems are in scope for the responsible disclosure programme:
- SwssChain node software (consensus client, RPC server, P2P layer).
- Settlement Consensus Protocol implementation (SAPE, DSA, PCA, BFTFA components).
- SwssChain core smart contracts (Deed registry, Settlement Combustion Model contracts, Governance contracts).
- SwssChain SDK packages (JavaScript, Python, Go).
- SWSS Explorer and SWSS Bridge smart contracts and backend services. Ecosystem applications enter scope as they reach production; a component not listed here is not yet in scope.
- SwssChain developer API endpoints and authentication systems.
The following are explicitly out of scope:
- Third-party applications and contracts deployed on SwssChain by developers outside the SWSS team.
- Social engineering attacks targeting SWSS team members.
- Physical security of data centres or hardware.
- Denial of service attacks (volumetric or resource exhaustion).
How to Report
Submit vulnerability reports to the SwssChain security team at [email protected]. Encrypt sensitive reports using the SwssChain security PGP key. The current key is issued by the security team on request to the same address, and is rotated with the programme rather than published indefinitely at a fixed location.
Include the following in your report:
- Title: A concise description of the vulnerability class.
- Affected Component: The specific system, contract address, or software module affected.
- Severity Assessment: Your assessment of the severity using the CVSS v3.1 framework where applicable.
- Impact Description: What an attacker could achieve by exploiting this vulnerability. Be specific: "an attacker could drain the Deed escrow contract of up to X SWSS Coin in a single transaction" is more useful than "funds could be stolen".
- Proof of Concept: A reproducible demonstration of the vulnerability. Testnet exploitation is strongly preferred over mainnet.
- Remediation Suggestion: If you have identified a remediation approach, include it. The development team retains final decision on remediation design.
Response Process
| Step | Timeline | Action |
|---|---|---|
| Acknowledgement | 24 hours | Security team confirms receipt and assigns a tracking reference. |
| Initial Assessment | 72 hours | Team assesses severity and confirms whether the issue is in-scope and reproducible. |
| Remediation | 7 to 30 days | Development and deployment of a fix. Timeline depends on severity and complexity. |
| Disclosure | After fix deployed | Co-ordinated public disclosure. Reporter is credited unless anonymity is requested. |
Severity Classification
| Severity | Criteria |
|---|---|
| Critical | Funds at immediate risk; network halt possible; consensus compromise achievable. |
| High | Significant financial loss possible; Finality Certificate forgery; access control bypass on critical contracts. |
| Medium | Limited financial impact; data exposure without funds at risk; griefing attacks. |
| Low | Minor inconsistencies; theoretical vulnerabilities with no practical exploit path. |
Recognition
Researchers who report confirmed High or Critical vulnerabilities through the responsible disclosure process will be recognised in the SwssChain Security Acknowledgements maintained by the SWSS Foundation. Recognition is by full name or pseudonym as preferred by the reporter. The SwssChain team reserves the right to withhold recognition for reports that do not follow the responsible disclosure process or that involve active exploitation of mainnet.
Legal Safe Harbour
Researchers who follow this responsible disclosure process in good faith (specifically, who do not exploit discovered vulnerabilities beyond testnet proof-of-concept demonstration, do not publicly disclose before remediation, and do not seek to profit from the vulnerability beyond formal recognition) will not face legal action from the SWSS organisation for their security research activities.
