Skip to content

A Hardware Hacking Tool with Web-Based CLI That Speaks Every Protocol

Added helper function

Andrei Vladescue2a97dc4172d
diff --git a/src/Abstracts/ANetworkController.cpp b/src/Abstracts/ANetworkController.cpp
index fd6aa2fc..45cd8fe5 100644
--- a/src/Abstracts/ANetworkController.cpp
+++ b/src/Abstracts/ANetworkController.cpp
@@ -153,6 +153,13 @@ void ANetworkController::handleNmap(const TerminalCommand &cmd)
// Parse args
// Parse hosts first
auto hosts_arg = cmd.getSubcommand();
+
+ // First helper invoke
+ if (hosts_arg.find('-h') || hosts_arg.find("--help")) {
+ terminalView.println(nmapService.getHelpText());
+ return;
+ }
+
if(!nmapService.parseHosts(hosts_arg)) {
terminalView.println("Nmap: Invalid host.");
return;
@@ -168,6 +175,12 @@ void ANetworkController::handleNmap(const TerminalCommand &cmd)
auto tokens = argTransformer.splitArgs(cmd.getArgs());
auto options = NmapService::parseNmapArgs(tokens);
+ // Second helper
+ if (options.help) {
+ terminalView.println(nmapService.getHelpText());
+ return;
+ }
+
if (options.hasTrash){
// TODO handle this better
//terminalView.println("Nmap: Invalid options.");
diff --git a/src/Services/NmapService.cpp b/src/Services/NmapService.cpp
index 612e1903..3b3e06a7 100644
--- a/src/Services/NmapService.cpp
+++ b/src/Services/NmapService.cpp
@@ -10,6 +10,10 @@
#include <Data/NmapUtils.h>
#include <unordered_set>
+extern "C" {
+#include <getopt.h> // provides getopt_long
+}
+
struct NmapTaskParams
{
std::vector<std::string> target_hosts;
@@ -26,6 +30,23 @@ void NmapService::setDefaultPorts(bool tcp){
}
}
+std::string NmapService::getHelpText() {
+ return
+ "Usage: nmap <host> [options]\r\n"
+ "\r\n"
+ "Options:\r\n"
+ " -h Show this help\r\n"
+ " -p <spec> Ports: 80 | 22,80,443 | 8000-8010 | 0x50\r\n"
+ " -sT TCP connect scan (default)\r\n"
+ " -sU UDP scan\r\n"
+ " -v / -vv Verbosity\r\n"
+ "\r\n"
+ "Examples:\r\n"
+ " nmap 192.168.1.10 -p 22,80-90 -sT -vv\r\n"
+ " nmap example.com -sU -p 53,123\r\n"
+ " nmap 10.0.0.5 -p 8080\r\n";
+}
+
NmapOptions NmapService::parseNmapArgs(const std::vector<std::string>& tokens) {
NmapOptions nmap_options;
std::vector<char*> argv;
@@ -42,9 +63,17 @@ NmapOptions NmapService::parseNmapArgs(const std::vector<std::string>& tokens) {
// Restart scanning at argv[1]
optind = 1;
+ static const option longopts[] = {
+ {"help", no_argument, nullptr, 'h'},
+ {"ports", required_argument, nullptr, 'p'},
+ {"scan", required_argument, nullptr, 's'}, // e.g. -sT / -sU
+ {nullptr, 0, nullptr, 0 }
+ };
+
int option;
- while ((option = getopt(argc, argv.data(), "p:utv")) != -1) {
+ while ((option = getopt(argc, argv.data(), "hp:s:utv")) != -1) {
switch (option) {
+ case 'h': nmap_options.help = true; break;
case 'p':
nmap_options.hasPort = true;
nmap_options.ports = optarg ? optarg : "";
diff --git a/src/Services/NmapService.h b/src/Services/NmapService.h
index 7b7f66f8..1624ec96 100644
--- a/src/Services/NmapService.h
+++ b/src/Services/NmapService.h
@@ -11,6 +11,7 @@ struct NmapOptions {
bool hasPort = false; // Did user pass `-p` ?
std::string ports; // "80", "22,80-90"
bool hasTrash = false; // Did user pass non-option tokens?
+ bool help = false; // -h or --help
};
enum class Layer4Protocol {
@@ -32,6 +33,7 @@ public:
void setDefaultPorts(bool tcp);
void setArgTransformer(ArgTransformer& arg_transformer);
void setLayer4(bool layer4_protocol);
+ std::string getHelpText();
private:
// Nmap Task, cause overflow if it runs in the main loop, so it must run in a dedicated FreeRTOS task with a larger stack