Merge branch 'scripts-25' into develop

Author: isaisabel

.gitignore

@@ -1 +1,166 @@
-.DS_Store
+# 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

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v1.5.1 - 27 July 2020
+## New Scripts
+- Added [layer to excel](https://github.com/mitre-attack/attack-scripts/tree/master/layers#to_excelpy) converter. See issue [#25](https://github.com/mitre-attack/attack-scripts/issues/25).
+
 # v1.5 - 8 July 2020
 ## New Scripts
 Added scripts used to generate the [sample layers in the ATT&CK Navigator repository](https://github.com/mitre-attack/attack-navigator/tree/develop/layers/data/samples). See issue [#21](https://github.com/mitre-attack/attack-scripts/issues/21) and [the sample layer README](scripts/layers/samples/README.md) for more details. The following scripts were added:
@@ -16,7 +20,7 @@ Added scripts used to generate the [sample layers in the ATT&CK Navigator reposi
 ## Fixes
 - Fixed bug in LayerOps causing issues with cross-tactic techniques, as well as a bug where a score lambda could affect the outcome of other lambdas.
 
-# v1.4 - 5 May 2020
+# V1.4 - 5 May 2020
 ## New Scripts
 - Added Layers folder with utility scripts for working with [ATT&CK Navigator](https://github.com/mitre-attack/attack-navigator) Layers. See the Layers [README](layers/README.md) for more details. See issues [#2](https://github.com/mitre-attack/attack-scripts/issues/2) and [#3](https://github.com/mitre-attack/attack-scripts/issues/3).
 

layers/README.md

@@ -7,7 +7,7 @@ This folder contains modules and scripts for working with ATT&CK Navigator layer
 |:-------|:------------|
 | [filter](core/filter.py) | Implements a basic [filter object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv3.md#filter-object-properties). |
 | [gradient](core/gradient.py) | Implements a basic [gradient object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv3.md#gradient-object-properties). |
-| [layer](core/layer.py) | Provides an interface for interacting with core module's layer representation. A further breakdown can be found in the corresponding section below. |
+| [layer](core/layer.py) | Provides an interface for interacting with core module's layer representation. A further breakdown can be found in the corresponding [section](#Layer) below. |
 | [layout](core/layout.py) | Implements a basic [layout object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv3.md#layout-object-properties). |
 | [legenditem](core/legenditem.py) | Implements a basic [legenditem object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv3.md#legenditem-object-properties). |
 | [metadata](core/metadata.py) | Implements a basic [metadata object](https://github.com/mitre-attack/attack-navigator/blob/develop/layers/LAYERFORMATv3.md#metadata-object-properties). |
@@ -16,7 +16,17 @@ This folder contains modules and scripts for working with ATT&CK Navigator layer
 #### Manipulator Scripts
 | script | description |
 |:-------|:------------|
-| [layerops](manipulators/layerops.py) | Provides a means by which to combine multiple ATT&CK layer objects in customized ways. A further breakdown can be found in the corresponding section below. |
+| [layerops](manipulators/layerops.py) | Provides a means by which to combine multiple ATT&CK layer objects in customized ways. A further breakdown can be found in the corresponding [section](#layerops.py) below. |
+
+#### Exporter Scripts
+| script | description |
+|:-------|:------------|
+| [to_excel](exporters/to_excel.py) | Provides a means by which to export an ATT&CK Layer to an excel file. A further breakdown can be found in the corresponding [section](#to_excel.py) below. |
+##### Utility Modules
+| 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 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.
@@ -119,3 +129,37 @@ lo4 = LayerOps(score=lambda x: '; '.join(x),
 out_layer6 = lo4.process([demo2, demo3])                      # Trigger processing on a list of demo2 and demo0
 out_layer6.to_file("C:\demo_layer6.json")                     # Save combined comment layer to file
 ```
+
+## 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 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 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
+x.to_xlsx(layer=layer, filepath="layer.xlsx")
+```
+The to_xlsx method exports the layer file referenced as `layer`, as an excel file to the 
+`filepath` specified. 
+
+#### Example Usage
+```python
+from layers import Layer
+from layers import ToExcel
+
+lay = Layer()
+lay.from_file("path/to/layer/file.json")
+# Using taxii server for template
+t = ToExcel(domain=lay.layer.domain, source='taxii')
+t.to_xlsx(layer=lay, filepath="demo.xlsx")
+#Using local stix data for template
+t2 = ToExcel(domain='mobile', source='local', local='path/to/local/stix.json')
+t2.to_xlsx(layer=lay, filepath="demo2.xlsx")
+```

layers/__init__.py

@@ -0,0 +1,3 @@
+from .core import *
+from .exporters import *
+from .manipulators import *

layers/core/gradient.py

@@ -1,3 +1,5 @@
+import colour
+import math
 try:
     from ..core.exceptions import typeChecker, typeCheckerArray
 except ValueError:
@@ -13,6 +15,8 @@ def __init__(self, colors, minValue, maxValue):
             :param minValue: The minValue for this gradient
             :param maxValue: The maxValue for this gradient
         """
+        self.__minValue = None
+        self.__maxValue = None
         self.colors = colors
         self.minValue = minValue
         self.maxValue = maxValue
@@ -27,6 +31,7 @@ def colors(self, colors):
         self.__colors = []
         for entry in colors:
             self.__colors.append(entry)
+        self._compute_curve()
 
     @property
     def minValue(self):
@@ -36,6 +41,7 @@ def minValue(self):
     def minValue(self, minValue):
         typeChecker(type(self).__name__, minValue, int, "minValue")
         self.__minValue = minValue
+        self._compute_curve()
 
     @property
     def maxValue(self):
@@ -45,6 +51,42 @@ def maxValue(self):
     def maxValue(self, maxValue):
         typeChecker(type(self).__name__, maxValue, int, "maxValue")
         self.__maxValue = maxValue
+        self._compute_curve()
+
+    def _compute_curve(self):
+        """
+            Computes the gradient color curve
+        """
+        if self.maxValue is not None and self.minValue is not None and self.colors is not None:
+            chunksize = int(math.floor((self.maxValue - self.minValue)/(len(self.colors) - 1)))
+            fchunksize = int(math.ceil((self.maxValue - self.minValue)/(len(self.colors) - 1)))
+            self.curve = []
+            index = 1
+            while index < len(self.colors):
+                s_c = colour.Color(self.colors[index-1])
+                e_c = colour.Color(self.colors[index])
+                if index == len(self.colors):
+                    curve_2 = list(s_c.range_to(e_c, fchunksize))
+                else:
+                    curve_2 = list(s_c.range_to(e_c, chunksize))
+                index += 1
+                self.curve.extend(curve_2)
+            self.curve.append(colour.Color(self.colors[-1]))
+
+    def compute_color(self, score):
+        """
+            Computes a specific color based on the score value provided
+            :returns: A hexadecimal color representation of the score on
+                the gradient
+        """
+        if score <= self.minValue:
+            return self.curve[0].hex_l
+        if score >= self.maxValue:
+            return self.curve[-1].hex_l
+
+        target = self.curve[score - self.minValue]
+        return target.hex_l
+
 
     def get_dict(self):
         """

layers/core/technique.py

@@ -50,7 +50,7 @@ def tactic(self, tactic):
 
     @property
     def comment(self):
-        if self.__tactic != UNSETVALUE:
+        if self.__comment != UNSETVALUE:
             return self.__comment
 
     @comment.setter

layers/exporters/__init__.py

@@ -0,0 +1,3 @@
+from .excel_templates import ExcelTemplates
+from .matrix_gen import MatrixGen
+from .to_excel import ToExcel