devstack-cli 10.0.180__tar.gz → 11.0.0__tar.gz

{devstack_cli-10.0.180/src/devstack_cli.egg-info → devstack_cli-11.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: devstack-cli
-Version: 10.0.180
+Version: 11.0.0
 Summary: Command-line access to Cloud Development Environments (CDEs) created by Cloudomation DevStack
 Author-email: Stefan Mückstein <stefan@cloudomation.com>
 Project-URL: Homepage, https://cloudomation.com/

{devstack_cli-10.0.180 → devstack_cli-11.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "devstack-cli"
-version = "10.0.180"
+version = "11.0.0"
 authors = [
     { name="Stefan Mückstein", email="stefan@cloudomation.com" },
 ]

{devstack_cli-10.0.180 → devstack_cli-11.0.0}/src/cli.py

@@ -10,6 +10,7 @@ import json
 import logging
 import os
 import pathlib
+import re
 import readline
 import shlex
 import shutil
@@ -56,6 +57,30 @@ logger.addHandler(rich.logging.RichHandler())
 json_logger = logging.getLogger('cli-json')
 json_logger.addHandler(rich.logging.RichHandler(highlighter=rich.highlighter.JSONHighlighter()))
 
+def is_valid_username(username: str) -> bool:
+    return re.match(r'^[a-zA-Z0-9]+[a-zA-Z0-9_.-]*$', username) is not None
+
+def is_valid_hostname(hostname: str) -> bool:
+    return re.match(r'^([a-zA-Z0-9][a-zA-Z0-9-]*\.)*([a-zA-Z0-9][a-zA-Z0-9-]*)$', hostname) is not None
+
+def is_valid_path(path: str) -> bool:
+    return re.match(r'^[a-zA-Z0-9/_.,\-+ ]+$', path) is not None
+
+def ensure_valid_username(username: str) -> str:
+    if not is_valid_username(username):
+        raise ValueError(f'Invalid username: "{username}". Username must start with an alphanumeric character, and contain only alphanumeric characters, dots, underscores and hyphens.')
+    return username
+
+def ensure_valid_hostname(hostname: str) -> str:
+    if not is_valid_hostname(hostname):
+        raise ValueError(f'Invalid hostname: "{hostname}". Hostname must start with an alphanumeric character, and contain only alphanumeric characters, dots, and hyphens.')
+    return hostname
+
+def ensure_valid_path(path: str) -> str:
+    if not is_valid_path(path):
+        raise ValueError(f'Invalid path: "{path}". Path must start with an alphanumeric character, and contain only alphanumeric characters, slashes, dots, underscores, commas, pluses, hyphens, and spaces.')
+    return path
+
 class SubprocessError(Exception):
     """A subprocess call returned with non-zero."""
 
@@ -83,6 +108,7 @@ class FileSystemEventHandlerToQueue(watchdog.events.FileSystemEventHandler):
         if event.event_type in (
                 watchdog.events.EVENT_TYPE_OPENED,
                 watchdog.events.EVENT_TYPE_CLOSED,
+                watchdog.events.EVENT_TYPE_CLOSED_NO_WRITE,
         ):
             return
         if event.event_type == watchdog.events.EVENT_TYPE_MODIFIED and event.is_directory:
@@ -96,7 +122,7 @@ class FileSystemEventHandlerToQueue(watchdog.events.FileSystemEventHandler):
 
 async def run_subprocess(
         program: str,
-        args: str,
+        args: typing.List[str],
         *,
         name: str,
         cwd: typing.Optional[pathlib.Path] = None,
@@ -975,13 +1001,13 @@ class Cli:
     async def _wait_running(self: 'Cli') -> None:
         logger.info('Waiting for CDE "%s" to reach status running...', self.cde_name)
         while True:
+            await asyncio.sleep(10)
             await self._update_cde_list()
             if self.cde['status'] == 'running':
                 break
             if self.cde['status'].endswith('_failed') or self.cde['status'] in {'not configured', 'deleted', 'connected', 'stopped'}:
                 logger.error('CDE "%s" failed to reach status running and is now in status "%s".', self.cde_name, self.cde['status'])
                 return
-            await asyncio.sleep(10)
         logger.info('CDE "%s" is now running', self.cde_name)
 
     async def _connect_disconnect_cde(self: 'Cli') -> None:
@@ -1001,10 +1027,11 @@ class Cli:
         logger.info('Connecting to CDE')
         known_hosts = await self._get_known_hosts()
         if known_hosts is None:
+            logger.error('Cannot connect to CDE. Host-key not found.')
             return
         self.known_hosts_file = await _create_temp_file(exit_stack=self.exit_stack, content=known_hosts)
         self.ssh_client = paramiko.SSHClient()
-        self.ssh_client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
+        self.ssh_client.load_host_keys(self.known_hosts_file.name)
         try:
             self.ssh_client.connect(
                 hostname=self.hostname,
@@ -1021,34 +1048,18 @@ class Cli:
         logger.info('Connected to CDE')
 
     async def _get_known_hosts(self: 'Cli') -> typing.Optional[str]:
-        if self.cde['value']['hostkey']:
-            if self.cde['value']['hostkey'].startswith(self.cde['value']['hostname']):
-                return self.cde['value']['hostkey']
-            return f"{self.cde['value']['hostname']} {self.cde['value']['hostkey']}"
         if not self.cde:
             logger.error('No CDE is selected. Cannot fetch host-key.')
             return None
         if not self.is_cde_running:
             logger.error('CDE is not running. Cannot fetch host-key.')
             return None
-        logger.debug('Scanning hostkeys of "%s"', self.hostname)
-        try:
-            stdout, stderr = await run_subprocess(
-                'ssh-keyscan',
-                [
-                    self.hostname,
-                ],
-                name='ssh-keyscan',
-                print_stdout=False,
-                print_stderr=False,
-            )
-        except SubprocessError as ex:
-            logger.error('%s Failed to fetch hostkeys. Is you CDE running?', ex)  # noqa: TRY400
-            sys.exit(1)
-        known_hosts = stdout
-        with contextlib.suppress(FileNotFoundError):
-            known_hosts += pathlib.Path(os.path.expandvars('$HOME/.ssh/known_hosts')).read_bytes()
-        return known_hosts
+        if not self.cde['value']['hostkey']:
+            logger.error('CDE record does not contain a hostkey.')
+            return None
+        if self.cde['value']['hostkey'].startswith(self.cde['value']['hostname']):
+            return self.cde['value']['hostkey']
+        return f"{self.cde['value']['hostname']} {self.cde['value']['hostkey']}"
 
     async def _disconnect_cde(self: 'Cli') -> None:
         logger.info('Disconnecting from CDE')
@@ -1236,6 +1247,8 @@ class Cli:
         self.port_forwarding_task = None
 
     async def _bg_port_forwarding(self: 'Cli') -> None:
+        remote_username = ensure_valid_username(self.cde_type['value']['remote-username'])
+        hostname = ensure_valid_hostname(self.hostname)
         service_ports = self.cde_type['value'].get('service-ports')
         if service_ports is None:
             service_ports = [
@@ -1252,6 +1265,11 @@ class Cli:
             for port
             in service_ports
         ]
+        for port in service_ports:
+            if port[0] < 1 or port[0] > 65535:
+                raise ValueError(f'Invalid port: "{port[0]}". Only numbers between 1 and 65535 are allowed.')
+            if port[1] < 1 or port[1] > 65535:
+                raise ValueError(f'Invalid port: "{port[1]}". Only numbers between 1 and 65535 are allowed.')
         while True:
             logger.info('Starting port forwarding of %s', ', '.join(str(port[0]) for port in service_ports))
             try:
@@ -1261,7 +1279,7 @@ class Cli:
                         '-o', 'ConnectTimeout=10',
                         '-o', f'UserKnownHostsFile={self.known_hosts_file.name}',
                         '-NT',
-                        f"{self.cde_type['value']['remote-username']}@{self.hostname}",
+                        f'{remote_username}@{hostname}',
                         *itertools.chain.from_iterable([
                             ('-L', f'{port[0]}:localhost:{port[1]}')
                             for port
@@ -1441,13 +1459,16 @@ class Cli:
         return await self._process_remote_item_copy_file(file_info.filename)
 
     async def _process_remote_item_copy_dir(self: 'Cli', filename: str) -> str:
+        remote_username = ensure_valid_username(self.cde_type['value']['remote-username'])
+        hostname = ensure_valid_hostname(self.hostname)
+        remote_source_directory = ensure_valid_path(self.cde_type['value']['remote-source-directory'])
         await run_subprocess(
             'rsync',
             [
                 '-e', f'ssh -o ConnectTimeout=10 -o UserKnownHostsFile={self.known_hosts_file.name}',
                 '--archive',
                 '--checksum',
-                f"{self.cde_type['value']['remote-username']}@{self.hostname}:{self.cde_type['value']['remote-source-directory']}/{filename}/",
+                f'{remote_username}@{hostname}:{remote_source_directory}/{filename}/',
                 str(self.local_source_directory / filename),
             ],
             name='Copy remote directory',
@@ -1455,23 +1476,27 @@ class Cli:
         return f'Copied directory "{filename}"'
 
     async def _process_remote_item_copy_file(self: 'Cli', filename: str) -> str:
+        remote_source_directory = ensure_valid_path(self.cde_type['value']['remote-source-directory'])
         await self.loop.run_in_executor(
             executor=None,
             func=functools.partial(
                 self.sftp_client.get,
-                remotepath=f"{self.cde_type['value']['remote-source-directory']}/{filename}",
+                remotepath=f'{remote_source_directory}/{filename}',
                 localpath=str(self.local_source_directory / filename),
             ),
         )
         return f'Copied file "{filename}"'
 
     async def _process_remote_item_clone(self: 'Cli', filename: str) -> str:
+        remote_username = ensure_valid_username(self.cde_type['value']['remote-username'])
+        hostname = ensure_valid_hostname(self.hostname)
+        remote_source_directory = ensure_valid_path(self.cde_type['value']['remote-source-directory'])
         await run_subprocess(
             'git',
             [
                 'clone',
                 '-q',
-                f"{self.cde_type['value']['remote-username']}@{self.hostname}:{self.cde_type['value']['remote-source-directory']}/{filename}",
+                f'{remote_username}@{hostname}:{remote_source_directory}/{filename}',
             ],
             name='Git clone',
             cwd=self.local_source_directory,
@@ -1486,7 +1511,7 @@ class Cli:
                 shlex.join([
                     'git',
                     '-C',
-                    f"{self.cde_type['value']['remote-source-directory']}/{filename}",
+                    f'{remote_source_directory}/{filename}',
                     'config',
                     '--get',
                     'remote.origin.url',
@@ -1511,10 +1536,13 @@ class Cli:
         return f'Cloned repository "{filename}"'
 
     async def _background_sync(self: 'Cli') -> None:
+        remote_username = ensure_valid_username(self.cde_type['value']['remote-username'])
+        hostname = ensure_valid_hostname(self.hostname)
+        remote_source_directory = ensure_valid_path(self.cde_type['value']['remote-source-directory'])
         logger.debug('Starting background sync')
         self.local_source_directory.mkdir(parents=True, exist_ok=True)
         with contextlib.suppress(OSError):
-            self.sftp_client.mkdir(self.cde_type['value']['remote-source-directory'])
+            self.sftp_client.mkdir(remote_source_directory)
         file_sync_exclusions = self.cde_type['value'].get('file-sync-exclusions')
         if file_sync_exclusions is None:
             file_sync_exclusions = [
@@ -1562,7 +1590,7 @@ class Cli:
                     '--human-readable',
                     '--verbose',
                     f'{self.local_source_directory}/',
-                    f"{self.cde_type['value']['remote-username']}@{self.hostname}:{self.cde_type['value']['remote-source-directory']}",
+                    f'{remote_username}@{hostname}:{remote_source_directory}',
                 ],
                 name='Background sync',
                 print_to_debug_log=True,
@@ -1578,19 +1606,22 @@ class Cli:
             logger.info('Background sync done')
 
     async def _reverse_background_sync(self: 'Cli') -> None:
+        remote_username = ensure_valid_username(self.cde_type['value']['remote-username'])
+        hostname = ensure_valid_hostname(self.hostname)
+        remote_output_directory = ensure_valid_path(self.cde_type['value']['remote-output-directory'])
         logger.debug('Starting reverse background sync')
         with contextlib.suppress(OSError):
-            self.sftp_client.mkdir(self.cde_type['value']['remote-output-directory'])
+            self.sftp_client.mkdir(remote_output_directory)
         self.local_output_directory.mkdir(parents=True, exist_ok=True)
         try:
-            stdout, stderr = await run_subprocess(
+            await run_subprocess(
                 'rsync',
                 [
                     '-e', f'ssh -o ConnectTimeout=10 -o UserKnownHostsFile={self.known_hosts_file.name}',
                     '--archive',
                     '--exclude', '__pycache__',
                     '--human-readable',
-                    f"{self.cde_type['value']['remote-username']}@{self.hostname}:{self.cde_type['value']['remote-output-directory']}/",
+                    f'{remote_username}@{hostname}:{remote_output_directory}/',
                     str(self.local_output_directory),
                 ],
                 name='Reverse background sync',
@@ -1780,12 +1811,12 @@ class Cli:
                         term_size=(terminal_size.columns, terminal_size.lines),
                 ) as conn:
                     try:
-                        async with conn.create_process(
+                        self.terminal_process = await conn.create_process(
                             stdin=os.dup(sys.stdin.fileno()),
                             stdout=os.dup(sys.stdout.fileno()),
                             stderr=os.dup(sys.stderr.fileno()),
-                        ) as self.terminal_process:
-                            await self.terminal_process.wait()
+                        )
+                        await self.terminal_process.wait()
                     finally:
                         self.terminal_process = None
             except asyncio.CancelledError:

{devstack_cli-10.0.180 → devstack_cli-11.0.0/src/devstack_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: devstack-cli
-Version: 10.0.180
+Version: 11.0.0
 Summary: Command-line access to Cloud Development Environments (CDEs) created by Cloudomation DevStack
 Author-email: Stefan Mückstein <stefan@cloudomation.com>
 Project-URL: Homepage, https://cloudomation.com/

devstack_cli-11.0.0/src/version.py

@@ -0,0 +1,9 @@
+"""
+constants, set by build
+"""
+
+MAJOR = '11'
+BRANCH_NAME = 'release-11'
+BUILD_DATE = '2025-02-26-033416'
+SHORT_SHA = '0dab1e2'
+VERSION = '11+release-11.2025-02-26-033416.0dab1e2'

devstack_cli-10.0.180/src/version.py

@@ -1,9 +0,0 @@
-"""
-constants, set by build
-"""
-
-MAJOR = '10'
-BRANCH_NAME = 'release-10'
-BUILD_DATE = '2025-01-29-073316'
-SHORT_SHA = '8202cdc'
-VERSION = '10+release-10.2025-01-29-073316.8202cdc'