Skip to content

Security: Muneer320/klicky

SECURITY.md

Security policy

Supported versions

Security fixes are currently applied to the latest commit on the default branch. Published packages are listed under Releases; a published package may not contain fixes from current source. No separate maintenance branches are supported.

Reporting a vulnerability

Please do not open a public issue for vulnerabilities involving:

  • Keystroke exposure
  • Input-device permissions
  • Unsafe file or socket permissions
  • Command execution
  • Path traversal
  • Malicious sound-pack handling

Use GitHub's private vulnerability reporting feature from the repository's Security tab. Include:

  1. A concise description
  2. Affected commit or version
  3. Reproduction steps
  4. Expected and actual behavior
  5. Impact assessment
  6. A suggested fix, if available

Reports will be acknowledged as soon as practical. Please allow time for a fix before public disclosure.

Security model

The privacy policy explains input handling, local settings, diagnostics and website hosting.

Klicky listens for global physical key events, which is inherently sensitive.

The daemon receives raw global key-down events, including events generated while passwords or other sensitive text are entered. Klicky discards those events after selecting a sound, but the permission itself carries keylogging capability and should be granted only to trusted software.

Linux

  • The daemon runs as the logged-in user, never as root.
  • The included udev rule uses uaccess only for devices tagged as keyboards.
  • Normal mode does not log key names.
  • Benchmark mode logs mapped key names and timing.
  • No event data is stored or transmitted.
  • IPC uses a Unix socket inside a mode 0700 runtime directory.
  • The socket and PID file use mode 0600.

macOS

  • Global input requires explicit Accessibility permission.
  • Klicky uses listen-only event taps.
  • No key data leaves the process.

Windows

  • The application runs in the user's interactive session without elevation or an input driver.
  • Passive Raw Input does not suppress or synthesize typing. Capture is gated while the desktop is locked or inactive.
  • Normal playback and aggregate benchmark diagnostics do not log key names or reconstruct typed text. Neither executable accesses the microphone.
  • Local-only control pipes restrict access to the current logon and validate the server process identity. Shutdown waits retain the actual native process handle.
  • Bundle leases protect against cooperating installer/process races; they do not protect a user from other software already running as that same user.
  • Standalone Windows EXE/ZIP downloads are unsigned; the Microsoft Store package is signed through Store delivery. Verify release checksums for standalone downloads and keep antivirus protection enabled. Report detections through the guidance above; signing or a version number is not an antivirus determination.

Network behavior

Keyboard playback makes no network requests. Update checks run only when requested with klicky update or the Windows tray's Check for updates action. The check uses HTTPS to read the latest stable release from GitHub; GitHub receives the request's IP address and a Klicky update-check user agent. No keyboard events, settings or usage statistics are included. There is no background update polling.

After confirmation, the existing installer or package manager handles downloads and installation. Store installations stay under Microsoft Store's control. Unknown, portable and source builds are not automatically overwritten. Windows standalone updates use the official HTTPS installation helper and its release checksum verification; this is not a code-signing or antivirus guarantee.

Operational guidance

  • Do not run benchmark mode while entering sensitive information.
  • Install sound packs only from sources you trust.
  • Review custom pack JSON before use.
  • Keep the binary and configuration owned by your user.
  • Do not broaden /dev/input permissions to world-readable mode.

Out of scope

The following are not considered vulnerabilities by themselves:

  • A local process running as the same user observing Klicky's public process state
  • Sound packs with unpleasant or unexpectedly loud recordings
  • Denial of service caused by a deliberately malformed local configuration owned by the same user, unless it crosses a privilege boundary

Development practices

Klicky tracks its development practices in the OpenSSF Best Practices entry.

There aren't any published security advisories