Spaces:
Paused
Paused
File size: 9,253 Bytes
7d4338a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | import asyncio
import paramiko
import time
import re
from typing import Tuple
from helpers.log import Log
from helpers.print_style import PrintStyle
# from helpers.strings import calculate_valid_match_lengths
class SSHInteractiveSession:
# end_comment = "# @@==>> SSHInteractiveSession End-of-Command <<==@@"
# ps1_label = "SSHInteractiveSession CLI>"
def __init__(
self, logger: Log, hostname: str, port: int, username: str, password: str, cwd: str|None = None
):
self.logger = logger
self.hostname = hostname
self.port = port
self.username = username
self.password = password
self.client = paramiko.SSHClient()
self.client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
self.shell = None
self.full_output = b""
self.last_command = b""
self.trimmed_command_length = 0 # Initialize trimmed_command_length
self.cwd = cwd
async def connect(self, keepalive_interval: int = 5):
"""
Establish the SSH connection and start an interactive shell.
Parameters
----------
keepalive_interval : int
Interval in **seconds** between keep-alive packets sent by Paramiko.
A value ≤ 0 disables Paramiko’s keep-alive feature.
"""
errors = 0
while True:
try:
# --- establish TCP/SSH session ---------------------------------
self.client.connect(
self.hostname,
self.port,
self.username,
self.password,
allow_agent=False,
look_for_keys=False,
)
# --------- NEW: enable transport-level keep-alives -------------
transport = self.client.get_transport()
if transport and keepalive_interval > 0:
# sends an SSH_MSG_IGNORE every <keepalive_interval> seconds
transport.set_keepalive(keepalive_interval)
# ----------------------------------------------------------------
# invoke interactive shell
self.shell = self.client.invoke_shell(width=100, height=50)
# disable systemd/OSC prompt metadata and disable local echo
initial_command = "unset PROMPT_COMMAND PS0; stty -echo"
if self.cwd:
initial_command = f"cd {self.cwd}; {initial_command}"
self.shell.send(f"{initial_command}\n".encode())
# wait for initial prompt/output to settle
while True:
full, part = await self.read_output()
if full and not part:
return
time.sleep(0.1)
except Exception as e:
errors += 1
if errors < 3:
PrintStyle.standard(f"SSH Connection attempt {errors}...")
self.logger.log(
type="info",
content=f"SSH Connection attempt {errors}...",
)
time.sleep(5)
else:
raise e
async def close(self):
if self.shell:
self.shell.close()
if self.client:
self.client.close()
async def send_command(self, command: str):
if not self.shell:
raise Exception("Shell not connected")
self.full_output = b""
# if len(command) > 10: # if command is long, add end_comment to split output
# command = (command + " \\\n" +SSHInteractiveSession.end_comment + "\n")
# else:
command = command + "\n"
self.last_command = command.encode()
self.trimmed_command_length = 0
self.shell.send(self.last_command)
async def read_output(
self, timeout: float = 0, reset_full_output: bool = False
) -> Tuple[str, str]:
if not self.shell:
raise Exception("Shell not connected")
if reset_full_output:
self.full_output = b""
partial_output = b""
leftover = b""
start_time = time.time()
while self.shell.recv_ready() and (
timeout <= 0 or time.time() - start_time < timeout
):
# data = self.shell.recv(1024)
data = self.receive_bytes()
# # Trim own command from output
# if (
# self.last_command
# and len(self.last_command) > self.trimmed_command_length
# ):
# command_to_trim = self.last_command[self.trimmed_command_length :]
# data_to_trim = leftover + data
# trim_com, trim_out = calculate_valid_match_lengths(
# command_to_trim,
# data_to_trim,
# deviation_threshold=8,
# deviation_reset=2,
# ignore_patterns=[
# rb"\x1b\[\?\d{4}[a-zA-Z](?:> )?", # ANSI escape sequences
# rb"\r", # Carriage return
# rb">\s", # Greater-than symbol
# ],
# debug=False,
# )
# leftover = b""
# if trim_com > 0 and trim_out > 0:
# data = data_to_trim[trim_out:]
# leftover = data
# self.trimmed_command_length += trim_com
partial_output += data
self.full_output += data
await asyncio.sleep(0.1) # Prevent busy waiting
# Decode once at the end
decoded_partial_output = partial_output.decode("utf-8", errors="replace")
decoded_full_output = self.full_output.decode("utf-8", errors="replace")
decoded_partial_output = clean_string(decoded_partial_output)
decoded_full_output = clean_string(decoded_full_output)
return decoded_full_output, decoded_partial_output
def receive_bytes(self, num_bytes=1024):
if not self.shell:
raise Exception("Shell not connected")
# Receive initial chunk of data
shell = self.shell
data = self.shell.recv(num_bytes)
# Helper function to ensure that we receive exactly `num_bytes`
def recv_all(num_bytes):
data = b""
while len(data) < num_bytes:
chunk = shell.recv(num_bytes - len(data))
if not chunk:
break # Connection might be closed or no more data
data += chunk
return data
# Check if the last byte(s) form an incomplete multi-byte UTF-8 sequence
if len(data) > 0:
last_byte = data[-1]
# Check if the last byte is part of a multi-byte UTF-8 sequence (continuation byte)
if (last_byte & 0b11000000) == 0b10000000: # It's a continuation byte
# Now, find the start of this sequence by checking earlier bytes
for i in range(
2, 5
): # Look back up to 4 bytes (since UTF-8 is up to 4 bytes long)
if len(data) - i < 0:
break
byte = data[-i]
# Detect the leading byte of a multi-byte sequence
if (byte & 0b11100000) == 0b11000000: # 2-byte sequence (110xxxxx)
data += recv_all(1) # Need 1 more byte to complete
break
elif (
byte & 0b11110000
) == 0b11100000: # 3-byte sequence (1110xxxx)
data += recv_all(2) # Need 2 more bytes to complete
break
elif (
byte & 0b11111000
) == 0b11110000: # 4-byte sequence (11110xxx)
data += recv_all(3) # Need 3 more bytes to complete
break
return data
def clean_string(input_string):
# Remove ANSI escape codes
ansi_escape = re.compile(r"\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])")
cleaned = ansi_escape.sub("", input_string)
# remove null bytes
cleaned = cleaned.replace("\x00", "")
# remove ipython \r\r\n> sequences from the start
cleaned = re.sub(r'^[ \r]*(?:\r*\n>[ \r]*)*', '', cleaned)
# also remove any amount of '> ' sequences from the start
cleaned = re.sub(r'^(>\s*)+', '', cleaned)
# Replace '\r\n' with '\n'
cleaned = cleaned.replace("\r\n", "\n")
# remove leading \r and spaces
cleaned = cleaned.lstrip("\r ")
# Split the string by newline characters to process each segment separately
lines = cleaned.split("\n")
for i in range(len(lines)):
# Handle carriage returns '\r' by splitting and taking the last part
parts = [part for part in lines[i].split("\r") if part.strip()]
if parts:
lines[i] = parts[
-1
].rstrip() # Overwrite with the last part after the last '\r'
return "\n".join(lines)
|