feat: implement HTTP server for remote UEFI shell capability #6

adrianlasota · 2025-09-02T14:52:24Z

This pull request introduces a new remote shell (RShell) connection mechanism for executing commands on remote systems via an HTTP-based protocol. The main changes include the addition of a robust RShellConnection class, a Flask-based RShell server, and a sample RShell client for UEFI shell environments. These components work together to allow remote command execution and result retrieval over HTTP, supporting both Linux and UEFI environments.

Key changes:

RShell Connection Implementation

Added the RShellConnection class in mfd_connect/rshell.py, which manages the lifecycle of RShell servers and clients, handles command execution via HTTP requests, and provides logging and error handling for unsupported features.
Integrated support for starting a local RShell server process and health-checking its status before establishing connections.

RShell Server

Introduced mfd_connect/rshell_server.py, a Flask-based HTTP server that manages command queues per client, handles command dispatch and result collection, and provides health check endpoints.
Implemented endpoints for executing commands, posting results/exceptions, and tracking client connections and command status.

RShell Client

Added mfd_connect/rshell_client.py, a sample HTTP client application designed for UEFI shell environments, which polls the RShell server for commands, executes them, and posts results or exceptions back to the server.
Included a custom sleep implementation to support environments where standard Python sleep is unavailable (e.g., UEFI shell).

Example Usage

Provided examples/rshell_example.py demonstrating how to instantiate and use the new RShellConnection to execute remote commands and manage connections.

mfd-intel-bot · 2025-09-02T14:53:36Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-09-02T14:53:49Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-09-02T14:55:19Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-09-02T14:55:32Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

Copilot

Pull Request Overview

This PR implements a remote shell (RShell) capability that enables HTTP-based command execution between a Python client and Flask server, with specific support for UEFI shell environments.

Key changes:

Added RShellConnection class for managing remote command execution via HTTP
Implemented Flask-based server for handling command queues and client connections
Created UEFI-compatible HTTP client with specialized handling for UEFI shell limitations

Reviewed Changes

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

File	Description
mfd_connect/rshell_server.py	Flask REST server managing command queues, health checks, and result collection
mfd_connect/rshell_client.py	HTTP client designed for UEFI shell with polling and command execution capabilities
mfd_connect/rshell.py	RShellConnection class providing remote command execution interface
examples/rshell_example.py	Usage example demonstrating RShellConnection functionality

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

mfd_connect/rshell_server.py

mfd_connect/rshell_client.py

mfd_connect/rshell.py

mfd-intel-bot · 2025-09-29T10:04:46Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-09-29T10:05:07Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-10-07T13:15:17Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-10-07T13:15:28Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-10-16T07:08:35Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-10-16T07:08:49Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-11-12T13:54:33Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-11-12T13:54:49Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

Copilot

Pull Request Overview

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

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

mfd_connect/rshell.py

mfd_connect/rshell_client.py

mfd_connect/rshell.py

mfd_connect/rshell_server.py

mfd-intel-bot · 2025-11-12T14:24:12Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-11-12T14:26:35Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

Signed-off-by: Lasota, Adrian <adrian.lasota@intel.com>

Copilot

Pull Request Overview

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

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-12T14:36:09Z

mfd_connect/rshell_server.py

+
+if __name__ == "__main__":
+    print("Starting Flask REST server...")
+    app.run(host="0.0.0.0", port=80)


Running Flask server on privileged port 80 without authentication or authorization checks exposes all endpoints to any network client. Consider using a non-privileged port (e.g., 8080) or implementing authentication middleware to verify client requests.

Suggested change

app.run(host="0.0.0.0", port=80)

app.run(host="0.0.0.0", port=8080)

Copilot · 2025-11-12T14:36:09Z

mfd_connect/rshell_server.py

+    """
+    print("Getting output for command ID:", command_id)
+    print(f"Waiting for output {timeout} seconds")
+    timeout = timeout + 5  # add time for client loop waiting


Magic number '5' lacks explanation. Consider documenting why 5 seconds are added to the timeout or defining it as a named constant (e.g., CLIENT_LOOP_BUFFER = 5).

Copilot · 2025-11-12T14:36:10Z

mfd_connect/rshell_client.py

+os_name = os.name
+
+
+def _sleep(interval):  # noqa: ANN001, ANN202


The busy-wait implementation of _sleep will consume 100% CPU during sleep intervals. This is inefficient even in UEFI environments. Consider using a less aggressive polling interval or documenting this performance trade-off.

Copilot · 2025-11-12T14:36:10Z

mfd_connect/rshell.py

+    def __init__(
+        self,
+        ip: str | IPv4Address | IPv6Address,
+        server_ip: str | IPv4Address | IPv6Address | None = "127.0.0.1",


Default value '127.0.0.1' has type str but parameter accepts None. The logic at line 56 checks if server_ip which treats empty string as falsy. Consider using None as default and explicitly setting to '127.0.0.1' when None, or adjust the conditional to if server_ip is None.

Copilot · 2025-11-12T14:36:10Z

examples/rshell_example.py

+logging.basicConfig(level=logging.DEBUG)
+from mfd_connect.rshell import RShellConnection 


Import statement should appear before code execution. Move the import of RShellConnection to line 4, before the logging.basicConfig() call.

Suggested change

logging.basicConfig(level=logging.DEBUG)

from mfd_connect.rshell import RShellConnection

from mfd_connect.rshell import RShellConnection

logging.basicConfig(level=logging.DEBUG)

mfd-intel-bot · 2025-11-12T14:53:51Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-11-12T14:54:28Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-11-12T14:55:35Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-11-12T14:55:58Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-11-12T14:56:19Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

mfd-intel-bot · 2025-11-12T14:56:21Z

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-connect@MFD-7178'

adrianlasota temporarily deployed to pypi September 2, 2025 14:52 — with GitHub Actions Inactive

adrianlasota force-pushed the MFD-7178 branch from 7904675 to b38783f Compare September 2, 2025 14:54

adrianlasota temporarily deployed to pypi September 2, 2025 14:54 — with GitHub Actions Inactive

adrianlasota requested a review from Copilot September 3, 2025 07:51

Copilot AI reviewed Sep 3, 2025

View reviewed changes

adrianlasota force-pushed the MFD-7178 branch from b38783f to 1fea908 Compare September 29, 2025 10:03

adrianlasota temporarily deployed to pypi September 29, 2025 10:03 — with GitHub Actions Inactive

adrianlasota force-pushed the MFD-7178 branch from 1fea908 to dfe39e4 Compare October 7, 2025 13:14

adrianlasota temporarily deployed to pypi October 7, 2025 13:14 — with GitHub Actions Inactive

adrianlasota force-pushed the MFD-7178 branch from dfe39e4 to abcb17d Compare October 16, 2025 07:07

adrianlasota temporarily deployed to pypi October 16, 2025 07:07 — with GitHub Actions Inactive

adrianlasota force-pushed the MFD-7178 branch from abcb17d to 7f6f67a Compare November 12, 2025 13:53

adrianlasota marked this pull request as ready for review November 12, 2025 13:53

adrianlasota temporarily deployed to pypi November 12, 2025 13:53 — with GitHub Actions Inactive

adrianlasota requested a review from Copilot November 12, 2025 13:53

Copilot AI reviewed Nov 12, 2025

View reviewed changes

adrianlasota force-pushed the MFD-7178 branch from 7f6f67a to 5ab80e4 Compare November 12, 2025 14:08

adrianlasota temporarily deployed to pypi November 12, 2025 14:08 — with GitHub Actions Inactive

adrianlasota force-pushed the MFD-7178 branch from 5ab80e4 to ec5d15c Compare November 12, 2025 14:28

adrianlasota temporarily deployed to pypi November 12, 2025 14:28 — with GitHub Actions Inactive

adrianlasota force-pushed the MFD-7178 branch from ec5d15c to ba8ddb4 Compare November 12, 2025 14:29

adrianlasota temporarily deployed to pypi November 12, 2025 14:29 — with GitHub Actions Inactive

feat: implement HTTP server for remote UEFI shell capability

41d81cf

Signed-off-by: Lasota, Adrian <adrian.lasota@intel.com>

adrianlasota force-pushed the MFD-7178 branch from ba8ddb4 to 41d81cf Compare November 12, 2025 14:34

adrianlasota temporarily deployed to pypi November 12, 2025 14:35 — with GitHub Actions Inactive

adrianlasota deployed to pypi November 12, 2025 14:35 — with GitHub Actions View deployment

adrianlasota requested a review from Copilot November 12, 2025 14:35

Copilot AI reviewed Nov 12, 2025

View reviewed changes

	app.run(host="0.0.0.0", port=80)
	app.run(host="0.0.0.0", port=8080)

		os_name = os.name


		def _sleep(interval): # noqa: ANN001, ANN202

		logging.basicConfig(level=logging.DEBUG)
		from mfd_connect.rshell import RShellConnection

feat: implement HTTP server for remote UEFI shell capability #6

Are you sure you want to change the base?

feat: implement HTTP server for remote UEFI shell capability #6

Uh oh!

Conversation

adrianlasota commented Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

RShell Connection Implementation

RShell Server

RShell Client

Example Usage

Uh oh!

mfd-intel-bot commented Sep 2, 2025

Uh oh!

mfd-intel-bot commented Sep 2, 2025

Uh oh!

mfd-intel-bot commented Sep 2, 2025

Uh oh!

mfd-intel-bot commented Sep 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mfd-intel-bot commented Sep 29, 2025

Uh oh!

mfd-intel-bot commented Sep 29, 2025

Uh oh!

mfd-intel-bot commented Oct 7, 2025

Uh oh!

mfd-intel-bot commented Oct 7, 2025

Uh oh!

mfd-intel-bot commented Oct 16, 2025

Uh oh!

mfd-intel-bot commented Oct 16, 2025

Uh oh!

mfd-intel-bot commented Nov 12, 2025

Uh oh!

mfd-intel-bot commented Nov 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mfd-intel-bot commented Nov 12, 2025

Uh oh!

mfd-intel-bot commented Nov 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

adrianlasota commented Sep 2, 2025 •

edited

Loading