Merge pull request #24 from cybersecmoo/feature/terminal

cybersecmoo · web-flow · commit fe3866057c5f · 2020-03-01T13:40:08.000Z
Feature/terminal
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "brownie-tub",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "main": "public/electron.js",
   "private": true,
   "author": "cybersecmoo <50770700+cybersecmoo@users.noreply.github.com>",
diff --git a/public/electron.js b/public/electron.js
@@ -2,7 +2,8 @@
 const { app, BrowserWindow, ipcMain } = require("electron");
 const path = require("path");
 const { getDatabase } = require("./db/setup-db");
-const { sendRequest, determineOS, listDir, workingDir } = require("./utils/requests");
+const { sendArbitraryCommand, determineOS, listDir, workingDir } = require("./utils/requests");
+const { parseMultiline } = require("./utils/utils");
 
 
 
@@ -27,6 +28,7 @@ async function createWindow() {
 
   const db = await getDatabase("shells", "websql");
   const shellCollection = db.shells;
+  var selectedShell = null;
 
   ipcMain.on("shell:create", async (event, shellDetails) => {
     try {
@@ -64,17 +66,29 @@ async function createWindow() {
 
   ipcMain.on("shell:select", async (event, shellDetails) => {
     try {
+      selectedShell = shellDetails;
       // TODO: Admin determination
-      shellDetails.os = await determineOS(shellDetails);
-      const dir = await listDir(shellDetails);
-      const dirName = await workingDir(shellDetails);
-      event.reply("shell:select-reply", { shell: shellDetails, dir: dir, dirName: dirName });
+      selectedShell.os = await determineOS(selectedShell);
+      const dir = await listDir(selectedShell);
+      const dirName = await workingDir(selectedShell);
+      event.reply("shell:select-reply", { shell: selectedShell, dir: dir, dirName: dirName });
     } catch (error) {
       console.error(error);
       event.reply("misc:alert", {alertType: "warning", alertMessage: "Failed to load shell details!"});
     }
   });
 
+  ipcMain.on("terminal:command", async (event, command) => {
+    try {
+      var output = await sendArbitraryCommand(selectedShell, command);
+      output = parseMultiline(output);
+      event.reply("terminal:command-reply", output);
+    } catch(err) {
+      console.log(err);
+      event.reply("misc:alert", {alertType: "warning", alertMessage: "Failed to send command!"});
+    }
+  });
+
   // Listen for window being closed
   mainWindow.on("closed", () => {
     mainWindow = null;
diff --git a/public/utils/requests.js b/public/utils/requests.js
@@ -73,29 +73,58 @@ const encodeCommand = (command, shellEncoding) => {
 	return encoded;
 }
 
+/** 
+ * Sends a predefined request type
+ * 
+ * @param {WebShellSchema} shell The details of the selected shell
+ * @param {String} reqType The name of the request type, as defined in `reqTypes.js`
+ * @exports 
+ */
 const sendRequest = async (shell, reqType) => {
 	var command = COMMAND_MAP[reqType][shell.os];
-	command = encodeCommand(command, shell.commandEncoding);
+	return sendArbitraryCommand(shell, command);
+}
 
-	const config = generateConfig(shell, command);
-	var response;
+/** @exports */
+const sendArbitraryCommand = async (shell, command) => {
+	try {
+		var request = encodeCommand(command, shell.commandEncoding);
 
-	if(shell.commandParamType === "POST") {
-		response = await axios.post(shell.ipOrHostname, config);
-	} else {
-		response = await axios.get(shell.ipOrHostname, config);
-	}
+		const config = generateConfig(shell, request);
+		var response;
+
+		if(shell.commandParamType === "POST") {
+			response = await axios.post(shell.ipOrHostname, config);
+		} else {
+			response = await axios.get(shell.ipOrHostname, config);
+		}
 
-	return response;
+		return response;
+	} catch (error) {
+		return null;
+	}
+	
 }
 
+/** 
+ * Gets the directory listing from the remote, and parses it
+ * 
+ * @param {WebShellSchema} shell The details of the selected shell
+ * @exports 
+ */
 const listDir = async (shell) => {
 	const response = await sendRequest(shell, LIST_DIR);
 	const dir = parseListDirResponse(response.data);
 
 	return dir;
 }
 
+/** 
+ * Determines what operating system the target is running
+ * 
+ * @param {WebShellSchema} shell The details of the selected shell
+ * @exports 
+ */
 const determineOS = async (shell) => {
 	const command = encodeCommand("uname -a", shell.commandEncoding);
 
@@ -122,11 +151,17 @@ const determineOS = async (shell) => {
 	return os;
 };
 
+/** 
+ * Gets the current working directory of the remote
+ * 
+ * @param {WebShellSchema} shell The details of the selected shell
+ * @exports 
+ */
 const workingDir = async (shell) => {
 	const response = await sendRequest(shell, WORKING_DIR);
 	const dirName = parseWorkingDir(response.data);
 
 	return dirName;
 };
 
-module.exports = { sendRequest, determineOS, listDir, workingDir };
+module.exports = { sendRequest, sendArbitraryCommand, determineOS, listDir, workingDir };
diff --git a/public/utils/utils.js b/public/utils/utils.js
@@ -1,7 +1,18 @@
 const { WINDOWS, LINUX, MAC } = require("./osTypes");
 
+/** 
+ * Uses a regex to split the input into its component lines
+ * 
+ * @param {String} multilineInput The data to split
+ * @exports 
+ */
+const parseMultiline = (multilineInput) => {
+	const lines = multilineInput.split(/\r?\n/);
+	return lines;
+}
+
 const parseWindowsListDir = (listDirResponse) => {
-	const lines = listDirResponse.split(/\r?\n/);
+	const lines = parseMultiline(listDirResponse);
 	var dir = [];
 
 	for(const lineNo in lines) {
@@ -39,7 +50,7 @@ const parseWindowsListDir = (listDirResponse) => {
 // NOTE This relies on parsing the output of `ls -la`, and is therefore not 100% reliable against crafted filenames. However, it should be fine against the vast 
 //	majority of files. Just be aware. 
 const parseUnixListDir = (listDirResponse) => {
-	const lines = listDirResponse.split(/\r?\n/);
+	const lines = parseMultiline(listDirResponse);
 	var dir = [];
 
 	for(const lineNo in lines) {
@@ -73,6 +84,13 @@ const parseUnixListDir = (listDirResponse) => {
 	return dir;
 }
 
+/** 
+ * Parses a directory listing, for Windows and Unix platforms
+ * 
+ * @param {Object} listDirResponse The output of the directory listing command
+ * @param {String} os The operating system used on the target
+ * @exports 
+ */
 const parseListDirResponse = (listDirResponse, os) => {
 	var dir;
 
@@ -85,9 +103,15 @@ const parseListDirResponse = (listDirResponse, os) => {
 	return dir;
 }
 
+/** 
+ * Parses the output of a working-directory request
+ * 
+ * @param {Object} workingDirResponse The output of the request to get the working directory
+ * @exports 
+ */
 const parseWorkingDir = (workingDirResponse) => {
-	const lines = workingDirResponse.split(/\r?\n/);
+	const lines = parseMultiline(workingDirResponse);
 	return lines[0];
 }
 
-module.exports = { parseListDirResponse, parseWorkingDir };
+module.exports = { parseMultiline, parseListDirResponse, parseWorkingDir };
diff --git a/src/App.css b/src/App.css
@@ -36,3 +36,15 @@
     transform: rotate(360deg);
   }
 }
+
+div.main {
+  height: 100vh;
+}
+
+.row1 {
+  height: 67vh;
+}
+
+.row2 {
+  height: 33vh;
+}
diff --git a/src/App.js b/src/App.js
@@ -9,6 +9,7 @@ import ShellList from "./components/shell-list.component";
 import ShellDetailPanel from "./components/shell-detail-panel.component";
 import DirectoryView from "./components/directory-view.component";
 import { Component } from 'react';
+import Terminal from "./components/terminal.component";
 
 const dark = createMuiTheme({
   palette: {
@@ -39,8 +40,8 @@ class App extends Component {
     return (
       <ThemeProvider theme={dark}>
         <CssBaseline />
-        <div>
-          <Grid container>
+        <div className="main">
+          <Grid container className="row1">
             <Grid item xs={2}>
               <ShellList />
             </Grid>
@@ -51,6 +52,15 @@ class App extends Component {
               <ShellDetailPanel />
             </Grid>
           </Grid>
+          <Grid container className="row2">
+            <Grid item xs={2}>
+            </Grid>         
+            <Grid item xs={8}>
+              <Terminal />
+            </Grid>
+            <Grid item xs={2}>
+            </Grid>  
+          </Grid>
           <Snackbar open={this.state.showAlert} autoHideDuration={6000} onClose={this.handleAlertClose}>
             <Alert severity={this.state.alertType} onClose={this.handleAlertClose}>
               {this.state.alertMessage}
diff --git a/src/components/shell-create-form.component.jsx b/src/components/shell-create-form.component.jsx
@@ -54,20 +54,19 @@ class ShellCreateForm extends Component {
 				<DialogContent>
 					<DialogTitle>Register a New Shell</DialogTitle>
 					<div>
-						<FormControl>
-							<TextField required autoFocus id="ipOrHostname" label="IP or URL" onChange={this.handleStringChanged("ipOrHostname")} fullWidth />
-						</FormControl>
+						<TextField required autoFocus size="small" id="ipOrHostname" label="IP or URL" onChange={this.handleStringChanged("ipOrHostname")} fullWidth />
 					</div>
 					
 					<div>
 						<FormControl>
-							<InputLabel required id="commandParamType-label">Param Type</InputLabel>
+							<InputLabel required size="small" id="commandParamType-label">Param Type</InputLabel>
 							<Select
 								required 
 								labelId="commandParamType-label"
 								id="commandParamType"
 								value={this.state.paramType}
 								onChange={this.handleStringChanged("commandParamType")}
+								size="small" 
 							>
 								<MenuItem value={"header"}>Header</MenuItem>
 								<MenuItem value={"cookie"}>Cookie</MenuItem>
@@ -83,18 +82,17 @@ class ShellCreateForm extends Component {
 								id="commandEncoding"
 								value={this.state.paramType}
 								onChange={this.handleStringChanged("commandEncoding")}
+								size="small" 
 							>
 								<MenuItem value="None">None</MenuItem>
 								<MenuItem value={"base64"}>Base64</MenuItem>
 							</Select>
 						</FormControl>
-						<FormControl>
-							<TextField required id="commandParam" label="Command Parameter" onChange={this.handleStringChanged("commandParam")} fullWidth />
-						</FormControl>
+						<TextField required id="commandParam" size="small" label="Command Parameter" onChange={this.handleStringChanged("commandParam")} fullWidth />
 					</div>
 	
 					<div>
-						<FormControlLabel control={
+						<FormControlLabel size="small" control={
 							<Checkbox checked={this.state.passwordEnabled} onChange={this.handleCheckboxChanged("passwordEnabled")} value="passwordEnabled" />
 						} 
 						label="Enable Password" />
@@ -108,6 +106,7 @@ class ShellCreateForm extends Component {
 								id="passwordParamType"
 								value={this.state.passwordParamType}
 								onChange={this.handleStringChanged("passwordParamType")}
+								size="small"
 							>
 								<MenuItem selected value={"none"}>None</MenuItem>
 								<MenuItem value={"header"}>Header</MenuItem>
@@ -116,12 +115,8 @@ class ShellCreateForm extends Component {
 								<MenuItem value={"GET"}>GET Param</MenuItem>
 							</Select>
 						</FormControl>
-						<FormControl>
-							<TextField id="passwordParam" label="Password Parameter" onChange={this.handleStringChanged("passwordParam")} fullWidth />
-						</FormControl>
-						<FormControl>
-							<TextField id="password" label="Password" onChange={this.handleStringChanged("password")} fullWidth />
-						</FormControl>
+						<TextField id="passwordParam" label="Password Parameter" size="small" onChange={this.handleStringChanged("passwordParam")} fullWidth />
+						<TextField id="password" label="Password" size="small" onChange={this.handleStringChanged("password")} fullWidth />
 					</div>
 				</DialogContent>
 				<DialogActions>
diff --git a/src/components/terminal.component.jsx b/src/components/terminal.component.jsx
diff --git a/src/components/terminal.css b/src/components/terminal.css

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "brownie-tub",`
`3`		`- "version": "0.4.0",`
	`3`	`+ "version": "0.5.0",`
`4`	`4`	`"main": "public/electron.js",`
`5`	`5`	`"private": true,`
`6`	`6`	`"author": "cybersecmoo <50770700+cybersecmoo@users.noreply.github.com>",`