summaryrefslogtreecommitdiff
path: root/python/examples/export-svg.py
blob: 5826a546265afb515d564806dcf8f365fb460396 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
from binaryninja import *
import os,sys

escape_table = {
	"&": "&",
	"'": "'",
	">": ">",
	"<": "&#60;",
	'"': "&#34;",
	' ': "&#160;",
}

def escape(string):
	return ''.join(escape_table.get(i,i) for i in string)

def save_svg(bv,function):
	filename = bv.file.filename.split(os.sep)[-1]
	outputfile = os.path.join(os.path.expanduser('~'), 'binaryninja-{filename}-{function}.html'.format(filename=filename,function=function.symbol.name))
	content = render_svg(function)
	output = open(outputfile,'w')
	output.write(content)
	output.close()
	#os.system('open %s' % outputfile)

def instruction_data_flow(function,address):
	''' TODO:  Extract data flow information '''
	length = function.view.get_instruction_length(function.arch,address)
	bytes = function.view.read(address, length)
	hex = bytes.encode('hex')
	padded = ' '.join([hex[i:i+2] for i in range(0, len(hex), 2)])
	return 'Opcode: {bytes}'.format(bytes=padded)

def render_svg(function):
	graph = function.create_graph()
	graph.layout_and_wait()
	heightconst = 15
	ratio = 0.54
	widthconst = int(heightconst*ratio)

	output = '''<html><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="{width}" height="{height}">
		<defs>
			<style type="text/css"><![CDATA[
				@import url(https://fonts.googleapis.com/css?family=Source+Code+Pro);
				svg {{
					background-color: rgb(42, 42, 42);
				}}
				.basicblock {{
					fill: rgb(74, 74, 74);
					stroke: rgb(224, 224, 224);
				}}
				.edge {{
					fill: none;
					stroke-width: 2px;
				}}
				.UnconditionalBranch {{
					stroke: rgb(128, 198, 233);
					color: rgb(128, 198, 233);
				}}
				.FalseBranch {{
					stroke: rgb(222, 143, 151);
					color: rgb(222, 143, 151);
				}}
				.TrueBranch {{
					stroke: rgb(162, 217, 175);
					color: rgb(162, 217, 175);
				}}
				.arrow {{
					stroke-width: 1;
					fill: currentColor;
				}}
				text {{
					font-family: 'Source Code Pro';
					font-size: 9pt;
					fill: rgb(224, 224, 224);
				}}
				.CodeSymbolToken {{
					fill: rgb(128, 198, 223);
				}}
				.DataSymbolToken {{
					fill: rgb(142, 230, 237);
				}}
				.TextToken, .InstructionToken, .BeginMemoryOperandToken, .EndMemoryOperandToken {{
					fill: rgb(224, 224, 224);
				}}
				.PossibleAddressToken, .IntegerToken {{
					fill: rgb(162, 217, 175);
				}}
				.RegisterToken {{
					fill: rgb(237, 223, 179);
				}}
				.AnnotationToken {{
					fill: rgb(218, 196, 209);
				}}
				.ImportToken {{
					fill: rgb(237, 189, 129);
				}}
				.StackVariableToken {{
					fill: rgb(193, 220, 199);
				}}
			]]></style>
			<marker id="arrow-TrueBranch" class="arrow TrueBranch" viewBox="0 0 10 10" refX="10" refY="5" markerUnits="strokeWidth" markerWidth="4" markerHeight="3" orient="auto">
				<path d="M 0 0 L 10 5 L 0 10 z" />
			</marker>
			<marker id="arrow-FalseBranch" class="arrow FalseBranch" viewBox="0 0 10 10" refX="10" refY="5" markerUnits="strokeWidth" markerWidth="4" markerHeight="3" orient="auto">
				<path d="M 0 0 L 10 5 L 0 10 z" />
			</marker>
			<marker id="arrow-UnconditionalBranch" class="arrow UnconditionalBranch" viewBox="0 0 10 10" refX="10" refY="5" markerUnits="strokeWidth" markerWidth="4" markerHeight="3" orient="auto">
				<path d="M 0 0 L 10 5 L 0 10 z" />
			</marker>
		</defs>
	'''.format(width=graph.width*widthconst, height=graph.height*heightconst)
	output += '''	<g id="functiongraph0" class="functiongraph">
			<title>Function Graph 0</title>
	'''
	edges = ''
	for i,block in enumerate(graph.blocks):

		#Calculate basic block location and coordinates
		x = int((block.x) * widthconst)
		y = int((block.y) * heightconst)
		width = int((block.width) * widthconst)
		height = int((block.height) * heightconst)

		#Render block
		output += '		<g id="basicblock{i}">\n'.format(i=i)
		output += '			<title>Basic Block {i}</title>\n'.format(i=i)
		output += '			<rect class="basicblock" x="{x}" y="{y}" height="{height}" width="{width}"/>\n'.format(x=x,y=y,width=width,height=height)

		#Render instructions, unfortunately tspans don't allow copying/pasting more
		#than one line at a time, need SVG 1.2 textarea tags for that it looks like

		output += '			<text x="{x}" y="{y}">\n'.format(x=x,y=y + (i + 1) * heightconst)
		for i,line in enumerate(block.lines):
			output += '				<tspan id="{address}" x="{x}" y="{y}">'.format(x=x,y=y + (i + 0.7) * heightconst,address=hex(line.address)[:-1])
			hover = instruction_data_flow(function, line.address)
			output += '<title>{hover}</title>'.format(hover=hover)
			for token in line.tokens:
				# TODO: add hover for hex, function, and reg tokens
				output+='<tspan class="{tokentype}">{text}</tspan>'.format(text=escape(token.text),tokentype=token.type)
			output += '</tspan>\n'
		output += '			</text>\n'
		output += '		</g>\n'

		#Edges are rendered in a seperate chunk so they have priority over the
		#basic blocks or else they'd render below them

		for edge in block.outgoing_edges:
			points = ""
			for x,y in edge.points:
				points += str(x*widthconst)+","+str(y*heightconst) + " "
			edges += '		<polyline class="edge {type}" points="{points}" marker-end="url(#arrow-{type})"/>\n'.format(type=edge.type,points=points)
	output += ' ' + edges + '\n'
	output += '	</g>\n'
	output += '</svg></html>'
	return output

PluginCommand.register_for_function("Export to SVG", "Exports an SVG of the current function to your home folder.", save_svg)