derivepassphrase.git

@@ -462,6 +462,11 @@ class SpawnedSSHAgentInfo(NamedTuple):

     isolated: bool

+class RunningSSHAgentInfo(NamedTuple):

+    socket: str

+    agent_type: KnownSSHAgent

+

+

 SUPPORTED_KEYS: Mapping[str, SSHTestKey] = {

     'ed25519': {

         'private_key': rb"""-----BEGIN OPENSSH PRIVATE KEY-----

@@ -234,7 +234,7 @@ _spawn_handlers = [

 @pytest.fixture

 def running_ssh_agent(  # pragma: no cover

     skip_if_no_af_unix_support: None,

-) -> Iterator[str]:

+) -> Iterator[tests.RunningSSHAgentInfo]:

     """Ensure a running SSH agent, if possible, as a pytest fixture.

     Check for a running SSH agent, or spawn a new one if possible.  We

@@ -245,9 +245,11 @@ def running_ssh_agent(  # pragma: no cover

     can it guarantee a particular set of loaded keys.

     Yields:

-        str:

-            The value of the SSH_AUTH_SOCK environment variable, to be

-            used to connect to the running agent.

+        :

+            A 2-tuple `(ssh_auth_sock, agent_type)`, where

+            `ssh_auth_sock` is the value of the `SSH_AUTH_SOCK`

+            environment variable, to be used to connect to the running

+            agent, and `agent_type` is the agent type.

     Raises:

         pytest.skip.Exception:

@@ -279,7 +281,7 @@ def running_ssh_agent(  # pragma: no cover

             monkeypatch.setenv('SSH_AUTH_SOCK', startup_ssh_auth_sock)

         else:  # pragma: no cover

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

-        for exec_name, spawn_func, _ in _spawn_handlers:

+        for exec_name, spawn_func, agent_type in _spawn_handlers:

             # Use match/case here once Python 3.9 becomes unsupported.

             if exec_name == '(system)':

                 assert (

@@ -291,7 +293,9 @@ def running_ssh_agent(  # pragma: no cover

                         client.list_keys()

                 except (KeyError, OSError):

                     continue

-                yield os.environ['SSH_AUTH_SOCK']

+                yield tests.RunningSSHAgentInfo(

+                    os.environ['SSH_AUTH_SOCK'], agent_type

+                )

                 assert (

                     os.environ.get('SSH_AUTH_SOCK', None)

                     == startup_ssh_auth_sock

@@ -342,7 +346,7 @@ def running_ssh_agent(  # pragma: no cover

                         pytest.MonkeyPatch.context()

                     )

                     monkeypatch2.setenv('SSH_AUTH_SOCK', ssh_auth_sock)

-                    yield ssh_auth_sock

+                    yield tests.RunningSSHAgentInfo(ssh_auth_sock, agent_type)

                 assert (

                     os.environ.get('SSH_AUTH_SOCK', None)

                     == startup_ssh_auth_sock

@@ -403,12 +403,12 @@ class TestCLI:

     def test_204c_key_override_on_command_line(

         self,

         monkeypatch: pytest.MonkeyPatch,

-        running_ssh_agent: str,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

         config: dict[str, Any],

         key_index: int,

     ) -> None:

         with monkeypatch.context():

-            monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent)

+            monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent.socket)

             monkeypatch.setattr(

                 ssh_agent.SSHAgentClient, 'list_keys', tests.list_keys

             )

@@ -433,10 +433,10 @@ class TestCLI:

     def test_205_service_phrase_if_key_in_global_config(

         self,

         monkeypatch: pytest.MonkeyPatch,

-        running_ssh_agent: str,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

     ) -> None:

         with monkeypatch.context():

-            monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent)

+            monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent.socket)

             monkeypatch.setattr(

                 ssh_agent.SSHAgentClient, 'list_keys', tests.list_keys

             )

@@ -491,11 +491,11 @@ class TestCLI:

     def test_206_setting_service_phrase_thus_overriding_key_in_config(

         self,

         monkeypatch: pytest.MonkeyPatch,

-        running_ssh_agent: str,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

         config: _types.VaultConfig,

     ) -> None:

         with monkeypatch.context():

-            monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent)

+            monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent.socket)

             monkeypatch.setattr(

                 ssh_agent.SSHAgentClient, 'list_keys', tests.list_keys

             )

@@ -1789,11 +1789,11 @@ Boo.

     def test_227_get_suitable_ssh_keys(

         self,

         monkeypatch: pytest.MonkeyPatch,

-        running_ssh_agent: str,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

         conn_hint: str,

     ) -> None:

         with monkeypatch.context():

-            monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent)

+            monkeypatch.setenv('SSH_AUTH_SOCK', running_ssh_agent.socket)

             monkeypatch.setattr(

                 ssh_agent.SSHAgentClient, 'list_keys', tests.list_keys

             )

@@ -1803,7 +1803,7 @@ Boo.

                 hint = ssh_agent.SSHAgentClient()

             elif conn_hint == 'socket':

                 hint = socket.socket(family=socket.AF_UNIX)

-                hint.connect(running_ssh_agent)

+                hint.connect(running_ssh_agent.socket)

             else:

                 assert conn_hint == 'none'

                 hint = None

@@ -348,10 +348,12 @@ class TestAgentInteraction:

     def test_300_constructor_bad_running_agent(

         self,

         monkeypatch: pytest.MonkeyPatch,

-        running_ssh_agent: str,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

     ) -> None:

         with monkeypatch.context() as monkeypatch2:

-            monkeypatch2.setenv('SSH_AUTH_SOCK', running_ssh_agent + '~')

+            monkeypatch2.setenv(

+                'SSH_AUTH_SOCK', running_ssh_agent.socket + '~'

+            )

             sock = socket.socket(family=socket.AF_UNIX)

             with pytest.raises(OSError):  # noqa: PT011

                 ssh_agent.SSHAgentClient(socket=sock)

@@ -379,7 +381,7 @@ class TestAgentInteraction:

     def test_310_truncated_server_response(

         self,

         monkeypatch: pytest.MonkeyPatch,

-        running_ssh_agent: str,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

         response: bytes,

     ) -> None:

         del running_ssh_agent

@@ -424,7 +426,7 @@ class TestAgentInteraction:

     def test_320_list_keys_error_responses(

         self,

         monkeypatch: pytest.MonkeyPatch,

-        running_ssh_agent: str,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

         response_code: _types.SSH_AGENT,

         response: bytes | bytearray,

         exc_type: type[Exception],

@@ -500,7 +502,7 @@ class TestAgentInteraction:

     def test_330_sign_error_responses(

         self,

         monkeypatch: pytest.MonkeyPatch,

-        running_ssh_agent: str,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

         key: bytes | bytearray,

         check: bool,

         response_code: _types.SSH_AGENT,

@@ -567,7 +569,7 @@ class TestAgentInteraction:

     )

     def test_340_request_error_responses(

         self,

-        running_ssh_agent: str,

+        running_ssh_agent: tests.RunningSSHAgentInfo,

         request_code: _types.SSH_AGENTC,

         response_code: _types.SSH_AGENT,

         exc_type: type[Exception],