From a7970050bdd7bfa53cee42393606e9ba0e0988b9 Mon Sep 17 00:00:00 2001 From: Lennolium Date: Thu, 28 Sep 2023 16:02:11 +0200 Subject: [PATCH] Added Code Security and Quality Section --- README.md | 39 ++++++++++++++++++++++++++++++++++++--- requirements.txt | 3 ++- 2 files changed, 38 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cf04997..414e5b7 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,8 @@ alt="stable version" > + +
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 @@ -67,7 +69,7 @@ shutdown process. - [Features](#features) - [Screenshots](#screenshots) -- [Why should I care?](#why-should-i-care) +- [Why should you care?](#why-should-you-care) - [Installation](#installation) - [Usage](#usage) - [GUI](#gui) @@ -117,7 +119,7 @@ shutdown process. -### Why should you care? +## Why should you care? A few reasons to use this tool: @@ -256,7 +258,6 @@ respectfully. - __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). -   @@ -271,6 +272,38 @@ respectfully. | Package for Apple silicon | Auto start | Code sign (Apple) | | Security audit | More actions (wipe ram, delete files/folders, email) | User defined actions | +  + + + +## 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, 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. + +
+ + Codacy + + + Black + + + + + + +
+
+ Pysa + +
  diff --git a/requirements.txt b/requirements.txt index 2d12d6f..27668d3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ -black==23.9.1 PySide6==6.5.2 darkdetect==0.8.0 +black==23.9.1 +bandit==1.7.5