From 2d24e2dff797879115b757c1564888bda17810d5 Mon Sep 17 00:00:00 2001 From: MrMcX Date: Mon, 27 Dec 2021 14:52:16 +0100 Subject: [PATCH] =?UTF-8?q?=E2=80=9EREADME.md=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 132 +++++++++++++++++++++++++++--------------------------- 1 file changed, 66 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index e327ddb..5c546d3 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,66 @@ -# eaas-vde-proxy - -## Overview - -![overview](README.assets/overview.png) - -## Documentation -See [[Wiki|Home]] - -## Problematic protocols - -Important and implemented: - -* DHCP -* ARP -* NBNS/NBDS (by filtering binary payload) - -Not supported: - -* IPv6 (NDP, Interface Identifier, ...) -* IPSec -* 802.1X -* IPX/LLC - -## Third party libraries - -* [gopacket](https://github.com/google/gopacket): similar to libpcap, for parsing and serializing packets *(BSD 3-clause license, authors: Andreas Krennmair & Google)* -* [dhcp4](https://github.com/krolaw/dhcp4): for handling and sending DHCP requests/responses *(BSD 3-clause license, author: Richard Warburton/krolaw)* -* [logrus](https://github.com/sirupsen/logrus): improved logging *(MIT license, author: Simon Eskildsen/sirupsen)* - -## Binaries -### proxy - main binary -``` -$ ./proxy -help -Usage of ./proxy: - -hostname string - Set a windows hostname to filter for in binary payloads - -log int - allowed: 5 (debug), 4 (info), 3 (warning), 2 (error), 1 (fatal) (default 4) - -logfile string - Location to write output to - -newip string - IP after change - -newmac string - MAC after change - -oldip string - IP before change - -oldmac string - MAC before change - -passthrough - Whether to pass every traffic through - -pidfile string - Location to write the pid to - -smain string - Main switch sock path, - for stdin/out (default "/run/vde/sw_main.sock") - -sproxy string - Proxy switch sock path (default "/run/vde/sw_proxy1.sock") - -wireshark - Whether to write all traffic to /tmp -``` - -### envctl - control VMs, network etc -``` -$ ./envctl -Usage: envctl {start|stop|restart|status} {all|network|vms|alpine|alpine1|alpine2|win1|win2|kali|proxy2|proxy3|proxies} -``` +# eaas-vde-proxy + +## Overview + +![overview](README.assets/overview.png) + +## Documentation +See [Wiki](wiki/Home) + +## Problematic protocols + +Important and implemented: + +* DHCP +* ARP +* NBNS/NBDS (by filtering binary payload) + +Not supported: + +* IPv6 (NDP, Interface Identifier, ...) +* IPSec +* 802.1X +* IPX/LLC + +## Third party libraries + +* [gopacket](https://github.com/google/gopacket): similar to libpcap, for parsing and serializing packets *(BSD 3-clause license, authors: Andreas Krennmair & Google)* +* [dhcp4](https://github.com/krolaw/dhcp4): for handling and sending DHCP requests/responses *(BSD 3-clause license, author: Richard Warburton/krolaw)* +* [logrus](https://github.com/sirupsen/logrus): improved logging *(MIT license, author: Simon Eskildsen/sirupsen)* + +## Binaries +### proxy - main binary +``` +$ ./proxy -help +Usage of ./proxy: + -hostname string + Set a windows hostname to filter for in binary payloads + -log int + allowed: 5 (debug), 4 (info), 3 (warning), 2 (error), 1 (fatal) (default 4) + -logfile string + Location to write output to + -newip string + IP after change + -newmac string + MAC after change + -oldip string + IP before change + -oldmac string + MAC before change + -passthrough + Whether to pass every traffic through + -pidfile string + Location to write the pid to + -smain string + Main switch sock path, - for stdin/out (default "/run/vde/sw_main.sock") + -sproxy string + Proxy switch sock path (default "/run/vde/sw_proxy1.sock") + -wireshark + Whether to write all traffic to /tmp +``` + +### envctl - control VMs, network etc +``` +$ ./envctl +Usage: envctl {start|stop|restart|status} {all|network|vms|alpine|alpine1|alpine2|win1|win2|kali|proxy2|proxy3|proxies} +```