Skip to content

Security: ReallyArtificial/approvalprotocol

Security

SECURITY.md

Security Policy

Supported Versions

We release patches for security vulnerabilities. Which versions are eligible for receiving such patches depends on the CVSS v3.0 Rating:

Version Supported
0.x ✅

Reporting a Vulnerability

The Approval Protocol team takes security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.

To report a security vulnerability, please use one of the following methods:

1. GitHub Security Advisories (Preferred)

Report security vulnerabilities through GitHub's Security Advisory feature:

  1. Go to https://github.com/reallyartificial/approvalprotocol/security/advisories
  2. Click "New draft security advisory"
  3. Fill in the details of your finding

2. Email

Send an email to harsh.joshi.pth@gmail.com with:

  • Type of issue (e.g., approval bypass, permission escalation, audit trail tampering, 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 it

What to Expect

  • Response Time: You should receive a response within 48 hours.
  • Acknowledgment: If the issue is confirmed, we will acknowledge it and work on a fix.
  • Updates: We will keep you informed about the progress.
  • Disclosure: We will coordinate with you on the disclosure timeline.

Security Update Process

  1. The security report is received and assigned to a primary handler
  2. The problem is confirmed and a list of affected versions is determined
  3. Code is audited to find any similar problems
  4. Fixes are prepared for all supported releases
  5. An advisory is published

Security Best Practices for Users

When using Approval Protocol in your projects:

  1. Keep Dependencies Updated

    npm update approvalprotocol
    npm audit fix
  2. Approval Security

    • Implement strong approval policies
    • Log all approval decisions with audit trails
    • Never bypass approval checks in production
    • Validate approval contexts
  3. Environment Variables

    • Never hardcode approval rules
    • Use environment variables for sensitive data
    • Keep .env files out of version control
  4. Audit Logging

    • Enable comprehensive audit logging
    • Monitor for unusual approval patterns
    • Regularly review audit trails
    • Implement approval expiration policies

Security Features

Approval Protocol includes several security considerations:

  • Audit Trails: All approval decisions are logged
  • Consent Tracking: Explicit consent tracking with timestamps
  • Input Validation: All inputs are validated before processing
  • No Eval: No dynamic code execution via eval()

Third-Party Dependencies

We regularly update our dependencies to include the latest security patches. You can check the current dependencies status:

npm audit

Contact

For any security-related questions that don't require reporting a vulnerability, please open a discussion in our GitHub repository.

Thank you for helping keep Approval Protocol and its users safe!

There aren't any published security advisories