Compare commits

...

26 Commits

Author SHA1 Message Date
Josiah Baldwin
fcf523dd62 Updated to work with websockets 15 proxy handling 2025-02-17 12:54:50 -08:00
Josiah Baldwin
9a1311167d Added traceback printing for autoreconnect test in case the error type changes 2025-02-17 12:54:01 -08:00
Josiah Baldwin
c2319fcf29 Updated requirements to websockets 15. This breaks things. 2025-02-17 12:22:31 -08:00
Josiah Baldwin
4d1c25a35c Merge pull request #37 from HuFlungDu/hotfix/1.1.2
Hotfix/1.1.2

Fixes #35 

Update Cryptography version to fix SSL vulnerability.
2025-02-17 12:12:13 -08:00
Josiah Baldwin
a07b0f129a Updated changelog 2025-02-17 12:07:19 -08:00
Josiah Baldwin
64dc5eccdf Updated cryptography requirement 2025-02-17 12:06:10 -08:00
Josiah Baldwin
1a7714663a Updated changelog 2025-02-17 11:51:13 -08:00
Josiah Baldwin
0a59edd19a Fixed semvar for requirements 2025-02-17 11:50:50 -08:00
Josiah Baldwin
f8600b09fe Merge pull request #33 from HuFlungDu/hotfix/1.1.1
Hotfix/1.1.1

Fix #29
2025-02-05 12:37:35 -08:00
Josiah Baldwin
351f425ce5 Merge pull request #32 from HuFlungDu/hotfix/1.1.1
Hotfix/1.1.1

Fix #29
2025-02-05 12:37:00 -08:00
Josiah Baldwin
77e76aeb7c Updated changelog 2025-02-05 12:35:23 -08:00
Josiah Baldwin
5393321f7b Fixed issue with getting device_info when multiple meshes are available 2025-02-05 12:30:13 -08:00
Josiah Baldwin
79554ebad6 Added differintiation between admin device info and unprivileged device info for tests, as unprivileged doesn't have any mesh info at the time of testing 2025-02-05 12:28:06 -08:00
Josiah Baldwin
1dbcd012ec Added test to check for issue with mulitple meshes 2025-02-05 12:16:01 -08:00
Josiah Baldwin
ace6884991 Merge pull request #27 from HuFlungDu/release/1.1.0
Release/1.1.0 > main
2025-01-08 14:26:38 -08:00
Josiah Baldwin
61eebf1532 Merge pull request #26 from HuFlungDu/release/1.1.0
1.1.0 Release > dev
2025-01-08 14:25:18 -08:00
Josiah Baldwin
fcfeac21a8 Updated changelog 2025-01-08 14:24:19 -08:00
Josiah Baldwin
19d10ee050 Merge pull request #25 from HuFlungDu/fix/multiple-run-commands
fix/multiple-run-commands
2025-01-08 14:10:21 -08:00
Josiah Baldwin
0c9ebf0ff2 Merge pull request #23 from HuFlungDu/feat/test-meshcetral-overrides
Feat/test-meshcentral-overrides
2025-01-08 14:10:13 -08:00
Josiah Baldwin
2556e72a73 Merge pull request #22 from HuFlungDu/fix/bad-auth
Fix/bad-auth
2025-01-08 14:10:03 -08:00
Josiah Baldwin
cda5f610a1 Merge pull request #21 from HuFlungDu/fix/raw-event-off
Fixed listening to raw not removing its listener correctly
2025-01-08 14:09:48 -08:00
Josiah Baldwin
564d466ff9 Fixed listening to raw not removing its listener correctly 2025-01-08 13:57:28 -08:00
Josiah Baldwin
125e6ac6ac Added override directory which will be copied over meshcentral code for testing purposes 2025-01-08 13:54:21 -08:00
Josiah Baldwin
1b849473bb Removed silencing of docker process. Useful for debugging server side things with overrides. 2025-01-08 13:48:41 -08:00
Josiah Baldwin
df25652ba6 Fixed run_commands parsing return from multiple devices incorrectly 2025-01-08 13:42:39 -08:00
Josiah Baldwin
9668e4d507 Added test for using run_command on multiple nodes 2025-01-08 13:38:49 -08:00
12 changed files with 75 additions and 41 deletions

View File

@@ -2,7 +2,34 @@
Changelog
=========
version 1.1.2
=============
Bugs:
* Fixed semver for requirements. New version of websockets broke this library.
Security:
* Updated cryptogaphy to ~44.0.1 to fix ssl vulnerability.
Version 1.1.1
=============
Bugs:
* Fixed bug when running device_info when user has access to multiple meshes
Version 1.1.0
=============
Features:
* Added overrides for meshcentral files for testing purposes
* Added `users` field to `device` object
Bugs:
* Fixed connection errors not raising immediately
* Fixed run_commands parsing return from multiple devices incorrectly
* Fixed listening to raw not removing its listener correctly
* Fixed javascript timecodes not being handled in gnu environments
* Changed some fstring formatting that locked the library into python >3.13
Version 1.0.0
===========
=============
First release

View File

@@ -5,8 +5,8 @@ sphinx>=3.2.1
sphinx-jinja2-compat>=0.1.1
sphinx-toolbox>=2.16.0
# sphinx_rtd_theme
cffi==1.17.1
cryptography==43.0.3
pycparser==2.22
websockets==13.1
cffi~=1.17.1
cryptography~=44.0.1
pycparser~=2.22
websockets~=15.0.0
enum_tools

Binary file not shown.

View File

@@ -44,9 +44,9 @@ python_requires = >=3.8
# For more information, check out https://semver.org/.
install_requires =
importlib-metadata
cryptography>=43.0.3
websockets>=13.1
python-socks[asyncio]
cryptography~=44.0.1
websockets~=15.0.0
python-socks[asyncio]~=2.5.3
[options.packages.find]

View File

@@ -144,7 +144,7 @@ class Session(object):
options["additional_headers"] = headers
async for websocket in util.proxy_connect(self.url, proxy_url=self._proxy, process_exception=util._process_websocket_exception, **options):
async for websocket in websockets.asyncio.client.connect(self.url, proxy=self._proxy, process_exception=util._process_websocket_exception, **options):
self.alive = True
self._socket_open.set()
try:
@@ -533,7 +533,7 @@ class Session(object):
data = await event_queue.get()
yield data
finally:
self._eventer.off("server_event", _)
self._eventer.off("raw", _)
async def events(self, filter=None):
'''
@@ -1363,10 +1363,10 @@ class Session(object):
node["meshid"] = meshid
if _mesh is not None:
node["mesh"] = _mesh
sysinfo["node"] = node
sysinfo["nodeid"] = nodeid
del sysinfo["result"]
del sysinfo["noinfo"]
break
else:
continue
break
if node is None:
raise ValueError("Invalid device id")
if lastconnect is not None:
@@ -1463,6 +1463,7 @@ class Session(object):
result.setdefault(node, {})["complete"] = True
if all(_["complete"] for key, _ in result.items()):
break
continue
elif (event["value"].startswith("Run commands")):
continue
result[node]["result"].append(event["value"])

View File

@@ -67,7 +67,7 @@ class Tunnel(object):
self.url = self._session.url.replace('/control.ashx', '/meshrelay.ashx?browser=1&p=' + str(self._protocol) + '&nodeid=' + self.node_id + '&id=' + self._tunnel_id + '&auth=' + self._authcookie["cookie"])
async for websocket in util.proxy_connect(self.url, proxy_url=self._session._proxy, process_exception=util._process_websocket_exception, **options):
async for websocket in websockets.asyncio.client.connect(self.url, proxy=self._session._proxy, process_exception=util._process_websocket_exception, **options):
self.alive = True
self._socket_open.set()
try:

View File

@@ -11,7 +11,6 @@ import ssl
import functools
import urllib
import python_socks
from python_socks.async_.asyncio import Proxy
from . import exceptions
def _encode_cookie(o, key):
@@ -164,17 +163,7 @@ def _process_websocket_exception(exc):
return exc
if isinstance(exc, python_socks._errors.ProxyError):
return None
return tmp
class proxy_connect(websockets.asyncio.client.connect):
def __init__(self,*args, proxy_url=None, **kwargs):
self.proxy = None
if proxy_url is not None:
self.proxy = Proxy.from_url(proxy_url)
super().__init__(*args, **kwargs)
async def create_connection(self, *args, **kwargs):
if self.proxy is not None:
parsed = urllib.parse.urlparse(self.uri)
self.connection_kwargs["sock"] = await self.proxy.connect(dest_host=parsed.hostname, dest_port=parsed.port)
return await super().create_connection(*args, **kwargs)
# Proxy errors show up like this now, and it's default to error out. Handle explicitly.
if isinstance(exc, websockets.exceptions.InvalidProxyMessage):
return None
return tmp

View File

@@ -62,7 +62,7 @@ class TestEnvironment(object):
return self
# Destroy the env in case it wasn't killed correctly last time.
subprocess.check_call(["docker", "compose", "down"], stdout=subprocess.DEVNULL, cwd=thisdir)
self._subp = _docker_process = subprocess.Popen(["docker", "compose", "up", "--build", "--force-recreate", "--no-deps"], stdout=subprocess.DEVNULL, cwd=thisdir)
self._subp = _docker_process = subprocess.Popen(["docker", "compose", "up", "--build", "--force-recreate", "--no-deps"], cwd=thisdir)
if not self._wait_for_meshcentral():
self.__exit__(None, None, None)
raise Exception("Failed to create docker instance")

View File

@@ -0,0 +1,4 @@
# Ignore everything in this directory
*
# Except this file
!.gitignore

View File

@@ -4,4 +4,5 @@ RUN apk add python3
WORKDIR /opt/meshcentral/
COPY ./scripts/meshcentral ./scripts
COPY ./config/meshcentral/data /opt/meshcentral/meshcentral-data
COPY ./config/meshcentral/overrides /opt/meshcentral/meshcentral
CMD ["python3", "/opt/meshcentral/scripts/create_users.py"]

View File

@@ -1,6 +1,6 @@
requests
pytest-asyncio
cffi==1.17.1
cryptography==43.0.3
cryptography~=44.0.1
pycparser==2.22
websockets==13.1
websockets~=15.0.0

View File

@@ -46,9 +46,11 @@ async def test_auto_reconnect(env):
for i in range(3):
try:
await admin_session.ping(timeout=10)
except:
continue
break
except* Exception as e:
print("".join(traceback.format_exception(e)))
pass
else:
break
else:
raise Exception("Failed to reconnect")
@@ -57,6 +59,7 @@ async def test_auto_reconnect(env):
try:
await admin_session.ping(timeout=10)
except* Exception as e:
print("".join(traceback.format_exception(e)))
pass
else:
break
@@ -200,21 +203,24 @@ async def test_mesh_device(env):
assert r[0].description == "New description", "Description either failed to change, or was changed by a user without permission to do so"
with env.create_agent(mesh.short_meshid) as agent:
# There once was a bug that occured whenever running run_commands with multiple meshes. We need to add devices to both meshes to be sure that bug is squashed.
with env.create_agent(mesh.short_meshid) as agent,\
env.create_agent(mesh.short_meshid) as agent2,\
env.create_agent(mesh2.short_meshid) as agent3:
# Test agent added to device group being propagated correctly
# Create agent isn't so good at waiting for the agent to show in the sessions. Give it a couple seconds to appear.
for i in range(3):
try:
r = await admin_session.list_devices(timeout=10)
print("\ninfo list_devices: {}\n".format(r))
assert len(r) == 1, "Incorrect number of agents connected"
assert len(r) == 3, "Incorrect number of agents connected"
except:
if i == 2:
raise
await asyncio.sleep(1)
else:
break
assert len(await privileged_session.list_devices(timeout=10)) == 1, "Incorrect number of agents connected"
assert len(await privileged_session.list_devices(timeout=10)) == 2, "Incorrect number of agents connected"
assert len(await unprivileged_session.list_devices(timeout=10)) == 0, "Unprivileged account has access to agent it should not"
r = await admin_session.list_devices(details=True, timeout=10)
@@ -226,6 +232,9 @@ async def test_mesh_device(env):
r = await admin_session.list_devices(meshid=mesh.meshid, timeout=10)
print("\ninfo list_devices_meshid: {}\n".format(r))
r = await admin_session.device_info(agent.nodeid, timeout=10)
print("\ninfo admin_device_info: {}\n".format(r))
# Test editing device info propagating correctly
assert await admin_session.edit_device(agent.nodeid, name="new_name", description="New Description", tags="device", consent=meshctrl.constants.ConsentFlags.all, timeout=10), "Failed to edit device info"
@@ -234,9 +243,12 @@ async def test_mesh_device(env):
assert await admin_session.edit_device(agent.nodeid, consent=meshctrl.constants.ConsentFlags.none, timeout=10), "Failed to edit device info"
# Test run_commands
r = await admin_session.run_command(agent.nodeid, "ls", timeout=10)
r = await admin_session.run_command([agent.nodeid, agent2.nodeid], "ls", timeout=10)
print("\ninfo run_command: {}\n".format(r))
assert "meshagent" in r[agent.nodeid]["result"], "ls gave incorrect data"
assert "meshagent" in r[agent2.nodeid]["result"], "ls gave incorrect data"
assert "Run commands completed." not in r[agent.nodeid]["result"], "Didn't parse run command ending correctly"
assert "Run commands completed." not in r[agent2.nodeid]["result"], "Didn't parse run command ending correctly"
assert "meshagent" in (await privileged_session.run_command(agent.nodeid, "ls", timeout=10))[agent.nodeid]["result"], "ls gave incorrect data"
# Test run commands with ndividual device permissions
@@ -265,7 +277,7 @@ async def test_mesh_device(env):
# Test getting individual device info
r = await unprivileged_session.device_info(agent.nodeid, timeout=10)
print("\ninfo device_info: {}\n".format(r))
print("\ninfo unprivileged_device_info: {}\n".format(r))
# This device info includes the mesh ID of the device, even though the user doesn't have acces to that mesh. That's odd.
# assert r.meshid is None, "Individual device is exposing its meshid"