forked from Narcissus/pylibmeshctrl
Compare commits
52 Commits
fix/device
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
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 | ||
|
|
04c8f622de | ||
|
|
ccb5f1eb40 | ||
|
|
ce2cf2bfe1 | ||
|
|
a3b4962e7f | ||
|
|
5947e48c5b | ||
|
|
31a8f00cd0 | ||
|
|
871d36b334 | ||
|
|
59fb1f104e | ||
|
|
9bd3e10ed7 |
@@ -3,3 +3,4 @@ Contributors
|
|||||||
============
|
============
|
||||||
|
|
||||||
* Josiah Baldwin <jbaldwin8889@gmail.com>
|
* Josiah Baldwin <jbaldwin8889@gmail.com>
|
||||||
|
* Daan Selen <https://github.com/DaanSelen>
|
||||||
@@ -2,6 +2,56 @@
|
|||||||
Changelog
|
Changelog
|
||||||
=========
|
=========
|
||||||
|
|
||||||
|
version 1.3.2
|
||||||
|
=============
|
||||||
|
|
||||||
|
Improvments:
|
||||||
|
* 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
|
||||||
|
=============
|
||||||
|
|
||||||
|
Bugs:
|
||||||
|
* Fixed handling of meshcentral's list_devices return with details=True
|
||||||
|
|
||||||
|
version 1.2.0
|
||||||
|
=============
|
||||||
|
|
||||||
|
Bugs:
|
||||||
|
* Fixed agent sometimes being None causing an oxception
|
||||||
|
* Fixed bad code in device_open_url
|
||||||
|
|
||||||
|
Features:
|
||||||
|
* Changed websockets version to 15. This now uses the proxy implemention from that library, instead of the previous hack.
|
||||||
|
* Added lastaddr and lastconnect to list_devices API
|
||||||
|
|
||||||
version 1.1.2
|
version 1.1.2
|
||||||
=============
|
=============
|
||||||
Bugs:
|
Bugs:
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ else:
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
# Change here if project is renamed and does not equal the package name
|
# Change here if project is renamed and does not equal the package name
|
||||||
dist_name = "meshctrl"
|
dist_name = "libmeshctrl"
|
||||||
__version__ = version(dist_name)
|
__version__ = version(dist_name)
|
||||||
except PackageNotFoundError: # pragma: no cover
|
except PackageNotFoundError: # pragma: no cover
|
||||||
__version__ = "unknown"
|
__version__ = "unknown"
|
||||||
|
|||||||
@@ -295,6 +295,23 @@ class Device(object):
|
|||||||
'''
|
'''
|
||||||
return await self._session.reset_devices(self.nodeid, timeout=timeout)
|
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):
|
async def sleep(self, timeout=None):
|
||||||
'''
|
'''
|
||||||
Sleep device
|
Sleep device
|
||||||
|
|||||||
@@ -157,7 +157,7 @@ class Files(tunnel.Tunnel):
|
|||||||
|
|
||||||
async def rm(self, path, files, recursive=False, timeout=None):
|
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:
|
Args:
|
||||||
path (str): Directory from which to delete files
|
path (str): Directory from which to delete files
|
||||||
|
|||||||
@@ -10,6 +10,8 @@ import io
|
|||||||
import ssl
|
import ssl
|
||||||
import urllib
|
import urllib
|
||||||
from python_socks.async_.asyncio import Proxy
|
from python_socks.async_.asyncio import Proxy
|
||||||
|
from platform import python_version
|
||||||
|
from . import __version__
|
||||||
from . import constants
|
from . import constants
|
||||||
from . import exceptions
|
from . import exceptions
|
||||||
from . import util
|
from . import util
|
||||||
@@ -45,7 +47,8 @@ class Session(object):
|
|||||||
closed (asyncio.Event): Event that occurs when the session closes permanently
|
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)
|
parsed = urllib.parse.urlparse(url)
|
||||||
|
|
||||||
if parsed.scheme not in ("wss", "ws"):
|
if parsed.scheme not in ("wss", "ws"):
|
||||||
@@ -106,6 +109,10 @@ class Session(object):
|
|||||||
self._file_tunnels = {}
|
self._file_tunnels = {}
|
||||||
self._ignore_ssl = ignore_ssl
|
self._ignore_ssl = ignore_ssl
|
||||||
self.auto_reconnect = auto_reconnect
|
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()
|
self._eventer = util.Eventer()
|
||||||
|
|
||||||
@@ -144,7 +151,7 @@ class Session(object):
|
|||||||
|
|
||||||
|
|
||||||
options["additional_headers"] = headers
|
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.alive = True
|
||||||
self._socket_open.set()
|
self._socket_open.set()
|
||||||
try:
|
try:
|
||||||
@@ -177,7 +184,7 @@ class Session(object):
|
|||||||
async def _listen_data_task(self, websocket):
|
async def _listen_data_task(self, websocket):
|
||||||
async for message in websocket:
|
async for message in websocket:
|
||||||
await self._eventer.emit("raw", message)
|
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"}':
|
if message == '{action:"pong"}':
|
||||||
message = '{"action":"pong"}'
|
message = '{"action":"pong"}'
|
||||||
|
|
||||||
@@ -233,23 +240,28 @@ class Session(object):
|
|||||||
async def __aexit__(self, exc_t, exc_v, exc_tb):
|
async def __aexit__(self, exc_t, exc_v, exc_tb):
|
||||||
await self.close()
|
await self.close()
|
||||||
|
|
||||||
@util._check_socket
|
def _generate_response_id(self, name):
|
||||||
async def _send_command(self, data, name, timeout=None):
|
responseid = f"meshctrl_{name}_{self._get_command_id()}"
|
||||||
id = 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
|
# 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:
|
while responseid in self._inflight:
|
||||||
id = f"meshctrl_{name}_{self._get_command_id()}"
|
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()
|
responded = asyncio.Event()
|
||||||
response = None
|
response = None
|
||||||
async def _(data):
|
async def _(data):
|
||||||
self._inflight.remove(id)
|
self._inflight.remove(responseid)
|
||||||
nonlocal response
|
nonlocal response
|
||||||
response = data
|
response = data
|
||||||
responded.set()
|
responded.set()
|
||||||
self._eventer.once(id, _)
|
self._eventer.once(responseid, _)
|
||||||
await self._message_queue.put(json.dumps(data | {"tag": id, "responseid": id}))
|
await self._message_queue.put(json.dumps(data | {"tag": responseid, "responseid": responseid}))
|
||||||
await asyncio.wait_for(responded.wait(), timeout=timeout)
|
await asyncio.wait_for(responded.wait(), timeout=timeout)
|
||||||
if isinstance(response, Exception):
|
if isinstance(response, Exception):
|
||||||
raise response
|
raise response
|
||||||
@@ -478,7 +490,14 @@ class Session(object):
|
|||||||
if "result" in res0:
|
if "result" in res0:
|
||||||
raise exceptions.ServerError(res0["result"])
|
raise exceptions.ServerError(res0["result"])
|
||||||
if details:
|
if details:
|
||||||
nodes = json.loads(res0["data"])
|
nodes = res0["data"]
|
||||||
|
# Accept any number of nested strings, meshcentral is odd
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
nodes = json.loads(nodes)
|
||||||
|
except TypeError:
|
||||||
|
break
|
||||||
|
|
||||||
for node in nodes:
|
for node in nodes:
|
||||||
if node["node"].get("meshid", None):
|
if node["node"].get("meshid", None):
|
||||||
node["node"]["mesh"] = mesh.Mesh(node["node"].get("meshid"), self)
|
node["node"]["mesh"] = mesh.Mesh(node["node"].get("meshid"), self)
|
||||||
@@ -557,7 +576,7 @@ class Session(object):
|
|||||||
while True:
|
while True:
|
||||||
data = await event_queue.get()
|
data = await event_queue.get()
|
||||||
if filter and not util.compare_dict(filter, data):
|
if filter and not util.compare_dict(filter, data):
|
||||||
continue
|
continue
|
||||||
yield data
|
yield data
|
||||||
finally:
|
finally:
|
||||||
self._eventer.off("server_event", _)
|
self._eventer.off("server_event", _)
|
||||||
@@ -1048,6 +1067,30 @@ class Session(object):
|
|||||||
raise exceptions.ServerError(data["result"])
|
raise exceptions.ServerError(data["result"])
|
||||||
return True
|
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):
|
async def add_device_group(self, name, description="", amtonly=False, features=0, consent=0, timeout=None):
|
||||||
'''
|
'''
|
||||||
@@ -1421,7 +1464,7 @@ class Session(object):
|
|||||||
|
|
||||||
async def run_command(self, nodeids, command, powershell=False, runasuser=False, runasuseronly=False, ignore_output=False, timeout=None):
|
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:
|
Args:
|
||||||
nodeids (str|list[str]): Unique ids of nodes on which to run the command
|
nodeids (str|list[str]): Unique ids of nodes on which to run the command
|
||||||
@@ -1458,47 +1501,164 @@ class Session(object):
|
|||||||
if (f"node//{nid}" == id):
|
if (f"node//{nid}" == id):
|
||||||
return nid
|
return nid
|
||||||
|
|
||||||
result = {n: {"complete": False, "result": [], "command": command} for n in nodeids}
|
result = None
|
||||||
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"}):
|
async for event in self.events({"action": "msg", "type": "console"}):
|
||||||
node = match_nodeid(event["nodeid"], nodeids)
|
node = match_nodeid(event["nodeid"], nodeids)
|
||||||
if node:
|
if node:
|
||||||
if event["value"] == "Run commands completed.":
|
if event["value"] == "Run commands completed.":
|
||||||
result.setdefault(node, {})["complete"] = True
|
console_result.setdefault(node, {})["complete"] = True
|
||||||
if all(_["complete"] for key, _ in result.items()):
|
if all(_["complete"] for key, _ in console_result.items()):
|
||||||
break
|
break
|
||||||
continue
|
continue
|
||||||
elif (event["value"].startswith("Run commands")):
|
elif (event["value"].startswith("Run commands")):
|
||||||
continue
|
continue
|
||||||
result[node]["result"].append(event["value"])
|
console_result[node]["result"].append(event["value"])
|
||||||
async def __(command):
|
|
||||||
data = await self._send_command(command, "run_command", timeout=timeout)
|
|
||||||
|
|
||||||
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))
|
||||||
|
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"])
|
raise exceptions.ServerError(data["result"])
|
||||||
|
elif data.get("type", None) != "runcommands" and data.get("result", "ok").lower() == "ok":
|
||||||
expect_response = False
|
reply_task.cancel()
|
||||||
if not ignore_output:
|
result = console_result
|
||||||
userid = (await self.user_info())["_id"]
|
expect_response = False
|
||||||
for n in nodeids:
|
if not ignore_output:
|
||||||
device_info = await self.device_info(n, timeout=timeout)
|
userid = (await self.user_info())["_id"]
|
||||||
try:
|
for n in nodeids:
|
||||||
permissions = device_info.mesh.links.get(userid, {}).get("rights",constants.DeviceRights.norights)\
|
device_info = await self.device_info(n, timeout=timeout)
|
||||||
# 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
|
try:
|
||||||
# |device_info.get("links", {}).get(userid, {}).get("rights", constants.DeviceRights.norights)
|
permissions = device_info.mesh.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
|
# 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
|
||||||
if not permissions&constants.DeviceRights.agentconsole:
|
# |device_info.get("links", {}).get(userid, {}).get("rights", constants.DeviceRights.norights)
|
||||||
result[n]["complete"] = True
|
# If we don't have agentconsole rights, we won't be able te read the output, so fill in blanks on this node
|
||||||
else:
|
if not permissions&constants.DeviceRights.agentconsole:
|
||||||
expect_response = True
|
result[n]["complete"] = True
|
||||||
except AttributeError:
|
else:
|
||||||
result[n]["complete"] = True
|
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" and not ignore_output:
|
||||||
|
result = reply_result
|
||||||
|
console_task.cancel()
|
||||||
|
tasks.append(reply_task)
|
||||||
|
else:
|
||||||
|
if not ignore_output:
|
||||||
|
console_task.cancel()
|
||||||
|
reply_task.cancel()
|
||||||
|
raise exceptions.ServerError(f"Unrecognized response: {data}")
|
||||||
|
|
||||||
tasks = []
|
tasks = []
|
||||||
async with asyncio.TaskGroup() as tg:
|
async with asyncio.TaskGroup() as tg:
|
||||||
if expect_response:
|
tasks.append(tg.create_task(__({ "action": 'runcommands', "nodeids": nodeids, "type": (2 if powershell else 0), "cmds": command, "runAsUser": runAsUser, "reply": not ignore_output}, tg, tasks)))
|
||||||
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 })))
|
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()}
|
return {n: v | {"result": "".join(v["result"])} for n,v in result.items()}
|
||||||
|
|
||||||
|
|||||||
@@ -37,7 +37,9 @@ class Agent(object):
|
|||||||
self._clienturl = clienturl
|
self._clienturl = clienturl
|
||||||
self._dockerurl = dockerurl
|
self._dockerurl = dockerurl
|
||||||
r = requests.post(f"{self._clienturl}/add-agent", json={"url": f"{self._dockerurl}", "meshid": self.meshid})
|
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):
|
def __enter__(self):
|
||||||
return self
|
return self
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
FROM python:3.12
|
FROM python:3.13
|
||||||
WORKDIR /usr/local/app
|
WORKDIR /usr/local/app
|
||||||
|
|
||||||
# Install the application dependencies
|
# Install the application dependencies
|
||||||
|
|||||||
@@ -1,8 +1,8 @@
|
|||||||
FROM ghcr.io/ylianst/meshcentral:latest
|
FROM ghcr.io/ylianst/meshcentral:1.1.50
|
||||||
RUN apk add curl
|
RUN apk add curl
|
||||||
RUN apk add python3
|
RUN apk add python3
|
||||||
WORKDIR /opt/meshcentral/
|
WORKDIR /opt/meshcentral/
|
||||||
COPY ./scripts/meshcentral ./scripts
|
COPY ./scripts/meshcentral ./scripts
|
||||||
COPY ./config/meshcentral/data /opt/meshcentral/meshcentral-data
|
COPY ./config/meshcentral/data /opt/meshcentral/meshcentral-data
|
||||||
COPY ./config/meshcentral/overrides /opt/meshcentral/meshcentral
|
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)
|
time.sleep(.1)
|
||||||
else:
|
else:
|
||||||
raise Exception(f"Failed to start agent: {text}")
|
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'])
|
@api.route('/remove-agent/<agentid>', methods=['POST'])
|
||||||
def remove_agent(agentid):
|
def remove_agent(agentid):
|
||||||
|
|||||||
@@ -7,9 +7,9 @@ thisdir = os.path.abspath(os.path.dirname(__file__))
|
|||||||
with open(os.path.join(thisdir, "users.json")) as infile:
|
with open(os.path.join(thisdir, "users.json")) as infile:
|
||||||
users = json.load(infile)
|
users = json.load(infile)
|
||||||
for username, password in users.items():
|
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"])
|
||||||
@@ -120,7 +120,7 @@ async def test_upload_download(env):
|
|||||||
downfilestream.seek(0)
|
downfilestream.seek(0)
|
||||||
|
|
||||||
start = time.perf_counter()
|
start = time.perf_counter()
|
||||||
r = await files.download(f"{pwd}/test", downfilestream, skip_http_attempt=True, timeout=5)
|
r = await files.download(f"{pwd}/test", downfilestream, skip_http_attempt=True, timeout=20)
|
||||||
print("\ninfo files_download: {}\n".format(r))
|
print("\ninfo files_download: {}\n".format(r))
|
||||||
assert r["result"] == True, "Download failed"
|
assert r["result"] == True, "Download failed"
|
||||||
assert r["size"] == len(randdata), "Downloaded wrong number of bytes"
|
assert r["size"] == len(randdata), "Downloaded wrong number of bytes"
|
||||||
|
|||||||
@@ -9,16 +9,7 @@ import requests
|
|||||||
|
|
||||||
async def test_sanity(env):
|
async def test_sanity(env):
|
||||||
async with meshctrl.Session(env.mcurl, user="unprivileged", password=env.users["unprivileged"], ignore_ssl=True) as s:
|
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:
|
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))
|
ping_task = tg.create_task(s.ping(timeout=10))
|
||||||
print("\ninfo ping: {}\n".format(ping_task.result()))
|
print("\ninfo ping: {}\n".format(ping_task.result()))
|
||||||
print("\ninfo user_info: {}\n".format(await s.user_info()))
|
print("\ninfo user_info: {}\n".format(await s.user_info()))
|
||||||
|
|||||||
@@ -251,7 +251,28 @@ async def test_mesh_device(env):
|
|||||||
assert "Run commands completed." not in r[agent2.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"
|
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 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")
|
||||||
|
|
||||||
|
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_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:
|
try:
|
||||||
await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10)
|
await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10)
|
||||||
except* (meshctrl.exceptions.ServerError, ValueError):
|
except* (meshctrl.exceptions.ServerError, ValueError):
|
||||||
@@ -266,7 +287,7 @@ async def test_mesh_device(env):
|
|||||||
else:
|
else:
|
||||||
raise Exception("Unprivileged user has access to device it should not")
|
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:
|
try:
|
||||||
await unprivileged_session.run_command(agent.nodeid, "ls", ignore_output=True, timeout=10)
|
await unprivileged_session.run_command(agent.nodeid, "ls", ignore_output=True, timeout=10)
|
||||||
@@ -284,12 +305,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 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"
|
# 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)
|
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"
|
assert await admin_session.move_to_device_group(agent.nodeid, mesh2.meshid, timeout=5), "Failed to move mesh to new device group"
|
||||||
@@ -303,7 +326,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"
|
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"
|
# assert "meshagent" in (await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10))[agent.nodeid]["result"], "ls gave incorrect data"
|
||||||
try:
|
try:
|
||||||
await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10)
|
await unprivileged_session.run_command(agent.nodeid, "ls", timeout=10)
|
||||||
@@ -313,6 +336,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)
|
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))
|
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"
|
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"
|
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