More flexible configuration and small bonuses

MANIFEST.in

@@ -1,7 +1,7 @@
 include LICENSE README.adoc TODO.adoc
 
 # Include the data files
-include config-example.json
+include config-example.js
 graft docs
 prune docs/presentation/
 graft malboxes

Makefile

@@ -1,5 +1,7 @@
 test:
 	pylint malboxes
+	./tests/config_example_valid.sh
+	python -m unittest discover
 
 pkg_clean:
 	rm -r build/ dist/ malboxes.egg-info/

README.adoc

@@ -24,6 +24,7 @@ https://github.com/gosecure/malboxes
 * Python 3.3+
 * appdirs
 * jinja2
+* jsmin
 * packer: https://www.packer.io/intro/getting-started/setup.html
 * vagrant: https://www.vagrantup.com/downloads.html
 
@@ -101,7 +102,7 @@ For example:
     malboxes build win10_64_analyst
 
 If you want to customize your configuration, look at the following location
-for a `config.json` file:
+for a `config.js` file:
 
 * Linux/Unix: `~/.config/malboxes/`
 * Mac OS X: `~/Library/Application Support/malboxes/`

TODO.adoc

@@ -1,20 +1,13 @@
 = TODO
 
-== pip packaging
-
-* where should the built boxes go?
-
-== Misc
-
-* Make work with trial ISOs
-
 == Minimal malware analyst use case
 
-* push sample w/ IDA debugger
-* open ports for remote IDA debugging
+* user/pass from config.js
+* vagrant: punch hole through NAT for IDA in firewall
+* disable Windows Defender
 * vagrant no net, NAT
-* vagrant update box + send on network (archiving)
-* vagrant team workflow
+* doc: vagrant update box + send on network (archiving)
+* doc: vagrant team workflow
 ** vagrant box repackaging covered here: http://huestones.co.uk/node/305
 * git malware analysis template integrated with malboxes
 * Integrate virtualbox and wireshark tips: https://www.virtualbox.org/wiki/Network_tips
@@ -106,3 +99,9 @@ To do malware analysis on embedded systems.
 == Support WinXP
 
 Talk to sholmes, he did it.
+
+== Optimizations
+
+=== Use VirtualBox's linked_clones Vagrant config
+
+https://www.vagrantup.com/docs/virtualbox/configuration.html

config-example.js

@@ -0,0 +1,35 @@
+{
+	/*
+	 * Malboxes Example Configuration File
+	 *
+	 * Uncomment a specific section of the file to trigger a particular feature.
+     *
+     * Paths should be written using forward slashes even on Windows.
+     * For ex: C:/Tools
+	 */
+
+	// This allows you to use a local filestore for ISOs.
+	// For all versions of Windows except Windows 10 you will need this.
+	// "iso_path": "/path/to/your/windows/isos/",
+
+	// Trial or registered version?
+	// If using a registered product update the product_key and set trial to 'false'.
+	// See https://github.com/GoSecure/malboxes/blob/master/docs/windows-licenses.adoc for more information.
+	"trial": "true",
+	//"trial": "false",
+	//"product_key": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
+
+	// VM username and password
+	// TODO. It doesn't work now.
+	//"username": "vagrant",
+	//"password": "vagrant",
+
+	// Setting the IDA Path will copy the IDA remote debugging tools into the guest
+	//"ida_path": "/path/to/your/ida",
+
+	// Setting Tools Path will copy all the files under the given path into the guest.
+	// Useful to copy proprietary or unpackaged tools.
+	//"tools_path": "/path/to/your/tools",
+
+	"_comment": "last line must finish without a comma for file to be valid json"
+}

docs/windows-licenses.adoc

@@ -6,7 +6,7 @@ Trial versions of Windows use a different .ISO. You can find them here:
 https://www.microsoft.com/en-us/evalcenter/evaluate-windows
 
 If you want to use a trial version make sure you have the following in your
-`config.json`:
+`config.js`:
 
     "trial": true
 
@@ -15,7 +15,7 @@ longer available. Open an issue if you can provide missing information.
 
 == Registered
 
-Specify your product key in your `config.json` file. For example:
+Specify your product key in your `config.js` file. For example:
 
     "trial": false,
     "product_key": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"

malboxes/__init__.py

@@ -17,14 +17,5 @@
 #
 
 def main():
-    from malboxes.malboxes import initialize, cleanup
-    try:
-        parser, args = initialize()
-        args.func(parser, args)
-
-    finally:
-        cleanup()
-
-
-if __name__ == "__main__":
+    from malboxes.malboxes import main
     main()