VeraCrypt Crash Collector

Overview

VeraCrypt Crash Collector is a web application designed to gather and manage crash reports from the VeraCrypt desktop application running on Linux and macOS. This app ensures that users have control over their data, as crash reports are only sent if users explicitly allow it after VeraCrypt detects a crash has occurred.

The collected crash reports provide vital information to improve the stability and performance of VeraCrypt by helping to identify and resolve issues.

Crash Reporting Mechanism

When a crash occurs, the following information is gathered by the crash reporting system:

• Program version: The specific version of VeraCrypt that encountered the issue.
• Operating system version: The version of the OS on which the crash occurred.
• Hardware architecture: Information about the CPU architecture (e.g., x86_64, ARM).
• Checksum of the VeraCrypt executable: A checksum that helps verify the integrity of the executable.
• Error category: The signal number indicating the type of error.
• Error address: The memory address where the fault occurred.
• Call stack: The sequence of function calls leading up to the error.

Important Note

No personal information is included in the crash reports. The call stack captured is purely technical and does not contain any user data.

Purpose

The goal of VeraCrypt Crash Collector is to streamline the crash report management process and provide a clear path to fixing any technical issues in VeraCrypt. It helps developers identify and resolve bugs by analyzing the crash data collected.

Contribution

Contributions are welcome! Please follow the contribution guidelines when submitting a pull request.

License

This project is licensed under the Apache License 2.0.

Requirements

• PHP 8.1 and up, with the SQLite extension
• Composer, to install the required dependencies

Installation

1. run composer install at the root of the project

2. check the configuration in .env, and, if required, change any value by saving it in a file named .env.local

3. make sure that the var/data directory is writeable (this is where the app will create its sqlite db by default), as well as var/cache/twig

4. create an administrator user: run the cli command ./bin/console user:create --is-superuser <username> <email> <firstname> <lastname>

5. set up the webserver:

   • configure the vhost root directory to be the public directory. No http access to any other folder please
   • make sure .php scripts are executed via the php interpreter
   • no rewrite rules are necessary