forked from Narcissus/pylibmeshctrl
Compare commits
63 Commits
release/1.
...
1.2.2
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f5c6e96597 | ||
|
|
428a1b31c7 | ||
|
|
16f3f99427 | ||
|
|
d21450e463 | ||
|
|
9e08a1af49 | ||
|
|
e9de43420e | ||
|
|
fcdf8add53 | ||
|
|
163b776dfc | ||
|
|
04c8f622de | ||
|
|
ccb5f1eb40 | ||
|
|
ce2cf2bfe1 | ||
|
|
a3b4962e7f | ||
|
|
5947e48c5b | ||
|
|
31a8f00cd0 | ||
|
|
871d36b334 | ||
|
|
59fb1f104e | ||
|
|
9bd3e10ed7 | ||
|
|
28e1d94ab9 | ||
|
|
51325a89d3 | ||
|
|
97dff80222 | ||
|
|
8da445348b | ||
|
|
ab1fba5cc1 | ||
|
|
34a80cdda7 | ||
|
|
fcf523dd62 | ||
|
|
9a1311167d | ||
|
|
c2319fcf29 | ||
|
|
4d1c25a35c | ||
|
|
e226fff8dd | ||
|
|
a07b0f129a | ||
|
|
64dc5eccdf | ||
|
|
1a7714663a | ||
|
|
0a59edd19a | ||
|
|
f8600b09fe | ||
|
|
351f425ce5 | ||
|
|
77e76aeb7c | ||
|
|
5393321f7b | ||
|
|
79554ebad6 | ||
|
|
1dbcd012ec | ||
|
|
ace6884991 | ||
|
|
61eebf1532 | ||
|
|
fcfeac21a8 | ||
|
|
19d10ee050 | ||
|
|
0c9ebf0ff2 | ||
|
|
2556e72a73 | ||
|
|
cda5f610a1 | ||
|
|
564d466ff9 | ||
|
|
125e6ac6ac | ||
|
|
1b849473bb | ||
|
|
df25652ba6 | ||
|
|
9668e4d507 | ||
|
|
fe4c2fe874 | ||
|
|
bb7cf17cd3 | ||
|
|
6919da4a42 | ||
|
|
ff120490fa | ||
|
|
d9991156f6 | ||
|
|
4fea858fbc | ||
|
|
3b4a18b379 | ||
|
|
c072d6012a | ||
|
|
0ee2e2dc94 | ||
|
|
f2d9fcd295 | ||
|
|
7456743709 | ||
|
|
07b828a150 | ||
|
|
cd7a356eb5 |
@@ -19,7 +19,7 @@ formats:
|
||||
build:
|
||||
os: ubuntu-22.04
|
||||
tools:
|
||||
python: "3.11"
|
||||
python: "3.13"
|
||||
|
||||
python:
|
||||
install:
|
||||
|
||||
@@ -2,7 +2,61 @@
|
||||
Changelog
|
||||
=========
|
||||
|
||||
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
|
||||
=============
|
||||
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
|
||||
|
||||
@@ -38,7 +38,7 @@ Library for remotely interacting with a
|
||||
Installation
|
||||
------------
|
||||
|
||||
pip install meshctrl
|
||||
pip install libmeshctrl
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
@@ -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
|
||||
BIN
requirements.txt
BIN
requirements.txt
Binary file not shown.
@@ -24,7 +24,7 @@ platforms = any
|
||||
# Add here all kinds of additional classifiers as defined under
|
||||
# https://pypi.org/classifiers/
|
||||
classifiers =
|
||||
Development Status :: 4 - Beta
|
||||
Development Status :: 5 - Production/Stable
|
||||
Programming Language :: Python
|
||||
|
||||
|
||||
@@ -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]
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -12,6 +12,7 @@ class Device(object):
|
||||
name (str|None): Device name as it is shown on the meshcentral server
|
||||
description (str|None): Device description as it is shown on the meshcentral server. Also accepted as desc.
|
||||
tags (list[str]|None): tags associated with device.
|
||||
users (list[str]|None): latest known usernames which have logged in.
|
||||
created_at (datetime.Datetime|int|None): Time at which device mas created. Also accepted as agct.
|
||||
computer_name (str|None): Device name as reported from the agent. This may be different from name. Also accepted as rname.
|
||||
icon (~meshctrl.constants.Icon): Icon displayed on the website
|
||||
@@ -38,6 +39,7 @@ class Device(object):
|
||||
name (str|None): Device name as it is shown on the meshcentral server
|
||||
description (str|None): Device description as it is shown on the meshcentral server.
|
||||
tags (list[str]): tags associated with device.
|
||||
users (list[str]): latest known usernames which have logged in.
|
||||
computer_name (str|None): Device name as reported from the agent. This may be different from name. Also accepted as rname.
|
||||
icon (~meshctrl.constants.Icon): Icon displayed on the website
|
||||
mesh (~meshctrl.mesh.Mesh|None): Mesh object under which this device exists. Is None for individual device access.
|
||||
@@ -54,11 +56,11 @@ class Device(object):
|
||||
links (dict[str, ~meshctrl.types.UserLink]|None): Collection of links for the device
|
||||
details (dict[str, dict]): Extra details about the device. These are not well defined, but are filled by calling :py:meth:`~meshctrl.session.Session.list_devices` with `details=True`.
|
||||
'''
|
||||
def __init__(self, nodeid, session, agent=None,
|
||||
def __init__(self, nodeid, session, agent=None,
|
||||
name=None, desc=None, description=None,
|
||||
tags=None,
|
||||
agct=None, created_at=None,
|
||||
rname=None, computer_name=None, icon=constants.Icon.desktop,
|
||||
tags=None, users=None,
|
||||
agct=None, created_at=None,
|
||||
rname=None, computer_name=None, icon=constants.Icon.desktop,
|
||||
mesh=None, mtype=None, meshtype=None, groupname=None, meshname=None,
|
||||
domain=None, host=None, ip=None, conn=None, connected=None,
|
||||
pwr=None, powered_on=None,
|
||||
@@ -69,7 +71,7 @@ class Device(object):
|
||||
if links is None:
|
||||
links = {}
|
||||
self.links = links
|
||||
if ("ver" in agent):
|
||||
if agent and "ver" in agent:
|
||||
agent = {
|
||||
"version": agent["ver"],
|
||||
"id": agent["id"],
|
||||
@@ -90,13 +92,14 @@ class Device(object):
|
||||
self.description = description if description is not None else desc
|
||||
self.os_description = os_description if os_description is not None else osdesc
|
||||
self.tags = tags if tags is not None else []
|
||||
self.users = users if users is not None else []
|
||||
self.details = details if details is not None else {}
|
||||
|
||||
created_at = created_at if created_at is not None else agct
|
||||
if not isinstance(created_at, datetime.datetime) and created_at is not None:
|
||||
try:
|
||||
created_at = datetime.datetime.fromtimestamp(created_at)
|
||||
except OSError:
|
||||
except (OSError, ValueError):
|
||||
# Meshcentral returns in miliseconds, while fromtimestamp, and most of python, expects the argument in seconds. Try seconds frist, then translate from ms if it fails.
|
||||
# This doesn't work for really early timestamps, but I don't expect that to be a problem here.
|
||||
created_at = datetime.datetime.fromtimestamp(created_at/1000.0)
|
||||
@@ -106,7 +109,7 @@ class Device(object):
|
||||
if not isinstance(lastconnect, datetime.datetime) and lastconnect is not None:
|
||||
try:
|
||||
lastconnect = datetime.datetime.fromtimestamp(lastconnect)
|
||||
except OSError:
|
||||
except (OSError, ValueError):
|
||||
# Meshcentral returns in miliseconds, while fromtimestamp, and most of python, expects the argument in seconds. Try seconds frist, then translate from ms if it fails.
|
||||
# This doesn't work for really early timestamps, but I don't expect that to be a problem here.
|
||||
lastconnect = datetime.datetime.fromtimestamp(lastconnect/1000.0)
|
||||
@@ -129,7 +132,7 @@ class Device(object):
|
||||
Returns:
|
||||
bool: True on success, raise otherwise
|
||||
|
||||
Raises:
|
||||
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
|
||||
@@ -147,7 +150,7 @@ class Device(object):
|
||||
Returns:
|
||||
bool: True on success, raise otherwise
|
||||
|
||||
Raises:
|
||||
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
|
||||
@@ -166,7 +169,7 @@ class Device(object):
|
||||
Returns:
|
||||
bool: True on success, raise otherwise
|
||||
|
||||
Raises:
|
||||
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
|
||||
@@ -183,7 +186,7 @@ class Device(object):
|
||||
Returns:
|
||||
~meshctrl.device.Device: Object representing the state of the device. This will be a new device, it will not update this device.
|
||||
|
||||
Raises:
|
||||
Raises:
|
||||
ValueError: `Invalid device id` if device is not found
|
||||
:py:class:`~meshctrl.exceptions.SocketError`: Info about socket closure
|
||||
asyncio.TimeoutError: Command timed out
|
||||
@@ -205,7 +208,7 @@ class Device(object):
|
||||
Returns:
|
||||
bool: True if successful, raise otherwise
|
||||
|
||||
Raises:
|
||||
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
|
||||
@@ -227,7 +230,7 @@ class Device(object):
|
||||
Returns:
|
||||
~meshctrl.types.RunCommandResponse: Output of command
|
||||
|
||||
Raises:
|
||||
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
|
||||
@@ -268,7 +271,7 @@ class Device(object):
|
||||
Returns:
|
||||
bool: True if successful
|
||||
|
||||
Raises:
|
||||
Raises:
|
||||
:py:class:`~meshctrl.exceptions.SocketError`: Info about socket closure
|
||||
asyncio.TimeoutError: Command timed out
|
||||
'''
|
||||
@@ -286,7 +289,7 @@ class Device(object):
|
||||
Returns:
|
||||
bool: True if successful
|
||||
|
||||
Raises:
|
||||
Raises:
|
||||
:py:class:`~meshctrl.exceptions.SocketError`: Info about socket closure
|
||||
asyncio.TimeoutError: Command timed out
|
||||
'''
|
||||
@@ -302,7 +305,7 @@ class Device(object):
|
||||
Returns:
|
||||
bool: True if successful
|
||||
|
||||
Raises:
|
||||
Raises:
|
||||
:py:class:`~meshctrl.exceptions.SocketError`: Info about socket closure
|
||||
asyncio.TimeoutError: Command timed out
|
||||
'''
|
||||
@@ -317,7 +320,7 @@ class Device(object):
|
||||
Returns:
|
||||
bool: True if successful
|
||||
|
||||
Raises:
|
||||
Raises:
|
||||
:py:class:`~meshctrl.exceptions.SocketError`: Info about socket closure
|
||||
asyncio.TimeoutError: Command timed out
|
||||
'''
|
||||
@@ -340,10 +343,10 @@ class Device(object):
|
||||
def __str__(self):
|
||||
return f"<Device: nodeid={self.nodeid} name={self.name} description={self.description} computer_name={self.computer_name} icon={self.icon} "\
|
||||
f"mesh={self.mesh} meshtype={self.meshtype} meshname={self.meshname} domain={self.domain} host={self.host} ip={self.ip} "\
|
||||
f"tags={self.tags} details={self.details} created_at={self.created_at} lastaddr={self.lastaddr} lastconnect={self.lastconnect} "\
|
||||
f"tags={self.tags} users={self.users} details={self.details} created_at={self.created_at} lastaddr={self.lastaddr} lastconnect={self.lastconnect} "\
|
||||
f"connected={self.connected} powered_on={self.powered_on} os_description={self.os_description} links={self.links} _extra_props={self._extra_props}>"
|
||||
def __repr__(self):
|
||||
return f"Device(nodeid={repr(self.nodeid)}, session={repr(self._session)}, name={repr(self.name)}, description={repr(self.description)}, computer_name={repr(self.computer_name)}, icon={repr(self.icon)}, "\
|
||||
f"mesh={repr(self.mesh)}, meshtype={repr(self.meshtype)}, meshname={repr(self.meshname)}, domain={repr(self.domain)}, host={repr(self.host)}, ip={repr(self.ip)}, "\
|
||||
f"tags={repr(self.tags)}, details={repr(self.details)} created_at={repr(self.created_at)} lastaddr={repr(self.lastaddr)} lastconnect={repr(self.lastconnect)} "\
|
||||
f"connected={repr(self.connected)}, powered_on={repr(self.powered_on)}, os_description={repr(self.os_description)}, links={repr(self.links)}, **{repr(self._extra_props)})"
|
||||
f"tags={repr(self.tags)}, users={repr(self.users)}, details={repr(self.details)} created_at={repr(self.created_at)} lastaddr={repr(self.lastaddr)} lastconnect={repr(self.lastconnect)} "\
|
||||
f"connected={repr(self.connected)}, powered_on={repr(self.powered_on)}, os_description={repr(self.os_description)}, links={repr(self.links)}, **{repr(self._extra_props)})"
|
||||
|
||||
@@ -2,7 +2,9 @@ class MeshCtrlError(Exception):
|
||||
"""
|
||||
Base class for Meshctrl errors
|
||||
"""
|
||||
pass
|
||||
def __init__(self, message, *args, **kwargs):
|
||||
self.message = message
|
||||
super().__init__(message, *args, **kwargs)
|
||||
|
||||
class ServerError(MeshCtrlError):
|
||||
"""
|
||||
@@ -25,6 +27,7 @@ class FileTransferError(MeshCtrlError):
|
||||
"""
|
||||
def __init__(self, message, stats):
|
||||
self.stats = stats
|
||||
super().__init__(message)
|
||||
|
||||
class FileTransferCancelled(FileTransferError):
|
||||
"""
|
||||
|
||||
@@ -31,7 +31,7 @@ class Mesh(object):
|
||||
domain (str|None): Domain on server to which device is connected.
|
||||
links (dict[str, ~meshctrl.types.UserLink]|None): Collection of links for the device group
|
||||
'''
|
||||
def __init__(self, meshid, session, creation=None, created_at=None, name=None,
|
||||
def __init__(self, meshid, session, creation=None, created_at=None, name=None,
|
||||
mtype=None, meshtype=None, creatorid=None, desc=None, description=None,
|
||||
domain=None, creatorname=None, links=None, **kwargs):
|
||||
self.meshid = meshid
|
||||
@@ -46,7 +46,7 @@ class Mesh(object):
|
||||
if not isinstance(created_at, datetime.datetime) and created_at is not None:
|
||||
try:
|
||||
created_at = datetime.datetime.fromtimestamp(created_at)
|
||||
except OSError:
|
||||
except (OSError, ValueError):
|
||||
# Meshcentral returns in miliseconds, while fromtimestamp, and most of python, expects the argument in seconds. Try seconds frist, then translate from ms if it fails.
|
||||
# This doesn't work for really early timestamps, but I don't expect that to be a problem here.
|
||||
created_at = datetime.datetime.fromtimestamp(created_at/1000.0)
|
||||
@@ -83,7 +83,7 @@ class Mesh(object):
|
||||
Returns:
|
||||
dict[str, ~meshctrl.types.AddUsersToDeviceGroupResponse]: Object showing which were added correctly and which were not, along with their result messages. str is userid to map response.
|
||||
|
||||
Raises:
|
||||
Raises:
|
||||
:py:class:`~meshctrl.exceptions.SocketError`: Info about socket closure
|
||||
asyncio.TimeoutError: Command timed out
|
||||
'''
|
||||
@@ -96,4 +96,4 @@ class Mesh(object):
|
||||
def __repr__(self):
|
||||
return f"Mesh(meshid={repr(self.meshid)}, session={repr(self._session)}, name={repr(self.name)}, description={repr(self.description)}, created_at={repr(self.created_at)}, "\
|
||||
f"meshtype={repr(self.meshtype)}, domain={repr(self.domain)}, "\
|
||||
f"created_at={repr(self.created_at)}, creatorid={repr(self.creatorid)}, creatorname={repr(self.creatorname)}, links={repr(self.links)}, **{repr(self._extra_props)})"
|
||||
f"created_at={repr(self.created_at)}, creatorid={repr(self.creatorid)}, creatorname={repr(self.creatorname)}, links={repr(self.links)}, **{repr(self._extra_props)})"
|
||||
|
||||
@@ -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 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, max_size=None, user_agent_header=self.user_agent_header, **options):
|
||||
self.alive = True
|
||||
self._socket_open.set()
|
||||
try:
|
||||
@@ -478,10 +485,21 @@ class Session(object):
|
||||
if "result" in res0:
|
||||
raise exceptions.ServerError(res0["result"])
|
||||
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:
|
||||
if node["node"].get("meshid", None):
|
||||
node["node"]["mesh"] = mesh.Mesh(node["node"].get("meshid"), self)
|
||||
if "lastConnect" in node and isinstance(node["lastConnect"], dict):
|
||||
node["node"]["lastconnect"] = node["lastConnect"].get("time")
|
||||
node["node"]["lastaddr"] = node["lastConnect"].get("addr")
|
||||
del node["lastConnect"]
|
||||
details = {}
|
||||
for key, val in node.items():
|
||||
if key != "node":
|
||||
@@ -533,7 +551,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 +1381,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 +1481,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"])
|
||||
@@ -1736,10 +1755,11 @@ class Session(object):
|
||||
tasks.append(tg.create_task(asyncio.wait_for(_(), timeout=timeout)))
|
||||
tasks.append({ "action": 'msg', "type": 'openUrl', "nodeid": nodeid, "url": url }, "device_open_url", timeout=timeout)
|
||||
|
||||
|
||||
success = tasks[0].result()
|
||||
res = tasks[1].result()
|
||||
success = tasks[2].result()
|
||||
|
||||
if data.get("result", "ok").lower() != "ok":
|
||||
if res.get("result", "ok").lower() != "ok":
|
||||
raise exceptions.ServerError(data["result"])
|
||||
|
||||
if not success:
|
||||
@@ -1824,7 +1844,7 @@ class Session(object):
|
||||
|
||||
async def upload(self, node, source, target, unique_file_tunnel=False, timeout=None):
|
||||
'''
|
||||
Upload a stream to a device. This creates an _File and destroys it every call. If you need to upload multiple files, use {@link Session#file_explorer} instead.
|
||||
Upload a stream to a device.
|
||||
|
||||
Args:
|
||||
node (~meshctrl.device.Device|str): Device or id of device to which to upload the file. If it is a device, it must have a ~meshctrl.mesh.Mesh device associated with it (the default). If it is a string, the device will be fetched prior to tunnel creation.
|
||||
@@ -1963,4 +1983,4 @@ class _FileExplorerWrapper:
|
||||
return await self._files.__aenter__()
|
||||
|
||||
async def __aexit__(self, exc_t, exc_v, exc_tb):
|
||||
return await self._files.__aexit__(exc_t, exc_v, exc_tb)
|
||||
return await self._files.__aexit__(exc_t, exc_v, exc_tb)
|
||||
|
||||
@@ -52,7 +52,7 @@ class Tunnel(object):
|
||||
options["ssl"] = self._session._ssl_context
|
||||
|
||||
if (len(self.node_id.split('/')) != 3):
|
||||
self.node_id = f"node/{self._session._currentDomain or ""}/{self.node_id}"
|
||||
self.node_id = f"node/{self._session._currentDomain or ''}/{self.node_id}"
|
||||
|
||||
self._tunnel_id = util._get_random_hex(6)
|
||||
|
||||
@@ -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:
|
||||
@@ -91,4 +91,4 @@ class Tunnel(object):
|
||||
await websocket.send(message)
|
||||
|
||||
async def _listen_data_task(self, websocket):
|
||||
raise NotImplementedError("Listen data not implemented")
|
||||
raise NotImplementedError("Listen data not implemented")
|
||||
|
||||
@@ -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):
|
||||
@@ -140,17 +139,20 @@ def compare_dict(dict1, dict2):
|
||||
return False
|
||||
|
||||
def _check_socket(f):
|
||||
async def _check_errs(self):
|
||||
if not self.alive and self._main_loop_error is not None:
|
||||
raise self._main_loop_error
|
||||
elif not self.alive and self.initialized.is_set():
|
||||
raise exceptions.SocketError("Socket Closed")
|
||||
|
||||
@functools.wraps(f)
|
||||
async def wrapper(self, *args, **kwargs):
|
||||
try:
|
||||
async with asyncio.TaskGroup() as tg:
|
||||
tg.create_task(asyncio.wait_for(self.initialized.wait(), 10))
|
||||
tg.create_task(asyncio.wait_for(self._socket_open.wait(), 10))
|
||||
await asyncio.wait_for(self.initialized.wait(), 10)
|
||||
await _check_errs(self)
|
||||
await asyncio.wait_for(self._socket_open.wait(), 10)
|
||||
finally:
|
||||
if not self.alive and self._main_loop_error is not None:
|
||||
raise self._main_loop_error
|
||||
elif not self.alive and self.initialized.is_set():
|
||||
raise exceptions.SocketError("Socket Closed")
|
||||
await _check_errs(self)
|
||||
return await f(self, *args, **kwargs)
|
||||
return wrapper
|
||||
|
||||
@@ -161,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
|
||||
@@ -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")
|
||||
|
||||
4
tests/environment/config/meshcentral/overrides/.gitignore
vendored
Normal file
4
tests/environment/config/meshcentral/overrides/.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
# Ignore everything in this directory
|
||||
*
|
||||
# Except this file
|
||||
!.gitignore
|
||||
@@ -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"]
|
||||
@@ -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
|
||||
@@ -120,7 +120,7 @@ async def test_upload_download(env):
|
||||
downfilestream.seek(0)
|
||||
|
||||
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))
|
||||
assert r["result"] == True, "Download failed"
|
||||
assert r["size"] == len(randdata), "Downloaded wrong number of bytes"
|
||||
|
||||
@@ -5,6 +5,8 @@ import meshctrl
|
||||
import requests
|
||||
import random
|
||||
import io
|
||||
import traceback
|
||||
import time
|
||||
thisdir = os.path.dirname(os.path.realpath(__file__))
|
||||
|
||||
async def test_admin(env):
|
||||
@@ -44,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")
|
||||
|
||||
@@ -55,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
|
||||
@@ -77,6 +82,17 @@ async def test_users(env):
|
||||
pass
|
||||
else:
|
||||
raise Exception("Connected with no password")
|
||||
|
||||
start = time.time()
|
||||
try:
|
||||
async with meshctrl.Session(env.mcurl, user="admin", password="The wrong password", ignore_ssl=True) as admin_session:
|
||||
pass
|
||||
except* meshctrl.exceptions.ServerError as eg:
|
||||
assert str(eg.exceptions[0]) == "Invalid Auth" or eg.exceptions[0].message == "Invalid Auth", "Didn't get invalid auth message"
|
||||
assert time.time() - start < 10, "Invalid auth wasn't raised until after timeout"
|
||||
pass
|
||||
else:
|
||||
raise Exception("Connected with bad password")
|
||||
async with meshctrl.Session(env.mcurl+"/", user="admin", password=env.users["admin"], ignore_ssl=True) as admin_session,\
|
||||
meshctrl.Session(env.mcurl, user="privileged", password=env.users["privileged"], ignore_ssl=True) as privileged_session,\
|
||||
meshctrl.Session(env.mcurl, user="unprivileged", password=env.users["unprivileged"], ignore_ssl=True) as unprivileged_session:
|
||||
@@ -187,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)
|
||||
@@ -213,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"
|
||||
|
||||
@@ -221,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
|
||||
@@ -252,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"
|
||||
|
||||
Reference in New Issue
Block a user