Add option to specify no user when generating SSH commands and config

Author: bennuttall

hostedpi/cli/options.py

@@ -25,6 +25,7 @@
 ipv6 = Annotated[bool, Option(help="Use the IPv6 connection method")]
 numeric = Annotated[bool, Option("--numeric", "-n", help="Use numeric IPv6 address in SSH command")]
 user = Annotated[str, Option("--username", "-u", help="Username for SSH connection")]
+no_user = Annotated[bool, Option("--no-user", help="Don't include a username in SSH command")]
 yes = Annotated[bool, Option("--yes", "-y", help="Proceed without confirmation")]
 number = Annotated[Union[int, None], Option(help="Number of Raspberry Pi servers to create", min=1)]
 full_table = Annotated[bool, Option(help="Show full table of Raspberry Pi server info")]

hostedpi/cli/ssh.py

@@ -16,6 +16,7 @@ def do_command(
     ipv6: options.ipv6 = False,
     numeric: options.numeric = False,
     user: options.user = "root",
+    no_user: options.no_user = False,
 ):
     """
     Get the SSH command to connect to a Raspberry Pi server
@@ -24,6 +25,9 @@ def do_command(
         print_error("--numeric is only supported with --ipv6")
         raise Exit(1)
 
+    if no_user:
+        user = None
+
     pi = get_pi(name)
     if pi is None:
         print_error(f"Pi '{name}' not found")
@@ -45,6 +49,7 @@ def do_config(
     ipv6: options.ipv6 = False,
     numeric: options.numeric = False,
     user: options.user = "root",
+    no_user: options.no_user = False,
 ):
     """
     Get the SSH config to connect to one or more Raspberry Pi servers
@@ -53,6 +58,9 @@ def do_config(
         print_error("--numeric is only supported with --ipv6")
         raise Exit(1)
 
+    if no_user:
+        user = None
+
     pis = get_pis(names, filter)
     for pi in pis:
         try:

hostedpi/pi.py

@@ -497,47 +497,55 @@ def cancel(self):
 
         self._cancelled = True
 
-    def get_ipv4_ssh_command(self, user: str = "root") -> str:
+    def get_ipv4_ssh_command(self, user: Union[str, None] = "root") -> str:
         """
         Construct an SSH command required to connect to the Pi using SSH over IPv4
         """
+        if user is None:
+            return f"ssh -p {self.ipv4_ssh_port} {self.ipv4_ssh_hostname}"
         return f"ssh -p {self.ipv4_ssh_port} {user}@{self.ipv4_ssh_hostname}"
 
-    def get_ipv6_ssh_command(self, *, user: str = "root", numeric: bool = False) -> str:
+    def get_ipv6_ssh_command(
+        self, *, user: Union[str, None] = "root", numeric: bool = False
+    ) -> str:
         """
         Construct an SSH command required to connect to the Pi using SSH over IPv6
         """
         if numeric:
+            if user is None:
+                return f"ssh [{self.ipv6_address.compressed}]"
             return f"ssh {user}@[{self.ipv6_address.compressed}]"
         else:
+            if user is None:
+                return f"ssh {self.ipv6_ssh_hostname}"
             return f"ssh {user}@{self.ipv6_ssh_hostname}"
 
-    def get_ipv4_ssh_config(self, user: str = "root") -> str:
+    def get_ipv4_ssh_config(self, user: Union[str, None] = "root") -> str:
         """
         Construct a string containing the IPv4 SSH config for the Pi. The contents could be added to
         an SSH config file for easy access to the Pi.
         """
-        return f"""Host {self.name}
-    user {user}
-    port {self.ipv4_ssh_port}
-    hostname {self.ipv4_ssh_hostname}
-        """.strip()
+        host_line = f"Host {self.name}\n"
+        user_line = f"    user {user}\n" if user else ""
+        port_line = f"    port {self.ipv4_ssh_port}\n"
+        hostname_line = f"    hostname {self.ipv4_ssh_hostname}"
+        return host_line + user_line + port_line + hostname_line
 
     def get_ipv6_ssh_config(
         self,
         *,
-        user: str = "root",
+        user: Union[str, None] = "root",
         numeric: bool = False,
     ) -> str:
         """
         Construct a string containing the SSH config for the Pi. The contents could be added to an
         SSH config file for easy access to the Pi.
         """
         hostname = self.ipv6_address.compressed if numeric else self.ipv6_ssh_hostname
-        return f"""Host {self.name}
-    user {user}
-    hostname {hostname}
-        """.strip()
+        host_line = f"Host {self.name}\n"
+        user_line = f"    user {user}\n" if user else ""
+        hostname_line = f"    hostname {hostname}"
+        return host_line + user_line + hostname_line
 
     def add_ssh_keys(self, ssh_keys: SSHKeySources) -> set[str]:
         """

hostedpi/picloud.py

@@ -109,14 +109,14 @@ def ipv6_ssh_config(self) -> str:
         """
         return self.get_ipv6_ssh_config()
 
-    def get_ipv4_ssh_config(self, user: str = "root") -> str:
+    def get_ipv4_ssh_config(self, user: Union[str, None] = "root") -> str:
         """
         Construct a string containing the IPv4 SSH config for all Pis within the account. The
         contents could be added to an SSH config file for easy access to the Pis in the account.
         """
         return "\n".join(pi.get_ipv4_ssh_config(user=user) for pi in self.pis.values())
 
-    def get_ipv6_ssh_config(self, user: str = "root", numeric: bool = False) -> str:
+    def get_ipv6_ssh_config(self, user: Union[str, None] = "root", numeric: bool = False) -> str:
         """
         Construct a string containing the IPv6 SSH config for all Pis within the account. The
         contents could be added to an SSH config file for easy access to the Pis in the account.