feat: added a set-auth command to set authentication details for a host in config, allowing users to store password/passphrases for specific hosts/ssh-keys in system's keyring

Author: Blackmamoth

src/sshsync/cli.py

@@ -168,8 +168,11 @@ def sync():
         print_error(e, True)
 
 
-@app.command(help="Set authentication method for one or more host")
+@app.command(help="Set authentication method for one or more unconfigured hosts.")
 def set_auth():
+    """
+    Set authentication method for one or more unconfigured hosts.
+    """
     try:
         config = Config()
         hosts = config.get_unconfigured_hosts()
@@ -253,7 +256,9 @@ def push(
             else (
                 config.get_hosts_by_group(group, regex)
                 if group
-                else [host_obj] if host_obj is not None else []
+                else [host_obj]
+                if host_obj is not None
+                else []
             )
         )
 
@@ -348,7 +353,9 @@ def pull(
             else (
                 config.get_hosts_by_group(group, regex)
                 if group
-                else [host_obj] if host_obj is not None else []
+                else [host_obj]
+                if host_obj is not None
+                else []
             )
         )
 

src/sshsync/client.py

@@ -185,9 +185,9 @@ async def _execute_command(
                     conn_kwargs["client_keys"] = [host.identity_file]
                 else:
                     host_pass = self.get_host_pass(host.alias)
-                    if host_pass is not None:
+                    if host_pass:
                         host_auth = self.config.config.host_auth.get(host.alias, None)
-                        if host_auth is not None:
+                        if host_auth:
                             if host_auth.auth == "key":
                                 conn_kwargs["client_keys"] = [host.identity_file]
                                 conn_kwargs["passphrase"] = host_pass
@@ -287,9 +287,9 @@ async def _push(
                 conn_kwargs["client_keys"] = [host.identity_file]
             else:
                 host_pass = self.get_host_pass(host.alias)
-                if host_pass is not None:
+                if host_pass:
                     host_auth = self.config.config.host_auth.get(host.alias, None)
-                    if host_auth is not None:
+                    if host_auth:
                         if host_auth.auth == "key":
                             conn_kwargs["client_keys"] = [host.identity_file]
                             conn_kwargs["passphrase"] = host_pass
@@ -360,9 +360,9 @@ async def _pull(
                 conn_kwargs["client_keys"] = [host.identity_file]
             else:
                 host_pass = self.get_host_pass(host.alias)
-                if host_pass is not None:
+                if host_pass:
                     host_auth = self.config.config.host_auth.get(host.alias, None)
-                    if host_auth is not None:
+                    if host_auth:
                         if host_auth.auth == "key":
                             conn_kwargs["client_keys"] = [host.identity_file]
                             conn_kwargs["passphrase"] = host_pass

src/sshsync/config.py

@@ -47,9 +47,21 @@ def __init__(self) -> None:
         self.configure_ssh_hosts()
 
     def configured_hosts(self):
+        """
+        Return a list of all configured hosts except the default host.
+
+        Returns:
+            list[Host]: List of configured Host objects excluding the default.
+        """
         return list(filter(lambda x: x.alias != "default", self.hosts))
 
     def _default_config(self) -> YamlConfig:
+        """
+        Return a default YamlConfig object with empty groups and host_auth.
+
+        Returns:
+            YamlConfig: Default configuration object.
+        """
         return YamlConfig(groups=dict(), host_auth=dict())
 
     def ensure_config_directory_exists(self) -> None:
@@ -62,6 +74,16 @@ def ensure_config_directory_exists(self) -> None:
     def _resolve_ssh_value(
         self, value: str | int | list[str | int] | None, default: str | int = ""
     ) -> str | int:
+        """
+        Resolve a value from SSH config, handling lists and defaults.
+
+        Args:
+            value (str | int | list[str | int] | None): The value to resolve.
+            default (str | int): Default value if input is None or empty.
+
+        Returns:
+            str | int: The resolved value.
+        """
         if isinstance(value, list):
             return value[0] if value else default
         return value or default
@@ -243,6 +265,12 @@ def get_ungrouped_hosts(self) -> list[str]:
         ]
 
     def get_unconfigured_hosts(self) -> list[dict[str, str]]:
+        """
+        Get a list of hosts that do not have authentication configured.
+
+        Returns:
+            list[dict[str, str]]: List of dicts with alias and identity_file for unconfigured hosts.
+        """
         return [
             {"alias": host.alias, "identity_file": host.identity_file}
             for host in self.hosts
@@ -266,6 +294,12 @@ def assign_groups_to_hosts(self, host_group_mapping: dict[str, list[str]]) -> No
         self._save_yaml()
 
     def save_host_auth(self, host_auth_details: dict[str, HostAuth]) -> None:
+        """
+        Save authentication details for hosts and update the YAML config file.
+
+        Args:
+            host_auth_details (dict[str, HostAuth]): Mapping of host aliases to HostAuth objects.
+        """
         self.config.host_auth = host_auth_details
         self._save_yaml()
 

src/sshsync/logging.py

@@ -5,6 +5,7 @@
 
 
 def get_log_path() -> Path:
+    """Return the log directory path, creating it if needed."""
     home = Path.home()
     if sys.platform.startswith("win"):
         log_dir = home.joinpath("AppData", "Local", "sshsync", "logs")
@@ -19,6 +20,7 @@ def get_log_path() -> Path:
 
 
 def setup_logging():
+    """Configure structlog for file logging."""
     structlog.configure(
         processors=[
             structlog.processors.TimeStamper(fmt="iso"),

src/sshsync/schemas.py

@@ -42,6 +42,14 @@ class Host:
 
 @dataclass
 class HostAuth:
+    """
+    Authentication method and passphrase info for a host.
+
+    Attributes:
+        auth (Literal["key", "password"]): Authentication type.
+        key_has_passphrase (bool | None): Whether the key has a passphrase.
+    """
+
     auth: Literal["key", "password"]
     key_has_passphrase: bool | None
 
@@ -53,18 +61,18 @@ class YamlConfig:
 
     Attributes:
         groups (dict[str, list[str]]): A mapping of group names to lists of host aliases.
+        host_auth (dict[str, HostAuth]): Mapping of host aliases to authentication info.
     """
 
     groups: dict[str, list[str]]
     host_auth: dict[str, HostAuth]
 
-    def as_dict(self) -> dict:
+    def as_dict(self) -> dict[str, object]:
         """
         Converts the `YamlConfig` instance into a dictionary format.
 
         Returns:
-            dict: A dictionary representation of the `YamlConfig` instance, where keys are attribute names
-                  and values are the corresponding attribute values.
+            dict: A dictionary representation of the `YamlConfig` instance.
         """
         return asdict(self)
 

src/sshsync/utils.py

@@ -92,6 +92,7 @@ def is_key_private(key_path: str) -> bool:
 
 
 def check_key_passphrase(key_path: str, passphrase: str) -> bool:
+    """Check if the given passphrase unlocks the SSH key."""
     path = Path(key_path).expanduser()
     if not key_path or not path.exists() or path.is_dir():
         return False
@@ -105,6 +106,7 @@ def check_key_passphrase(key_path: str, passphrase: str) -> bool:
 def get_pass(
     host: str, pass_type: Literal["passphrase", "password"], key_path: str = ""
 ) -> str:
+    """Prompt the user for a password or passphrase, validating if needed."""
     while True:
         val = Prompt.ask(f"Please enter {pass_type} for host `{host}`", password=True)
         if not val.strip():
@@ -118,6 +120,7 @@ def get_pass(
 
 
 def set_keyring(host: str, password: str):
+    """Store a password in the keyring for a host."""
     keyring.set_password("sshsync", host, password)