aws-ssh-utils 0.4.0__tar.gz → 0.5.0__tar.gz

{aws_ssh_utils-0.4.0 → aws_ssh_utils-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: aws-ssh-utils
-Version: 0.4.0
+Version: 0.5.0
 Summary: Easy AWS SSHing
 Project-URL: Homepage, https://github.com/mvanderlee/aws-ssh-utils
 Author-email: Michiel Vanderlee <jmt.vanderlee@gmail.com>
@@ -86,9 +86,14 @@ Options:
 ```
 
 Scroll back with the mouse wheel or `shift+PgUp`/`shift+PgDn`; typing jumps back to the prompt.
-`F12` shows/hides the sidebar, `ctrl+w` closes a failed tab, `ctrl+q` quits. Every other key goes to the focused shell.
+`F5` refreshes the EC2 and EMR lists, `F12` shows/hides the sidebar, `ctrl+w` closes a failed tab, `ctrl+q` quits.
+Every other key goes to the focused shell.
 Logs are viewable with `textual console`.
 
+Right-click an EC2 instance and choose **Custom…** to select an SSH key, private or public IP, and username.
+The form selects the instance's matching private key from `~/.ssh` and detects the username from its AMI.
+**Connect** opens a shell using those settings directly over SSH.
+
 To keep diagnostics and crash tracebacks in a file, use the global `--log-file` option:
 
 ```shell

{aws_ssh_utils-0.4.0 → aws_ssh_utils-0.5.0}/README.md

@@ -48,9 +48,14 @@ Options:
 ```
 
 Scroll back with the mouse wheel or `shift+PgUp`/`shift+PgDn`; typing jumps back to the prompt.
-`F12` shows/hides the sidebar, `ctrl+w` closes a failed tab, `ctrl+q` quits. Every other key goes to the focused shell.
+`F5` refreshes the EC2 and EMR lists, `F12` shows/hides the sidebar, `ctrl+w` closes a failed tab, `ctrl+q` quits.
+Every other key goes to the focused shell.
 Logs are viewable with `textual console`.
 
+Right-click an EC2 instance and choose **Custom…** to select an SSH key, private or public IP, and username.
+The form selects the instance's matching private key from `~/.ssh` and detects the username from its AMI.
+**Connect** opens a shell using those settings directly over SSH.
+
 To keep diagnostics and crash tracebacks in a file, use the global `--log-file` option:
 
 ```shell

aws_ssh_utils-0.5.0/aws_ssh_utils/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.5.0"

{aws_ssh_utils-0.4.0 → aws_ssh_utils-0.5.0}/aws_ssh_utils/commands/app.py

@@ -25,6 +25,7 @@ from textual.widgets.option_list import Option
 from textual.widgets.tree import TreeNode
 
 from aws_ssh_utils.cli_utils import detect_environment, detect_scrollback, render_attempts, scrollback_option
+from aws_ssh_utils.commands.custom_connection import CustomConnection
 from aws_ssh_utils.connection import Attempt, Environment, Target, connect, open_shell_channel
 from aws_ssh_utils.ec2_utils import ec2_name, ec2_target, get_running_ec2_instances, get_vpc_names
 from aws_ssh_utils.emr_utils import emr_target, get_emr_clusters, get_emr_instances, group_role, group_sort_key
@@ -251,6 +252,7 @@ class SSHApp(TerminalApp):
     """
     BINDINGS: ClassVar[list[BindingType]] = [
         Binding('ctrl+q', 'quit', 'Quit', priority=True),
+        Binding('f5', 'refresh_instances', 'Refresh', priority=True),
         Binding('f12', 'toggle_sidebar', 'Toggle sidebar', priority=True),
         Binding('ctrl+w', 'close_tab', 'Close tab'),
     ]
@@ -320,6 +322,18 @@ class SSHApp(TerminalApp):
         if shells.active:
             shells.remove_pane(shells.active)
 
+    def action_refresh_instances(self):
+        # Let in-flight list requests finish before invalidating their results.
+        if any(worker.node is self and not worker.is_finished for worker in self.workers):
+            return
+        for prefix in ('ec2', 'emr'):
+            self.query_one(f'#{prefix}-error').display = False
+            self.query_one(f'#{prefix}-loading').display = True
+        self.cluster_instances.clear()
+        self.filter_emr()
+        self.load_ec2()
+        self.load_emr()
+
     def on_tabbed_content_tab_activated(self, event: TabbedContent.TabActivated):
         if event.tabbed_content.id != 'shells' or event.pane.id != event.tabbed_content.active:
             return
@@ -400,10 +414,17 @@ class SSHApp(TerminalApp):
         options = [
             Option('Connect via private IP', id='private'),
             Option('Connect via public IP', id='public', disabled=not instance.get('PublicIpAddress')),
+            Option('Custom…', id='custom'),
         ]
 
+        def on_custom(target: Target | None):
+            if target is not None:
+                self.open_shell(f'{target.user}@{ec2_name(instance)}', lambda: target)
+
         def on_choice(choice: str | None):
-            if choice:
+            if choice == 'custom':
+                self.push_screen(CustomConnection(self.ec2, instance), on_custom)
+            elif choice:
                 self.open_ec2_shell(instance, public=choice == 'public')
 
         self.push_screen(ContextMenu(event.screen_offset, options), on_choice)

aws_ssh_utils-0.5.0/aws_ssh_utils/commands/custom_connection.py

@@ -0,0 +1,132 @@
+"""Custom SSH connection form for an EC2 instance."""
+
+from pathlib import Path
+from typing import TYPE_CHECKING, ClassVar
+
+from botocore.exceptions import BotoCoreError, ClientError
+from textual import work
+from textual.app import ComposeResult
+from textual.binding import Binding, BindingType
+from textual.containers import Horizontal, Vertical
+from textual.screen import ModalScreen
+from textual.widgets import Button, Input, Label, RadioButton, RadioSet, Select, Static
+
+from aws_ssh_utils.connection import Target, list_ssh_key_files
+from aws_ssh_utils.ec2_utils import ec2_name, guess_ec2_user
+
+if TYPE_CHECKING:
+    from mypy_boto3_ec2 import EC2Client
+    from mypy_boto3_ec2.type_defs import InstanceTypeDef
+
+
+class CustomConnection(ModalScreen[Target | None]):
+    DEFAULT_CSS = """
+    CustomConnection { align: center middle; }
+    CustomConnection > Vertical {
+        width: 64;
+        max-width: 95%;
+        height: auto;
+        max-height: 95%;
+        overflow-y: auto;
+        padding: 1 2;
+        border: round $accent;
+        background: $surface;
+    }
+    CustomConnection Label { margin-top: 1; }
+    CustomConnection RadioSet { width: 1fr; height: auto; }
+    CustomConnection Horizontal { height: auto; margin-top: 1; align-horizontal: right; }
+    CustomConnection Button { margin-left: 1; }
+    CustomConnection #custom-error { color: $error; height: auto; }
+    """
+    BINDINGS: ClassVar[list[BindingType]] = [Binding('escape', 'cancel', 'Cancel')]
+
+    def __init__(self, ec2: 'EC2Client', instance: 'InstanceTypeDef'):
+        super().__init__()
+        self.ec2 = ec2
+        self.instance = instance
+
+    def compose(self) -> ComposeResult:
+        private = self.instance.get('PrivateIpAddress', '')
+        public = self.instance.get('PublicIpAddress', '')
+        with Vertical():
+            yield Static(f'Custom connection — {ec2_name(self.instance)}', markup=False)
+            yield Label('SSH key')
+            yield Select([('Default keys / SSH agent', '')], allow_blank=False, id='custom-key', disabled=True)
+            yield Label('Address')
+            with RadioSet(id='custom-address'):
+                yield RadioButton(f'Private: {private or "unavailable"}', value=bool(private), disabled=not private, id='private')
+                yield RadioButton(
+                    f'Public: {public or "unavailable"}',
+                    value=bool(public and not private),
+                    disabled=not public,
+                    id='public',
+                )
+            yield Label('User')
+            yield Input(placeholder='Detecting username…', id='custom-user', disabled=True)
+            yield Static('', id='custom-error', markup=False)
+            with Horizontal():
+                yield Button('Cancel', id='custom-cancel')
+                yield Button('Connect', variant='primary', id='custom-connect', disabled=True)
+
+    def on_mount(self):
+        self.load_defaults()
+
+    @work(thread=True, exit_on_error=False)
+    def load_defaults(self):
+        keys = list_ssh_key_files()
+        error = ''
+        try:
+            user = guess_ec2_user(self.ec2, self.instance)
+        except (BotoCoreError, ClientError):
+            user = ''
+            error = 'Could not detect the username. Enter the SSH user.'
+        self.app.call_from_thread(self.set_defaults, keys, user, error)
+
+    def set_defaults(self, keys: list[str], user: str, error: str):
+        if not self.is_mounted:
+            return
+        select = self.query_one('#custom-key', Select)
+        select.set_options([('Default keys / SSH agent', ''), *((key, key) for key in keys)])
+        key_name = self.instance.get('KeyName')
+        select.value = next((key for key in keys if key_name in (Path(key).name, Path(key).stem)), '')
+        select.disabled = False
+        user_input = self.query_one('#custom-user', Input)
+        user_input.value = user
+        user_input.placeholder = 'SSH username'
+        user_input.disabled = False
+        self.query_one('#custom-error', Static).update(error)
+        self.query_one('#custom-connect', Button).disabled = False
+
+    def on_input_changed(self, event: Input.Changed):
+        event.stop()
+
+    def action_cancel(self):
+        self.dismiss(None)
+
+    def on_button_pressed(self, event: Button.Pressed):
+        event.stop()
+        if event.button.id == 'custom-cancel':
+            self.action_cancel()
+            return
+        user_input = self.query_one('#custom-user', Input)
+        user = user_input.value.strip()
+        error = self.query_one('#custom-error', Static)
+        if not user or any(char.isspace() for char in user):
+            error.update('Enter an SSH username without spaces.')
+            user_input.focus()
+            return
+        address = self.query_one('#custom-address', RadioSet).pressed_button
+        ip = self.instance.get('PublicIpAddress' if address and address.id == 'public' else 'PrivateIpAddress', '')
+        if not ip:
+            error.update('This instance has no available IP address.')
+            return
+        key = self.query_one('#custom-key', Select).value
+        self.dismiss(
+            Target(
+                instance_id=self.instance.get('InstanceId', ''),
+                ip=ip,
+                user=user,
+                key_file=key if isinstance(key, str) and key else None,
+                ssh_only=True,
+            ),
+        )

{aws_ssh_utils-0.4.0 → aws_ssh_utils-0.5.0}/aws_ssh_utils/connection.py

@@ -44,6 +44,8 @@ class Target:
     key_file: str | None = None
     """Explicit key file, used instead of looking up `key_name` in ~/.ssh."""
     opkssh_provider: str | None = None
+    ssh_only: bool = False
+    """Connect directly with this user, IP and key, bypassing automatic connection strategies."""
 
 
 @dataclass(frozen=True)
@@ -94,6 +96,7 @@ def connect(
 
     `on_progress` gets a snapshot of all attempts whenever one changes state.
     Unknown host keys are trusted, unless `confirm_host_key` declines them.
+    With `target.ssh_only`, only the supplied SSH settings are tried.
     """
     open_ssh_ = partial(open_ssh, confirm_host_key=confirm_host_key)
     attempts: list[Attempt] = []
@@ -116,6 +119,17 @@ def connect(
         on_progress(list(attempts))
         return Connection(client, attempt.via)
 
+    if target.ssh_only:
+        keys = [target.key_file] if target.key_file else []
+        attempts.append(
+            Attempt(
+                Path(target.key_file).stem if target.key_file else 'default key',
+                ssh_command(target.user, target.ip, keys, identities_only=bool(keys)),
+                lambda: open_ssh_(target.ip, target.user, keys, use_defaults=not keys),
+            ),
+        )
+        return try_attempt(0)
+
     config = find_ssh_config(target)
     if config is not None:
         alias, options = config
@@ -369,6 +383,22 @@ def proxy_socket(command: str | list[str], on_stderr: OnOutput) -> socket.socket
 
 
 # region - keys
+def list_ssh_key_files() -> list[str]:
+    """Find OpenSSH/PEM private keys in ~/.ssh, including nested directories."""
+    keys = []
+    for dirpath, _, filenames in os.walk(SSH_DIR):
+        for name in filenames:
+            path = Path(dirpath) / name
+            try:
+                with path.open('rb') as key:
+                    header = key.readline(128).strip()
+            except OSError:
+                continue
+            if header.startswith(b'-----BEGIN ') and header.endswith(b'PRIVATE KEY-----'):
+                keys.append(str(path))
+    return sorted(keys, key=str.casefold)
+
+
 def find_ssh_key_file(key_name: str | None) -> str | None:
     """Recursively search ~/.ssh for a file named `key_name`, with or without extension."""
     if not key_name:

aws_ssh_utils-0.4.0/aws_ssh_utils/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.4.0"