Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 288
Expand file tree
/
Copy pathwebsocketprovider.py
More file actions
294 lines (243 loc) · 9.84 KB
/
Copy pathwebsocketprovider.py
File metadata and controls
294 lines (243 loc) · 9.84 KB
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# Copyright (c) 2015-2024 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 abc
import ctypes
from json import loads, dumps
import sys
import traceback
from urllib.parse import urlencode
# Binary Ninja Components
import binaryninja._binaryninjacore as core
import binaryninja
from .log import log_error
def nop(*args, **kwargs):
pass
def to_bytes(field):
if type(field) == bytes:
return field
if type(field) == str:
return field.encode()
return str(field).encode()
class WebsocketClient(object):
"""
This class implements a websocket client. See :py:func:`~WebsocketClient.connect` for more details.
"""
_registered_clients = []
def __init__(self, provider, handle=None):
if handle is None:
self._cb = core.BNWebsocketClientCallbacks()
self._cb.context = 0
self._cb.destroyClient = self._cb.destroyClient.__class__(self._destroy_client)
self._cb.connect = self._cb.connect.__class__(self._connect)
self._cb.write = self._cb.write.__class__(self._write)
self._cb.disconnect = self._cb.disconnect.__class__(self._disconnect)
self.handle = core.BNInitWebsocketClient(provider.handle, self._cb)
self.__class__._registered_clients.append(self)
else:
self.handle = core.handle_of_type(handle, core.BNWebsocketClient)
self._must_free = handle is not None
self.on_connected = nop
self.on_disconnected = nop
self.on_error = nop
self.on_data = nop
self._connected = False
def __del__(self):
if self._must_free:
core.BNFreeWebsocketClient(self.handle)
def _destroy_client(self, ctxt):
try:
if self in self.__class__._registered_clients:
self.__class__._registered_clients.remove(self)
self.perform_destroy_client()
except:
log_error(traceback.format_exc())
def _connect(self, ctxt, host, header_count, header_keys, header_values):
# Extract headers
keys_ptr = ctypes.cast(header_keys, ctypes.POINTER(ctypes.c_char_p))
values_ptr = ctypes.cast(header_values, ctypes.POINTER(ctypes.c_char_p))
header_key_array = (ctypes.c_char_p * header_count).from_address(ctypes.addressof(keys_ptr.contents))
header_value_array = (ctypes.c_char_p * header_count).from_address(ctypes.addressof(values_ptr.contents))
headers = {}
for i in range(header_count):
headers[header_key_array[i]] = header_value_array[i]
return self.perform_connect(host, headers)
def _write(self, data, len, ctxt):
try:
data_bytes = (ctypes.c_char * len).from_buffer(data)
self.perform_write(data_bytes)
return True
except:
log_error(traceback.format_exc())
return False
def _disconnect(self, ctxt):
return self.perform_disconnect()
def _connected_callback(self, ctxt):
self.on_connected()
return True
def _disconnected_callback(self, ctxt):
self.on_disconnected()
def _error_callback(self, msg, ctxt):
self.on_error(msg)
def _read_callback(self, data, len, ctxt):
c = ctypes.cast(data, ctypes.POINTER(ctypes.c_ubyte))
data_bytes = (ctypes.c_ubyte * len).from_address(ctypes.addressof(c.contents))
self.on_data(bytes(data_bytes))
return True
@abc.abstractmethod
def perform_connect(self, host, headers):
raise NotImplementedError
@abc.abstractmethod
def perform_destroy_client(self):
raise NotImplementedError
@abc.abstractmethod
def perform_write(self, data):
raise NotImplementedError
@abc.abstractmethod
def perform_disconnect(self):
raise NotImplementedError
def connect(self, url, headers=None, on_connected=nop, on_disconnected=nop, on_error=nop, on_data=nop):
r"""
Connect to a given url, asynchronously. The connection will be run in a separate thread managed by the websocket provider.
Client callbacks are set according to whichever on\_ callback parameters you pass.
Callbacks will be called **on the thread of the connection**, so be sure to execute_on_main_thread any long-running
or gui operations in the callbacks.
If the connection succeeds, on_connected will be called. On normal termination, on_disconnected will be called.
If the connection succeeds, but later fails, on_disconnected will not be called, and on_error will be called instead.
If the connection fails, neither on_connected nor on_disconnected will be called, and on_error will be called instead.
If on_connected or on_data return false, the connection will be aborted.
:param str url: full url with scheme, domain, optionally port, and path
:param dict headers: dictionary of string header keys to string header values
:param function() -> bool on_connected: function to call when connection succeeds
:param function() -> void on_disconnected: function to call when connection is closed normally
:param function(str) -> void on_error: function to call when connection is closed with an error
:param function(bytes) -> bool on_data: function to call when data is read from the websocket
:return: if the connection has started, but not necessarily if it succeeded
:rtype: bool
:Example:
>>> provider = list(WebsocketProvider)[0]
>>> client = provider.create_instance()
>>> client.connect("ws://localhost:8080", {})
True
"""
if self._connected:
raise RuntimeError("Cannot use connect() twice on the same WebsocketClient")
self._connected = True
if headers is None:
headers = {}
header_keys = (ctypes.c_char_p * len(headers))()
header_values = (ctypes.c_char_p * len(headers))()
for (i, item) in enumerate(headers.items()):
key, value = item
header_keys[i] = to_bytes(key)
header_values[i] = to_bytes(value)
# Store this so the callbacks are not GC'd
self.io_callbacks = core.BNWebsocketClientOutputCallbacks()
self.io_callbacks.context = 0
self.io_callbacks.connectedCallback = self.io_callbacks.connectedCallback.__class__(self._connected_callback)
self.io_callbacks.disconnectedCallback = self.io_callbacks.disconnectedCallback.__class__(
self._disconnected_callback
)
self.io_callbacks.errorCallback = self.io_callbacks.errorCallback.__class__(self._error_callback)
self.io_callbacks.readCallback = self.io_callbacks.readCallback.__class__(self._read_callback)
self.on_connected = on_connected
self.on_disconnected = on_disconnected
self.on_error = on_error
self.on_data = on_data
return core.BNConnectWebsocketClient(
self.handle, url, len(headers), header_keys, header_values, self.io_callbacks
)
def write(self, data):
"""
Send some data to the websocket
:param bytes data: data to write
:return: true if successful
:rtype: bool
"""
return core.BNWriteWebsocketClientData(
self.handle, (ctypes.c_ubyte * len(data)).from_buffer_copy(data), len(data)
)
def disconnect(self):
"""
Disconnect the websocket
:return: true if successful
:rtype: bool
"""
return core.BNDisconnectWebsocketClient(self.handle)
class _WebsocketProviderMetaclass(type):
@property
def list(self):
"""List all WebsocketProvider types (read-only)"""
binaryninja._init_plugins()
count = ctypes.c_ulonglong()
types = core.BNGetWebsocketProviderList(count)
result = []
for i in range(0, count.value):
result.append(WebsocketProvider(types[i]))
core.BNFreeWebsocketProviderList(types)
return result
def __iter__(self):
binaryninja._init_plugins()
count = ctypes.c_ulonglong()
types = core.BNGetWebsocketProviderList(count)
try:
for i in range(0, count.value):
yield WebsocketProvider(types[i])
finally:
core.BNFreeWebsocketProviderList(types)
def __getitem__(self, value):
binaryninja._init_plugins()
provider = core.BNGetWebsocketProviderByName(str(value))
if provider is None:
raise KeyError("'%s' is not a valid websocket provider" % str(value))
return WebsocketProvider(provider)
def __setattr__(self, name, value):
try:
type.__setattr__(self, name, value)
except AttributeError:
raise AttributeError("attribute '%s' is read only" % name)
class WebsocketProvider(metaclass=_WebsocketProviderMetaclass):
name = None
instance_class = None
_registered_providers = []
def __init__(self, handle=None):
if handle is not None:
self.handle = core.handle_of_type(handle, core.BNWebsocketProvider)
self.__dict__["name"] = core.BNGetWebsocketProviderName(handle)
def register(self):
self._cb = core.BNWebsocketProviderCallbacks()
self._cb.context = 0
self._cb.createInstance = self._cb.createInstance.__class__(self._create_instance)
self.handle = core.BNRegisterWebsocketProvider(self.__class__.name, self._cb)
self.__class__._registered_providers.append(self)
def _create_instance(self, ctxt):
try:
assert self.__class__.instance_class is not None, "instance_class can not be None"
result = self.__class__.instance_class(self)
if result is None:
return None
return ctypes.cast(core.BNNewWebsocketClientReference(result.handle), ctypes.c_void_p).value
except:
log_error(traceback.format_exc())
return None
def create_instance(self):
result = core.BNCreateWebsocketProviderClient(self.handle)
if result is None:
return None
return WebsocketClient(self, handle=result)
You can’t perform that action at this time.