aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Touhey <thomas@touhey.fr>2021-06-08 09:27:43 +0200
committerThomas Touhey <thomas@touhey.fr>2021-06-08 09:27:43 +0200
commit17d5705030f91e03c94525e055b4cde183fc33b1 (patch)
tree6ca6c4797b9ea0cfa1b6dd09aef42f1352c3f212
parentb38619c041a53471a2256adaade863286861916c (diff)
added rawshell description
-rw-r--r--docs/explain/modem-protocols.rst4
-rw-r--r--docs/explain/modem/jackmac.rst39
2 files changed, 43 insertions, 0 deletions
diff --git a/docs/explain/modem-protocols.rst b/docs/explain/modem-protocols.rst
index acc4fe0..31c1e04 100644
--- a/docs/explain/modem-protocols.rst
+++ b/docs/explain/modem-protocols.rst
@@ -303,6 +303,9 @@ Some known port protocols are the following:
* - 5222
- ``opus-pickup-remote``
-
+ * - 5731
+ - ``jackmac-rawshell-control``
+ - :ref:`modem-jackmac-rawshell`
* - 5900
- ``opus-vnc``
- :ref:`modem-opus-vnc`
@@ -358,6 +361,7 @@ In the following chapters, we'll go more in depth on port protocols.
modem/oneos
modem/opus
modem/ldd
+ modem/jackmac
.. _repeat command: https://github.com/SquidDev-CC/CC-Tweaked/blob/4be0b15afa9d81baf7859cf6c04c048896d7ccdf/src/main/resources/data/computercraft/lua/rom/programs/rednet/repeat.lua
.. _EtherTypes: https://fr.wikipedia.org/wiki/EtherType
diff --git a/docs/explain/modem/jackmac.rst b/docs/explain/modem/jackmac.rst
new file mode 100644
index 0000000..4bee1d2
--- /dev/null
+++ b/docs/explain/modem/jackmac.rst
@@ -0,0 +1,39 @@
+JackMac's protocols
+=====================
+
+JackMacWindows_ is the author of the `CraftOS-PC`_ emulator, and a number of
+snippets and programs as proof of concepts which he publishes as gists_.
+
+In this document, we'll describe protocols of some of their software.
+
+.. _modem-jackmac-rawshell:
+
+rawshell protocols
+------------------
+
+rawshell_ is an encrypted KVM protocol, announced as follows by its creator:
+
+ I've made a new remote shell program for ComputerCraft. Currently called
+ "rawshell" (name WIP), it allows you to host a shell server on a computer
+ that other computers can connect to over a modem, allowing those computers
+ to run programs on the server and see the output.
+
+ Unlike the aging nsh program it replaces, rawshell features end-to-end
+ encryption, backgrounding support, built-in password authentication, and
+ custom launch programs/shells.
+
+ Support for file transfer is in progress as well.
+
+ -- JackMacWindows on the Computer Mods Discord Server, June 6th, 2021
+
+It uses a port protocol on port 5731 to setup a connection, then redirects
+connections on any port provided to the server through the command-line.
+
+.. todo::
+
+ Describe the protocol.
+
+.. _JackMacWindows: https://forums.computercraft.cc/index.php?action=profile;u=210
+.. _CraftOS-PC: https://www.craftos-pc.cc/
+.. _gists: https://gist.github.com/MCJack123
+.. _rawshell: https://gist.github.com/MCJack123/8c8861e5e3082d2bed18d07641b5b2cc