docs: adding preliminary documentation

This commit is contained in:
Andrew Rioux 2023-04-30 01:37:40 -04:00
parent de2c2cc862
commit 9ebf4b931b
4 changed files with 23 additions and 1 deletions

View File

@ -6,3 +6,6 @@ Each example/proof of concept listed is listed in the order it was added, and hi
* [[./bind-shell/README.org][bind-shell]] * [[./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 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

View File

@ -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

3
nl-sys/README.org Normal file
View File

@ -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

View File

@ -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