add gitignore, genericify exceptions, misc cleanup

isaisabel · isaisabel · commit 563299895691 · 2020-07-17T13:36:03.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,166 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# End of https://www.toptal.com/developers/gitignore/api/python,macos
diff --git a/layers/README.md b/layers/README.md
@@ -26,7 +26,7 @@ This folder contains modules and scripts for working with ATT&CK Navigator layer
 | script | description |
 |:-------|:------------|
 | [excel_templates](exporters/excel_templates.py) | Provides a means by which to convert a matrix into a clean excel matrix template. |
-| [matrix_gen](exporters/matrix_gen.py) | Provides a means by which to generate a matrix from raw data, either from the ATT&CK TAXII server or from a local collection. |
+| [matrix_gen](exporters/matrix_gen.py) | Provides a means by which to generate a matrix from raw data, either from the ATT&CK TAXII server or from a local STIX Bundle. |
 
 ## Layer
 The Layer class provides format validation and read/write capabilities to aid in working with ATT&CK Navigator Layers in python. It is the primary interface through which other Layer-related classes defined in the core module should be used. The Layer class API and a usage example are below.
@@ -133,14 +133,14 @@ out_layer6.to_file("C:\demo_layer6.json")                     # Save combined co
 ## to_excel.py
 to_excel.py provides the ToExcel class, which is a way to export an existing layer file as an Excel 
 spreadsheet. The ToExcel class has an optional parameter for the initialization function, that 
-tells the exporter what data source to use when building the output matrix. Valid options include using live data from cti-taxii.mitre.org or using a local collection. 
+tells the exporter what data source to use when building the output matrix. Valid options include using live data from cti-taxii.mitre.org or using a local STIX bundle. 
 
 ##### ToExcel()
 ```python
 x = ToExcel(domain='enterprise', source='taxii', local=None)
 ```
 The ToExcel constructor takes domain, server, and local arguments during instantiation. The domain can 
-be either `enterprise` or `mobile`, and can be pulled directly from a layer file as `layer.domain`. The source argument tells the matrix generation tool which data source to use when building the matrix. `taxii` indicates that the tool should utilize the `cti-taxii` server when building the matrix, while the `local` option indicates that it should use a local collection respectively. The local argument is only required if the source is set to `local`, in which case it should be a path to a local stix collection.
+be either `enterprise` or `mobile`, and can be pulled directly from a layer file as `layer.domain`. The source argument tells the matrix generation tool which data source to use when building the matrix. `taxii` indicates that the tool should utilize the `cti-taxii` server when building the matrix, while the `local` option indicates that it should use a local bundle respectively. The local argument is only required if the source is set to `local`, in which case it should be a path to a local stix bundle.
 
 ##### .to_file() Method
 ```python
diff --git a/layers/exporters/excel_templates.py b/layers/exporters/excel_templates.py
@@ -16,7 +16,7 @@ def __init__(self, source='taxii', local=None, domain='enterprise'):
             Initialization - Creates a ExcelTemplate object
 
             :param source: Source to use when compiling the matrix
-            :param local: Optional path to local stix data
+            :param local: Optional path to local stix data, required if source == "local"
             :param domain: The domain to utilize
         """
         muse = domain
diff --git a/layers/exporters/matrix_gen.py b/layers/exporters/matrix_gen.py
@@ -71,12 +71,6 @@ def subtechniques(self):
     def subtechniques(self, subtechniques):
         self.__subtechniques = subtechniques
 
-class BadSource(Exception):
-    pass
-
-class BadLocation(Exception):
-    pass
-
 class MatrixGen:
     def __init__(self, source='taxii', local=None):
         """
@@ -88,7 +82,7 @@ def __init__(self, source='taxii', local=None):
         self.convert_data = {}
         if source.lower() not in ['taxii', 'local']:
             print('[MatrixGen] - Unable to generate matrix, source {} is not one of "taxii" or "local"'.format(source))
-            raise BadSource
+            raise ValueError
 
         if source.lower() == 'taxii':
             self.server = Server('https://cti-taxii.mitre.org/taxii')
@@ -100,14 +94,11 @@ def __init__(self, source='taxii', local=None):
                     self.collections[collection.title.split(' ')[0].lower()] = TAXIICollectionSource(tc)
         elif source.lower() == 'local':
             if local is not None:
-                try:
-                    self.collections['enterprise'] = FileSystemSource(local)
-                    self.collections['mobile'] = FileSystemSource(local)
-                except:
-                    raise BadLocation
+                self.collections['enterprise'] = FileSystemSource(local)
+                self.collections['mobile'] = FileSystemSource(local)
             else:
                 print('[MatrixGen] - "local" source specified, but path to local source not provided')
-                raise BadSource
+                raise ValueError
         self.matrix = {}
         self._build_matrix()
 
diff --git a/layers/exporters/to_excel.py b/layers/exporters/to_excel.py
@@ -8,12 +8,6 @@
     from ..core import Layer
     from ..exporters import ExcelTemplates
 
-class NoLayer(Exception):
-    pass
-
-class MisMatchDomain(Exception):
-    pass
-
 class ToExcel:
     def __init__(self, domain='enterprise', source='taxii', local=None):
         """
@@ -33,15 +27,12 @@ def to_xlsx(self, layer, filepath="layer.xlsx"):
             :param layer: A layer to initialize the instance with
             :param filepath: The location to write the excel file to
         """
-        if layer is not None:
-            if not isinstance(layer, Layer):
-                raise TypeError
-            
-        if layer is None:
-            raise NoLayer
 
+        if not isinstance(layer, Layer):
+            raise TypeError
+            
         if self.domain not in layer.layer.domain:
-            raise MisMatchDomain
+            raise ValueError(f"layer domain ({layer.layer.domain}) does not match exporter domain ({self.domain})")
 
         included_subs = []
         if layer.layer.techniques:
