Skip to content

Security: aldrin-labs/abyssbook

Security

SECURITY.md

Security Policy

Reporting Security Vulnerabilities

We take the security of abyssbook seriously. If you believe you have found a security vulnerability, please report it to us through coordinated disclosure.

Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.

Instead, please send an email to security@aldrin.com with the following information:

  • Type of issue (e.g., buffer overflow, SQL injection, cross-site scripting, etc.)
  • Full paths of source file(s) related to the manifestation of the issue
  • The location of the affected source code (tag/branch/commit or direct URL)
  • Any special configuration required to reproduce the issue
  • Step-by-step instructions to reproduce the issue
  • Proof-of-concept or exploit code (if possible)
  • Impact of the issue, including how an attacker might exploit the issue

Response Timeline

  • Acknowledgment: We will acknowledge receipt of your vulnerability report within 48 hours
  • Initial Assessment: We will provide an initial assessment within 5 business days
  • Resolution: We aim to resolve critical vulnerabilities within 30 days

Vulnerability Categories

Critical Severity

  • Remote code execution vulnerabilities
  • Authentication bypass
  • Privilege escalation
  • Data corruption or loss
  • Financial/orderbook manipulation

High Severity

  • Cross-site scripting (XSS)
  • SQL injection
  • Unauthorized data access
  • CLI injection vulnerabilities
  • Blockchain transaction manipulation

Medium Severity

  • Information disclosure
  • Denial of service
  • CSRF vulnerabilities
  • Input validation errors

Low Severity

  • Configuration issues
  • Minor information leaks
  • Non-exploitable bugs

Dependency Security

Current Status

As of the latest audit, abyssbook uses zero external third-party dependencies, relying exclusively on Zig's standard library. This significantly reduces our attack surface.

Dependency Management Process

  1. Before Adding Dependencies:

    • Security review required for all new dependencies
    • Check CVE databases and security advisories
    • Evaluate dependency maintenance status
    • Document security rationale in PR description
  2. Ongoing Monitoring:

    • Automated vulnerability scanning in CI pipeline
    • Regular dependency audits (monthly)
    • Subscribe to security advisories for all dependencies
    • Immediate response to critical vulnerabilities
  3. Update Process:

    • Security updates prioritized over feature updates
    • Test all updates in isolated environment
    • Verify no regressions in security-critical components
    • Document all security-related changes

Secure Development Practices

Code Review Requirements

  • All code changes require security-focused review
  • Special attention to input validation and sanitization
  • Review CLI argument parsing for injection vulnerabilities
  • Validate blockchain transaction handling

Testing Requirements

  • Security tests for all public interfaces
  • Fuzz testing for input parsing
  • Integration tests for blockchain operations
  • CLI security validation tests

Build Security

  • Reproducible builds when possible
  • Secure CI/CD pipeline configuration
  • Regular security scanning in automated builds
  • No secrets in source code or build artifacts

Supported Versions

We provide security updates for the following versions:

Version Supported
main branch
Latest release
Previous release
Older versions

Security Features

Built-in Security Measures

  • Input Validation: All CLI inputs validated and sanitized
  • Memory Safety: Zig's memory safety features enabled
  • Logging: Security events logged for monitoring
  • Error Handling: Secure error handling prevents information leaks

Blockchain Security

  • Transaction Validation: All blockchain transactions validated
  • API Security: HTTPS required for blockchain API calls
  • Key Management: Secure key handling practices
  • Rate Limiting: Protection against API abuse

Security Monitoring

Automated Monitoring

  • Dependency vulnerability scanning
  • Static code analysis
  • Security test automation
  • Performance monitoring for DoS detection

Manual Reviews

  • Quarterly security audits
  • Code review for security implications
  • Third-party security assessments (when needed)
  • Penetration testing (planned)

Incident Response

Response Team

  • Security Lead: Primary contact for security issues
  • Development Team: Code fixes and patches
  • Operations Team: Deployment and monitoring
  • Communication Team: User notifications and advisories

Response Process

  1. Detection: Vulnerability identified or reported
  2. Assessment: Severity evaluation and impact analysis
  3. Containment: Immediate measures to limit exposure
  4. Remediation: Develop and test fixes
  5. Deployment: Release security updates
  6. Communication: Notify users and document changes
  7. Post-Incident: Review and improve processes

Security Tools and Resources

Recommended Tools

  • zig fmt for consistent code formatting
  • zig test for comprehensive testing
  • Static analysis tools for Zig
  • Custom fuzzing for input validation

Security Resources

Contact Information


Last Updated: 2025-06-17
Next Review: 2025-09-17

There aren’t any published security advisories