Skip to content

Security: simonfrvr/soroban-security-scanner

Security

SECURITY.md

πŸ”’ Security Policy

Security Governance

This document outlines the security governance framework for the Soroban Security Scanner, including vulnerability disclosure, security review processes, and incident response procedures.

Responsible Disclosure

Reporting Security Vulnerabilities

If you discover a security vulnerability in the Soroban Security Scanner, please follow our responsible disclosure process:

  1. Initial Report: Submit a Vulnerability Report through GitHub Issues
  2. Security Team Review: Our security team will acknowledge receipt within 48 hours
  3. Assessment Period: We will assess the vulnerability within 5 business days
  4. Resolution Timeline:
    • Critical: 24-48 hours
    • High: 7 days
    • Medium: 14 days
    • Low: 30 days
  5. Public Disclosure: After fix deployment, coordinated disclosure

Emergency Contact

For critical security issues requiring immediate attention:

Note: Do NOT create public GitHub issues for security vulnerabilities until they have been addressed.

Security Review Process

Automated Security Scanning

All code changes undergo automated security scanning:

  1. Static Analysis

    • Rust: Clippy, cargo-audit
    • JavaScript/TypeScript: ESLint security rules
    • Smart Contracts: Soroban-specific analyzers
  2. Dependency Scanning

    • Cargo-audit for Rust dependencies
    • npm audit for JavaScript dependencies
    • Automated dependency updates with Dependabot
  3. Container Security

    • Docker image scanning
    • Kubernetes manifest validation
    • Secrets detection

Manual Security Review

Required Reviews

Change Type Review Required Reviewers
Smart Contract Changes βœ… Mandatory Security Lead + 2 external auditors
Core Scanner Modifications βœ… Mandatory Security Team
Protocol Changes βœ… Mandatory Security Lead + Protocol Council
Authentication/Authorization βœ… Mandatory Security Team + Technical Lead
Infrastructure Changes βœ… Recommended DevOps + Security
Documentation Updates ❌ Not Required N/A
Test Updates ❌ Not Required N/A

Review Checklist

  • Input validation and sanitization
  • Authentication and authorization checks
  • Access control implementation
  • Encryption and key management
  • Error handling and logging
  • Race condition prevention
  • Memory safety (Rust smart contracts)
  • Reentrancy protection
  • Integer overflow/underflow protection
  • Front-running protection
  • Smart contract upgrade safety
  • Timelock adequacy
  • Multi-signature requirements met

Formal Verification

For all smart contract changes:

  • Runtime verification using Soroban SDK tools
  • Property-based testing with foundry/forge
  • Invariant checking
  • Formal specification in TLA+ or similar
  • Third-party audit report

Incident Response

Incident Classification

Severity Description Response Time
Critical Active exploit, data breach, fund loss < 1 hour
High Vulnerability with exploit potential < 4 hours
Medium Vulnerability without known exploit < 24 hours
Low Minor security issue < 7 days

Response Procedure

Critical Incidents (P0)

  1. Detection: Automated monitoring or manual report
  2. Triage: Security team confirms incident (15 minutes)
  3. Containment: Emergency protocols activated (1 hour)
    • Disable vulnerable features
    • Deploy emergency patches
    • Implement circuit breakers
    • Notify stakeholders
  4. Eradication: Root cause removal (4-24 hours)
  5. Recovery: Full service restoration (4-48 hours)
  6. Post-Incident: Review and documentation (within 7 days)

High Priority Incidents (P1)

  1. Detection & Triage: < 4 hours
  2. Containment: < 12 hours
  3. Eradication: < 3 days
  4. Recovery: < 7 days
  5. Post-Incident: < 14 days

Medium Priority Incidents (P2)

  1. Triage: < 24 hours
  2. Fix Deployment: < 14 days
  3. Verification: < 21 days

Low Priority Incidents (P3)

  1. Triage: < 7 days
  2. Fix Deployment: < 30 days

Emergency Protocol Override

In critical security incidents, the following emergency protocols may be invoked:

  1. Emergency Council Session: Within 1 hour
  2. Emergency Vote: 24-hour window, 90% threshold
  3. Emergency Deployment: Immediate after approval
  4. Transparency Report: Within 24 hours of resolution

Security Monitoring

Continuous Monitoring

  • Runtime Security: Falco, Prometheus alerts
  • Network Security: IDS/IPS, anomaly detection
  • Access Monitoring: Audit logs, SIEM integration
  • Smart Contract Monitoring: On-chain event tracking

Alert Thresholds

Metric Warning Critical
Failed Auth Attempts 10/min 50/min
Smart Contract Reverts 5% 20%
Response Time 2s 5s
Error Rate 1% 5%
Resource Usage 70% 90%

Vulnerability Management

CVSS Scoring

All vulnerabilities are scored using CVSS v3.1:

  • Critical (9.0-10.0): Immediate action required
  • High (7.0-8.9): Action required within 7 days
  • Medium (4.0-6.9): Action required within 30 days
  • Low (0.1-3.9): Action required within 90 days

Remediation Tracking

All vulnerabilities tracked in dedicated security project:

  • Jira/GitHub Issues with security labels
  • SLA tracking dashboard
  • Regular status updates
  • Post-remediation verification

Security Training

Required Training

Role Training Frequency
Developers Secure Coding, Rust Security Quarterly
DevOps Infrastructure Security, K8s Hardening Quarterly
QA Security Testing, Penetration Testing Semi-annually
Management Security Governance, Risk Management Annually

Compliance & Standards

Standards Alignment

  • OWASP Top 10
  • NIST Cybersecurity Framework
  • ISO 27001
  • SOC 2 Type II
  • Smart Contract Security Best Practices (ConsenSys, Trail of Bits)

Audit Schedule

  • Internal Security Audit: Quarterly
  • External Penetration Test: Semi-annually
  • Smart Contract Audit: Per major release
  • Compliance Audit: Annually

Governance Oversight

Security Committee

  • Chair: Security Lead
  • Members: Security researchers, protocol council reps, external advisors
  • Meetings: Bi-weekly for incident review, monthly for security posture

Reporting

  • Monthly: Security metrics and incident summary
  • Quarterly: Security posture report
  • Annually: Comprehensive security review

Documentation

Required Security Documentation

  • Architecture Threat Model (updated quarterly)
  • Data Flow Diagrams (updated per major change)
  • Access Control Matrix (updated per change)
  • Cryptographic Implementation Details
  • Incident Response Playbooks
  • Disaster Recovery Plan

Bug Bounty Program

Coming Soon:

  • HackerOne program
  • Reward tiers: $500 - $100,000
  • Scope: Smart contracts, core infrastructure
  • Safe harbor policy for good faith researchers

Contact

Purpose Contact
Vulnerability Reporting security@soroban-security.org
Emergency Response security-emergency@soroban-security.org
Security Inquiries security-team@soroban-security.org

Policy Version

  • Version: 1.0
  • Effective Date: [Current Date]
  • Review Cycle: Annual
  • Last Updated: [Current Date]

For questions about this policy, contact the Security Team.

There aren't any published security advisories