A cross-platform note-taking & target-tracking app for penetration testers built on ElectronJS.
Check Releases for support on different Operating Systems.
App supports auto-updating system when new release gets available.
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
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.
Setup Electron (if you want to run dev-environment)
- First install Node.JS on your system
- now run
sudo npm install electron -g --unsafe-perm=true --allow-root
- Download or Clone this repository
- Within its folder run
sudo npm install --unsafe-perm=true --allow-rootto 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
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:
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 (firstname.lastname@example.org) to understand how a specific package is integrated.
To report a security-vulnerability within the app, please send us an email directly to email@example.com
If issues are derived from a 3rd-party module, also report to the person or team maintaining the module.
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.
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
- Sahil Ahamad