„README.md“ ändern

README.md

@@ -1,66 +1,66 @@
-# eaas-vde-proxy
+# eaas-vde-proxy
-
+
-## Overview
+## Overview
-
+
-![overview](README.assets/overview.png)
+![overview](README.assets/overview.png)
-
+
-## Documentation
+## Documentation
-See [[Wiki|Home]]
+See [Wiki](wiki/Home)
-
+
-## Problematic protocols
+## Problematic protocols
-
+
-Important and implemented:
+Important and implemented:
-
+
-* DHCP
+* DHCP
-* ARP
+* ARP
-* NBNS/NBDS (by filtering binary payload)
+* NBNS/NBDS (by filtering binary payload)
-
+
-Not supported:
+Not supported:
-
+
-* IPv6 (NDP, Interface Identifier, ...)
+* IPv6 (NDP, Interface Identifier, ...)
-* IPSec
+* IPSec
-* 802.1X
+* 802.1X
-* IPX/LLC
+* IPX/LLC
-
+
-## Third party libraries
+## 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)*
+* [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)*
+* [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)*
+* [logrus](https://github.com/sirupsen/logrus): improved logging *(MIT license, author: Simon Eskildsen/sirupsen)*
-
+
-## Binaries
+## Binaries
-### proxy - main binary
+### proxy - main binary
-```
+```
-$ ./proxy -help
+$ ./proxy -help
-Usage of ./proxy:
+Usage of ./proxy:
-  -hostname string
+  -hostname string
-        Set a windows hostname to filter for in binary payloads
+        Set a windows hostname to filter for in binary payloads
-  -log int
+  -log int
-        allowed: 5 (debug), 4 (info), 3 (warning), 2 (error), 1 (fatal) (default 4)
+        allowed: 5 (debug), 4 (info), 3 (warning), 2 (error), 1 (fatal) (default 4)
-  -logfile string
+  -logfile string
-        Location to write output to
+        Location to write output to
-  -newip string
+  -newip string
-        IP after change
+        IP after change
-  -newmac string
+  -newmac string
-        MAC after change
+        MAC after change
-  -oldip string
+  -oldip string
-        IP before change
+        IP before change
-  -oldmac string
+  -oldmac string
-        MAC before change
+        MAC before change
-  -passthrough
+  -passthrough
-        Whether to pass every traffic through
+        Whether to pass every traffic through
-  -pidfile string
+  -pidfile string
-        Location to write the pid to
+        Location to write the pid to
-  -smain string
+  -smain string
-        Main switch sock path, - for stdin/out (default "/run/vde/sw_main.sock")
+        Main switch sock path, - for stdin/out (default "/run/vde/sw_main.sock")
-  -sproxy string
+  -sproxy string
-        Proxy switch sock path (default "/run/vde/sw_proxy1.sock")
+        Proxy switch sock path (default "/run/vde/sw_proxy1.sock")
-  -wireshark
+  -wireshark
-        Whether to write all traffic to /tmp
+        Whether to write all traffic to /tmp
-```
+```
-
+
-### envctl - control VMs, network etc
+### envctl - control VMs, network etc
-```
+```
-$ ./envctl
+$ ./envctl
-Usage: envctl {start|stop|restart|status} {all|network|vms|alpine|alpine1|alpine2|win1|win2|kali|proxy2|proxy3|proxies}
+Usage: envctl {start|stop|restart|status} {all|network|vms|alpine|alpine1|alpine2|win1|win2|kali|proxy2|proxy3|proxies}
-```
+```