forked from Narcissus/pylibmeshctrl
Compare commits
48 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cac746906f | ||
|
|
6290bc7298 | ||
|
|
5975e145a7 | ||
|
|
cd6707a279 | ||
|
|
7b9d82b8e6 | ||
|
|
7cefd24a9d | ||
|
|
cbc1f9223f | ||
|
|
3fa1ca2e32 | ||
|
|
ee812220fb | ||
|
|
002f652c8c | ||
|
|
0b09f64821 | ||
|
|
12a3040f89 | ||
|
|
e0694f980c | ||
|
|
61053549f2 | ||
|
|
fb3d043431 | ||
|
|
c13985739b | ||
|
|
db1914c87b | ||
|
|
b0d071d87f | ||
|
|
3bcedf5610 | ||
|
|
9c7a8c39b0 | ||
|
|
7ba6989325 | ||
|
|
748e39d5b4 | ||
|
|
6dae40eb40 | ||
|
|
c7d628716e | ||
|
|
1f9979ddd1 | ||
| d4b9524814 | |||
|
|
bc1db8f2b3 | ||
|
|
403c0cd0ec | ||
|
|
0b0029563a | ||
|
|
0b32896c88 | ||
|
|
2304810ee6 | ||
|
|
4cda54ab60 | ||
|
|
87fad5aa13 | ||
|
|
6daaa91758 | ||
|
|
078e07cb4f | ||
|
|
0e569ae0cb | ||
|
|
62fdc79aeb | ||
|
|
c450ad7a96 | ||
|
|
891f7bfc12 | ||
|
|
4953d85cdc | ||
|
|
f5c6e96597 | ||
|
|
428a1b31c7 | ||
|
|
16f3f99427 | ||
|
|
d21450e463 | ||
|
|
9e08a1af49 | ||
|
|
e9de43420e | ||
|
|
fcdf8add53 | ||
|
|
163b776dfc |
@@ -3,3 +3,4 @@ Contributors
|
||||
============
|
||||
|
||||
* Josiah Baldwin <jbaldwin8889@gmail.com>
|
||||
* Daan Selen <https://github.com/DaanSelen>
|
||||
@@ -2,6 +2,48 @@
|
||||
Changelog
|
||||
=========
|
||||
|
||||
version 1.3.3
|
||||
=============
|
||||
|
||||
Improvements:
|
||||
* Dependency bumps
|
||||
|
||||
Bugs:
|
||||
* Fix run_commands having an issue with ignore_output
|
||||
|
||||
version 1.3.2
|
||||
=============
|
||||
|
||||
Improvements:
|
||||
* Fix race condition that could occur when running `run_command` or `run_console_command`
|
||||
|
||||
version 1.3.1
|
||||
=============
|
||||
|
||||
Improvments:
|
||||
* Basically just everything in 1.3.0, this is a release fix
|
||||
|
||||
version 1.3.0
|
||||
=============
|
||||
|
||||
Improvements:
|
||||
* Improved how run_commands was handled (#51)
|
||||
* Added remove device functionality (#52)
|
||||
* Added run_console_commands functionality (#55)
|
||||
|
||||
Bugs:
|
||||
* Silly documentation being wrong (#53)
|
||||
|
||||
version 1.2.2
|
||||
=============
|
||||
|
||||
Improvements:
|
||||
* Added user agent to websocket headers
|
||||
|
||||
Bugs:
|
||||
* Fixed library's __version__ implementation
|
||||
* Fixed data from certain devices not showing up due to overloading websocket packet sizes
|
||||
|
||||
version 1.2.1
|
||||
=============
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ sphinx-jinja2-compat>=0.1.1
|
||||
sphinx-toolbox>=2.16.0
|
||||
# sphinx_rtd_theme
|
||||
cffi~=1.17.1
|
||||
cryptography~=44.0.1
|
||||
pycparser~=2.22
|
||||
websockets~=15.0.0
|
||||
enum_tools
|
||||
enum_tools
|
||||
cryptography~=46.0.5
|
||||
websockets~=16.0.0
|
||||
BIN
requirements.txt
BIN
requirements.txt
Binary file not shown.
@@ -44,9 +44,9 @@ python_requires = >=3.8
|
||||
# For more information, check out https://semver.org/.
|
||||
install_requires =
|
||||
importlib-metadata
|
||||
cryptography~=44.0.1
|
||||
websockets~=15.0.0
|
||||
python-socks[asyncio]~=2.5.3
|
||||
cryptography~=46.0.5
|
||||
websockets~=16.0.0
|
||||
python-socks[asyncio]~=2.8.1
|
||||
|
||||
|
||||
[options.packages.find]
|
||||
|
||||
@@ -8,7 +8,7 @@ else:
|
||||
|
||||
try:
|
||||
# Change here if project is renamed and does not equal the package name
|
||||
dist_name = "meshctrl"
|
||||
dist_name = "libmeshctrl"
|
||||
__version__ = version(dist_name)
|
||||
except PackageNotFoundError: # pragma: no cover
|
||||
__version__ = "unknown"
|
||||
@@ -24,4 +24,4 @@ from . import files
|
||||
from . import exceptions
|
||||
from . import device
|
||||
from . import mesh
|
||||
from . import user_group
|
||||
from . import user_group
|
||||
|
||||
@@ -295,6 +295,23 @@ class Device(object):
|
||||
'''
|
||||
return await self._session.reset_devices(self.nodeid, timeout=timeout)
|
||||
|
||||
async def remove(self, timeout=None):
|
||||
'''
|
||||
Remove device from MeshCentral
|
||||
|
||||
Args:
|
||||
nodeids (str|list[str]): nodeid(s) of the device(s) that have to be removed
|
||||
timeout (int): duration in seconds to wait for a response before throwing an error
|
||||
|
||||
Returns:
|
||||
bool: True on success, raise otherwise
|
||||
|
||||
Raises:
|
||||
:py:class:`~meshctrl.exceptions.SocketError`: Info about socket closure
|
||||
asyncio.TimeoutError: Command timed out
|
||||
'''
|
||||
return self._session.remove_devices(self.nodeid, timeout)
|
||||
|
||||
async def sleep(self, timeout=None):
|
||||
'''
|
||||
Sleep device
|
||||
|
||||
@@ -157,7 +157,7 @@ class Files(tunnel.Tunnel):
|
||||
|
||||
async def rm(self, path, files, recursive=False, timeout=None):
|
||||
"""
|
||||
Create a directory on the device. This API doesn't error if the file doesn't exist.
|
||||
Remove a set of files or directories from the device. This API doesn't error if the file doesn't exist.
|
||||
|
||||
Args:
|
||||
path (str): Directory from which to delete files
|
||||
|
||||
@@ -10,6 +10,8 @@ import io
|
||||
import ssl
|
||||
import urllib
|
||||
from python_socks.async_.asyncio import Proxy
|
||||
from platform import python_version
|
||||
from . import __version__
|
||||
from . import constants
|
||||
from . import exceptions
|
||||
from . import util
|
||||
@@ -45,7 +47,8 @@ class Session(object):
|
||||
closed (asyncio.Event): Event that occurs when the session closes permanently
|
||||
'''
|
||||
|
||||
def __init__(self, url, user=None, domain=None, password=None, loginkey=None, proxy=None, token=None, ignore_ssl=False, auto_reconnect=False):
|
||||
def __init__(self, url, user=None, domain=None, password=None, loginkey=None, proxy=None, token=None, ignore_ssl=False, auto_reconnect=False, user_agent_header=None):
|
||||
default_user_agent_header = f"Python/{python_version()} websockets/{websockets.__version__} pylibmeshctrl/{__version__}"
|
||||
parsed = urllib.parse.urlparse(url)
|
||||
|
||||
if parsed.scheme not in ("wss", "ws"):
|
||||
@@ -106,6 +109,10 @@ class Session(object):
|
||||
self._file_tunnels = {}
|
||||
self._ignore_ssl = ignore_ssl
|
||||
self.auto_reconnect = auto_reconnect
|
||||
if user_agent_header:
|
||||
self.user_agent_header = user_agent_header
|
||||
else:
|
||||
self.user_agent_header = default_user_agent_header
|
||||
|
||||
self._eventer = util.Eventer()
|
||||
|
||||
@@ -144,7 +151,7 @@ class Session(object):
|
||||
|
||||
|
||||
options["additional_headers"] = headers
|
||||
async for websocket in websockets.asyncio.client.connect(self.url, proxy=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, max_size=None, user_agent_header=self.user_agent_header, **options):
|
||||
self.alive = True
|
||||
self._socket_open.set()
|
||||
try:
|
||||
@@ -177,7 +184,7 @@ class Session(object):
|
||||
async def _listen_data_task(self, websocket):
|
||||
async for message in websocket:
|
||||
await self._eventer.emit("raw", message)
|
||||
# Meshcentral does pong wrong and breaks our parsing, so fix it here.
|
||||
# Meshcentral does pong wrong and breaks our parsing, so fix it here. This is fixed now, but we want compatibility with old versions.
|
||||
if message == '{action:"pong"}':
|
||||
message = '{"action":"pong"}'
|
||||
|
||||
@@ -233,23 +240,28 @@ class Session(object):
|
||||
async def __aexit__(self, exc_t, exc_v, exc_tb):
|
||||
await self.close()
|
||||
|
||||
@util._check_socket
|
||||
async def _send_command(self, data, name, timeout=None):
|
||||
id = f"meshctrl_{name}_{self._get_command_id()}"
|
||||
def _generate_response_id(self, name):
|
||||
responseid = f"meshctrl_{name}_{self._get_command_id()}"
|
||||
# This fixes a very theoretical bug with hash colisions in the case of an infinite int of requests. Now the bug will only happen if there are currently 2**32-1 of the same type of request going out at the same time
|
||||
while id in self._inflight:
|
||||
id = f"meshctrl_{name}_{self._get_command_id()}"
|
||||
while responseid in self._inflight:
|
||||
responseid = f"meshctrl_{name}_{self._get_command_id()}"
|
||||
return responseid
|
||||
|
||||
self._inflight.add(id)
|
||||
@util._check_socket
|
||||
async def _send_command(self, data, name, timeout=None, responseid=None):
|
||||
if responseid is None:
|
||||
responseid = self._generate_response_id(name)
|
||||
|
||||
self._inflight.add(responseid)
|
||||
responded = asyncio.Event()
|
||||
response = None
|
||||
async def _(data):
|
||||
self._inflight.remove(id)
|
||||
self._inflight.remove(responseid)
|
||||
nonlocal response
|
||||
response = data
|
||||
responded.set()
|
||||
self._eventer.once(id, _)
|
||||
await self._message_queue.put(json.dumps(data | {"tag": id, "responseid": id}))
|
||||
self._eventer.once(responseid, _)
|
||||
await self._message_queue.put(json.dumps(data | {"tag": responseid, "responseid": responseid}))
|
||||
await asyncio.wait_for(responded.wait(), timeout=timeout)
|
||||
if isinstance(response, Exception):
|
||||
raise response
|
||||
@@ -564,7 +576,7 @@ class Session(object):
|
||||
while True:
|
||||
data = await event_queue.get()
|
||||
if filter and not util.compare_dict(filter, data):
|
||||
continue
|
||||
continue
|
||||
yield data
|
||||
finally:
|
||||
self._eventer.off("server_event", _)
|
||||
@@ -1055,6 +1067,30 @@ class Session(object):
|
||||
raise exceptions.ServerError(data["result"])
|
||||
return True
|
||||
|
||||
async def remove_devices(self, nodeids, timeout=None):
|
||||
'''
|
||||
Remove device(s) from MeshCentral
|
||||
|
||||
Args:
|
||||
nodeids (str|list[str]): nodeid(s) of the device(s) that have to be removed
|
||||
timeout (int): duration in seconds to wait for a response before throwing an error
|
||||
|
||||
Returns:
|
||||
bool: True on success, raise otherwise
|
||||
|
||||
Raises:
|
||||
:py:class:`~meshctrl.exceptions.ServerError`: Error text from server if there is a failure
|
||||
:py:class:`~meshctrl.exceptions.SocketError`: Info about socket closure
|
||||
asyncio.TimeoutError: Command timed out
|
||||
'''
|
||||
if isinstance(nodeids, str):
|
||||
nodeids = [nodeids]
|
||||
|
||||
data = await self._send_command({ "action": 'removedevices', "nodeids": nodeids}, "remove_devices", timeout=timeout)
|
||||
|
||||
if data.get("result", "ok").lower() != "ok":
|
||||
raise exceptions.ServerError(data["result"])
|
||||
return True
|
||||
|
||||
async def add_device_group(self, name, description="", amtonly=False, features=0, consent=0, timeout=None):
|
||||
'''
|
||||
@@ -1428,7 +1464,7 @@ class Session(object):
|
||||
|
||||
async def run_command(self, nodeids, command, powershell=False, runasuser=False, runasuseronly=False, ignore_output=False, timeout=None):
|
||||
'''
|
||||
Run a command on any number of nodes. WARNING: Non namespaced call. Calling this function again before it returns may cause unintended consequences.
|
||||
Run a command on any number of nodes. WARNING: Non namespaced call on older versions of meshcentral (<1.0.22). Calling this function on those versions again before it returns may cause unintended consequences.
|
||||
|
||||
Args:
|
||||
nodeids (str|list[str]): Unique ids of nodes on which to run the command
|
||||
@@ -1466,46 +1502,166 @@ class Session(object):
|
||||
return nid
|
||||
|
||||
result = {n: {"complete": False, "result": [], "command": command} for n in nodeids}
|
||||
async def _():
|
||||
console_result = {n: {"complete": False, "result": [], "command": command} for n in nodeids}
|
||||
reply_result = {n: {"complete": False, "result": [], "command": command} for n in nodeids}
|
||||
async def _console():
|
||||
async for event in self.events({"action": "msg", "type": "console"}):
|
||||
node = match_nodeid(event["nodeid"], nodeids)
|
||||
if node:
|
||||
if event["value"] == "Run commands completed.":
|
||||
result.setdefault(node, {})["complete"] = True
|
||||
if all(_["complete"] for key, _ in result.items()):
|
||||
console_result.setdefault(node, {})["complete"] = True
|
||||
if all(_["complete"] for key, _ in console_result.items()):
|
||||
break
|
||||
continue
|
||||
elif (event["value"].startswith("Run commands")):
|
||||
continue
|
||||
result[node]["result"].append(event["value"])
|
||||
async def __(command):
|
||||
data = await self._send_command(command, "run_command", timeout=timeout)
|
||||
console_result[node]["result"].append(event["value"])
|
||||
|
||||
if data.get("result", "ok").lower() != "ok":
|
||||
async def _reply(responseid, data=None):
|
||||
# Returns True when all results are in, Falsey otherwise
|
||||
def _parse_event(event):
|
||||
node = match_nodeid(event["nodeid"], nodeids)
|
||||
if node:
|
||||
reply_result.setdefault(node, {})["complete"] = True
|
||||
reply_result[node]["result"].append(event["result"])
|
||||
if all(_["complete"] for key, _ in reply_result.items()):
|
||||
return True
|
||||
if data is not None:
|
||||
if _parse_event(data):
|
||||
return
|
||||
async for event in self.events({"action": "msg", "type": "runcommands", "responseid":responseid}):
|
||||
if _parse_event(event):
|
||||
break
|
||||
|
||||
async def __(command, tg, tasks):
|
||||
nonlocal result
|
||||
responseid = self._generate_response_id("run_command")
|
||||
|
||||
if not ignore_output:
|
||||
reply_task = tg.create_task(asyncio.wait_for(_reply(responseid), timeout=timeout))
|
||||
# We still need to parse the console results because it sends them without namespace, this will likely break older versions of meshcentral
|
||||
console_task = tg.create_task(asyncio.wait_for(_console(), timeout=timeout))
|
||||
data = await self._send_command(command, "run_command", timeout=timeout, responseid=responseid)
|
||||
|
||||
if data.get("type", None) != "runcommands" and data.get("result", "ok").lower() != "ok":
|
||||
raise exceptions.ServerError(data["result"])
|
||||
|
||||
expect_response = False
|
||||
if not ignore_output:
|
||||
userid = (await self.user_info())["_id"]
|
||||
for n in nodeids:
|
||||
device_info = await self.device_info(n, timeout=timeout)
|
||||
try:
|
||||
permissions = device_info.mesh.links.get(userid, {}).get("rights",constants.DeviceRights.norights)\
|
||||
# This should work for device rights, but it only seems to work for mesh rights. Not sure why, but I can't get the events to show up when the user only has individual device rights
|
||||
# |device_info.get("links", {}).get(userid, {}).get("rights", constants.DeviceRights.norights)
|
||||
# If we don't have agentconsole rights, we won't be able te read the output, so fill in blanks on this node
|
||||
if not permissions&constants.DeviceRights.agentconsole:
|
||||
elif data.get("type", None) != "runcommands" and data.get("result", "ok").lower() == "ok":
|
||||
expect_response = False
|
||||
if not ignore_output:
|
||||
reply_task.cancel()
|
||||
result = console_result
|
||||
userid = (await self.user_info())["_id"]
|
||||
for n in nodeids:
|
||||
device_info = await self.device_info(n, timeout=timeout)
|
||||
try:
|
||||
permissions = device_info.mesh.links.get(userid, {}).get("rights",constants.DeviceRights.norights)
|
||||
# This should work for device rights, but it only seems to work for mesh rights. Not sure why, but I can't get the events to show up when the user only has individual device rights
|
||||
# |device_info.get("links", {}).get(userid, {}).get("rights", constants.DeviceRights.norights)
|
||||
# If we don't have agentconsole rights, we won't be able te read the output, so fill in blanks on this node
|
||||
if not permissions&constants.DeviceRights.agentconsole:
|
||||
result[n]["complete"] = True
|
||||
else:
|
||||
expect_response = True
|
||||
except AttributeError:
|
||||
result[n]["complete"] = True
|
||||
else:
|
||||
expect_response = True
|
||||
except AttributeError:
|
||||
result[n]["complete"] = True
|
||||
if expect_response:
|
||||
tasks.append(console_task)
|
||||
else:
|
||||
console_task.cancel()
|
||||
elif data.get("type", None) == "runcommands":
|
||||
console_task.cancel()
|
||||
if not ignore_output:
|
||||
result = reply_result
|
||||
tasks.append(reply_task)
|
||||
else:
|
||||
# if not ignore_output:
|
||||
console_task.cancel()
|
||||
reply_task.cancel()
|
||||
raise exceptions.ServerError(f"Unrecognized response: {data}")
|
||||
|
||||
tasks = []
|
||||
async with asyncio.TaskGroup() as tg:
|
||||
if expect_response:
|
||||
tasks.append(tg.create_task(asyncio.wait_for(_(), timeout=timeout)))
|
||||
tasks.append(tg.create_task(__({ "action": 'runcommands', "nodeids": nodeids, "type": (2 if powershell else 0), "cmds": command, "runAsUser": runAsUser })))
|
||||
tasks.append(tg.create_task(__({ "action": 'runcommands', "nodeids": nodeids, "type": (2 if powershell else 0), "cmds": command, "runAsUser": runAsUser, "reply": True}, tg, tasks)))
|
||||
|
||||
return {n: v | {"result": "".join(v["result"])} for n,v in result.items()}
|
||||
|
||||
async def run_console_command(self, nodeids, command, powershell=False, runasuser=False, runasuseronly=False, ignore_output=False, timeout=None):
|
||||
'''
|
||||
Run a mesh console command on any number of nodes. WARNING: Non namespaced call. Calling this function again before it returns may cause unintended consequences.
|
||||
|
||||
Args:
|
||||
nodeids (str|list[str]): Unique ids of nodes on which to run the command
|
||||
command (str): Command to run
|
||||
ignore_output (bool): Don't bother trying to get the output. Every device will return an empty string for its result.
|
||||
timeout (int): duration in seconds to wait for a response before throwing an error
|
||||
|
||||
Returns:
|
||||
dict[str, ~meshctrl.types.RunCommandResponse]: Dict containing mapped output of the commands by device
|
||||
|
||||
Raises:
|
||||
:py:class:`~meshctrl.exceptions.ServerError`: Error text from server if there is a failure
|
||||
:py:class:`~meshctrl.exceptions.SocketError`: Info about socket closure
|
||||
ValueError: `Invalid device id` if device is not found
|
||||
asyncio.TimeoutError: Command timed out
|
||||
'''
|
||||
if isinstance(nodeids, str):
|
||||
nodeids = [nodeids]
|
||||
|
||||
def match_nodeid(id, ids):
|
||||
for nid in ids:
|
||||
if (nid == id):
|
||||
return nid
|
||||
if (nid[6:] == id):
|
||||
return nid
|
||||
if (f"node//{nid}" == id):
|
||||
return nid
|
||||
|
||||
result = {n: {"complete": False, "result": [], "command": command} for n in nodeids}
|
||||
async def _console():
|
||||
async for event in self.events({"action": "msg", "type": "console"}):
|
||||
# We can pick up run commands here sometimes if they are run in quick succession. Try to avoid that.
|
||||
if (not event["value"].startswith("Run commands")):
|
||||
node = match_nodeid(event["nodeid"], nodeids)
|
||||
if node:
|
||||
result[node]["result"].append(event["value"])
|
||||
result.setdefault(node, {})["complete"] = True
|
||||
if all(_["complete"] for key, _ in result.items()):
|
||||
break
|
||||
async def __(command, tg, tasks):
|
||||
console_task = tg.create_task(asyncio.wait_for(_console(), timeout=timeout))
|
||||
data = await self._send_command(command, "run_console_command", timeout=timeout)
|
||||
|
||||
if data.get("type", None) != "runcommands" and data.get("result", "ok").lower() != "ok":
|
||||
raise exceptions.ServerError(data["result"])
|
||||
elif data.get("type", None) != "runcommands" and data.get("result", "ok").lower() == "ok":
|
||||
expect_response = False
|
||||
|
||||
if not ignore_output:
|
||||
userid = (await self.user_info())["_id"]
|
||||
for n in nodeids:
|
||||
device_info = await self.device_info(n, timeout=timeout)
|
||||
try:
|
||||
permissions = device_info.mesh.links.get(userid, {}).get("rights",constants.DeviceRights.norights)\
|
||||
# This should work for device rights, but it only seems to work for mesh rights. Not sure why, but I can't get the events to show up when the user only has individual device rights
|
||||
# |device_info.get("links", {}).get(userid, {}).get("rights", constants.DeviceRights.norights)
|
||||
# If we don't have agentconsole rights, we won't be able te read the output, so fill in blanks on this node
|
||||
if not permissions&constants.DeviceRights.agentconsole:
|
||||
result[n]["complete"] = True
|
||||
else:
|
||||
expect_response = True
|
||||
except AttributeError:
|
||||
result[n]["complete"] = True
|
||||
if expect_response:
|
||||
tasks.append(console_task)
|
||||
else:
|
||||
console_task.cancel()
|
||||
else:
|
||||
console_task.cancel()
|
||||
raise exceptions.ServerError(f"Unrecognized response: {data}")
|
||||
|
||||
tasks = []
|
||||
async with asyncio.TaskGroup() as tg:
|
||||
tasks.append(tg.create_task(__({ "action": 'runcommands', "nodeids": nodeids, "type": 4, "cmds": command}, tg, tasks)))
|
||||
|
||||
return {n: v | {"result": "".join(v["result"])} for n,v in result.items()}
|
||||
|
||||
|
||||
@@ -4,7 +4,10 @@ import subprocess
|
||||
import time
|
||||
import json
|
||||
import atexit
|
||||
import pytest
|
||||
try:
|
||||
import pytest
|
||||
except:
|
||||
pass
|
||||
import requests
|
||||
thisdir = os.path.abspath(os.path.dirname(__file__))
|
||||
|
||||
@@ -37,7 +40,9 @@ class Agent(object):
|
||||
self._clienturl = clienturl
|
||||
self._dockerurl = dockerurl
|
||||
r = requests.post(f"{self._clienturl}/add-agent", json={"url": f"{self._dockerurl}", "meshid": self.meshid})
|
||||
self.nodeid = r.json()["id"]
|
||||
agent_json = r.json()
|
||||
self.nodeid = agent_json["id"]
|
||||
self.nodehex = agent_json["hex"]
|
||||
|
||||
def __enter__(self):
|
||||
return self
|
||||
@@ -66,6 +71,9 @@ class TestEnvironment(object):
|
||||
if not self._wait_for_meshcentral():
|
||||
self.__exit__(None, None, None)
|
||||
raise Exception("Failed to create docker instance")
|
||||
if not self._wait_for_client_server():
|
||||
self.__exit__(None, None, None)
|
||||
raise Exception("Failed to create client server")
|
||||
return self
|
||||
|
||||
def _wait_for_meshcentral(self, timeout=30):
|
||||
@@ -88,6 +96,26 @@ class TestEnvironment(object):
|
||||
return False
|
||||
return True
|
||||
|
||||
def _wait_for_client_server(self, timeout=30):
|
||||
start = time.time()
|
||||
while time.time() - start < timeout:
|
||||
try:
|
||||
data = subprocess.check_output(["docker", "inspect", "meshctrl-client", "--format='{{json .State.Health}}'"], cwd=thisdir, stderr=subprocess.DEVNULL)
|
||||
# docker outputs for humans, not computers. This is the easiest way to chop off the ends
|
||||
data = json.loads(data.strip()[1:-1])
|
||||
except Exception as e:
|
||||
time.sleep(1)
|
||||
continue
|
||||
try:
|
||||
if data["Status"] == "healthy":
|
||||
break
|
||||
except:
|
||||
pass
|
||||
time.sleep(1)
|
||||
else:
|
||||
return False
|
||||
return True
|
||||
|
||||
def __exit__(self, exc_t, exc_v, exc_tb):
|
||||
pass
|
||||
|
||||
@@ -110,10 +138,13 @@ def _kill_docker_process():
|
||||
|
||||
atexit.register(_kill_docker_process)
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def env():
|
||||
with TestEnvironment() as e:
|
||||
yield e
|
||||
try:
|
||||
@pytest.fixture(scope="session")
|
||||
def env():
|
||||
with TestEnvironment() as e:
|
||||
yield e
|
||||
except:
|
||||
pass
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
FROM python:3.12
|
||||
FROM python:3.13
|
||||
WORKDIR /usr/local/app
|
||||
|
||||
# Install the application dependencies
|
||||
|
||||
@@ -9,6 +9,8 @@ services:
|
||||
image: client
|
||||
build:
|
||||
dockerfile: client.dockerfile
|
||||
sysctls:
|
||||
net.ipv6.conf.all.disable_ipv6: 1
|
||||
ports:
|
||||
- 5000:5000
|
||||
depends_on:
|
||||
@@ -20,6 +22,10 @@ services:
|
||||
# - ./meshcentral/mongodb_data:/data/db
|
||||
networks:
|
||||
- meshctrl
|
||||
healthcheck:
|
||||
test: curl --fail http://localhost:5000/ || exit 1
|
||||
interval: 5s
|
||||
timeout: 120s
|
||||
extra_hosts:
|
||||
- "host.docker.internal:host-gateway"
|
||||
|
||||
@@ -28,6 +34,8 @@ services:
|
||||
container_name: meshctrl-meshcentral
|
||||
# use the official meshcentral container
|
||||
image: meshcentral
|
||||
sysctls:
|
||||
net.ipv6.conf.all.disable_ipv6: 1
|
||||
build:
|
||||
dockerfile: meshcentral.dockerfile
|
||||
ports:
|
||||
@@ -55,6 +63,8 @@ services:
|
||||
image: ubuntu/squid:latest
|
||||
restart: unless-stopped
|
||||
container_name: meshctrl-squid
|
||||
sysctls:
|
||||
net.ipv6.conf.all.disable_ipv6: 1
|
||||
ports:
|
||||
- 3128:3128
|
||||
|
||||
|
||||
@@ -1,9 +1,19 @@
|
||||
# Logs are managed by logrotate on Debian
|
||||
logfile_rotate 0
|
||||
|
||||
acl all src all
|
||||
acl to_ipv6 dst ipv6
|
||||
acl from_ipv6 src ipv6
|
||||
|
||||
acl to_ipv4 dst ipv4
|
||||
acl from_ipv4 src ipv4
|
||||
|
||||
#acl all src all
|
||||
acl Safe_ports port 8086
|
||||
acl SSS_ports port 8086
|
||||
http_access allow to_ipv4
|
||||
http_access allow from_ipv4
|
||||
http_access deny to_ipv6
|
||||
http_access deny from_ipv6
|
||||
http_access allow all
|
||||
debug_options ALL,0 85,2 88,2
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
FROM ghcr.io/ylianst/meshcentral:latest
|
||||
FROM ghcr.io/ylianst/meshcentral:1.1.56
|
||||
RUN apk add curl
|
||||
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"]
|
||||
ENTRYPOINT ["python3", "/opt/meshcentral/scripts/create_users.py"]
|
||||
@@ -53,7 +53,7 @@ def add_agent():
|
||||
time.sleep(.1)
|
||||
else:
|
||||
raise Exception(f"Failed to start agent: {text}")
|
||||
return {"id": agent_id}
|
||||
return {"id": agent_id, "hex": agent_hex}
|
||||
|
||||
@api.route('/remove-agent/<agentid>', methods=['POST'])
|
||||
def remove_agent(agentid):
|
||||
@@ -62,7 +62,7 @@ def remove_agent(agentid):
|
||||
|
||||
@api.route('/', methods=['GET'])
|
||||
def slash():
|
||||
return [_["id"] for _ in agents]
|
||||
return [value["id"] for key, value in agents.items()]
|
||||
|
||||
if __name__ == '__main__':
|
||||
api.run()
|
||||
@@ -7,9 +7,9 @@ thisdir = os.path.abspath(os.path.dirname(__file__))
|
||||
with open(os.path.join(thisdir, "users.json")) as infile:
|
||||
users = json.load(infile)
|
||||
for username, password in users.items():
|
||||
subprocess.check_output(["node", "/opt/meshcentral/meshcentral", "--createaccount", username, "--pass", password, "--name", username])
|
||||
print(subprocess.check_output(["node", "/opt/meshcentral/meshcentral", "--createaccount", username, "--pass", password, "--name", username]))
|
||||
|
||||
|
||||
subprocess.check_output(["node", "/opt/meshcentral/meshcentral", "--adminaccount", "admin"])
|
||||
print(subprocess.check_output(["node", "/opt/meshcentral/meshcentral", "--adminaccount", "admin"]))
|
||||
|
||||
subprocess.call(["bash", "/opt/meshcentral/startup.sh"])
|
||||
subprocess.call(["bash", "/opt/meshcentral/entrypoint.sh"])
|
||||
@@ -1,6 +1,6 @@
|
||||
requests
|
||||
pytest-asyncio
|
||||
cffi==1.17.1
|
||||
cryptography~=44.0.1
|
||||
pycparser==2.22
|
||||
websockets~=15.0.0
|
||||
cryptography~=46.0.5
|
||||
websockets~=16.0.0
|
||||
@@ -9,16 +9,7 @@ import requests
|
||||
|
||||
async def test_sanity(env):
|
||||
async with meshctrl.Session(env.mcurl, user="unprivileged", password=env.users["unprivileged"], ignore_ssl=True) as s:
|
||||
got_pong = asyncio.Event()
|
||||
async def _():
|
||||
async for raw in s.raw_messages():
|
||||
if raw == '{action:"pong"}':
|
||||
got_pong.set()
|
||||
break
|
||||
ping_task = None
|
||||
async with asyncio.TaskGroup() as tg:
|
||||
tg.create_task(asyncio.wait_for(_(), timeout=5))
|
||||
tg.create_task(asyncio.wait_for(got_pong.wait(), timeout=5))
|
||||
ping_task = tg.create_task(s.ping(timeout=10))
|
||||
print("\ninfo ping: {}\n".format(ping_task.result()))
|
||||
print("\ninfo user_info: {}\n".format(await s.user_info()))
|
||||
|
||||
@@ -251,7 +251,41 @@ async def test_mesh_device(env):
|
||||
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
|
||||
# Test run_commands ignore output
|
||||
r = await admin_session.run_command([agent.nodeid, agent2.nodeid], "ls", ignore_output=True, timeout=10)
|
||||
print("\ninfo run_command ignore_output: {}\n".format(r))
|
||||
assert r[agent.nodeid]["result"] == '', "Ignore output returned an output"
|
||||
assert r[agent2.nodeid]["result"] == '', "Ignore output returned an output"
|
||||
|
||||
# Test run_commands missing device
|
||||
try:
|
||||
await admin_session.run_command([agent.nodeid, "notanid"], "ls", timeout=10)
|
||||
except* (meshctrl.exceptions.ServerError, ValueError):
|
||||
pass
|
||||
else:
|
||||
raise Exception("Run command on a device that doesn't exist did not raise an exception")
|
||||
|
||||
# Test run_console_command
|
||||
r = await admin_session.run_console_command([agent.nodeid, agent2.nodeid], "info", timeout=10)
|
||||
print("\ninfo run_console_command: {}\n".format(r))
|
||||
assert agent.nodeid in r[agent.nodeid]["result"], "Run console command gave bad response"
|
||||
assert agent2.nodeid in r[agent2.nodeid]["result"], "Run console command gave bad response"
|
||||
|
||||
# Test run_console_command ignore output
|
||||
r = await admin_session.run_console_command([agent.nodeid, agent2.nodeid], "info", timeout=10, ignore_output=True)
|
||||
print("\ninfo run_console_command ignore_output: {}\n".format(r))
|
||||
assert r[agent.nodeid]["result"] == '', "Ignore output returned an output"
|
||||
assert r[agent2.nodeid]["result"] == '', "Ignore output returned an output"
|
||||
|
||||
# Test run_commands missing device
|
||||
try:
|
||||
await admin_session.run_console_command([agent.nodeid, "notanid"], "info", timeout=10)
|
||||
except* (meshctrl.exceptions.ServerError, ValueError):
|
||||
pass
|
||||
else:
|
||||
raise Exception("Run console command on a device that doesn't exist did not raise an exception")
|
||||
|
||||
# Test run commands with individual device permissions
|
||||
try:
|
||||
await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10)
|
||||
except* (meshctrl.exceptions.ServerError, ValueError):
|
||||
@@ -266,7 +300,7 @@ async def test_mesh_device(env):
|
||||
else:
|
||||
raise Exception("Unprivileged user has access to device it should not")
|
||||
|
||||
assert (await admin_session.add_users_to_device((await unprivileged_session.user_info())["_id"], agent.nodeid, meshctrl.constants.MeshRights.norights)), "Failed to add user to device"
|
||||
assert (await admin_session.add_users_to_device((await unprivileged_session.user_info())["_id"], agent.nodeid, meshctrl.constants.DeviceRights.norights)), "Failed to add user to device"
|
||||
|
||||
try:
|
||||
await unprivileged_session.run_command(agent.nodeid, "ls", ignore_output=True, timeout=10)
|
||||
@@ -284,12 +318,14 @@ async def test_mesh_device(env):
|
||||
|
||||
assert r.links[(await unprivileged_session.user_info())["_id"]]["rights"] == meshctrl.constants.DeviceRights.norights, "Unprivileged user has too many rights!"
|
||||
|
||||
assert (await admin_session.add_users_to_device([(await unprivileged_session.user_info())["_id"]], agent.nodeid, meshctrl.constants.DeviceRights.remotecontrol|meshctrl.constants.DeviceRights.agentconsole|meshctrl.constants.DeviceRights.remotecommands)), "Failed to modify user's permissions"
|
||||
assert (await admin_session.add_users_to_device([(await unprivileged_session.user_info())["_id"]], agent.nodeid, meshctrl.constants.DeviceRights.fullrights)), "Failed to modify user's permissions"
|
||||
|
||||
assert (await unprivileged_session.device_info(agent.nodeid, timeout=10)).links[(await unprivileged_session.user_info())["_id"]]["rights"] == meshctrl.constants.DeviceRights.remotecontrol|meshctrl.constants.DeviceRights.agentconsole|meshctrl.constants.DeviceRights.remotecommands, "Adding permissions did not update unprivileged user."
|
||||
assert (await unprivileged_session.device_info(agent.nodeid, timeout=10)).links[(await unprivileged_session.user_info())["_id"]]["rights"] == meshctrl.constants.DeviceRights.fullrights, "Adding permissions did not update unprivileged user."
|
||||
|
||||
# For now, this expects no response. If we ever figure out why the server isn't sending console information te us when it should, fix this.
|
||||
# For now, this expects no response. If we ever figure out why the server isn't sending console information to us when it should, fix this.
|
||||
# assert "meshagent" in (await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10))[agent.nodeid]["result"], "ls gave incorrect data"
|
||||
# Meshcentral has a 10 second cache on user perms.
|
||||
#await asyncio.sleep(15)
|
||||
await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10)
|
||||
|
||||
assert await admin_session.move_to_device_group(agent.nodeid, mesh2.meshid, timeout=5), "Failed to move mesh to new device group"
|
||||
@@ -303,7 +339,7 @@ async def test_mesh_device(env):
|
||||
|
||||
assert await admin_session.move_to_device_group([agent.nodeid], mesh.name, isname=True, timeout=5), "Failed to move mesh to new device group by name"
|
||||
|
||||
# For now, this expe namects no response. If we ever figure out why the server isn't sending console information te us when it should, fix this.
|
||||
# For now, this expects no response. If we ever figure out why the server isn't sending console information te us when it should, fix this.
|
||||
# assert "meshagent" in (await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10))[agent.nodeid]["result"], "ls gave incorrect data"
|
||||
try:
|
||||
await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10)
|
||||
@@ -313,6 +349,15 @@ async def test_mesh_device(env):
|
||||
r = await admin_session.remove_users_from_device_group((await privileged_session.user_info())["_id"], mesh.meshid, timeout=10)
|
||||
print("\ninfo remove_users_from_device_group: {}\n".format(r))
|
||||
assert (r[(await privileged_session.user_info())["_id"]]["success"]), "Failed to remove user from device group"
|
||||
|
||||
await admin_session.remove_devices(agent2.nodeid, timeout=10)
|
||||
try:
|
||||
await admin_session.device_info(agent2.nodeid, timeout=10)
|
||||
except ValueError:
|
||||
pass
|
||||
else:
|
||||
raise Exception("Device not deleted")
|
||||
|
||||
assert (await admin_session.remove_users_from_device(agent.nodeid, (await unprivileged_session.user_info())["_id"], timeout=10)), "Failed to remove user from device"
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user