docs: updated docs to work more with examples

Cargo.lock

@@ -25,19 +25,6 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
 
-[[package]]
-name = "bind-shell-backdoor"
-version = "0.1.0"
-dependencies = [
- "anyhow",
- "ed25519-dalek",
- "log",
- "pcap-sys",
- "simple_logger",
- "tokio",
- "tokio-stream",
-]
-
 [[package]]
 name = "block-buffer"
 version = "0.9.0"
@@ -71,14 +58,6 @@ version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
 
-[[package]]
-name = "client"
-version = "0.1.0"
-dependencies = [
- "anyhow",
- "ed25519-dalek",
-]
-
 [[package]]
 name = "cmake"
 version = "0.1.50"
@@ -174,6 +153,35 @@ dependencies = [
  "libc",
 ]
 
+[[package]]
+name = "ex-bind-shell-backdoor"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "ed25519-dalek",
+ "log",
+ "pcap-sys",
+ "simple_logger",
+ "tokio",
+ "tokio-stream",
+]
+
+[[package]]
+name = "ex-bind-shell-client"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "ed25519-dalek",
+]
+
+[[package]]
+name = "ex-bind-shell-key-generator"
+version = "0.1.0"
+dependencies = [
+ "ed25519-dalek",
+ "rand",
+]
+
 [[package]]
 name = "futures"
 version = "0.3.28"
@@ -308,14 +316,6 @@ version = "1.0.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "453ad9f582a441959e5f0d088b02ce04cfe8d51a8eaf077f12ac6d3e94164ca6"
 
-[[package]]
-name = "key-generator"
-version = "0.1.0"
-dependencies = [
- "ed25519-dalek",
- "rand",
-]
-
 [[package]]
 name = "lazy_static"
 version = "1.4.0"

README.org

@@ -8,4 +8,4 @@ Developed using libpcap to enable evading local firewalls and with an eye toward
 * Development
 To develop or compile this project, open it in GitHub Codespaces or using Visual Studio Code's Dev Container extension (requires Docker to be installed)
 
-* [[./examples/bind-shell/README.org][Example bind shell implementation]]
+* [[./examples/README.org][Check out the examples/proofs of concept used in development]]

docker-compose.yml

@@ -4,10 +4,10 @@ services:
     image: ubuntu:20.04
     volumes:
       - ./target:/backdoor
-    command: /backdoor/release/bind-shell-backdoor
+    command: /backdoor/release/ex-bind-shell-backdoor
     
   examples_bindshell_client:
     image: alpine
     volumes:
       - ./target:/backdoor
-    command: /backdoor/release/client examples_bindshell_target:54248
+    command: /backdoor/release/ex-bind-shell-client examples_bindshell_target:54248

examples/README.org

@@ -0,0 +1,8 @@
+#+TITLE: Examples and proofs of concept
+
+This directory is used to highlight proofs of concept and help ease the understanding and development of the sparse framework
+
+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

examples/bind-shell/backdoor/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "bind-shell-backdoor"
+name = "ex-bind-shell-backdoor"
 version = "0.1.0"
 edition = "2021"
 

examples/bind-shell/client/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "client"
+name = "ex-bind-shell-client"
 version = "0.1.0"
 edition = "2021"
 

examples/bind-shell/key-generator/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "key-generator"
+name = "ex-bind-shell-key-generator"
 version = "0.1.0"
 edition = "2021"