Skip to content

Security: bivlked/WinClean

Security

SECURITY.md

Security Policy

Supported Versions

Version Supported
2.x
1.x

Security Features

WinClean is designed with security in mind:

  • System Restore Point: Created before any changes
  • Protected Paths: Critical system folders are never touched
  • No Network Data: Script doesn't send any data externally
  • No Credentials: Script never stores or transmits credentials
  • Dry Run Mode: -ReportOnly flag to preview all changes
  • Signed Commits: All releases are signed

Protected Paths (Never Modified)

C:\Windows\
C:\Program Files\
C:\Program Files (x86)\
C:\Users\
C:\Users\<Username>\

Reporting a Vulnerability

If you discover a security vulnerability in WinClean, please report it responsibly:

How to Report

  1. DO NOT create a public GitHub issue for security vulnerabilities
  2. Email the maintainer directly (create a private security advisory)
  3. Or use GitHub's private vulnerability reporting

What to Include

  • Description of the vulnerability
  • Steps to reproduce
  • Potential impact
  • Suggested fix (if any)

Response Timeline

  • Initial Response: Within 48 hours
  • Status Update: Within 7 days
  • Fix Timeline: Depends on severity
    • Critical: 24-48 hours
    • High: 1 week
    • Medium: 2 weeks
    • Low: Next release

After Reporting

  1. We will acknowledge receipt of your report
  2. We will investigate and determine impact
  3. We will develop and test a fix
  4. We will release a patched version
  5. We will publicly acknowledge your contribution (unless you prefer anonymity)

Security Best Practices for Users

When using WinClean:

  1. Always download from official sources (GitHub releases)
  2. Verify the script before running (-ReportOnly mode)
  3. Run with minimum necessary privileges (though admin is required)
  4. Keep PowerShell updated to the latest version
  5. Review the changelog before updating to new versions

Scope

The following are in scope for security reports:

  • Code execution vulnerabilities
  • Privilege escalation
  • Data destruction outside intended scope
  • Information disclosure
  • Bypass of safety mechanisms

The following are out of scope:

  • Issues requiring physical access to the machine
  • Social engineering
  • Issues in dependencies not controlled by this project
  • Issues already publicly known

Thank you for helping keep WinClean secure!

There aren’t any published security advisories