Skip to content

Security: reapercanuk39/zram-tuning

Security

SECURITY.md

Security Policy

Supported Versions

Version Supported
1.x.x

Security Considerations

Scripts Run as Root

Most scripts in this project require root privileges to:

  • Configure kernel parameters (/sys/block/zram*, /proc/sys/vm/*)
  • Manage swap devices
  • Load/unload kernel modules

Recommendations:

  1. Review scripts before running with sudo
  2. Use configuration files instead of command-line arguments for sensitive values
  3. Run benchmarks in isolated environments when possible

Safe Defaults

All scripts use safe defaults:

  • No destructive operations without explicit confirmation
  • Graceful fallbacks when features are unavailable
  • Logging of all configuration changes
  • Backup creation before modifying system files

Known Limitations

  1. PID file race conditions: Daemon scripts use PID files which could theoretically be exploited. Mitigated by root-only permissions.

  2. Temporary files: Some scripts create temporary files in /tmp. These are cleaned up on exit but could be targets during execution.

  3. Loop devices: Writeback setup uses loop devices. Ensure backing files are on trusted filesystems.

Reporting a Vulnerability

If you discover a security vulnerability:

  1. Do NOT open a public issue
  2. Email the maintainers directly (see repository contact info)
  3. Include:
    • Description of the vulnerability
    • Steps to reproduce
    • Potential impact
    • Suggested fix (if any)

We will respond within 48 hours and work with you to address the issue.

Best Practices for Users

  1. Verify downloads: Check release signatures when available
  2. Review before running: Especially scripts from forks or PRs
  3. Monitor system: Use the included monitoring tools to detect anomalies
  4. Keep updated: Apply security updates to your kernel and this toolkit
  5. Backup configurations: Before major changes to ZRAM setup

There aren't any published security advisories