oxbrbtx/PrimAITE
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

#2718 - Updates to Terminal following discussion about implementation with actions.

Browse Source
This commit is contained in:
Charlie Crane
2024-08-08 14:20:23 +01:00
parent ff054830bc
commit 5f5ea5e524
1 changed files with 25 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
src/primaite/simulator/system/services/terminal/terminal.py
View File

@@ -52,9 +52,7 @@ class TerminalClientConnection(BaseModel):
"""Flag to state whether the connection is active or not""" """Flag to state whether the connection is active or not"""
def __str__(self) -> str: def __str__(self) -> str:
return ( return f"{self.__class__.__name__}(connection_id: '{self.connection_uuid}, ip_address: {self.ip_address}')"
f"{self.__class__.__name__}(connection_id: '{self.connection_uuid}, ssh_session_id: {self.ssh_session_id}')"
)
def __repr__(self) -> str: def __repr__(self) -> str:
return self.__str__() return self.__str__()
@@ -176,7 +174,6 @@ class Terminal(Service):
status="success", status="success",
data={ data={
"connection ID": login.connection_uuid, "connection ID": login.connection_uuid,
"ssh_session_id": login.ssh_session_id,
"ip_address": login.ip_address, "ip_address": login.ip_address,
}, },
) )
@@ -189,19 +186,28 @@ class Terminal(Service):
return RequestResponse( return RequestResponse(
status="success", status="success",
data={ data={
"connection ID": login.connection_uuid,
"ssh_session_id": login.ssh_session_id,
"ip_address": login.ip_address, "ip_address": login.ip_address,
}, },
) )
else: else:
return RequestResponse(status="failure", data={}) return RequestResponse(status="failure", data={})
def _execute_request(request: RequestFormat, context: Dict) -> RequestResponse: def remote_execute_request(request: RequestFormat, context: Dict) -> RequestResponse:
"""Execute an instruction.""" """Execute an instruction."""
command: str = request[0] command: str = request[0]
connection_id: str = request[1] ip_address: IPv4Address = IPv4Address(request[1])
return self.execute(command, connection_id=connection_id) remote_connection = self._get_connection_from_ip(ip_address=ip_address)
outcome = remote_connection.execute(command)
if outcome:
return RequestResponse(
status="success",
data={},
)
else:
return RequestResponse(
status="failure",
data={},
)
def _logoff(request: RequestFormat, context: Dict) -> RequestResponse: def _logoff(request: RequestFormat, context: Dict) -> RequestResponse:
"""Logoff from connection.""" """Logoff from connection."""
@@ -222,20 +228,23 @@ class Terminal(Service):
rm.add_request( rm.add_request(
"Execute", "Execute",
request_type=RequestType(func=_execute_request), request_type=RequestType(func=remote_execute_request),
) )
rm.add_request("Logoff", request_type=RequestType(func=_logoff)) rm.add_request("Logoff", request_type=RequestType(func=_logoff))
return rm return rm
def execute(self, command: List[Any], connection_id: str) -> Optional[RequestResponse]: def execute(self, command: List[Any]) -> Optional[RequestResponse]:
"""Execute a passed ssh command via the request manager.""" """Execute a passed ssh command via the request manager."""
valid_connection = self._check_client_connection(connection_id=connection_id) return self.parent.apply_request(command)
if valid_connection:
return self.parent.apply_request(command) def _get_connection_from_ip(self, ip_address: IPv4Address) -> Optional[RemoteTerminalConnection]:
"""Find Remote Terminal Connection from a given IP."""
for connection in self._connections:
if self._connections[connection].ip_address == ip_address:
return self._connections[connection]
else: else:
self.sys_log.error("Invalid connection ID provided")
return None return None
def _create_local_connection(self, connection_uuid: str, session_id: str) -> TerminalClientConnection: def _create_local_connection(self, connection_uuid: str, session_id: str) -> TerminalClientConnection:
@@ -471,7 +480,7 @@ class Terminal(Service):
command = payload.ssh_command command = payload.ssh_command
valid_connection = self._check_client_connection(payload.connection_uuid) valid_connection = self._check_client_connection(payload.connection_uuid)
if valid_connection: if valid_connection:
return self.execute(command, payload.connection_uuid) return self.execute(command)
else: else:
self.sys_log.error(f"Connection UUID:{payload.connection_uuid} is not valid. Rejecting Command.") self.sys_log.error(f"Connection UUID:{payload.connection_uuid} is not valid. Rejecting Command.")