Metadata-Version: 2.1
Name: r0c
Version: 1.3.0
Summary: retr0chat telnet/vt100 chat server
Home-page: https://github.com/9001/r0c
Author: ed
Author-email: r0c@ocv.me
License: MIT
Description: # `r0c` telnet server
        
        * retr0chat, irc-like chat service for superthin clients [(on PyPI)](https://pypi.org/project/r0c/)
        * MIT-Licensed, 2018-01-07, ed @ irc.rizon.net
        * **[windows telnet 360 noscope](https://ocv.me/r0c.webm)** <- good video
        
        ![screenshot of telnet connected to a r0c server](https://raw.githubusercontent.com/9001/r0c/master/docs/r0c.png)
        
        * download the latest release (standalone): **[r0c.py](https://github.com/9001/r0c/releases/latest/download/r0c.py)**
        
        ## summary
        
        imagine being stuck on ancient gear, in the middle of nowhere, on a slow connection between machines that are even more archaic than the toaster you're trying to keep from falling apart
        
        retr0chat is the lightweight, no-dependencies, runs-anywhere solution for when life gives you lemons
        
        * tries to be irssi
        * zero dependencies on python 2.6, 2.7, 3.x
        * supports telnet, netcat, /dev/tcp, TLS clients
        * fallbacks for inhumane conditions
          * linemode
          * no vt100 / ansi escape codes
        
        ## endorsements
        
        * the german federal office for information security [does not approve](https://ocv.me/stuff/r0c-bsi.png)
        
        ## features
        
        irc-like:
        * public channels with persistent history (pgup/pgdn)
        * private messages (`/msg acidburn hey`)
        * nick completion with `Tab ↹`
        * notifications (bell/visual) on hilights and PMs
        * command subset (`/nick`, `/join`, `/part`, `/names`, `/topic`, `/me`)
        * inline message coloring, see `/help`
        
        technical:
        * client behavior detection (echo, colors, charset, newline)
        * message input with readline-like editing (arrow-left/right, home/end, backspace)
          * history of sent messages (arrow-up/down)
        * bandwidth-conservative (push/pop lines instead of full redraws; scroll-regions)
        
        ## windows clients
        
        * use [putty](https://the.earth.li/~sgtatham/putty/latest/w32/putty.exe) in telnet mode
        * or [the powershell client](https://github.com/9001/r0c/blob/master/clients/powershell.ps1)
        * or enable `Telnet Client` in control panel `->` programs `->` programs and features `->` turn windows features on or off, then press WIN+R and run `telnet r0c.int`
        
        putty is the best option;
        * the powershell client is OK and no longer spammy as of windows 10.0.15063 (win10 1703 / LTSC)
        * windows-telnet has a bug (since win7) where [non-ascii letters occasionally render but usually dont](https://ocv.me/stuff/win10-telnet.webm)
          * this is due to a buffer overflow in `telnet.exe`, so r0c will apply a rate-limit to avoid it
          * looks like messages larger than 512 bytes end up messing with the unicode glyphs area? or something
        
        ## linux clients
        
        most to least recommended
        
        | client | example |
        | :---   | :---    |
        | telnet | `telnet r0c.int` |
        | socat  | `socat -,raw,echo=0 tcp:r0c.int:531` |
        | bash   | [mostly internals](https://github.com/9001/r0c/blob/master/clients/bash.sh) |
        | netcat | `nc r0c.int 531` |
        
        you can even `exec 147<>/dev/tcp/r0c.int/531;cat<&147&while IFS= read -rn1 x;do [ -z "$x" ]&&x=$'\n';printf %s "$x">&147;done` (disconnect using `exec 147<&-; killall cat #sorry`)
        
        ## tls clients
        
        if you enable TLS with `-tpt 2424` (telnet) and/or `-tpn 1515` (netcat) you can connect to r0c with TLS encryption using any of the following:
        
        * `telnet-ssl -zssl -zsecure -zcacert=r0c.crt r0c.int 2424`
        * `socat -,raw,echo=0 openssl:r0c.int:1515,cafile=cert.crt`
        * `stty -icanon; ncat --ssl --ssl-trustfile r0c.crt -v r0c.int 1515`
        * `stty -icanon; openssl s_client -CAfile ~/.r0c/cert.crt -connect r0c.int:1515`
        
        ## firewall rules
        
        telnet uses port 23 by default, so on the server you'll want to port-forward `23` to `2323` (and `531` to `1531` for plaintext):
        
        ```bash
        iptables -A INPUT -p tcp --dport 23 -m state --state NEW -j ACCEPT
        iptables -A INPUT -p tcp --dport 531 -m state --state NEW -j ACCEPT
        iptables -A INPUT -p tcp --dport 2323 -m state --state NEW -j ACCEPT
        iptables -A INPUT -p tcp --dport 1531 -m state --state NEW -j ACCEPT
        iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 23 -j REDIRECT --to-port 2323
        iptables -t nat -A PREROUTING -i eth0 -p tcp --dport 531 -j REDIRECT --to-port 1531
        ```
        
        ## documentation
        
        not really but there is a [list of commands](https://github.com/9001/r0c/blob/master/docs/help-commands.md) and a [list of hotkeys](https://github.com/9001/r0c/blob/master/docs/help-hotkeys.md)
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: IronPython
Classifier: Programming Language :: Python :: Implementation :: Jython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Environment :: Console
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Topic :: Communications :: Chat
Description-Content-Type: text/markdown
