REMOTE SHELL integration using tmux to interact without ssh creds

[ShreyasMahajann]

The feature enables us to use the product with web shells or scenarios where we do not have SSH credentials.
python src/hackingBuddyGPT/cli/wintermute.py LinuxPrivesc --conn=ssh
python src/hackingBuddyGPT/cli/wintermute.py LinuxPrivesc --conn=local_shell --conn.tmux_session=<tmux_session_name>[

hackGptdemo.mp4

[Copilot]

Pull Request Overview

This PR introduces local shell integration using tmux to enable hackingBuddyGPT to interact with shells without requiring SSH credentials. The feature allows users to connect to local tmux sessions for testing and development scenarios.

Key changes:

• Added LocalShellConnection class for tmux-based shell interaction
• Implemented LocalShellCapability for command execution through tmux
• Updated LinuxPrivesc use case to support both SSH and local shell connections

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
src/hackingBuddyGPT/utils/local_shell/local_shell.py	Implements complete tmux-based shell connection with command execution, output capture, and completion detection
src/hackingBuddyGPT/utils/local_shell/init.py	Package initialization for local shell utilities
src/hackingBuddyGPT/usecases/privesc/linux.py	Updates LinuxPrivesc to support both SSH and local shell connections
src/hackingBuddyGPT/capabilities/local_shell.py	Implements capability for local shell command execution
README.md	Documentation updates explaining the new local shell feature and usage examples

[Copilot]

The run_simple_fallback method is quite long (49 lines) and handles multiple responsibilities including setting tmux options, command execution, and output extraction. Consider breaking this into smaller, focused methods.

Suggested change

	self._set_tmux_history_limit(50000)
	clear_marker = self._send_clear_marker()
	self.send_command(command)
	self.wait_for_command_completion()
	end_marker = self._send_end_marker()
	output = self.capture_output(50000)
	result = self._extract_output_between_markers(output, clear_marker, end_marker, command)
	self._set_tmux_history_limit(10000)
	return result
	except Exception as e:
	self._set_tmux_history_limit(10000)
	raise RuntimeError(f"Error executing command: {e}")
	def _set_tmux_history_limit(self, limit):
	subprocess.run(['tmux', 'set-option', '-t', self.tmux_session, 'history-limit', str(limit)],
	capture_output=True)
	def _send_clear_marker(self):
	clear_marker = f"__CLEAR_{uuid.uuid4().hex[:8]}__"
	self.send_command('clear')
	time.sleep(0.3)
	self.send_command(f'echo "{clear_marker}"')
	time.sleep(0.3)
	return clear_marker
	def _send_end_marker(self):
	end_marker = f"__END_{uuid.uuid4().hex[:8]}__"
	self.send_command(f'echo "{end_marker}"')
	time.sleep(0.5)
	return end_marker
	def _extract_output_between_markers(self, output, clear_marker, end_marker, command):
	lines = output.splitlines()
	start_idx = -1
	end_idx = -1
	for i, line in enumerate(lines):
	if clear_marker in line:
	start_idx = i
	elif end_marker in line and start_idx != -1:
	end_idx = i
	break
	if start_idx != -1 and end_idx != -1:
	result_lines = lines[start_idx + 1:end_idx]
	if result_lines and command in result_lines[0]:
	result_lines = result_lines[1:]
	result = '\n'.join(result_lines).strip()
	else:
	result = self._extract_recent_output(output, command)
	return result

[Copilot]

Catching all exceptions with 'Exception' is too broad and can mask unexpected errors. Consider catching more specific exceptions like subprocess.CalledProcessError or RuntimeError.

Suggested change

	except Exception as e:
	except (RuntimeError, subprocess.CalledProcessError) as e:

[Copilot]

Catching all exceptions with 'Exception' is too broad and can mask unexpected errors. Consider catching more specific exceptions like subprocess.CalledProcessError.

Suggested change

	return result
	except subprocess.SubprocessError as e:
	raise RuntimeError(f"Error executing command: {e}")
	finally:
	subprocess.run(['tmux', 'set-option', '-t', self.tmux_session, 'history-limit', '10000'],
	capture_output=True)

[Copilot]

The history-limit is set to 50000 and then restored to 10000 in the finally block, but there's no guarantee the original value was 10000. Consider capturing and restoring the original value instead.

Suggested change

	original_history_limit = None
	try:
	# Get the current history-limit value
	result = subprocess.run(
	['tmux', 'show-options', '-g', 'history-limit'],
	capture_output=True, text=True
	)
	if result.returncode == 0:
	# Output is like: 'history-limit 10000'
	match = re.search(r'history-limit\s+(\d+)', result.stdout)
	if match:
	original_history_limit = match.group(1)
	# Set history-limit to 50000
	subprocess.run(['tmux', 'set-option', '-t', self.tmux_session, 'history-limit', '50000'],
	capture_output=True)
	clear_marker = f"__CLEAR_{uuid.uuid4().hex[:8]}__"
	self.send_command('clear')
	time.sleep(0.3)
	self.send_command(f'echo "{clear_marker}"')
	time.sleep(0.3)
	self.send_command(command)
	self.wait_for_command_completion()
	end_marker = f"__END_{uuid.uuid4().hex[:8]}__"
	self.send_command(f'echo "{end_marker}"')
	time.sleep(0.5)
	output = self.capture_output(50000)
	lines = output.splitlines()
	start_idx = -1
	end_idx = -1
	for i, line in enumerate(lines):
	if clear_marker in line:
	start_idx = i
	elif end_marker in line and start_idx != -1:
	end_idx = i
	break

[Copilot]

The magic number 1.5 for min_stable_time should be made configurable or defined as a class constant to improve maintainability.

[Copilot]

The comment '# This is CORRECT - use the commented version' is confusing and doesn't provide useful information. Consider removing it or making it more descriptive.

Suggested change

	out, _, _ = self.conn.run(cmd) # This is CORRECT - use the commented version
	out, _, _ = self.conn.run(cmd)