portacode 1.4.15.dev3__tar.gz → 1.4.15.dev5__tar.gz

{portacode-1.4.15.dev3 → portacode-1.4.15.dev5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: portacode
-Version: 1.4.15.dev3
+Version: 1.4.15.dev5
 Summary: Portacode CLI client and SDK
 Home-page: https://github.com/portacode/portacode
 Author: Meena Erian

{portacode-1.4.15.dev3 → portacode-1.4.15.dev5}/portacode/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.4.15.dev3'
-__version_tuple__ = version_tuple = (1, 4, 15, 'dev3')
+__version__ = version = '1.4.15.dev5'
+__version_tuple__ = version_tuple = (1, 4, 15, 'dev5')
 
 __commit_id__ = commit_id = None

{portacode-1.4.15.dev3 → portacode-1.4.15.dev5}/portacode/connection/handlers/WEBSOCKET_PROTOCOL.md

@@ -27,6 +27,10 @@ The Portacode server acts as a **routing middleman** between client sessions and
 
 - **`source_client_session`** (Server → Device): Server **adds this** when forwarding client commands to devices (so device knows which client sent the command and can target responses back). Clients never include this field.
 
+### Proxying infrastructure updates
+
+Portacode infrastructure devices (like the proxmox host) can send events on behalf of the LXC Devices they manage. Such messages include the optional `on_behalf_of_device` field and the server silently replaces `device_id` with that child device before routing. The gateway enforces that the sender is the child’s `proxmox_parent` (via `Device.proxmox_parent`) so only the infrastructure owner can impersonate a child device. Messages that fail this check are dropped.
+
 This document describes the complete protocol for communicating with devices through the server, guiding app developers on how to get their client sessions to communicate with devices.
 
 ## Table of Contents
@@ -326,12 +330,9 @@ Configures a Proxmox node for Portacode infrastructure usage (API token validati
 
 **Payload Fields:**
 
-*   `token_identifier` (string, optional when reconfiguring): API token identifier in the form `user@realm!tokenid`. Required on first configuration or when replacing the stored token.
-*   `token_value` (string, optional when reconfiguring): Secret value associated with the token. Required when `token_identifier` is supplied.
-*   `verify_ssl` (boolean, optional): When true, the handler verifies SSL certificates; defaults to `false`. When omitted, the last configured value is preserved.
-*   `cloudflare_api_token` (string, optional): Cloudflare API token the host can reuse later to provision tunnels.
-
-The setup command also installs `cloudflared` on the node so Cloudflare tunnels can be created afterward.
+*   `token_identifier` (string, required): API token identifier in the form `user@realm!tokenid`.
+*   `token_value` (string, required): Secret value associated with the token.
+*   `verify_ssl` (boolean, optional): When true, the handler verifies SSL certificates; defaults to `false`.
 
 **Responses:**
 
@@ -364,7 +365,7 @@ Creates a Portacode-managed LXC container, starts it, and bootstraps the Portaco
 *   `username` (string, optional): OS user to provision (defaults to `svcuser`).
 *   `password` (string, optional): Password for the user (used only during provisioning).
 *   `ssh_key` (string, optional): SSH public key to add to the user.
-*   `device_id` (string, optional): ID of the Device record that already exists on the dashboard.
+*   `device_id` (string, required): ID of the dashboard Device record that represents the container. The handler persists this value in the host metadata file so related events can always be correlated back to that Device.
 *   `device_public_key` (string, optional): PEM-encoded Portacode public key. When supplied together with `device_private_key` the handler injects the keypair, records the device metadata, and runs `portacode service install` automatically.
 *   `device_private_key` (string, optional): PEM-encoded private key that pairs with `device_public_key`. Both key fields must be present for the automatic service-install mode.
 
@@ -412,51 +413,6 @@ Deletes a managed container from Proxmox (stopping it first if necessary) and re
 *   Emits a [`proxmox_container_action`](#proxmox_container_action-event) event with `action="remove"` and the refreshed infra snapshot after deletion.
 *   Emits an [`error`](#error) event on failure.
 
-### `create_cloudflare_tunnel`
-
-Creates or updates a Cloudflare tunnel in front of a managed container. The container must be running and a Cloudflare API token must already be configured via `setup_proxmox_infra`.
-
-**Payload Fields:**
-
-*   `ctid` (string, required): Identifier of the container.
-*   `container_port` (integer, required): Port inside the container to expose through Cloudflare.
-*   `cloudflare_url` (string, optional): Hostname (e.g., `app.example.com`) that the tunnel should serve. Leave blank to let Cloudflare create a quick tunnel (`*.cfargotunnel.com`) automatically.
-*   `protocol` (string, optional): One of `http`, `https`, or `tcp` (defaults to `http`).
-
-**Responses:**
-
-*   Emits a [`cloudflare_tunnel_created`](#cloudflare_tunnel_created-event) event with the tunnel metadata, the refreshed infra snapshot, and the optional `device_id` so dashboards can refresh the CT list.
-*   Emits an [`error`](#error) event on failure.
-
-### `update_cloudflare_tunnel`
-
-Refreshes the tunnel configuration for an existing tunnel (different port, URL, or protocol).
-
-**Payload Fields:**
-
-*   `ctid` (string, required): Identifier of the container.
-*   `container_port` (integer, optional): New container port.
-*   `cloudflare_url` (string, optional): New hostname (leave blank to keep the current hostname or let Cloudflare assign a quick tunnel).
-*   `protocol` (string, optional): New protocol (`http`, `https`, or `tcp`).
-
-**Responses:**
-
-*   Emits a [`cloudflare_tunnel_updated`](#cloudflare_tunnel_updated-event) event with the refreshed tunnel metadata, the refreshed infra snapshot, and the optional `device_id`.
-*   Emits an [`error`](#error) event on failure.
-
-### `remove_cloudflare_tunnel`
-
-Stops and removes any tunnel metadata associated with a container.
-
-**Payload Fields:**
-
-*   `ctid` (string, required): Identifier of the container.
-
-**Responses:**
-
-*   Emits a [`cloudflare_tunnel_removed`](#cloudflare_tunnel_removed-event) event with the refreshed infra snapshot and optional `device_id`.
-*   Emits an [`error`](#error) event on failure.
-
 ### `proxmox_container_created`
 
 Emitted after a successful `create_proxmox_container` action. Contains the new container ID, the Portacode public key produced inside the container, and the bootstrap logs.
@@ -469,7 +425,8 @@ Emitted after a successful `create_proxmox_container` action. Contains the new c
 *   `public_key` (string): Portacode public auth key created inside the new container.
 *   `container` (object): Metadata such as `vmid`, `hostname`, `template`, `storage`, `disk_gib`, `ram_mib`, and `cpus`.
 *   `setup_steps` (array[object]): Detailed bootstrap step results (name, stdout/stderr, elapsed time, and status).
-*   `device_id` (string, optional): Mirrors the `device_id` supplied with `create_proxmox_container`, if any.
+*   `device_id` (string): Mirrors the dashboard Device ID supplied with `create_proxmox_container`. The handler records this value in the container metadata file so subsequent events can reference the same Device.
+*   `on_behalf_of_device` (string): Same value as `device_id` when the container host is reporting progress for the child device; only proxmox parents may include this field.
 *   `service_installed` (boolean): True when the handler already ran `portacode service install` (with a provided keypair); otherwise it remains False and the dashboard can call `start_portacode_service`.
 
 ### `proxmox_container_progress`
@@ -487,6 +444,7 @@ Sent intermittently while `create_proxmox_container` is executing so callers can
 *   `message` (string): Short description of what is happening or why a failure occurred.
 *   `details` (object, optional): Contains `attempt` (if retries were needed) and `error_summary` when a step fails.
 *   `request_id` (string, optional): Mirrors the request ID from the incoming `create_proxmox_container` payload when available.
+ *   `on_behalf_of_device` (string, optional): When present the proxmox device is reporting progress for the referenced dashboard device; the gateway verifies the proxmox node is the child’s `proxmox_parent` before routing the event.
 
 ### `start_portacode_service`
 
@@ -1174,8 +1132,6 @@ Provides system information in response to a `system_info` action. Handled by [`
                     *   `message` (string|null): Informational text about the network setup attempt.
                     *   `bridge` (string): The bridge interface configured (typically `vmbr1`).
                     *   `health` (string|null): `"healthy"` when the connectivity verification succeeded.
-                *   `cloudflare` (object): Optional Cloudflare metadata collected for future tunnels:
-                    *   `configured` (boolean): True when a Cloudflare API token is stored.
                 *   `node_status` (object|null): Status response returned by the Proxmox API when validating the token.
                 *   `managed_containers` (object): Cached summary of the Portacode-managed containers:
                     *   `updated_at` (string): ISO timestamp when this snapshot was last refreshed.
@@ -1193,11 +1149,6 @@ Provides system information in response to a `system_info` action. Handled by [`
                         *   `cpu_share` (number): vCPU-equivalent share requested at creation.
                         *   `status` (string): Lowercase lifecycle status (e.g., `running`, `stopped`, `deleted`).
                         *   `created_at` (string|null): ISO timestamp recorded when the CT was provisioned.
-                        *   `tunnel` (object|null): Tunnel metadata that includes:
-                            *   `url` (string): Public hostname assigned for this tunnel.
-                            *   `container_port` (integer): Container port exposed via the tunnel.
-                            *   `protocol` (string): Protocol advertised when the tunnel was configured.
-                            *   `status` (string): `running`, `stopped`, or `unknown`.
     *   `portacode_version` (string): Installed CLI version returned by `portacode.__version__`.
 
 ### `proxmox_infra_configured`
@@ -1232,6 +1183,8 @@ Emitted after a successful `create_proxmox_container` action to report the newly
 *   `public_key` (string): Portacode public auth key discovered inside the container.
 *   `container` (object): Metadata such as `vmid`, `hostname`, `template`, `storage`, `disk_gib`, `ram_mib`, and `cpus`.
 *   `setup_steps` (array[object]): Detailed bootstrap step reports including stdout/stderr, elapsed time, and pass/fail status.
+*   `device_id` (string): Mirrors the device ID supplied with `create_proxmox_container` and persisted inside the host metadata file for this CT.
+*   `on_behalf_of_device` (string): Same value as `device_id` when the container host is reporting progress for the child device.
 
 ### `proxmox_container_progress`
 
@@ -1248,6 +1201,7 @@ Sent continuously while `create_proxmox_container` runs so dashboards can show a
 *   `message` (string): Short human-readable description of the action or failure.
 *   `details` (object, optional): Contains `attempt` (when retries are used) and `error_summary` on failure.
 *   `request_id` (string, optional): Mirrors the `create_proxmox_container` request when provided.
+*   `on_behalf_of_device` (string, optional): Mirrors the child device ID when a proxmox host reports progress for that child; only proxmox parents can supply this field.
 
 ### `proxmox_container_action`
 
@@ -1263,48 +1217,6 @@ Emitted after `start_proxmox_container`, `stop_proxmox_container`, or `remove_pr
 *   `details` (object, optional): Exit status information (e.g., `exitstatus`, `stop_exitstatus`, `delete_exitstatus`).
 *   `infra` (object): Same snapshot described under [`system_info`](#system_info-event) `proxmox.infra`, including the updated `managed_containers` summary.
 
-### `cloudflare_tunnel_created`
-
-Submitted after a successful `create_cloudflare_tunnel` action.
-
-**Event Fields:**
-
-*   `event` (string): `cloudflare_tunnel_created`.
-*   `ctid` (string): Container ID associated with the tunnel.
-*   `success` (boolean): True when the tunnel is running.
-*   `device_id` (string, optional): Mirrors the `device_id` supplied with the command, letting dashboards refresh that device immediately.
-*   `message` (string): Summary text; when a hostname was assigned (including Quick Tunnel), the host is appended (e.g., `Created ... -> example.com`).
-*   `tunnel` (object): Tunnel metadata matching the manager view. When using Cloudflare Quick Tunnel (no hostname supplied), `tunnel.url` holds the autogenerated `*.cfargotunnel.com` hostname.
-*   `infra` (object): Snapshot produced by `get_infra_snapshot`, including the refreshed `managed_containers` list.
-
-### `cloudflare_tunnel_updated`
-
-Sent when `update_cloudflare_tunnel` completes.
-
-**Event Fields:**
-
-*   `event` (string): `cloudflare_tunnel_updated`.
-*   `ctid` (string): Container ID associated with the tunnel.
-*   `success` (boolean): True on success.
-*   `device_id` (string, optional): Mirrors the command's `device_id`.
-*   `message` (string): Summary text; includes the new hostname when one was assigned or changed.
-*   `tunnel` (object): Updated tunnel metadata.
-*   `infra` (object): Snapshot produced by `get_infra_snapshot` so dashboards can refresh the managed container list.
-
-### `cloudflare_tunnel_removed`
-
-Sent after a tunnel has been removed from a container record.
-
-**Event Fields:**
-
-*   `event` (string): `cloudflare_tunnel_removed`.
-*   `ctid` (string): Container ID that no longer has a tunnel.
-*   `success` (boolean): True on success.
-*   `device_id` (string, optional): Mirrors the command's `device_id`.
-*   `message` (string): Summary text.
-*   `tunnel` (null): Always `null` to explicitly clear the stored tunnel metadata.
-*   `infra` (object): The refreshed snapshot so dashboards see the updated container list.
-
 ### <a name="clock_sync_response"></a>`clock_sync_response`
 
 Reply sent by the gateway immediately after receiving a `clock_sync_request`. Devices use this event plus the measured round-trip time to keep their local `ntp_clock` offset accurate.

{portacode-1.4.15.dev3 → portacode-1.4.15.dev5}/portacode/connection/handlers/__init__.py

@@ -43,15 +43,12 @@ from .project_state_handlers import (
 )
 from .proxmox_infra import (
     ConfigureProxmoxInfraHandler,
-    CreateCloudflareTunnelHandler,
     CreateProxmoxContainerHandler,
     RevertProxmoxInfraHandler,
     StartPortacodeServiceHandler,
     StartProxmoxContainerHandler,
     StopProxmoxContainerHandler,
-    RemoveCloudflareTunnelHandler,
     RemoveProxmoxContainerHandler,
-    UpdateCloudflareTunnelHandler,
 )
 
 __all__ = [
@@ -65,7 +62,6 @@ __all__ = [
     "TerminalListHandler",
     "SystemInfoHandler",
     "ConfigureProxmoxInfraHandler",
-    "CreateCloudflareTunnelHandler",
     "CreateProxmoxContainerHandler",
     # File operation handlers (optional - register as needed)
     "FileReadHandler",
@@ -95,9 +91,7 @@ __all__ = [
     "StartPortacodeServiceHandler",
     "StartProxmoxContainerHandler",
     "StopProxmoxContainerHandler",
-    "RemoveCloudflareTunnelHandler",
     "RemoveProxmoxContainerHandler",
-    "UpdateCloudflareTunnelHandler",
     "UpdatePortacodeHandler",
     "RevertProxmoxInfraHandler",
 ]