Files
voculinux/SECURITY.md
T
Jatin K MalikandGitHub f8e5de5621 feat: Make Whisper tiny the default engine and download during install (#45)
* feat: Make Whisper tiny the default engine and download during install

- Changed default engine from 'vosk' to 'whisper' in config_manager.py
- Changed default model_size from 'small' to 'tiny' in config_manager.py
- Added install_whisper_model() function to install.sh that downloads
  the Whisper tiny model (~75MB) during installation
- Whisper model is downloaded when Whisper package is installed
  (in non-interactive mode or with --with-whisper flag)
- Updated installation summary to show Whisper model status
- Updated documentation (README.md, INSTALL.md, SECURITY.md, USER_GUIDE.md)
  to reflect Whisper tiny as the default engine

This provides a better out-of-box experience: users can install and
immediately use Vocalinux without any additional downloads or prompts.

* test: Update test to reflect whisper as default engine
2025-12-28 20:31:29 -08:00

2.4 KiB

Security Policy

Supported Versions

Version Supported
0.2.x ✅
< 0.2 ❌

Reporting a Vulnerability

We take security seriously. If you discover a security vulnerability within Vocalinux, please follow these steps:

Do NOT

  • Open a public GitHub issue for security vulnerabilities
  • Disclose the vulnerability publicly before it's fixed

Do

  1. Email the maintainer directly: Send an email to jatinkrmalik@gmail.com with:

    • A clear description of the vulnerability
    • Steps to reproduce the issue
    • Potential impact assessment
    • Any suggested fixes (optional)
  2. Use the subject line: "Vocalinux Security Vulnerability Report"

  3. Wait for acknowledgment: You should receive a response within 48 hours

What to Expect

  1. Acknowledgment: We'll confirm receipt within 48 hours
  2. Assessment: We'll evaluate the severity and impact
  3. Timeline: We'll provide an estimated fix timeline
  4. Fix: We'll work on a fix and coordinate disclosure
  5. Credit: If desired, we'll credit you in the release notes

Security Considerations

Privacy

Vocalinux is designed with privacy in mind:

  • Offline by default: Both Whisper (default) and VOSK engines work completely offline
  • Local processing: All speech recognition happens on your device
  • No data collection: We don't collect or transmit your voice data
  • No telemetry: We don't track usage or behavior

Whisper AI (Default Engine)

Whisper is the default speech recognition engine:

  • Whisper processes locally on your machine
  • Models are downloaded once and cached locally
  • No audio data is sent to external servers

File Permissions

The application stores data in:

  • ~/.config/vocalinux/ - Configuration (mode 700)
  • ~/.local/share/vocalinux/ - Data and models (mode 700)

Known Limitations

  1. Text injection: Uses xdotool/wtype which may have implications for input monitoring
  2. Keyboard shortcuts: Global keyboard hooks require appropriate permissions
  3. Virtual environments: Running in a venv provides some isolation

Updates

Keep your installation updated to receive security fixes:

cd vocalinux
git pull origin main
pip install --upgrade -e .

Contact

For security concerns: jatinkrmalik@gmail.com

For general issues: https://github.com/jatinkrmalik/vocalinux/issues