feature: allow agent forwarding with paramiko (#130)

Author: chrishoage

changelogs/fragments/130-connection-forward-agent.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - proxmox_pct_remote - allow forward agent with paramiko (https://github.com/ansible-collections/community.proxmox/pull/130).

plugins/connection/proxmox_pct_remote.py

@@ -159,6 +159,15 @@
     ini:
       - section: defaults
         key: use_persistent_connections
+  forward_agent:
+    description: "Enable SSH agent forwarding."
+    type: boolean
+    default: False
+    env:
+      - name: ANSIBLE_PARAMIKO_FORWARD_AGENT
+    ini:
+      - section: paramiko_connection
+        key: forward_agent
   banner_timeout:
     type: float
     default: 30
@@ -676,6 +685,9 @@ def exec_command(self, cmd: str, in_data: bytes | None = None, sudoable: bool =
 
         display.vvv(f'EXEC {cmd}', host=self.get_option('remote_addr'))
 
+        if self.get_option('forward_agent'):
+            paramiko.agent.AgentRequestHandler(chan)
+
         cmd = to_bytes(cmd, errors='surrogate_or_strict')
 
         no_prompt_out = b''

tests/unit/plugins/connection/test_proxmox_pct_remote.py

@@ -304,6 +304,25 @@ def test_exec_command_with_privilege_escalation(mock_ssh, connection):
     mock_channel.sendall.assert_called_once_with(b'sudo_password\n')
 
 
+@patch('paramiko.SSHClient')
+def test_exec_command_with_forward_agent(mock_ssh, connection):
+    """ Test exec_command with forward agent """
+    mock_client = MagicMock()
+    mock_channel = MagicMock()
+    mock_transport = MagicMock()
+
+    mock_client.get_transport.return_value = mock_transport
+    mock_transport.open_session.return_value = mock_channel
+    connection._connected = True
+    connection.ssh = mock_client
+
+    connection.set_option('forward_agent', True)
+
+    with patch('paramiko.agent.AgentRequestHandler') as mock_agent_handler:
+        connection.exec_command('test command')
+        mock_agent_handler.assert_called_once_with(mock_channel)
+
+
 def test_put_file(connection):
     """ Test putting a file to the remote system """
     connection.exec_command = MagicMock()