A cross-platform note-taking & target-tracking app for penetration testers built on ElectronJS.
- Windows:
- Linux:
- Download Payloads & Templates: Contains data from PayloadsAllthethings and bb-report-templates.
App supports auto-updating system when new release gets available.
Portable Version: The portable application allows installing the software on a portable device such as a USB - when you want to work upon different device. The current storage schema gives you an ability to use the same target’s data on multiple devices (with import/export) without creating same target with multiple instances.
The current version is specially designed for Windows users therefore, installation process is pretty straightforward - just use the installer and it will be installed under the applications section.
For Linux users (it's a bit complex and we will try to fix it very soon), you will need to give permission to the app ; just chmod +x swiftness-0.1.0.AppImage for installer file and then open it (in first attempt, it will try to install) and then it will be ready to use. (Make sure you're extracting the app in a dedicated folder)
If you want to use the portable version, extract the folder and give same permission to Swiftness executable file and utilise in the same manner.
- First install Node.JS on your system
- now run
npm install electron -g - Download or Clone this repository
- Within its folder run
npm installto install dependencies - And to run use
npm run dev
To update just use git pull or if dependencies are updated than first install them by npm install
It’s pretty straightforward to use SwiftnessX, I’ve created a small video on how to use Targets with checklist: https://www.youtube.com/watch?v=s227q_rTVkw
For Templates and Payloads, download this file, which has data from PayloadsAllthethings and bb-report-templates.
🌱 Feature Request / Changes: This is a very early version of SwiftnessX with a completely new flow and architecture from macOS build and it's likely that some features & flow may not be perfect. We encourage you to tell us if a flow or feature is not fitting in, we will discuss with you and along with other users’ on possible way to improve or change that.
🚨 Security: Electron projects are often dependent upon too many 3rd party libraries and in result it has more chances of being vulnerable to security-vulnerabilities compared to native-apps.
We tried our best to not make app’s modules too dependent upon the 3rd party packages however, we still recommend you to understand the basics of ElectronJS and let us know if you observe any security vulnerabilities.
To understand the basics of Electron Security & NodeJS Packages:
- https://electronjs.org/docs/tutorial/security
- https://www.blackhat.com/docs/us-17/thursday/us-17-Carettoni-Electronegativity-A-Study-Of-Electron-Security-wp.pdf
- https://www.youtube.com/watch?v=QSMbk2nLTBk
You can find the packages under package.json, check them:
- You can check how packages are integrated and can manually check the process by debugging the app in dev-environment. (explained above)
- Use Chromium Developer Tools to check each functionality and their dependent JS files.
Directly ask us on Issues Section or Email ([email protected]) to understand how a specific package is integrated.
To report a security-vulnerability within the app, please send us an email directly to [email protected]
If issues are derived from a 3rd-party module, also report to the person or team maintaining the module.
🐛 Bugs:
When opening a new issue in the ehrishirajsharma/SwifnessX issue tracker, users will be presented with a template that should be filled in.
The two most important pieces of information needed to evaluate the report are a description of the bug and a simple test case to recreate it. It easier to fix a bug if it can be reproduced.
See How to create a Minimal, Complete, and Verifiable example.
Reference & Inspired from: https://github.com/electron/electron/blob/master/docs/development/issues.md
Special thanks to the below contributors - It would not be possible without their contributions:
- Tomas Baskys
- Pankaj Prajapat

