8c17396285
This commit improves the management of script execution process by enhancing the way terminal commands are handled, paving the way for easier future modifications and providing clearer feedback to users when scripts are cancelled. Previously, the UI displayed a generic error message which could lead to confusion if the user intentionally cancelled the script execution. Now, a specific error dialog will appear, improving the user experience by accurately reflecting the action taken by the user. This change affects code execution on Linux where closing GNOME terminal returns exit code `137` which is then treated by script cancellation by privacy.sexy to show the accurate error dialog. It does not affect macOS and Windows as curret commands result in success (`0`) exit code on cancellation. Additionally, this update encapsulates OS-specific logic into dedicated classes, promoting better separation of concerns and increasing the modularity of the codebase. This makes it simpler to maintain and extend the application. Key changes: - Display a specific error message for script cancellations. - Refactor command execution into dedicated classes. - Improve file permission setting flexibility and avoid setting file permissions on Windows as it's not required to execute files. - Introduce more granular error types for script execution. - Increase logging for shell commands to aid in debugging. - Expand test coverage to ensure reliability. - Fix error dialogs not showing the error messages due to incorrect propagation of errors. Other supported changes: - Update `SECURITY.md` with details on script readback and verification. - Fix a typo in `IpcRegistration.spec.ts`. - Document antivirus scans in `desktop-vs-web-features.md`.
94 lines
4.7 KiB
Markdown
94 lines
4.7 KiB
Markdown
# Desktop vs. Web Features
|
|
|
|
This table outlines the differences between the desktop and web versions of `privacy.sexy`.
|
|
|
|
| Feature | Desktop | Web |
|
|
| ------- | ------- | --- |
|
|
| [Usage without installation](#usage-without-installation) | 🔴 Not available | 🟢 Available |
|
|
| [Offline usage](#offline-usage) | 🟢 Available | 🟡 Partially available |
|
|
| [Auto-updates](#auto-updates) | 🟢 Available | 🟢 Available |
|
|
| [Logging](#logging) | 🟢 Available | 🔴 Not available |
|
|
| [Secure script execution/storage](#secure-script-executionstorage) | 🟢 Available | 🔴 Not available |
|
|
| [Native dialogs](#native-dialogs) | 🟢 Available | 🔴 Not available |
|
|
|
|
## Feature descriptions
|
|
|
|
### Usage without installation
|
|
|
|
You can use the web version directly in a browser without installation.
|
|
The desktop version requires download and installation.
|
|
|
|
> **Note for Linux users:** On Linux, privacy.sexy is available as an `AppImage`, a portable format that doesn't need traditional installation.
|
|
> This allows Linux users to use the desktop version without full installation, akin to the web version.
|
|
|
|
### Offline usage
|
|
|
|
The web version, once loaded, supports offline use.
|
|
Desktop version inherently allows offline usage.
|
|
|
|
### Auto-updates
|
|
|
|
Both the desktop and web versions of privacy.sexy provide timely access to the latest features and security improvements. The updates are automatically deployed from source code, reflecting the latest changes for enhanced security and reliability. For more details, see [CI/CD documentation](./../ci-cd.md).
|
|
|
|
The desktop version ensures secure delivery through cryptographic signatures and version checks.
|
|
|
|
[Security is a top priority](./../../SECURITY.md#update-security-and-integrity) at privacy.sexy.
|
|
|
|
> **Note for macOS users:** On macOS, the desktop version's auto-update process involves manual steps due to Apple's code signing costs.
|
|
> Users get notified about updates but might need to complete the installation manually.
|
|
> Consider [donating](https://github.com/sponsors/undergroundwires) to help improve this process ❤️.
|
|
|
|
### Logging
|
|
|
|
The desktop version supports logging of activities to aid in troubleshooting.
|
|
This feature is not available in the web version.
|
|
|
|
Log file locations vary by operating system:
|
|
|
|
- macOS: `$HOME/Library/Logs/privacy.sexy`
|
|
- Linux: `$HOME/.config/privacy.sexy/logs`
|
|
- Windows: `%APPDATA%\privacy.sexy\logs`
|
|
|
|
> 💡 privacy.sexy provides scripts to securely erase these logs.
|
|
|
|
### Secure script execution/storage
|
|
|
|
The desktop version of privacy.sexy enables direct script execution, providing a seamless and integrated experience.
|
|
This direct execution capability isn't available in the web version due to inherent browser restrictions.
|
|
|
|
**Script execution history:**
|
|
|
|
For enhanced auditability and easier troubleshooting, the desktop version keeps a record of executed scripts in designated directories.
|
|
These locations vary based on the operating system:
|
|
|
|
- macOS: `$HOME/Library/Application Support/privacy.sexy/runs`
|
|
- Linux: `$HOME/.config/privacy.sexy/runs`
|
|
- Windows: `%APPDATA%\privacy.sexy\runs`
|
|
|
|
> 💡 privacy.sexy provides scripts to securely erase your script execution history.
|
|
|
|
**Script antivirus scans:**
|
|
|
|
To enhance system protection, the desktop version of privacy.sexy automatically verifies the security of script
|
|
execution files by reading them back.
|
|
This process triggers antivirus scans to verify that scripts are safe before the execution.
|
|
|
|
**Script integrity checks:**
|
|
|
|
The desktop version of privacy.sexy implements robust integrity checks for both script execution and storage.
|
|
Featuring tamper protection, the application actively verifies the integrity of script files before executing or saving them.
|
|
If the actual contents of a script file do not align with the expected contents, the application refuses to execute or save the script.
|
|
This proactive approach ensures only unaltered and verified scripts undergo processing, thereby enhancing both security and reliability.
|
|
|
|
**Error handling:**
|
|
|
|
The desktop version of privacy.sexy features advanced error handling capabilities.
|
|
In scenarios where script execution or storage encounters failure, the desktop application initiates automated troubleshooting and self-healing processes.
|
|
It employs robust and reliable execution strategies, including self-healing mechanisms, and provides guidance and troubleshooting information to resolve issues effectively.
|
|
This proactive error handling and user guidance enhances the application's security and reliability.
|
|
|
|
### Native dialogs
|
|
|
|
The desktop version uses native dialogs, offering more features and reliability compared to the browser's file system dialogs.
|
|
These native dialogs provide a more integrated and user-friendly experience, aligning with the operating system's standard interface and functionalities.
|