Pip packaging

.gitignore

@@ -7,6 +7,15 @@ builds/
 # Python
 __pycache__/
 
+# Python pip/setuptools packaging
+build/
+dist/
+*.egg-info/
+
 # Generic
 *~
 *.swp
+
+# Documentation artifacts
+README.html
+docs/*.html

.travis.yml

@@ -1,7 +1,5 @@
 language: python
 python:
-# disabled since pylint is currently broken on 3.2
-#- "3.2"
 - "3.3"
 - "3.4"
 - "3.5"

MANIFEST.in

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

Makefile

@@ -1,2 +1,5 @@
 test:
-	pylint malboxes.py
+	pylint malboxes
+
+pkg_clean:
+	rm -r build/ dist/ malboxes.egg-info/

README.adoc

@@ -20,33 +20,46 @@ https://github.com/gosecure/malboxes
 
 == Requirements
 
-* Python 3
+* Python 3.3+
+* appdirs
 * jinja2
-* packer (sometimes called packer-io)
-* vagrant
+* packer: https://www.packer.io/intro/getting-started/setup.html
+* vagrant: https://www.vagrantup.com/downloads.html
+
+== Installation
+
+    sudo pip install git+https://github.com/GoSecure/malboxes.git@pip-packaging#egg=malboxes
 
 == Usage
 
 === Box creation
 
-Copy `config-example.json` to `config.json`. Modify it and run:
+Run:
 
-    ./malboxes.py build <profile>
+    malboxes build <profile>
 
 You can also list all supported profiles with:
 
-    ./malboxes.py list
+    malboxes list
 
 This will build a Vagrant box ready for malware investigation you can now
 include it in a Vagrantfile afterwards.
 
 For example:
 
-    ./malboxes.py build win10_64_analyst
+    malboxes build win10_64_analyst
+
+If you want to customize your configuration, look at the following location
+for a `config.json` file:
+
+* Linux/Unix: `~/.config/malboxes/`
+* Mac OS X: `~/Library/Application Support/malboxes/`
+* Win 7+: `C:\Users\<username>\AppData\Local\malboxes\malboxes\`
+
 
 === Per analysis instances
 
-    ./malboxes.py spin win10_64_analyst <name>
+    malboxes spin win10_64_analyst <name>
 
 This will create a `Vagrantfile` prepared to use for malware analysis. Move it
 into the analysis folder of your choice and issue:
@@ -59,7 +72,7 @@ shared in the VM. This can be changed by commenting the relevant part of the
 
 For example:
 
-    ./malboxes.py spin win7_32_analyst 20160519.cryptolocker.xyz
+    malboxes spin win7_32_analyst 20160519.cryptolocker.xyz
 
 // FIXME
 
@@ -69,21 +82,27 @@ You can modify (add, modify or delete) registry keys, directories and files like
 
 Registry keys:
 
-    ./malboxes.py registry profile modtype key name value valuetype
+    malboxes registry <profile> <modtype> <key name> <value> <valuetype>
 
-    Ex: ./malboxes registry win10_64_analyst add HKCU:\Software Malboxes IsAwesome String
+Example:
+
+    malboxes registry win10_64_analyst add HKCU:\Software "Malboxes IsAwesome" String
 
 Directories and files:
 
-    ./malboxes.py directory profile modtype dirpath
+    malboxes directory <profile> <modtype> <dirpath>
+
+Example:
 
-    Ex: ./malboxes.py directory BadAPT57 delete C:\Windows\System32
+    malboxes directory BadAPT57 delete C:\Windows\System32
 
 You can add packages to install that are specific to the profile:
 
-    ./malboxes.py package profile package
+    malboxes package <profile> <package>
+
+Example:
 
-    Ex: ./malboxes.py package RansomwareThatINeedRevengeOn chrome
+    malboxes package RansomwareThatINeedRevengeOn chrome
 
 == More information
 
@@ -99,6 +118,12 @@ by link:{twob}[Olivier Bilodeau] and link:{twhg}[Hugo Genesse]
   (PDF, degraded)
 * Video (coming soon)
 
+== License
+
+Code is licensed under the GPLv3+, see `LICENSE` for details. Documentation
+and presentation material is licensed under the Creative Commons
+Attribution-ShareAlike 4.0, see `docs/LICENSE` for details.
+
 == Credits
 
 After I had the idea for an improved malware analyst workflow based on what

TODO.adoc

@@ -1,5 +1,11 @@
 = TODO
 
+== pip packaging
+
+* where should the built boxes go?
+
+== Misc
+
 * Make work with trial ISOs
 
 == Minimal malware analyst use case

config-example.json

@@ -1,7 +1,7 @@
 {
 	"iso_path": "/path/to/your/windows/isos/",
 	"_comment": "If using a registered product update the product_key and set trial to 'false'.",
-	"_comment": "See doc/windows-licenses.adoc for more information.",
+	"_comment": "See docs/windows-licenses.adoc for more information.",
 	"trial": "true",
 	"product_key": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
 	"username": "vagrant",

docs/LICENSE

@@ -0,0 +1 @@
+TODO: https://creativecommons.org/licenses/by-sa/4.0/

docs/devel.adoc

@@ -0,0 +1,7 @@
+= Development guide
+
+== Install malboxes in development mode
+
+From the project's git repository root directory, execute:
+
+    sudo pip install -e . --no-deps