Merge pull request #2 from cytopia/release-0.3

Release 0.3
cytopia · Jan 14, 2020 · 56ed5bd · 56ed5bd
2 parents c7316ba + 5958eeb
commit 56ed5bd
Show file tree

Hide file tree

Showing 4 changed files with 92 additions and 25 deletions.
diff --git a/Makefile b/Makefile
@@ -5,7 +5,7 @@ endif
 # -------------------------------------------------------------------------------------------------
 # Default configuration
 # -------------------------------------------------------------------------------------------------
-.PHONY: help build clean
+.PHONY: help lint pycodestyle pydocstyle black dist sdist bdist build checkbuild deploy autoformat clean
 
 
 VERSION = 2.7
@@ -74,11 +74,6 @@ build:
 		python:$(VERSION)-alpine \
 		python setup.py build
 
-
-# -------------------------------------------------------------------------------------------------
-# Publish Targets
-# -------------------------------------------------------------------------------------------------
-
 checkbuild:
 	docker run \
 		--rm \
@@ -89,6 +84,11 @@ checkbuild:
 		sh -c "pip install twine \
 		&& twine check dist/*"
 
+
+# -------------------------------------------------------------------------------------------------
+# Publish Targets
+# -------------------------------------------------------------------------------------------------
+
 deploy:
 	docker run \
 		--rm \
@@ -104,6 +104,13 @@ deploy:
 # Misc Targets
 # -------------------------------------------------------------------------------------------------
 
+autoformat:
+	docker run \
+		--rm \
+		$$(tty -s && echo "-it" || echo) \
+		-v $(PWD):/data \
+		-w /data \
+		cytopia/black -l 100 badchars
 clean:
 	-rm -rf badchars.egg-info/
 	-rm -rf dist/

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 [![PyPI - Implementation](https://img.shields.io/pypi/implementation/badchars)](https://pypi.org/project/badchars/)
 [![PyPI - License](https://img.shields.io/pypi/l/badchars)](https://pypi.org/project/badchars/)
 
-Bad char generator to instruct encoders such as [shikata-ga-nai](https://github.com/rapid7/metasploit-framework/blob/master/modules/encoders/x86/shikata_ga_nai.rb)
+A hex bad char generator to instruct encoders such as [shikata-ga-nai](https://github.com/rapid7/metasploit-framework/blob/master/modules/encoders/x86/shikata_ga_nai.rb)
 to transform those to other chars.
 
 
@@ -29,7 +29,7 @@ optional arguments:
   -h, --help            show this help message and exit
   -v, --version         Show version information,
   -l int, --length int  Length of badchars to create. Default: 255
-  -f str, --format str  Format output: python, c, php, js
+  -f str, --format str  Format output: python, c, php, bash, js
 ```
 
 
@@ -43,12 +43,12 @@ $ badchars
 \x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f\x20\x21\x22\x23\x24\x25\x26\x27\x28\x29\x2a\x2b\x2c\x2d\x2e\x2f\x30\x31\x32\x33\x34\x35\x36\x37\x38\x39\x3a\x3b\x3c\x3d\x3e\x3f\x40\x41\x42\x43\x44\x45\x46\x47\x48\x49\x4a\x4b\x4c\x4d\x4e\x4f\x50\x51\x52\x53\x54\x55\x56\x57\x58\x59\x5a\x5b\x5c\x5d\x5e\x5f\x60\x61\x62\x63\x64\x65\x66\x67\x68\x69\x6a\x6b\x6c\x6d\x6e\x6f\x70\x71\x72\x73\x74\x75\x76\x77\x78\x79\x7a\x7b\x7c\x7d\x7e\x7f\x80\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f\x90\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f\xa0\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf\xb0\xb1\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf\xc0\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff
 ```
 
-#### C code
+#### Python
 ```bash
-$ badchars -f c
+$ badchars -f python
 ```
-```cpp
-char badchars[] =
+```python
+badchars = (
   "\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10"
   "\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f\x20"
   "\x21\x22\x23\x24\x25\x26\x27\x28\x29\x2a\x2b\x2c\x2d\x2e\x2f\x30"
@@ -64,15 +64,16 @@ char badchars[] =
   "\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0"
   "\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0"
   "\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0"
-  "\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff";
+  "\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff"
+)
 ```
 
-#### Python
+#### C code
 ```bash
-$ badchars -f python
+$ badchars -f c
 ```
-```python
-badchars = (
+```cpp
+char badchars[] =
   "\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10"
   "\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f\x20"
   "\x21\x22\x23\x24\x25\x26\x27\x28\x29\x2a\x2b\x2c\x2d\x2e\x2f\x30"
@@ -88,10 +89,58 @@ badchars = (
   "\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0"
   "\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0"
   "\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0"
-  "\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff"
+  "\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff";
+```
+
+#### Bash
+```bash
+$ badchars -f bash
+```
+```bash
+badchars=(
+  \\x01 \\x02 \\x03 \\x04 \\x05 \\x06 \\x07 \\x08 \\x09 \\x0a \\x0b \\x0c \\x0d \\x0e \\x0f \\x10
+  \\x11 \\x12 \\x13 \\x14 \\x15 \\x16 \\x17 \\x18 \\x19 \\x1a \\x1b \\x1c \\x1d \\x1e \\x1f \\x20
+  \\x21 \\x22 \\x23 \\x24 \\x25 \\x26 \\x27 \\x28 \\x29 \\x2a \\x2b \\x2c \\x2d \\x2e \\x2f \\x30
+  \\x31 \\x32 \\x33 \\x34 \\x35 \\x36 \\x37 \\x38 \\x39 \\x3a \\x3b \\x3c \\x3d \\x3e \\x3f \\x40
+  \\x41 \\x42 \\x43 \\x44 \\x45 \\x46 \\x47 \\x48 \\x49 \\x4a \\x4b \\x4c \\x4d \\x4e \\x4f \\x50
+  \\x51 \\x52 \\x53 \\x54 \\x55 \\x56 \\x57 \\x58 \\x59 \\x5a \\x5b \\x5c \\x5d \\x5e \\x5f \\x60
+  \\x61 \\x62 \\x63 \\x64 \\x65 \\x66 \\x67 \\x68 \\x69 \\x6a \\x6b \\x6c \\x6d \\x6e \\x6f \\x70
+  \\x71 \\x72 \\x73 \\x74 \\x75 \\x76 \\x77 \\x78 \\x79 \\x7a \\x7b \\x7c \\x7d \\x7e \\x7f \\x80
+  \\x81 \\x82 \\x83 \\x84 \\x85 \\x86 \\x87 \\x88 \\x89 \\x8a \\x8b \\x8c \\x8d \\x8e \\x8f \\x90
+  \\x91 \\x92 \\x93 \\x94 \\x95 \\x96 \\x97 \\x98 \\x99 \\x9a \\x9b \\x9c \\x9d \\x9e \\x9f \\xa0
+  \\xa1 \\xa2 \\xa3 \\xa4 \\xa5 \\xa6 \\xa7 \\xa8 \\xa9 \\xaa \\xab \\xac \\xad \\xae \\xaf \\xb0
+  \\xb1 \\xb2 \\xb3 \\xb4 \\xb5 \\xb6 \\xb7 \\xb8 \\xb9 \\xba \\xbb \\xbc \\xbd \\xbe \\xbf \\xc0
+  \\xc1 \\xc2 \\xc3 \\xc4 \\xc5 \\xc6 \\xc7 \\xc8 \\xc9 \\xca \\xcb \\xcc \\xcd \\xce \\xcf \\xd0
+  \\xd1 \\xd2 \\xd3 \\xd4 \\xd5 \\xd6 \\xd7 \\xd8 \\xd9 \\xda \\xdb \\xdc \\xdd \\xde \\xdf \\xe0
+  \\xe1 \\xe2 \\xe3 \\xe4 \\xe5 \\xe6 \\xe7 \\xe8 \\xe9 \\xea \\xeb \\xec \\xed \\xee \\xef \\xf0
+  \\xf1 \\xf2 \\xf3 \\xf4 \\xf5 \\xf6 \\xf7 \\xf8 \\xf9 \\xfa \\xfb \\xfc \\xfd \\xfe \\xff
 )
 ```
 
+#### PHP
+```bash
+$ badchars -f php
+```
+```php
+$badchars =
+  "\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f\x10" +
+  "\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f\x20" +
+  "\x21\x22\x23\x24\x25\x26\x27\x28\x29\x2a\x2b\x2c\x2d\x2e\x2f\x30" +
+  "\x31\x32\x33\x34\x35\x36\x37\x38\x39\x3a\x3b\x3c\x3d\x3e\x3f\x40" +
+  "\x41\x42\x43\x44\x45\x46\x47\x48\x49\x4a\x4b\x4c\x4d\x4e\x4f\x50" +
+  "\x51\x52\x53\x54\x55\x56\x57\x58\x59\x5a\x5b\x5c\x5d\x5e\x5f\x60" +
+  "\x61\x62\x63\x64\x65\x66\x67\x68\x69\x6a\x6b\x6c\x6d\x6e\x6f\x70" +
+  "\x71\x72\x73\x74\x75\x76\x77\x78\x79\x7a\x7b\x7c\x7d\x7e\x7f\x80" +
+  "\x81\x82\x83\x84\x85\x86\x87\x88\x89\x8a\x8b\x8c\x8d\x8e\x8f\x90" +
+  "\x91\x92\x93\x94\x95\x96\x97\x98\x99\x9a\x9b\x9c\x9d\x9e\x9f\xa0" +
+  "\xa1\xa2\xa3\xa4\xa5\xa6\xa7\xa8\xa9\xaa\xab\xac\xad\xae\xaf\xb0" +
+  "\xb1\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xbb\xbc\xbd\xbe\xbf\xc0" +
+  "\xc1\xc2\xc3\xc4\xc5\xc6\xc7\xc8\xc9\xca\xcb\xcc\xcd\xce\xcf\xd0" +
+  "\xd1\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xdb\xdc\xdd\xde\xdf\xe0" +
+  "\xe1\xe2\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xeb\xec\xed\xee\xef\xf0" +
+  "\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9\xfa\xfb\xfc\xfd\xfe\xff";
+```
+
 
 ## License
 

diff --git a/badchars b/badchars
@@ -12,20 +12,29 @@ import math
 DEFAULT_LENGTH = 255
 FORMATS = {
     "c": {
-        "block": {"pre": "char badchars[] = \n", "post": '";'},
+        "block": {"pre": "char badchars[] =\n", "post": '";'},
         "line": {"pre": '  "', "post": '"'},
+        "char": {"esc": "\\", "delim": ""},
     },
     "js": {
-        "block": {"pre": "var badchars = \n", "post": '";'},
+        "block": {"pre": "var badchars =\n", "post": '";'},
         "line": {"pre": '  "', "post": '" +'},
+        "char": {"esc": "\\", "delim": ""},
     },
     "php": {
-        "block": {"pre": "$badchars = \n", "post": '";'},
+        "block": {"pre": "$badchars =\n", "post": '";'},
         "line": {"pre": '  "', "post": '" +'},
+        "char": {"esc": "\\", "delim": ""},
+    },
+    "bash": {
+        "block": {"pre": "badchars=(\n", "post": "\n)"},
+        "line": {"pre": "  ", "post": ""},
+        "char": {"esc": "\\\\", "delim": " "},
     },
     "python": {
         "block": {"pre": "badchars = (\n", "post": '"\n)'},
         "line": {"pre": '  "', "post": '"'},
+        "char": {"esc": "\\", "delim": ""},
     },
 }
 
@@ -65,7 +74,9 @@ def print_badchars(length, format=None):
                 if count == length:
                     break
                 count += 1
-                sys.stdout.write("\\x" + "{:02x}".format(count))
+                sys.stdout.write(FORMATS[format]["char"]["esc"] + "x" + "{:02x}".format(count))
+                if count % linebreak and count != length:
+                    sys.stdout.write(FORMATS[format]["char"]["delim"])
             if count == length:
                 break
             sys.stdout.write(FORMATS[format]["line"]["post"])
@@ -102,7 +113,7 @@ def main():
         "-v",
         "--version",
         action="version",
-        version="%(prog)s 0.2 by cytopia",
+        version="%(prog)s 0.3 by cytopia",
         help="Show version information,",
     )
     parser.add_argument(

diff --git a/setup.py b/setup.py
@@ -5,8 +5,8 @@
 
 setup(
     name="badchars",
-    version="0.2",
-    description="A badchar generator for different formats.",
+    version="0.3",
+    description="A hex badchar generator for different programming languages.",
     license="MIT",
     long_description=long_description,
     long_description_content_type="text/markdown",