rename files to allow them to be imported

author: Jordan Wiens <jordan@psifertex.com> 2016-09-13 18:24:02 -0400
committer: Jordan Wiens <jordan@psifertex.com> 2016-09-13 18:25:04 -0400
commit: 11d6f78e43e0f305be43aeb8fc75d9d6733e508a (patch)
tree: ab47f3aefcbc295971adef788e27fe50ce466cb9 /python/examples/export_svg.py
parent: b398b6a0a8683ae844e6b61389d02317f53a252e (diff)
1 files changed, 166 insertions, 0 deletions
diff --git a/python/examples/export_svg.py b/python/examples/export_svg.py
new file mode 100755
index 00000000..02a6d57e
--- /dev/null
+++ b/python/examples/export_svg.py
@@ -0,0 +1,166 @@
+from binaryninja import *
+import os,sys
+
+escape_table = {
+	"'": "&#39;",
+	">": "&#62;",
+	"<": "&#60;",
+	'"': "&#34;",
+	' ': "&#160;"
+}
+
+def escape(string):
+	string=string.decode('utf-8').encode('ascii','xmlcharrefreplace') 	#handle extended unicode
+	return ''.join(escape_table.get(i,i) for i in string) 				#still escape the basics
+
+def save_svg(bv,function):
+	filename = os.path.basename(bv.file.filename) 
+	address = hex(function.start).replace('L','')
+	outputfile = os.path.join(os.path.expanduser('~'), 'binaryninja-{filename}-{function}.html'.format(filename=filename,function=address))
+	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.48
+	widthconst = heightconst*ratio
+
+	output = '''<html>
+	<head>
+		<style type="text/css">
+			@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: 1px;
+			}
+			.UnconditionalBranch, .IndirectBranch {
+				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>
+		<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.2/jquery.min.js"></script>
+	</head>
+'''
+	output += '''<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="{width}" height="{height}">
+		<defs>
+			<marker id="arrow-TrueBranch" class="arrow TrueBranch" viewBox="0 0 10 10" refX="10" refY="5" markerUnits="strokeWidth" markerWidth="8" markerHeight="6" 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="8" markerHeight="6" 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="8" markerHeight="6" orient="auto">
+				<path d="M 0 0 L 10 5 L 0 10 z" />
+			</marker>
+			<marker id="arrow-IndirectBranch" class="arrow IndirectBranch" viewBox="0 0 10 10" refX="10" refY="5" markerUnits="strokeWidth" markerWidth="8" markerHeight="6" 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 = ((block.x) * widthconst)
+		y = ((block.y) * heightconst)
+		width = ((block.width) * widthconst)
+		height = ((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="instr-{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)
author	Jordan Wiens <jordan@psifertex.com>	2016-09-13 18:24:02 -0400
committer	Jordan Wiens <jordan@psifertex.com>	2016-09-13 18:25:04 -0400
commit	11d6f78e43e0f305be43aeb8fc75d9d6733e508a (patch)
tree	ab47f3aefcbc295971adef788e27fe50ce466cb9 /python/examples/export_svg.py
parent	b398b6a0a8683ae844e6b61389d02317f53a252e (diff)