Initial Commit

Author: ehrishirajsharma

README.md

@@ -1 +1,113 @@
-# SwiftnessX
+# SwiftnessX
+A cross-platform note-taking & target-tracking app for penetration testers built on ElectronJS.
+
+
+
+![](https://d2mxuefqeaa7sj.cloudfront.net/s_22468EE0712254D3EA421A4DBACA2646DD071E2B892C4DFAA54AF6BB35E989C4_1541430229290_main-view.png)
+
+
+
+
+## Downloads
+
+**Windows:** 
+**Linux:** 
+**Download Payloads & Templates:** Contains data from [PayloadsAllthethings](https://github.com/swisskyrepo/PayloadsAllTheThings) and [bb-report-templates](https://github.com/gwen001/bb-reports-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. 
+
+Windows: 
+Linux:
+
+
+## Installation
+
+The current version is especially 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)
+
+
+1. First install [Node.JS](https://nodejs.org/en/download/) on your system
+2. now run `npm install electron -g`
+3. Download or Clone this repository
+4. Within its folder run `npm install` to install dependencies
+5. 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`
+
+
+## Usage
+****
+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](https://github.com/swisskyrepo/PayloadsAllTheThings) and [bb-report-templates](https://github.com/gwen001/bb-reports-templates).
+
+
+## Discuss
+
+
+- **Feature Request / Changes:** This is a very early version of SwiftnessX with a completely new flow and architecture from macOS build and its 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. 
+
+
+  Also do not hesitate on requesting a feature - we are actively working on this project
+
+
+  
+- **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 derieved 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](https://stackoverflow.com/help/mcve).
+  
+  **Reference & Inspired from:** https://github.com/electron/electron/blob/master/docs/development/issues.md
+****
+
+## Credits
+
+Special thanks to the below contributors - It would not be possible without their contributions:
+
+
+- Tomas Baskys
+- Pankaj Prajapat
+

app/.eslintrc

@@ -0,0 +1,21 @@
+{
+  "rules": {
+    "flowtype/boolean-style": ["error", "boolean"],
+    "flowtype/define-flow-type": "warn",
+    "flowtype/delimiter-dangle": ["error", "never"],
+    "flowtype/generic-spacing": ["error", "never"],
+    "flowtype/no-primitive-constructor-types": "error",
+    "flowtype/no-weak-types": "warn",
+    "flowtype/object-type-delimiter": ["error", "comma"],
+    "flowtype/require-parameter-type": "off",
+    "flowtype/require-return-type": "off",
+    "flowtype/require-valid-file-annotation": "off",
+    "flowtype/semi": ["error", "always"],
+    "flowtype/space-after-type-colon": ["error", "always"],
+    "flowtype/space-before-generic-bracket": ["error", "never"],
+    "flowtype/space-before-type-colon": ["error", "never"],
+    "flowtype/union-intersection-spacing": ["error", "always"],
+    "flowtype/use-flow-type": "error",
+    "flowtype/valid-syntax": "error"
+  }
+}

app/about.html

@@ -0,0 +1,47 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Swiftness</title>
+    <script>
+      (function() {
+        if (!process.env.HOT) {
+          const link = document.createElement('link');
+          link.rel = 'stylesheet';
+          link.href = './dist/about.css';
+          // HACK: Writing the script path should be done with webpack
+          document.getElementsByTagName('head')[0].appendChild(link);
+        }
+      }());
+    </script>
+    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
+  </head>
+  <body>
+    <div id="root"></div>
+    <script>
+      {
+        const scripts = [];
+
+        // Dynamically insert the DLL script in development env in the
+        // renderer process
+        if (process.env.NODE_ENV === 'development') {
+          scripts.push('../dll/renderer.dev.dll.js');
+        }
+
+        // Dynamically insert the bundled app script in the renderer process
+        const port = process.env.PORT || 1212;
+        scripts.push(
+          (process.env.HOT)
+            ? 'http://localhost:' + port + '/dist/about.dev.js'
+            : './dist/about.prod.js'
+        );
+
+        document.write(
+          scripts
+            .map(script => `<script defer src="${script}"><\/script>`)
+            .join('')
+        );
+      }
+    </script>
+  </body>
+</html>

app/aboutRenderer.js

@@ -0,0 +1,11 @@
+import React from 'react';
+import { render } from 'react-dom';
+import AboutDialog from './components/AboutDialog';
+
+render(<AboutDialog />, document.getElementById('root'));
+
+if (module.hot) {
+  module.hot.accept('./containers/Root', () => {
+    render(<AboutDialog />, document.getElementById('root'));
+  });
+}

app/actions/about.js

@@ -0,0 +1,15 @@
+// @flow
+export const OPEN_ABOUT = 'OPEN_ABOUT';
+export const CLOSE_ABOUT = 'CLOSE_ABOUT';
+
+export function openAbout() {
+  return {
+    type: OPEN_ABOUT
+  };
+}
+
+export function closeAbout() {
+  return {
+    type: CLOSE_ABOUT
+  };
+}

app/actions/export.js

@@ -0,0 +1,15 @@
+// @flow
+export const OPEN_EXPORT = 'OPEN_EXPORT';
+export const CLOSE_EXPORT = 'CLOSE_EXPORT';
+
+export function openExport() {
+  return {
+    type: OPEN_EXPORT
+  };
+}
+
+export function closeExport() {
+  return {
+    type: CLOSE_EXPORT
+  };
+}