summaryrefslogtreecommitdiff
path: root/python/collaboration/examples/sync_test.py
blob: 33de8caf4f6c79b03538900ac2bdc2651f4f1991 (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
# coding=utf-8
# Copyright (c) 2015-2026 Vector 35 Inc
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

import platform
import shutil
from pathlib import Path

import binaryninja
import binaryninja.enterprise as enterprise
import binaryninja.collaboration as collaboration


if platform.system() == 'Windows':
	TEST_FILE = 'C:\\Windows\\System32\\printui.exe'
else:
	TEST_FILE = '/bin/ls'


def main():
	with enterprise.LicenseCheckout():
		# Connect to remote from Enterprise
		remote = collaboration.enterprise_remote()
		if not remote:
			return
		if not remote.is_connected:
			# Will pull default credentials from Enterprise
			remote.connect()

		# Create test project
		project = remote.create_project("Test Project", "Test project for test purposes")
		file = None
		project_dir = None
		try:
			print(f'Created project {project.name}')
			file = project.upload_new_file(TEST_FILE)
			print(f'Created file {project.name}/{file.name}')

			project_dir = Path(file.default_path).parent

			print(f'Snapshots: {[snapshot.id for snapshot in file.snapshots]}')
			with binaryninja.load(file.default_path) as bv:
				assert collaboration.RemoteFile.get_for_bv(bv) == file
				assert bv.entry_function is not None, "Failed to get binary entry function"

				print(f'Setting entry function at 0x{bv.entry_function.start:08x} name to \'entry_function\'')
				bv.entry_function.name = 'entry_function'
				bv.file.save_auto_snapshot()

				file.sync(bv, lambda conflicts: False)
				print(f'Snapshots: {[snapshot.id for snapshot in file.snapshots]}')

			# Delete the bndb, redownload and see if the function name is preserved
			Path(file.default_path).unlink()

			print(f'Redownloading {project.name}/{file.name}...')
			file.download()
			with binaryninja.load(file.core_file) as bv:
				assert bv.entry_function is not None, "Failed to get binary entry function after redownload"

				print(f'Entry function name: {bv.entry_function.name}')
				assert bv.entry_function.name == 'entry_function'

		finally:
			# Clean up
			if file is not None:
				project.delete_file(file)
			if project.is_open:
				project.core_project.close()
			remote.delete_project(project)
			if project_dir is not None:
				shutil.rmtree(project_dir)


if __name__ == '__main__':
	main()