def export(self,
showName,
showID,
lhandle,
config,
sort=0,
scores=[],
colors=[],
subtechs=[],
exclude=[]):
"""
Export a layer object to an SVG object
:param showName: Boolean of whether or not to show names
:param showID: Boolean of whether or not to show IDs
:param lhandle: The layer object being exported
:param config: A SVG Config object
:param sort: The sort mode
:param scores: List of tactic scores
:param colors: List of tactic default colors
:param subtechs: List of visible subtechniques
:param exclude: List of excluded techniques
:return:
"""
grad = False
if len(scores):
grad = lhandle.gradient
d, presence, overlay = self._build_headers(lhandle.name, config,
lhandle.description,
lhandle.filters, grad)
self.codex = self.h._adjust_ordering(self.codex, sort, scores)
self.lhandle = lhandle
index = 0
lengths = []
border = convertToPx(config.border, config.unit)
glob = G(tx=border)
for x in self.codex:
su = len(x.techniques)
for enum in exclude:
if enum[0] in [y.id for y in x.techniques]:
if self.h.convert(
enum[1]) == x.tactic.name or enum[1] == False:
su -= 1
for y in x.subtechniques:
if y in [z[0] for z in subtechs]:
su += len(x.subtechniques[y])
lengths.append(su)
tech_width = ((convertToPx(config.width, config.unit) - 1.2 * border) / sum([1 for x in lengths if x > 0])) - \
border
header_offset = convertToPx(config.headerHeight, config.unit)
if presence == 0:
header_offset = 0
header_offset += 2.5 * border
tech_height = (
convertToPx(config.height, config.unit) - header_offset -
convertToPx(config.border, config.unit)) / (max(lengths) + 1)
incre = tech_width + 1.1 * border
for x in self.codex:
disp = ''
if showName and showID:
disp = x.tactic.id + ": " + x.tactic.name
elif showName:
disp = x.tactic.name
elif showID:
disp = x.tactic.id
g = G(tx=index, ty=header_offset)
fs, _ = _optimalFontSize(disp,
tech_width,
tech_height,
maxFontSize=28)
tx = Text(ctype='TacticName',
font_size=fs,
text=disp,
position='middle')
gt = G(tx=(tech_width) / 2, ty=(tech_height) / 2)
gt.append(tx)
a = self.get_tactic(x,
tech_height,
tech_width,
colors=colors,
subtechs=subtechs,
exclude=exclude,
mode=(showName, showID),
scores=scores,
config=config)
b = G(ty=tech_height)
g.append(gt)
b.append(a)
g.append(b)
if a:
glob.append(g)
index += incre
d.append(glob)
if overlay:
d.append(overlay)
return d
def _build_headers(self,
name,
config,
desc=None,
filters=None,
gradient=None):
"""
Internal - build the header blocks for the svg
:param name: The name of the layer being exported
:param config: SVG Config object
:param desc: Description of the layer being exported
:param filters: Any filters applied to the layer being exported
:param gradient: Gradient information included with the layer
:return: Instantiated SVG header
"""
max_x = convertToPx(config.width, config.unit)
max_y = convertToPx(config.height, config.unit)
header_height = convertToPx(config.headerHeight, config.unit)
ff = config.font
d = draw.Drawing(max_x, max_y, origin=(0, -max_y), displayInline=False)
psych = 0
overlay = None
if config.showHeader:
border = convertToPx(config.border, config.unit)
root = G(tx=border, ty=border, style='font-family: {}'.format(ff))
header = G()
root.append(header)
b1 = G()
header.append(b1)
header_count = 0
if config.showAbout:
header_count += 1
if config.showFilters:
header_count += 1
if config.showLegend and gradient is not False and config.legendDocked:
header_count += 1
operation_x = (max_x - border) - (1.5 * border *
(header_count - 1))
if header_count > 0:
header_width = operation_x / header_count
if config.showAbout:
if desc is not None:
g = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='about',
t1text=name,
t2text=desc,
config=config)
else:
g = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='about',
t1text=name,
config=config)
b1.append(g)
psych += 1
if config.showFilters:
fi = filters
if fi is None:
fi = Filter()
fi.platforms = ["Windows", "Linux", "macOS"]
fi.stages = ["act"]
g2 = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='filters',
t1text=', '.join(
fi.platforms),
t2text=fi.stages[0],
config=config)
b2 = G(tx=operation_x / header_count * psych +
1.5 * border * psych)
header.append(b2)
b2.append(g2)
psych += 1
if config.showLegend and gradient is not False:
gr = gradient
if gr is None:
gr = Gradient(colors=["#ff6666", "#ffe766", "#8ec843"],
minValue=1,
maxValue=100)
colors = []
div = round(
(gr.maxValue - gr.minValue) / (len(gr.colors) * 2 - 1))
for i in range(0, len(gr.colors) * 2 - 1):
colors.append(
(gr.compute_color(int(gr.minValue + div * i)),
gr.minValue + div * i))
colors.append((gr.compute_color(gr.maxValue), gr.maxValue))
if config.legendDocked:
b3 = G(tx=operation_x / header_count * psych +
1.5 * border * psych)
g3 = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='legend',
variant='graphic',
colors=colors,
config=config)
header.append(b3)
b3.append(g3)
psych += 1
else:
adjusted_height = convertToPx(config.legendHeight,
config.unit)
adjusted_width = convertToPx(config.legendWidth,
config.unit)
g3 = SVG_HeaderBlock().build(height=adjusted_height,
width=adjusted_width,
label='legend',
variant='graphic',
colors=colors,
config=config)
lx = convertToPx(config.legendX, config.unit)
if not lx:
lx = max_x - adjusted_width - convertToPx(
config.border, config.unit)
ly = convertToPx(config.legendY, config.unit)
if not ly:
ly = max_y - adjusted_height - convertToPx(
config.border, config.unit)
overlay = G(tx=lx, ty=ly)
if (ly + adjusted_height) > max_y or (
lx + adjusted_width) > max_x:
print(
"[WARNING] - Floating legend will render partly out of view..."
)
overlay.append(g3)
d.append(root)
return d, psych, overlay
def _build_headers(self,
name,
config,
domain='Enterprise',
version='8',
desc=None,
filters=None,
gradient=None):
"""
Internal - build the header blocks for the svg
:param name: The name of the layer being exported
:param config: SVG Config object
:param domain: The layer's domain
:param version: The layer's version
:param desc: Description of the layer being exported
:param filters: Any filters applied to the layer being exported
:param gradient: Gradient information included with the layer
:return: Instantiated SVG header
"""
max_x = convertToPx(config.width, config.unit)
max_y = convertToPx(config.height, config.unit)
header_height = convertToPx(config.headerHeight, config.unit)
ff = config.font
d = draw.Drawing(max_x, max_y, origin=(0, -max_y), displayInline=False)
psych = 0
overlay = None
if config.showHeader:
border = convertToPx(config.border, config.unit)
root = G(tx=border, ty=border, style='font-family: {}'.format(ff))
header = G()
root.append(header)
b1 = G()
header.append(b1)
header_count = 0
showAgg = False
if config.showAbout:
header_count += 1
if config.showFilters:
header_count += 1
if config.showDomain:
header_count += 1
if config.showLegend and gradient is not False and config.legendDocked:
header_count += 1
if self.lhandle.layout:
if self.lhandle.layout.showAggregateScores:
showAgg = True
header_count += 1
if config.showFilters:
header_count -= 1
operation_x = (max_x - border) - (1.5 * border *
(header_count - 1)) - border
if header_count > 0:
header_width = operation_x / header_count
if config.showAbout:
if desc is not None:
g = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='about',
t1text=name,
t2text=desc,
config=config)
else:
g = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='about',
t1text=name,
config=config)
b1.append(g)
psych += 1
if config.showDomain:
if domain.startswith('mitre-'):
domain = domain[6:].capitalize()
if domain.endswith('-attack'):
domain = domain[:-7].capitalize()
tag = domain + ' ATT&CK v' + version
if config.showFilters and showAgg:
fi = filters
if fi is None:
fi = Filter()
fi.platforms = ["Windows", "Linux", "macOS"]
gD = SVG_HeaderBlock().build(
height=header_height,
width=header_width,
label='domain & platforms',
t1text=tag,
t2text=', '.join(fi.platforms),
config=config)
else:
gD = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='domain',
t1text=tag,
config=config)
bD = G(tx=operation_x / header_count * psych +
1.5 * border * psych)
header.append(bD)
bD.append(gD)
psych += 1
if config.showFilters and not showAgg:
fi = filters
if fi is None:
fi = Filter()
fi.platforms = ["Windows", "Linux", "macOS"]
g2 = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='filters',
t1text=', '.join(
fi.platforms),
config=config)
b2 = G(tx=operation_x / header_count * psych +
1.5 * border * psych)
header.append(b2)
b2.append(g2)
psych += 1
if showAgg:
t1 = f"showing aggregate scores using the {self.lhandle.layout.aggregateFunction} " \
f"aggregate function"
stub = "does not include"
if self.lhandle.layout.countUnscored:
stub = "includes"
t2 = f"{stub} unscored techniques as having a score of 0"
gA = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='aggregate',
t1text=t1,
t2text=t2,
config=config)
bA = G(tx=operation_x / header_count * psych +
1.5 * border * psych)
header.append(bA)
bA.append(gA)
psych += 1
if config.showLegend and gradient is not False:
gr = gradient
if gr is None:
gr = Gradient(colors=["#ff6666", "#ffe766", "#8ec843"],
minValue=1,
maxValue=100)
colors = []
div = round(
(gr.maxValue - gr.minValue) / (len(gr.colors) * 2 - 1))
for i in range(0, len(gr.colors) * 2 - 1):
colors.append(
(gr.compute_color(int(gr.minValue + div * i)),
gr.minValue + div * i))
colors.append((gr.compute_color(gr.maxValue), gr.maxValue))
if config.legendDocked:
b3 = G(tx=operation_x / header_count * psych +
1.5 * border * psych)
g3 = SVG_HeaderBlock().build(height=header_height,
width=header_width,
label='legend',
variant='graphic',
colors=colors,
config=config)
header.append(b3)
b3.append(g3)
psych += 1
else:
adjusted_height = convertToPx(config.legendHeight,
config.unit)
adjusted_width = convertToPx(config.legendWidth,
config.unit)
g3 = SVG_HeaderBlock().build(height=adjusted_height,
width=adjusted_width,
label='legend',
variant='graphic',
colors=colors,
config=config)
lx = convertToPx(config.legendX, config.unit)
if not lx:
lx = max_x - adjusted_width - convertToPx(
config.border, config.unit)
ly = convertToPx(config.legendY, config.unit)
if not ly:
ly = max_y - adjusted_height - convertToPx(
config.border, config.unit)
overlay = G(tx=lx, ty=ly)
if (ly + adjusted_height) > max_y or (
lx + adjusted_width) > max_x:
print(
"[WARNING] - Floating legend will render partly out of view..."
)
overlay.append(g3)
d.append(root)
return d, psych, overlay
