Bugfixes and tweaks from review comments

Author: clittle

layers/README.md

@@ -147,7 +147,7 @@ tells the exporter what data source to use when building the output matrix. Vali
 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.
+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 official ATT&CK Taxii Server (`cti-taxii`) 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_xlsx() Method
 ```python
@@ -172,14 +172,14 @@ t2.to_xlsx(layer=lay, filepath="demo2.xlsx")
 ```
 
 ## to_svg.py
-to_svg.py provides the ToSVG class, which is a way to export an existing layer file as an SVG image file. The ToSVG class, like the ToExcel class, has an optional parameter for the initialization function, that 
+to_svg.py provides the ToSvg class, which is a way to export an existing layer file as an SVG image file. The ToSvg class, like 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. 
 
-##### ToSVG()
+##### ToSvg()
 ```python
 x = ToSvg(domain='enterprise', source='taxii', local=None, config=None)
 ```
-The ToSVG constructor, just like 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. The `config` parameter is an optional SVGConfig object that can be used to configure the export as desired. If not provided, the configuration for the export will be set to default values.
+The ToSvg constructor, just like 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. The `config` parameter is an optional SVGConfig object that can be used to configure the export as desired. If not provided, the configuration for the export will be set to default values.
 
 ##### SVGConfig()
 ```python
@@ -190,25 +190,25 @@ y = SVGConfig(width=8.5, height=11, headerHeight=1, unit="in", showSubtechniques
 ```
 The SVGConfig object is used to configure how an SVG export behaves. The defaults for each of the available values can be found in the declaration above, and a brief explanation for each field is included in the table below. The config object should be provided to the ToSvg object during instantiation, but if values need to be updated on the fly, the currently loaded configuration can be interacted with at `ToSvg().config`. The configuration can also be populated from a json file using the `.load_from_file(filename="path/to/file.json")` method, or stored to one using the `.save_to_file(filename="path/to/file.json)` method.
 
-| attribute| description |
-|:-------|:------------|
-| width | Desired SVG width |
-| height | Desired SVG height |
-| headerHeight | Desired Header Block height |
-| unit | SVG measurement units (qualifies width, height, etc.) |
-| showSubtechniques | Display form for subtechniques - "all", "expanded" (decided by layer), or "none" |
-| font | What font style to use - "sans", "sans-serif", or "monospace" |
-| tableBorderColor | Hex color to use for the technique borders |
-| showHeader | Whether or not to show Header Blocks |
-| legendDocked | Whether or not the legend should be docked |
-| legendX | Where to place the legend on the x axis if not docked |
-| legendY | Where to place the legend on the y axis if not docked |
-| legendWidth | Width of the legend if not docked |
-| legendHeight | Height of the legend if not docked |
-| showLegend | Whether or not to show the legend |
-| showFilters | Whether or not to show the Filter Header Block |
-| showAbout | Whether or not to show the About Header Block | 
-| border | What default border width to use |
+| attribute| description | type | default value |
+|:-------|:------------|:------------|:------------|
+| width | Desired SVG width | number | 8.5 |
+| height | Desired SVG height | number | 11 |
+| headerHeight | Desired Header Block height | number | 1 |
+| unit | SVG measurement units (qualifies width, height, etc.) - "in", "cm", "px", "em", or "pt"| string | "in" | 
+| showSubtechniques | Display form for subtechniques - "all", "expanded" (decided by layer), or "none" | string | "expanded" | 
+| font | What font style to use - "serif", "sans-serif", or "monospace" | string | "sans-serif" |
+| tableBorderColor | Hex color to use for the technique borders | string | "#6B7279" | 
+| showHeader | Whether or not to show Header Blocks | bool | True |
+| legendDocked | Whether or not the legend should be docked | bool | True |
+| legendX | Where to place the legend on the x axis if not docked | number | 0 |
+| legendY | Where to place the legend on the y axis if not docked | number | 1 |
+| legendWidth | Width of the legend if not docked | number | 2 |
+| legendHeight | Height of the legend if not docked | number | 1 |
+| showLegend | Whether or not to show the legend | bool | True |
+| showFilters | Whether or not to show the Filter Header Block | bool | True |
+| showAbout | Whether or not to show the About Header Block | bool | True |
+| border | What default border width to use | number | 0.104 | 
 
 ##### .to_svg() Method
 ```python

layers/exporters/fonts/sans.ttf layers/exporters/fonts/serif.ttflayers/exporters/fonts/sans.ttf renamed to layers/exporters/fonts/serif.ttf

@@ -139,7 +139,8 @@ def _get_technique_listing(self, tactic, domain='enterprise'):
         subtechs = {}
         techs = self.collections[domain].query([Filter('type', '=', 'attack-pattern'), Filter('kill_chain_phases.phase_name', '=', tactic)])
         for entry in techs:
-            if entry['kill_chain_phases'][0]['kill_chain_name'] == 'mitre-attack':
+            if entry['kill_chain_phases'][0]['kill_chain_name'] == 'mitre-attack' or \
+                            entry['kill_chain_phases'][0]['kill_chain_name'] == 'mitre-mobile-attack':
                 tid = [t['external_id'] for t in entry['external_references'] if 'attack' in t['source_name']]
                 if '.' not in tid[0]:
                     techniques.append(MatrixEntry(id=tid[0], name=entry['name']))

layers/exporters/matrix_gen.py

@@ -3,6 +3,12 @@
 import os
 from PIL import ImageFont
 
+try:
+    from core.gradient import Gradient
+except ModuleNotFoundError:
+    from ..core.gradient import Gradient
+
+
 def convertToPx(quantity, unit):
     """
         INTERNAL: Convert values to pixels
@@ -37,6 +43,20 @@ def _getstringwidth(string, font, size):
     length, _ = font.getsize(string)
     return length
 
+def _getstringheight(string, font, size):
+    """
+        INTERNAL: Calculate the width of a string (in pixels)
+
+        :param string: string to evaluate
+        :param font: font to use
+        :param size: font size
+        :return: pixel height of string
+    """
+    font = ImageFont.truetype('{}/fonts/{}.ttf'.format(os.path.sep.join(__file__.split(os.path.sep)[:-1]), font),
+                              int(size))
+    _, height = font.getsize(string)
+    return height
+
 def _findSpace(words, width, height, maxFontSize):
     """
         INTERNAL: Find space locations for a string to keep it within width x height
@@ -57,8 +77,10 @@ def _findSpace(words, width, height, maxFontSize):
     for w in range(0, len(words)):
         word = words[w]
         longestWordLength = max(longestWordLength, len(word))
-
-    fitTextWidth = ((width - (2 * padding)) / longestWordLength * 1.45)
+    try:
+        fitTextWidth = ((width - (2 * padding)) / longestWordLength * 1.45)
+    except:
+        pass
     size = min(maxFontSize, fitTextHeight, fitTextWidth)
     return size
 
@@ -101,6 +123,7 @@ def _optimalFontSize(st, width, height, maxFontSize=12):
 class Cell(draw.DrawingParentElement):
     TAG_NAME = 'rect'
     def __init__(self, height, width, fill, tBC, ctype=None):
+        # tBC = tableBorderColor, ctype='class' field on resulting svg object, fill=[R,G,B]
         super().__init__(height=height, width=width, style='fill: rgb({}, {}, {})'.format(fill[0], fill[1], fill[2]),
                          stroke=tBC)
         if ctype:
@@ -109,6 +132,7 @@ def __init__(self, height, width, fill, tBC, ctype=None):
 class HeaderRect(draw.DrawingParentElement):
     TAG_NAME = 'rect'
     def __init__(self, width, height, ctype, x=None, y=None, outline=True):
+        # ctype='class' field on resulting svg object, x=x coord, y=y coord
         super().__init__(width=width, height=height, fill='white', rx='5')
         self.args['class'] = ctype
         if x:
@@ -121,6 +145,7 @@ def __init__(self, width, height, ctype, x=None, y=None, outline=True):
 class G(draw.DrawingParentElement):
     TAG_NAME = 'g'
     def __init__(self, tx=None, ty=None, style=None, ctype=None):
+        # tx=translate x, ty=translate y, ctype='class' field on resulting svg object
         super().__init__()
         if tx is None:
             tx = 0
@@ -135,10 +160,12 @@ def __init__(self, tx=None, ty=None, style=None, ctype=None):
 class Line(draw.DrawingParentElement):
     TAG_NAME = 'line'
     def __init__(self, x1, x2, y1, y2, stroke):
+        # x1=start x, x2=stop x, y1=start y, y2=stop y, stroke='stroke' field on resulting svg object
         super().__init__(x1=x1, x2=x2, y1=y1, y2=y2, stroke=stroke)
 
 class Text(draw.Text):
     def __init__(self, text, font_size, ctype, position=None, tx=None, ty=None, x=None, y=None, fill=None):
+        # ctype='class' object on resulting svg, position='text-anchor' field, tx/ty=translate x/y, x/y=x/y coord
         if x is None:
             x = 0
         if y is None:
@@ -159,6 +186,7 @@ def __init__(self, text, font_size, ctype, position=None, tx=None, ty=None, x=No
 class Swatch(draw.DrawingParentElement):
     TAG_NAME = 'rect'
     def __init__(self, height, width, fill):
+        # fill= [R,G,B]
         super().__init__(height=height, width=width, style='fill: rgb({}, {}, {})'.format(fill[0], fill[1], fill[2]))
 
 
@@ -181,10 +209,10 @@ def build(height, width, label, config, variant='text', t1text=None, t2text=None
         g = G(ty=5)
         rect = HeaderRect(width, height, 'header-box')
         g.append(rect)
-        rect2 = HeaderRect(_getstringwidth(label, config.font, 12), height/5, 'label-cover', x=8, y=-9.67,
-                           outline=False)
+        rect2 = HeaderRect(_getstringwidth(label, config.font, 12), _getstringheight(label, config.font, 12),
+                           'label-cover', x=7, y=-5, outline=False)
         g.append(rect2)
-        text = Text(label, 12, 'header-box-label', x=10, y=3)
+        text = Text(label, 12, 'header-box-label', x=8, y=3)
         g.append(text)
         internal = G(tx=5, ctype='header-box-content')
         g.append(internal)
@@ -193,18 +221,25 @@ def build(height, width, label, config, variant='text', t1text=None, t2text=None
             internal.append(upper)
             if t1text is not None:
                 fs, patch_text = _optimalFontSize(t1text, width, (height-80/2), maxFontSize=28)
-                t1 = Text("\n".join(patch_text), fs, '', x=4, y=20)
+                lines = len(patch_text)
+                y = (height-5)/4 + 2.1
+                if lines > 1:
+                    y = y - (((height-5)/16) * (lines-1))
+                t1 = Text("\n".join(patch_text), fs, '', x=4, y=y)
                 upper.append(t1)
                 upper.append(Line(0, width-10, (height-5)/2, (height-5)/2, stroke='#dddddd'))
-                if t2text is not None:
+                if t2text is not None and t2text is not "":
                     upper_fs = fs
-                    lower = G(tx=0, ty= ((height-5)/2 + 20))
+                    lower_offset = ((height-5)/2 + 2.1)
+                    lower = G(tx=0, ty= lower_offset)
                     fs, patch_text = _optimalFontSize(t2text, width, (height - (height/3 + upper_fs)), maxFontSize=28)
-                    y = 10
+                    y = (height-5)/4 + 2.1
                     lines = len(patch_text)
                     adju = "\n".join(patch_text)
                     if lines > 1:
-                        y = y / (4 ** lines)
+                        y = y - (((height - 5) / 16) * (lines - 1))
+                    if float(fs) > lower_offset:
+                        y = y + 2*(float(fs) - lower_offset)
                     t2 = Text(adju, fs, '', x=4, y=y)
                     lower.append(t2)
                     internal.append(lower)
@@ -237,6 +272,8 @@ def build(height, width, label, config, variant='text', t1text=None, t2text=None
 class SVG_Technique:
     def __init__(self, gradient):
         self.grade = gradient
+        if self.grade == None:
+            self.grade = Gradient(colors=["#ff6666", "#ffe766", "#8ec843"], minValue=1, maxValue=100)
 
     def build(self, offset, technique, height, width, tBC, subtechniques=[], mode=(True, False), tactic=None,
               colors=[]):
@@ -254,7 +291,6 @@ def build(self, offset, technique, height, width, tBC, subtechniques=[], mode=(T
             :param colors: List of all default color values if no score can be found
             :return: The newly created SVG technique block
         """
-        indent = 11.2
         g = G(ty=offset)
         c = self._com_color(technique, tactic, colors)
         t = dict(name=self._disp(technique.name, technique.id, mode), id=technique.id,
@@ -264,21 +300,21 @@ def build(self, offset, technique, height, width, tBC, subtechniques=[], mode=(T
         g.append(text)
         new_offset = height
         for entry in subtechniques:
-            gp = G(tx=indent, ty=new_offset)
+            gp = G(tx=width/5, ty=new_offset)
             g.append(gp)
             c = self._com_color(entry, tactic, colors)
             st = dict(name=self._disp(entry.name, entry.id, mode), id=entry.id,
                      color=tuple(int(c[i:i + 2], 16) for i in (0, 2, 4)))
-            subtech, subtext = self._block(st, height, width - indent, tBC=tBC)
+            subtech, subtext = self._block(st, height, width - width/5, tBC=tBC)
             gp.append(subtech)
             gp.append(subtext)
             new_offset = new_offset + height
         if len(subtechniques):
-            g.append(draw.Lines(2, -height,
-                                9, -height * 2,
-                                9, -height * (len(subtechniques) + 1),
-                                indent, -height * (len(subtechniques) + 1),
-                                indent, -height,
+            g.append(draw.Lines(width/16, -height,
+                                width/8, -height * 2,
+                                width/8, -height * (len(subtechniques) + 1),
+                                width/5, -height * (len(subtechniques) + 1),
+                                width/5, -height,
                        close=True,
                        fill=tBC,
                        stroke=tBC))
@@ -304,7 +340,7 @@ def _block(technique, height, width, tBC):
 
         y = height / 2
         if lines > 0:
-            y = y - y / (2**lines) + fs / (lines + 1)
+            y = (height - (lines * fs)) / 2 + height/10 #padding
         else:
             y = y + fs / 4
 
@@ -332,9 +368,6 @@ def _com_color(self, technique, tactic, colors=[]):
             for x in colors:
                 if x[0] == technique.id and (x[1] == tactic or not x[1]):
                     c = x[2][1:]
-        if c == 'FFFFFF':
-            if 0 >= self.grade.minValue:
-                c = self.grade.compute_color(0)[1:]
         return c
 
     @staticmethod