From 2709a479da23ffb3df86a58387eb3d4c7975c5c5 Mon Sep 17 00:00:00 2001
From: Marcello Lamonaca <marcello@lamonaca.eu>
Date: Mon, 18 Sep 2023 16:10:14 +0200
Subject: [PATCH] feat(ssh): add `ssh` notes

---
 docs/misc/ssh.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 mkdocs.yml       |  3 ++-
 2 files changed, 47 insertions(+), 1 deletion(-)
 create mode 100644 docs/misc/ssh.md

diff --git a/docs/misc/ssh.md b/docs/misc/ssh.md
new file mode 100644
index 0000000..f800750
--- /dev/null
+++ b/docs/misc/ssh.md
@@ -0,0 +1,45 @@
+# SSH
+
+`ssh` is a program for logging into a remote machine and for executing commands on a remote machine. It is intended to provide secure encrypted communications between two untrusted hosts over an insecure network.
+
+## Basics
+
+```sh
+ssh user@destination <command> # exec <command> in remote machine ($SHELL if omitted)
+ssh user@destination -i <path/to/private-key>  # use key for auth
+ssh user@destination -f  # exec ssh in the background
+ssh user@destination -N  # do not send commands to the server (do not start $SHELL)
+ssh user@destination -g  # allow remote hosts to connect to local forwarded ports
+ssh user@destination -t  # force pseudo-tty emulation
+```
+
+> **Note**: use `~` while connected to use the "ssh console".
+
+### Jump-Hosts
+
+Connect to the final destination jumping through the specifies other destinations.
+
+```sh
+ssh -J user_1@destination_1,user_2@destination_2 user@final_destination
+```
+
+## Port Forwarding
+
+![ssh-tunnels](https://iximiuz.com/ssh-tunnels/ssh-tunnels.png "SSH Tunnels Cheat Sheet By Ivan Velichko")
+
+### Local Port Forwarding
+
+Start listening on `local_address:local_port` and forward any traffic to `remote_address:remote_port`.
+
+```sh
+ssh -N -f -L local_address:local_port:remote_address:remote_port user@destination
+ssh -N -f -L local_port:remote_address:remote_port user@destination  # local_address defaults to localhost
+```
+
+### Remote Port Forwarding
+
+Start listening on `remote_address:remote_port` and forward any traffic to `local_address:local_port`.
+
+```sh
+ssh -N -f -R remote_address:remote_port:local_address:local_port user@destination
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 8d65e1c..0052ad5 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -182,4 +182,5 @@ nav:
   - Misc:
     - Git: misc/git.md
     - GraphQL: misc/graph-ql.md
-    - RegEx: misc/regular-expressions.md
\ No newline at end of file
+    - RegEx: misc/regular-expressions.md
+    - SSH: misc/ssh.md
\ No newline at end of file