From 9ebf4b931be87c7a85f138f8ef9e1a8b31a974fe Mon Sep 17 00:00:00 2001 From: Andrew Rioux Date: Sun, 30 Apr 2023 01:37:40 -0400 Subject: [PATCH] docs: adding preliminary documentation --- examples/README.org | 5 ++++- examples/reverse-shell/README.org | 13 +++++++++++++ nl-sys/README.org | 3 +++ pcap-sys/README.org | 3 +++ 4 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 examples/reverse-shell/README.org create mode 100644 nl-sys/README.org diff --git a/examples/README.org b/examples/README.org index 2ee9527..31ddaef 100644 --- a/examples/README.org +++ b/examples/README.org @@ -5,4 +5,7 @@ This directory is used to highlight proofs of concept and help ease the understa Each example/proof of concept listed is listed in the order it was added, and highlights the feature being developed that was supplemented by such a proof of concept * [[./bind-shell/README.org][bind-shell]] -This example was used to set up the dev containers workspace, to verify that the static linking against libpcap was actually possible and feasible, and to see how small binaries could get when statically linked \ No newline at end of file +This example was used to set up the dev containers workspace, to verify that the static linking against libpcap was actually possible and feasible, and to see how small binaries could get when statically linked + +* [[./reverse-shell/README.org][reverse-shell]] +Used to set up nl-sys to allow for better interfacing with the routing tables of the host operating system \ No newline at end of file diff --git a/examples/reverse-shell/README.org b/examples/reverse-shell/README.org new file mode 100644 index 0000000..09e49e4 --- /dev/null +++ b/examples/reverse-shell/README.org @@ -0,0 +1,13 @@ +#+TITLE: Example reverse shell proof of concept + +This bind shell works through local host firewalls on Linux systems using UDP to send and receive messages + +* Setup +** libpcap +Follow the directions in the main README in order to pull in the libpcap dependency + +** Build the code +Once the previous step is completed, run ~cargo build --release~ in a terminal. + +* Running the code +First, open two shells. In one, run ~docker-compose up examples_reverseshell_target~, and in the other run ~docker-compose run examples_reverseshell_server~. It will be possible to type in commands to examples_bindshell_server and run them in the target container \ No newline at end of file diff --git a/nl-sys/README.org b/nl-sys/README.org new file mode 100644 index 0000000..efb4469 --- /dev/null +++ b/nl-sys/README.org @@ -0,0 +1,3 @@ +#+TITLE: nl-sys + +This library provides Rust wrappers around the netlink socket protocol that the Linux kernel uses in order to provide access to routing tables and interface information \ No newline at end of file diff --git a/pcap-sys/README.org b/pcap-sys/README.org index e69de29..9eb32fe 100644 --- a/pcap-sys/README.org +++ b/pcap-sys/README.org @@ -0,0 +1,3 @@ +#+TITLE: pcap-sys + +This library provides wrappers around libpcap that when built in the dev container environment allow for full static linking against libpcap \ No newline at end of file