Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Lennolium/swiftGuard
Anti-forensic macOS tray application designed to safeguard your system by monitoring USB ports.
https://github.com/Lennolium/swiftGuard
anti-forensics defensive-security macos opsec physical-security security tampering-detection
Last synced: 26 days ago
JSON representation
Anti-forensic macOS tray application designed to safeguard your system by monitoring USB ports.
- Host: GitHub
- URL: https://github.com/Lennolium/swiftGuard
- Owner: Lennolium
- License: gpl-3.0
- Created: 2023-09-20T10:41:51.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-02T09:27:11.000Z (about 1 year ago)
- Last Synced: 2024-11-08T13:09:37.365Z (about 1 month ago)
- Topics: anti-forensics, defensive-security, macos, opsec, physical-security, security, tampering-detection
- Language: Python
- Homepage:
- Size: 140 MB
- Stars: 330
- Watchers: 34
- Forks: 14
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
- Mac-Menubar-Megalist - swiftGuard
README
Anti-forensic macOS tray application designed to safeguard your system by monitoring USB ports.
It ensures your device's security by automatically initiating either a system shutdown or hibernation
if an unauthorized device connects or a connected device is unplugged. It offers the flexibility to whitelist
designated devices, to select an action to be executed and to set a countdown timer, allowing to disarm the
shutdown process.
[](https://www.paypal.me/smogg)
[](https://buymeacoffee.com/lennolium)
## Contents
- [Features](#features)
- [Screenshots](#screenshots)
- [Why should you care?](#why-should-you-care)
- [Installation](#installation)
- [Usage](#usage)
- [GUI](#gui)
- [CLI](#cli)
- [Development](#development)
- [Roadmap](#roadmap)
- [Security & Code Quality](#security--code-quality)
- [Contributors](#contributors)
- [Credits](#credits)
- [License](#license)
## Features
- __Monitoring:__ Continuously monitors USB ports for device activity, even in sleep mode.
- __Whitelisting:__ Allows users to whitelist authorized devices, ensuring
hassle-free connectivity.
- __Discrete:__ Operates in the macOS system tray, minimizing
interruptions.
- __Customizable:__ Allows users to configure various settings, including
action (shutdown/hibernate), countdown timer and auto start.
- __Lightweight:__ Designed to consume minimal system resources for optimal
performance.
- __Privacy:__ Only connects to the internet to check for updates at startup.
- __Open Source:__ Provides transparency and
allows community contributions for continuous development.
## Screenshots
*__Left:__ Manipulation button to defuse the alarm. __Right:__ Whitelist and Settings menu.*
## Why should you care?
A few reasons to use this tool:
- __Anti-Forensic Measures:__ In case the police or other thugs break in. The police often use a [mouse jiggler](https://en.wikipedia.org/wiki/Mouse_jiggler)
to prevent the screen saver or sleep mode from being activated.
- __Prevent Data Exfiltration:__ You do not want someone adding or copying documents to or from your computer via USB.
- __Public Environments:__ If you frequently use your Mac in public places like libraries or cafes, swiftGuard
acts as an additional layer of security against physical attacks in a [potentially vulnerable](https://www.ccn.com/fbi-illegally-stole-ross-ulbrichts-laptop-brought-silk-road/) setting.
- __Server Protection:__ You want to improve the security of your home or company server (e.g. your Raspberry Pi, NAS, etc.).
- __Data Protection Regulations:__ Many industries and organizations are subject to strict data protection
regulations. swiftGuard helps maintain compliance by preventing unauthorized data transfers and access through USB ports.
> **Tip**: You might also want to use a cord to attach a USB key to your wrist. Then plug the key into your computer and
> run swiftGuard. If your computer is robbed, the USB is removed and the computer shuts down immediately.
## Installation
1. Obtain the most recent version by downloading it from [Releases](https://github.com/Lennolium/swiftGuard/releases/latest).
2. Open the downloaded `swiftGuard.dmg` file.
3. Drag the swiftGuard application into the Applications folder.
4. Open the swiftGuard application from the Applications folder (by right-clicking and selecting `Open`, see Note below)
5. swiftGuard should now appear in the macOS system tray.
6. Test at least once if the shutdown or hibernation is executed correctly. On first run you will be asked to grant the necessary
permissions by macOS.
7. Automatic startup at login can be enabled in the app's settings menu.
> **Important**: Make sure you use FileVault, macOS's built-in disk encryption feature, to encrypt your entire disk,
> ensuring that your data remains secure even if your device falls into the wrong hands.
> Otherwise, unauthorized users may gain access to your data easily: `System Preferences > Security & Privacy > Security > FileVault` > Do NOT enable iCloud Recovery!
>__Note:__ If you get a warning that the application is from an _unidentified developer_, you have to open
>`System Preferences > Security & Privacy > Security` and click `Open Anyway`
>to allow the application to run.
See [INSTALL.md](https://github.com/Lennolium/swiftGuard/blob/main/INSTALL.md) for further details and instructions if you are upgrading from an older version.
## Usage
### GUI
1. Open the swiftGuard application from the Applications folder.
2. Click on the application icon in the macOS system tray to open the
main menu.
3. Click the `Guarding/Inactive` entry to start or pause the guarding of your USB ports.
4. The `Devices` menu displays all allowed and connected devices. Allowed devices are indicated with a checkmark,
even if they are not connected.
5. To add or remove a device from the whitelist, simply click on the corresponding device entry.
6. If manipulation is detected, an alert (`Manipulation`) will appear in the main menu. Clicking on it
will reset the alarm. The `Exit` button will not work.
7. In the `Settings` menu you can set a delay (0 - 60 seconds) and an action (`Shutdown` or `Hibernate`). The delay
determines how long swiftGuard will wait for you to reset/defuse the alarm before executing the action.
>**Notes:**
>- swiftGuard alerts you if devices are removed that were connected before or while the application was started,
>except you add them to the whitelist.
>- Connecting new devices will always trigger an alert, if these devices are not whitelisted.
>- If you encounter any problems, please check the log file in the `~/Library/Logs/swiftGuard` folder.
>- Your settings and whitelisted devices are stored in the `~/Library/Preferences/swiftGuard/swiftguard.ini` file.
### CLI
You can run swiftGuard as a simple Python script from the command line without a graphical user interface (GUI).
This is useful when operating swiftGuard on a headless system or saving system resources. However, you will lose the
ability to defuse the shutdown process via the GUI, but you can kill the swiftGuard process from the command line
instead. The preferences and whitelists are stored in the same location as the GUI version and can be edited
manually. For further information, please refer to the [src/swiftguard/cli.py](https://github.com/Lennolium/swiftGuard/blob/main/src/swiftguard/cli.py) file.
1. Open a terminal and navigate to the desired install directory.
```bash
cd ~/Desktop
```
2. Clone the repository.
```bash
git clone https://github.com/Lennolium/swiftGuard.git
```
3. Navigate to the swiftGuard directory.
```bash
cd swiftGuard
```
4. Create a virtual environment and activate it.
```bash
python3 -m venv venv
source venv/bin/activate
pip install poetry
```
5. Install `poetry` in the venv.
```bash
pip install poetry
```
6. Install `swiftguard` in development mode.
```bash
poetry install
```
This installs swiftguard and its python packages in the virtual environment `venv/bin/swiftguard` and `venv/lib/python3.11/site-packages` in development mode, so you can
change code in the `src/swiftguard` folder and immediately test it in the terminal.
7. Run it in CLI mode.
```bash
swiftguard
```
GUI mode: `swiftguardgui`
> **Notes:**
>
> - Settings/Whitelist: `~/Library/Preferences/swiftGuard/swiftguard.ini`
> - Logs: `~/Library/Logs/swiftGuard/swiftguard.log` Logs are rotated every 2 MB with a maximum of 5 files.
> You can set the log level (Debug=1, ..., Critical=5) and the log output (file, syslog, stdout; required: file) in the `swiftguard.ini` file.
## Development
As an open-source project, I strive for transparency and collaboration in my development process. I greatly
appreciate any contributions members of our community can provide. Whether you are fixing bugs, proposing features,
improving documentation, or spreading awareness - your involvement strengthens the project. Please review the
[code of conduct](https://github.com/Lennolium/swiftGuard/blob/main/.github/CODE_OF_CONDUCT.md) to understand how we work together
respectfully.
- __Bug Report:__ If you are experiencing an issue while using the application, please [create an issue](https://github.com/Lennolium/swiftGuard/issues/new/choose).
- __Feature Request:__ Make this project better by [submitting a feature request](https://github.com/Lennolium/swiftGuard/discussions/2).
- __Documentation:__ Improve our documentation by [adding a wiki page](https://github.com/Lennolium/swiftGuard/wiki).
- __Community Support:__ Help others on [GitHub Discussions](https://github.com/Lennolium/swiftGuard/discussions).
- __Security Report:__ Report critical security issues via our [template](https://github.com/Lennolium/swiftGuard/blob/main/.github/SECURITY.md).
## Roadmap
| **Now** | **Next** | **Later** |
|----------------------------------------|------------------------------------------------------|-----------------------------|
| Unit tests | Linux support | CI/CD |
| Code quality | Bluetooth and WiFi detection (Apple Watch) | Website/Docs/Wiki |
| Custom system wide hotkey for defusing | Auto update (yet: just notifying) | Encrypted configuration |
| E-Mail notification | Native Apple silicon support | Code sign (Apple) |
| Countdown dialog | More actions (wipe ram, delete files/folders, email) | User defined actions |
| Passwort protected defusing (Dialog) | Translations | Professional security audit |
## Security & Code Quality
Regarding swiftGuard is a security application and therefore security is of the utmost importance. I am committed to ensuring
that it is secure and reliable for all users. I am grateful for any feedback regarding security issues and will do my best to
address them as quickly as possible. Please refer to the [security policy](https://github.com/Lennolium/swiftGuard/blob/main/.github/SECURITY.md) for more information.
Additionally, I let my code be checked by several code quality and security tools (Bandit, Black, Codacy, CodeQL, PMD CPD, Prospector, Pylint, Pysa, Pyre, Trivy and Radon).
The results can be found by clicking on the badges below. These routines are **no replacement for a manual code and security audit**, but they help to find errors and vulnerabilities.
Please note that the results of these tools are not always accurate and may contain false positives.
## Contributors
Thank you so much for giving feedback, implementing features and improving the code and project!
## Credits
This application is heavily inspired and based on project
[usbkill](https://github.com/hephaest0s/usbkill) by Hephaestos and [BusKill](https://github.com/BusKill/buskill-app) by Michael Altfield.
I want to thank him and all the other great contributors of usbkill for
their great work, inspiration and help. I firmly believe in the
principles of the open source community, which call for the sharing and
enhancement of one another work. The purpose of this project is to
revive an abandoned project and to support others in learning and
comprehending the fundamentals of Python, Qt and macOS, and to develop
their own projects.
Many more credits are in the [acknowledgments](https://github.com/Lennolium/swiftGuard/blob/main/ACKNOWLEDGMENTS) file.
## License
Provided under the terms of the [GNU GPL3 License](https://www.gnu.org/licenses/gpl-3.0.en.html) © Lennart Haack 2023.
See [LICENSE](https://github.com/Lennolium/swiftGuard/blob/main/LICENSE) file for details.
For the licenses of used third party libraries and software, please refer to the [ACKNOWLEDGMENTS](https://github.com/Lennolium/swiftGuard/blob/main/ACKNOWLEDGMENTS) file.
