derivepassphrase.git

@@ -757,7 +757,7 @@ class SocketProvider:

             dist = (

                 entry_point.dist.name  # type: ignore[union-attr]

                 if getattr(entry_point, "dist", None) is not None

-                else None

+                else "<unknown>"

             )

             origin = origins.get(key, "derivepassphrase")

             if not callable(provider_entry.provider):

@@ -295,13 +295,13 @@ def spawn_noop(  # pragma: no cover [unused]

 spawn_handlers: dict[str, tuple[str, SpawnFunc, tests.data.KnownSSHAgent]] = {

-    "pageant": (

-        "pageant",

+    "unix-pageant": (

+        "unix-pageant",

         spawn_pageant_on_posix,

-        tests.data.KnownSSHAgent.Pageant,

+        tests.data.KnownSSHAgent.UNIXPageant,

     ),

-    "ssh-agent": (

-        "ssh-agent",

+    "openssh-agent": (

+        "openssh-agent",

         spawn_openssh_agent_on_posix,

         tests.data.KnownSSHAgent.OpenSSHAgent,

     ),

@@ -414,7 +414,7 @@ def spawn_named_agent(

         ):

             ssh_auth_sock = None

         elif spawn_func is spawn_noop:

-            ssh_auth_sock = os.environ["SSH_AUTH_SOCK"]

+            ssh_auth_sock = os.environ.get("SSH_AUTH_SOCK")

         elif proc is None:  # pragma: no cover [external]

             err_msg = f"Cannot spawn usable {exec_name}"

             raise CannotSpawnError(err_msg)

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

             reason="agent excluded via PERMITTED_AGENTS environment variable",

         ),

     ]

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

+    # Some agents require UNIX domain socket support.

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

         marks.append(

             pytest.mark.skipif(

                 not hasattr(socket, "AF_UNIX"),

@@ -656,7 +657,13 @@ def spawn_ssh_agent(

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

         try:

             yield from spawn_named_agent(*request.param)

-        except (KeyError, OSError, CannotSpawnError) as exc:

+        except KeyError as exc:

+            pytest.skip(

+                f"The environment variable {exc.args[0]!r} was not found"

+                if exc.__class__ is KeyError

+                else exc.args[0]

+            )

+        except (OSError, CannotSpawnError) as exc:

             pytest.skip(exc.args[0])

         return

@@ -756,12 +763,13 @@ def ssh_agent_client_with_test_keys_loaded(  # noqa: C901

                     current_loaded_keys = frozenset({

                         pair.key for pair in client.list_keys()

                     })

-                    if agent_type == tests.data.KnownSSHAgent.Pageant and (

+                    if agent_type == tests.data.KnownSSHAgent.UNIXPageant and (

                         key_struct.public_key_data in current_loaded_keys

                     ):

                         pass

-                    elif agent_type == tests.data.KnownSSHAgent.Pageant and (

-                        not isolated

+                    elif (

+                        agent_type == tests.data.KnownSSHAgent.UNIXPageant

+                        and (not isolated)

                     ):

                         request_code, payload = prepare_payload(

                             private_key_data, isolated=True

@@ -163,10 +163,16 @@ 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).

+        Pageant (str):

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

+        OpenSSHAgentOnWindows (str):

+            The agent from OpenBSD's OpenSSH suite (Powershell/Windows

+            version, on Windows).

         StubbedSSHAgent (str):

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

             suite.

@@ -175,10 +181,14 @@ class KnownSSHAgent(str, enum.Enum):

     UNKNOWN = "(unknown)"

     """"""

-    Pageant = "Pageant"

+    UNIXPageant = "UNIXPageant"

     """"""

     OpenSSHAgent = "OpenSSHAgent"

     """"""

+    Pageant = "Pageant"

+    """"""

+    OpenSSHAgentOnWindows = "OpenSSHAgentOnWindows"

+    """"""

     StubbedSSHAgent = "StubbedSSHAgent"

     """"""

@@ -342,22 +352,25 @@ class VaultTestConfig(NamedTuple):

 # ------------------------------

-posix_entry = _types.SSHAgentSocketProviderEntry(

-    socketprovider.SocketProvider.resolve("posix"), "posix", ()

+ssh_auth_sock_on_posix_entry = _types.SSHAgentSocketProviderEntry(

+    socketprovider.SocketProvider.resolve("ssh_auth_sock_on_posix"),

+    "ssh_auth_sock_on_posix",

+    (),

 )

 """

 The standard [`_types.SSHAgentSocketProviderEntry`][] for the UNIX

 domain socket handler on POSIX systems.

 """

-the_annoying_os_entry = _types.SSHAgentSocketProviderEntry(

-    socketprovider.SocketProvider.resolve("the_annoying_os"),

-    "the_annoying_os",

+pageant_on_the_annoying_os_entry = _types.SSHAgentSocketProviderEntry(

+    socketprovider.SocketProvider.resolve("pageant_on_the_annoying_os"),

+    "pageant_on_the_annoying_os",

     (),

 )

 """

 The standard [`_types.SSHAgentSocketProviderEntry`][] for the Windows

-named pipe handler on The Annoying Operating System.

+named pipe handler (connecting to Pageant) on The Annoying Operating

+System.

 """

 faulty_entry_callable = _types.SSHAgentSocketProviderEntry(

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

                 SignAction.FAIL,

                 "does not support communicating with it",

                 [],

-                id="no-agent-support",

+                id="no-native-agent-available",

             ),

             pytest.param(

                 None,

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

                 SignAction.FAIL,

                 "does not support communicating with it",

                 [],

-                id="no-agent-support",

+                id="no-agents-in-agent-provider-list",

             ),

             pytest.param(

                 None,

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

                 SignAction.FAIL,

                 "does not support communicating with it",

                 ["Cannot connect to an SSH agent via UNIX domain sockets"],

-                id="no-agent-support",

+                id="no-unix-domain-sockets",

             ),

             pytest.param(

                 None,

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

                 SignAction.FAIL,

                 "does not support communicating with it",

                 ["Cannot connect to an SSH agent via Windows named pipes"],

-                id="no-agent-support",

+                id="no-windows-named-pipes",

             ),

             pytest.param(

                 None,

@@ -80,14 +80,14 @@ class Parametrize(types.SimpleNamespace):

             pytest.param(

                 [

                     importlib.metadata.EntryPoint(

-                        name=data.posix_entry.key,

+                        name=data.ssh_auth_sock_on_posix_entry.key,

                         group=socketprovider.SocketProvider.ENTRY_POINT_GROUP_NAME,

-                        value="tests.data: posix_entry",

+                        value="tests.data: ssh_auth_sock_on_posix_entry",

                     ),

                     importlib.metadata.EntryPoint(

-                        name=data.the_annoying_os_entry.key,

+                        name=data.pageant_on_the_annoying_os_entry.key,

                         group=socketprovider.SocketProvider.ENTRY_POINT_GROUP_NAME,

-                        value="tests.data: the_annoying_os_entry",

+                        value="tests.data: pageant_on_the_annoying_os_entry",

                     ),

                 ],

                 id="existing-entries",

@@ -818,10 +818,10 @@ class TestSSHAgentSocketProviderRegistry:

     ) -> None:

         """Resolving a non-existant entry fails."""

         new_registry = {

-            "posix": socketprovider.SocketProvider.registry["posix"],

-            "the_annoying_os": socketprovider.SocketProvider.registry[

+            "posix": socketprovider.SocketProvider.resolve("posix"),

+            "the_annoying_os": socketprovider.SocketProvider.resolve(

                 "the_annoying_os"

-            ],

+            ),

         }

         with pytest.MonkeyPatch.context() as monkeypatch:

             monkeypatch.setattr(

@@ -840,10 +840,10 @@ class TestSSHAgentSocketProviderRegistry:

         names = ["spam", "ham", "eggs", "parrot"]

         new_registry = {

-            "posix": socketprovider.SocketProvider.registry["posix"],

-            "the_annoying_os": socketprovider.SocketProvider.registry[

+            "posix": socketprovider.SocketProvider.resolve("posix"),

+            "the_annoying_os": socketprovider.SocketProvider.resolve(

                 "the_annoying_os"

-            ],

+            ),

         }

         with pytest.MonkeyPatch.context() as monkeypatch:

             monkeypatch.setattr(

@@ -873,12 +873,12 @@ class TestSSHAgentSocketProviderRegistry:

         provider = socketprovider.SocketProvider.resolve(existing)

         new_registry = {

-            "posix": socketprovider.SocketProvider.registry["posix"],

-            "the_annoying_os": socketprovider.SocketProvider.registry[

+            "posix": socketprovider.SocketProvider.resolve("posix"),

+            "the_annoying_os": socketprovider.SocketProvider.resolve(

                 "the_annoying_os"

-            ],

+            ),

             "unix_domain": "posix",

-            "the_annoying_os_named_pipe": "the_annoying_os",

+            "windows_named_pipe": "the_annoying_os",

         }

         names = [

             k