Cleanup

Author: brandonasuncion

README.md

@@ -1,13 +1,25 @@
 # Python Code Obfuscator
-I was browsing /r/dailyprogrammer on Reddit one day, and attempted one of the [daily challenges](https://www.reddit.com/r/dailyprogrammer/comments/2ao99p/7142014_challenge_171_easy_hex_to_8x8_bitmap/). After doing the challenge, I read through the comments and found a [ very interesting submission](https://www.reddit.com/r/dailyprogrammer/comments/2ao99p/7142014_challenge_171_easy_hex_to_8x8_bitmap/cixkjuu/).
+I was browsing /r/dailyprogrammer on Reddit one day, and attempted one of the daily challenges. After doing the challenge, I read through the comments and found a [very interesting submission](https://www.reddit.com/r/dailyprogrammer/comments/2ao99p/7142014_challenge_171_easy_hex_to_8x8_bitmap/cixkjuu/).
 
 Seeing that baffled me at first sight, but after reading [/u/ntxhhf's breakdown](https://www.reddit.com/r/dailyprogrammer/comments/2ao99p/7142014_challenge_171_easy_hex_to_8x8_bitmap/ciza4c9/) of his code, I was inspired to make my own code obfuscator for Python using the ideas in his post.
 
-*So what exactly does this script do?*
-It takes your regular-looking Python code, and makes it unreadable!
+*What exactly does this script do?*  
+It takes your regular-looking Python code, and obfuscates it! It takes any specified Python script, and will attempt to create an equivalent script that has the *same exact* functionality as the original, but is incredibly difficult for humans to read regularly.
+
+*"So... how is this useful?"*  
+According to [Wikipedia](https://en.wikipedia.org/wiki/Obfuscation_(software))...
+> Programmers may deliberately obfuscate code to conceal its purpose (security through obscurity) or its logic or implicit values embedded in it, primarily, in order to prevent tampering, deter reverse engineering, or even as a puzzle or recreational challenge for someone reading the source code.
 
 ## Usage
-`$ python obfuscator.py inputfile outputfile`
+> usage: obfuscator.py [-h] [--debug] inputfile outputfile
+>
+> positional arguments:
+>   inputfile   Name of the input file
+>   outputfile  Name of the output file
+>
+> optional arguments:
+>   -h, --help  show this help message and exit
+>   --debug     Show debug info
 
 ## Examples
 
@@ -61,6 +73,22 @@ _=str(''.join(chr(__RSV) for __RSV in [0x62,0x75,0x69,0x6c,0x74,0x69,0x6e,0x73])
 getattr(__import__(_), __)(getattr(__import__(_), ___)(((____**____)+(__________<<(____**____)))))
 ```
 
+## Mini-FAQ
+* **Should I use this for distributing my source code?**  
+As of the time I'm writing this, I highly recommend against that idea. There are some instances of code in that the parser cannot handle (multi-line strings, for instance). Also, the output really won't do much to prevent reverse-engineering.
+* **The output is too big! How do I reduce the output size?**
+As of right now, the biggest impact is the inefficiency of encoding strings. For the smallest output, make sure to set the following constants in the script:
+   ```
+   USE_HEXSTRINGS = True
+   OBFUSCATE_BUILTINS = False
+   REMOVE_COMMENTS = True
+   ```
+* **It's still too big!**
+That wasn't a question. But yes, I will be doing periodic optimizations to this project when I have time. After all, it is just a side-project for me! :)
+* **Is there a license?**
+Yes, it is currently distributed under the [Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/).
+
 ## Credits
-* Brandon Asuncion (me@brandonasuncion.tech) - Code
+* Brandon Asuncion - Code  
+    Questions/Comments? Feel free to contact me at: **me@brandonasuncion.tech**
 * [/u/ntxhhf](https://www.reddit.com/r/dailyprogrammer/comments/2ao99p/7142014_challenge_171_easy_hex_to_8x8_bitmap/ciza4c9/) - For the idea, and his breakdown of using lists/sets to create boolean values and integers

obfuscator.py

@@ -1,35 +1,36 @@
-#!/usr/bin/python
-'''
-Python Code Obfuscator
-by Brandon Asuncion
-	me@brandonasuncion.tech
-'''
+#!/usr/bin/env python3
+
+
+#	Python Code Obfuscator
+#	by Brandon Asuncion
+#	
+#	Questions/Comments?	me@brandonasuncion.tech
+
 
 import string
 import sys
+import argparse
 
 # How strings are encoded
 #	Turning off will remove all numbers in the code,
 #	but will increase output size by a lot!
 USE_HEXSTRINGS = True
 
-# Remove comments from code
-REMOVE_COMMENTS = True
-
 # Obfuscate Python's built-in function calls
-# 	Note: Code output will be large!
 OBFUSCATE_BUILTINS = False
 
+# Remove comments from code
+REMOVE_COMMENTS = True
+
 # Special code replacements
 REPLACEMENTS = {
 	'True': '(()==())',
 	'False': '(()==[])',
 }
 
-# Name of variable for internal actions (such as string decryption)
-RESERVED_VAR = "__RSV"
-
-BUILTINS_CONST = "__B"
+# Ignore the following two constants if you don't know what they mean
+RESERVED_VAR = "__RSV"		# Name of variable for internal actions (such as string decryption)
+BUILTINS_CONST = "__B"		# name used in the header for storing the "builtins" string
 
 _RESERVED = [
 	# Python reserved keywords
@@ -59,7 +60,7 @@
 ]
 
 # Might not be a complete list...
-PREPAD = [';', ':', '=', '+', '-', '*', '%', '^', '<<', '>>', '|', '^', '/', ',', '{', '}', '[', ']']
+_PREPAD = [';', ':', '=', '+', '-', '*', '%', '^', '<<', '>>', '|', '^', '/', ',', '{', '}', '[', ']']
 
 class Obfuscator(object):
 
@@ -174,7 +175,7 @@ def obfuscate(self, code, append_header = True):
 
 		# Pad certain characters so they can be parsed properly
 		prepadded = code
-		for p in PREPAD:
+		for p in _PREPAD:
 			prepadded = prepadded.replace(p, " {} ".format(p))
 		prepadded = prepadded.replace('(', "( ").replace(')', ' )')
 
@@ -217,7 +218,7 @@ def obfuscate(self, code, append_header = True):
 
 
 			# arithmetic and similar symbols are passed along as well
-			if symbol in PREPAD:
+			if symbol in _PREPAD:
 				result += symbol
 				continue
 
@@ -310,33 +311,40 @@ def obfuscate_lines(self, code):
 
 			result += self.obfuscate(line, False) + "\n"
 		return self.getHeader() + result
+		
+class MyArgParser(argparse.ArgumentParser):
+	def error(self, message):
+		sys.stderr.write('Error: {}\n'.format(message))
+		self.print_help()
+		sys.exit(2)
 
 def main():
-	if len(sys.argv) < 3:
-		print('Usage: obfuscator.py inputfile outputfile')
-	else:
-		with open(sys.argv[1], 'r') as fh:
-			lines = fh.read()
-			
-		obf = Obfuscator()
-		output = obf.obfuscate_lines(lines)
-		print(output)
-			
-		with open(sys.argv[2], 'w') as fh:
-			fh.write(output)
+	parser = MyArgParser(description='Python Code Obfuscator by Brandon Asuncion (me@brandonasuncion.tech)')
+	parser.add_argument('inputfile', help="Name of the input file")
+	parser.add_argument('outputfile', help="Name of the output file")
+	parser.add_argument('--debug', help="Show debug info", action="store_true")
+	args = vars(parser.parse_args())
+		
+	print('Opening {} for obfuscation'.format(args['inputfile']))
+	with open(args['inputfile'], 'r') as fh:
+		lines = fh.read()
+		
+	obf = Obfuscator()
+	output = obf.obfuscate_lines(lines)
+		
+	with open(args['outputfile'], 'w') as fh:
+		fh.write(output)
+		print('Written to {}\n'.format(args['outputfile']))
 
-		'''
-		print('VARIABLES')
+	if args['debug']:
+		print('CONVERTED VARIABLES')
 		for v in obf.variables:
 			print("{}\t=> {}".format(v, obf.variables[v]))
-	
+
 		print('\nVARIABLES IN HEADER')
-		for n in sorted(obf.header_variables, key = lambda x: int(x)):
+		for n in sorted(obf.header_variables, key=len):
 			print("{}\t=> {}".format(n, obf.header_variables[n]))
-		print()
-		'''
-		print('Written to {}'.format(sys.argv[2]))
-		
+		print()		
 
 if __name__ == "__main__":
 	main()