derivepassphrase.git

@@ -153,7 +153,7 @@ def skip_if_no_af_unix_support() -> None:  # pragma: no cover [external]

         pytest.skip("No Python or system support for UNIX domain sockets.")

-class SpawnFunc(Protocol):

+class SSHAgentSpawnFunc(Protocol):

     """Spawns an SSH agent, if possible."""

     def __call__(

@@ -315,21 +315,21 @@ class SpawnHandler(NamedTuple):

     key: str

     executable: str | None

-    spawn_func: SpawnFunc

+    spawn_func: SSHAgentSpawnFunc

     agent_type: tests.data.KnownSSHAgent

     agent_name: str | None

 spawn_handlers: dict[str, SpawnHandler] = {

-    "pageant": SpawnHandler(

-        "pageant",

+    "unix-pageant": SpawnHandler(

+        "unix-pageant",

         None,

         spawn_pageant_on_posix,

-        tests.data.KnownSSHAgent.Pageant,

+        tests.data.KnownSSHAgent.UNIXPageant,

         "Pageant (UNIX)",

     ),

-    "ssh-agent": SpawnHandler(

-        "ssh-agent",

+    "openssh": SpawnHandler(

+        "openssh",

         None,

         spawn_openssh_agent_on_posix,

         tests.data.KnownSSHAgent.OpenSSHAgent,

@@ -350,8 +350,8 @@ spawn_handlers: dict[str, SpawnHandler] = {

         "stub_agent_with_address_and_deterministic_dsa "

         "(derivepassphrase test suite)",

     ),

-    "(system)": SpawnHandler(

-        "(system)",

+    "(system-agent)": SpawnHandler(

+        "(system-agent)",

         None,

         spawn_noop,

         tests.data.KnownSSHAgent.UNKNOWN,

@@ -392,7 +392,7 @@ class CannotSpawnError(RuntimeError):

 def spawn_named_agent(

     executable: str | None,

-    spawn_func: SpawnFunc,

+    spawn_func: SSHAgentSpawnFunc,

     agent_type: tests.data.KnownSSHAgent,

     agent_name: str,

 ) -> Iterator[tests.data.SpawnedSSHAgentInfo]:  # pragma: no cover [external]

@@ -587,7 +587,7 @@ for key, handler in spawn_handlers.items():

             "environment variable.",

         ),

     ]

-    if key in {"pageant", "ssh-agent", "(system)"}:

+    if key in {"unix-pageant", "openssh", "(system-agent)"}:

         marks.append(

             pytest.mark.skipif(

                 not hasattr(socket, "AF_UNIX"),

@@ -824,12 +824,12 @@ def ssh_agent_client_with_test_keys_loaded(  # noqa: C901

                         pair.key for pair in client.list_keys()

                     })

                     if (

-                        agent_type == tests.data.KnownSSHAgent.Pageant

+                        agent_type == tests.data.KnownSSHAgent.UNIXPageant

                         and key_struct.public_key_data in current_loaded_keys

                     ):

                         pass

                     elif (

-                        agent_type == tests.data.KnownSSHAgent.Pageant

+                        agent_type == tests.data.KnownSSHAgent.UNIXPageant

                         and not isolated

                     ):

                         request_code, payload = prepare_payload(

@@ -163,10 +163,11 @@ class KnownSSHAgent(str, enum.Enum):

     Attributes:

         UNKNOWN (str):

             Not a known agent, or not known statically.

-        Pageant (str):

-            The agent from Simon Tatham's PuTTY suite.

+        UNIXPageant (str):

+            The agent from Simon Tatham's PuTTY suite (on

+            UNIX/BSD/POSIX).

         OpenSSHAgent (str):

-            The agent from OpenBSD's OpenSSH suite.

+            The agent from OpenBSD's OpenSSH suite (on UNIX/BSD/POSIX).

         StubbedSSHAgent (str):

             The stubbed, fake agent pseudo-socket defined in this test

             suite.

@@ -175,7 +176,7 @@ class KnownSSHAgent(str, enum.Enum):

     UNKNOWN = "(unknown)"

     """"""

-    Pageant = "Pageant"

+    UNIXPageant = "UNIXPageant"

     """"""

     OpenSSHAgent = "OpenSSHAgent"

     """"""

@@ -199,26 +199,22 @@ class SocketAddressAction(str, enum.Enum):

     """Test fixture settings for the SSH agent socket address.

     Attributes:

-        MANGLE_WINDOWS_NAMED_PIPE:

-            Mangle the address for the Windows named pipe endpoint.

-        MANGLE_SSH_AUTH_SOCK:

-            Mangle the address for the UNIX domain socket (the

-            `SSH_AUTH_SOCK` environment variable).

-        UNSET_WINDOWS_NAMED_PIPE:

-            Unset the address for the Windows named pipe endpoint.

-        UNSET_SSH_AUTH_SOCK:

-            Unset the `SSH_AUTH_SOCK` environment variable (the address

-            for the UNIX domain socket).

+        MANGLE_ADDRESS:

+            Mangle the socket address.

+

+            For UNIX domain sockets, mangle the `SSH_AUTH_SOCK`

+            environment variable.

+        UNSET_ADDRESS:

+            Unset the socket address.

+

+            For UNIX domain sockets, unset the `SSH_AUTH_SOCK`

+            environment variable.

     """

-    MANGLE_WINDOWS_NAMED_PIPE = enum.auto()

-    """"""

-    MANGLE_SSH_AUTH_SOCK = enum.auto()

+    MANGLE_ADDRESS = enum.auto()

     """"""

-    UNSET_WINDOWS_NAMED_PIPE = enum.auto()

-    """"""

-    UNSET_SSH_AUTH_SOCK = enum.auto()

+    UNSET_ADDRESS = enum.auto()

     """"""

     def __call__(

@@ -228,19 +224,14 @@ class SocketAddressAction(str, enum.Enum):

         # TODO(the-13th-letter): Rewrite using structural pattern

         # matching.

         # https://the13thletter.info/derivepassphrase/latest/pycompatibility/#after-eol-py3.9

-        if self in {

-            self.MANGLE_WINDOWS_NAMED_PIPE,

-            self.UNSET_WINDOWS_NAMED_PIPE,

-        }:  # pragma: no cover [unused]

-            pass

-        elif self == self.MANGLE_SSH_AUTH_SOCK:

+        if self == self.MANGLE_ADDRESS:

             monkeypatch.setenv(

                 "SSH_AUTH_SOCK",

                 os.environ["SSH_AUTH_SOCK"] + "~"

                 if "SSH_AUTH_SOCK" in os.environ

                 else "/",

             )

-        elif self == self.UNSET_SSH_AUTH_SOCK:

+        elif self == self.UNSET_ADDRESS:

             monkeypatch.delenv("SSH_AUTH_SOCK", raising=False)

         else:

             raise AssertionError()

@@ -480,7 +471,7 @@ class Parametrize(types.SimpleNamespace):

             ),

             pytest.param(

                 None,

-                SocketAddressAction.MANGLE_SSH_AUTH_SOCK,

+                SocketAddressAction.MANGLE_ADDRESS,

                 None,

                 SignAction.FAIL,

                 "Cannot connect to the SSH agent",

@@ -489,7 +480,7 @@ class Parametrize(types.SimpleNamespace):

             ),

             pytest.param(

                 None,

-                SocketAddressAction.UNSET_SSH_AUTH_SOCK,

+                SocketAddressAction.UNSET_ADDRESS,

                 None,

                 SignAction.FAIL,

                 "Cannot find any running SSH agent",