hcs-cli 0.1.349__tar.gz → 0.1.352__tar.gz

{hcs_cli-0.1.349 → hcs_cli-0.1.352}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hcs-cli
-Version: 0.1.349
+Version: 0.1.352
 Summary: Horizon Cloud Service CLI.
 Project-URL: Homepage, https://github.com/euc-eng/hcs-cli
 Project-URL: Bug Tracker, https://github.com/euc-eng/hcs-cli/issues
@@ -14,7 +14,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.9
-Requires-Dist: hcs-core>=0.1.350
+Requires-Dist: hcs-core>=0.1.352
 Requires-Dist: inquirerpy>=0.3.4
 Requires-Dist: paho-mqtt>=2.1.0
 Requires-Dist: reportlab>=4.0.0

{hcs_cli-0.1.349 → hcs_cli-0.1.352}/hcs_cli/__init__.py

@@ -1,3 +1,3 @@
-__version__ = "0.1.349"
+__version__ = "0.1.352"
 
 from . import service as service  # noqa: F401

{hcs_cli-0.1.349 → hcs_cli-0.1.352}/hcs_cli/cmds/logout.py

@@ -10,3 +10,4 @@ from hcs_core.ctxp import profile
 def logout():
     """Logout the current profile."""
     profile.auth.delete()
+    profile.auth_user.delete()

hcs_cli-0.1.352/hcs_cli/cmds/user/__init__.py

@@ -0,0 +1,5 @@
+"""
+Copyright © 2025-2026 Omnissa, LLC.
+"""
+
+help = "Commands for desktop users."

hcs_cli-0.1.352/hcs_cli/cmds/user/auth/__init__.py

@@ -0,0 +1,3 @@
+"""HCS end-user authentication inspection commands."""
+
+help = "Inspect current end-user authentication"

hcs_cli-0.1.352/hcs_cli/cmds/user/auth/details.py

@@ -0,0 +1,11 @@
+"""Show decoded HCS end-user JWT details."""
+
+import click
+
+from hcs_cli.support import user_auth
+
+
+@click.command()
+def details():
+    """Show decoded JWT header and payload."""
+    return user_auth.token_details()

hcs_cli-0.1.352/hcs_cli/cmds/user/auth/refresh.py

@@ -0,0 +1,11 @@
+"""Refresh HCS end-user authentication."""
+
+import click
+
+from hcs_cli.support import user_auth
+
+
+@click.command()
+def refresh():
+    """Refresh saved end-user access and refresh tokens."""
+    return user_auth.refresh()

hcs_cli-0.1.352/hcs_cli/cmds/user/auth/status.py

@@ -0,0 +1,11 @@
+"""Show HCS end-user authentication status."""
+
+import click
+
+from hcs_cli.support import user_auth
+
+
+@click.command()
+def status():
+    """Show login status, user, organization, and token TTL."""
+    return user_auth.status()

hcs_cli-0.1.352/hcs_cli/cmds/user/auth/token.py

@@ -0,0 +1,11 @@
+"""Show current HCS end-user bearer token."""
+
+import click
+
+from hcs_cli.support import user_auth
+
+
+@click.command()
+def token():
+    """Show bearer token."""
+    return user_auth.access_token()

hcs_cli-0.1.352/hcs_cli/cmds/user/desktop/__init__.py

@@ -0,0 +1,3 @@
+"""HCS end-user desktop commands."""
+
+help = "Commands for end-user desktops"

hcs_cli-0.1.352/hcs_cli/cmds/user/desktop/launch.py

@@ -0,0 +1,12 @@
+"""Generate desktop spec for authenticated HCS end user."""
+
+import click
+
+from hcs_cli.service import portal
+
+
+@click.command()
+@click.argument("desktop_id", type=str, required=True)
+def launch(desktop_id: str):
+    """Generate dspec for DESKTOP_ID from 'hcs user desktop list'."""
+    return portal.user.launch(desktop_id)

hcs_cli-0.1.352/hcs_cli/cmds/user/desktop/list.py

@@ -0,0 +1,11 @@
+"""List desktops available to authenticated HCS end user."""
+
+import click
+
+from hcs_cli.service import portal
+
+
+@click.command()
+def list():
+    """List desktop and application entitlements for logged-in user."""
+    return portal.user.list_desktops()

hcs_cli-0.1.352/hcs_cli/cmds/user/desktop/restart.py

@@ -0,0 +1,12 @@
+"""Restart authenticated HCS end-user desktop."""
+
+import click
+
+from hcs_cli.service import portal
+
+
+@click.command()
+@click.argument("desktop_id", type=str, required=True)
+def restart(desktop_id: str):
+    """Restart DESKTOP_ID from 'hcs user desktop list'."""
+    return portal.user.restart(desktop_id)

hcs_cli-0.1.352/hcs_cli/cmds/user/login.py

@@ -0,0 +1,15 @@
+"""Authenticate an HCS end user."""
+
+import click
+
+from hcs_cli.support import user_auth
+
+
+@click.command()
+@click.option("--idp", "-i", required=True, help="IDP tenant domain configured in HCS Auth.")
+@click.option("--username", "-u", required=True, help="User principal name.")
+@click.option("--password", "-p", required=True, help="User password.")
+def login(idp: str, username: str, password: str):
+    """Authenticate an end user and show login status."""
+    user_auth.login(idp, username, password)
+    return user_auth.status()

hcs_cli-0.1.352/hcs_cli/cmds/user/logout.py

@@ -0,0 +1,11 @@
+"""Log out authenticated HCS end user."""
+
+import click
+
+from hcs_cli.support import user_auth
+
+
+@click.command()
+def logout():
+    """Log out current end user and remove saved authentication."""
+    return user_auth.logout()

hcs_cli-0.1.352/hcs_cli/cmds/user/session/__init__.py

@@ -0,0 +1,3 @@
+"""HCS end-user session commands."""
+
+help = "Commands for end-user sessions"

hcs_cli-0.1.352/hcs_cli/cmds/user/session/list.py

@@ -0,0 +1,11 @@
+"""List sessions for authenticated HCS end user."""
+
+import click
+
+from hcs_cli.service import portal
+
+
+@click.command()
+def list():
+    """List active sessions for logged-in user."""
+    return portal.user.list_sessions()

hcs_cli-0.1.352/hcs_cli/cmds/user/session/logoff.py

@@ -0,0 +1,12 @@
+"""Log off authenticated HCS end-user session."""
+
+import click
+
+from hcs_cli.service import portal
+
+
+@click.command()
+@click.argument("session_id", type=str, required=True)
+def logoff(session_id: str):
+    """Log off SESSION_ID."""
+    return portal.user.logoff(session_id)

hcs_cli-0.1.352/hcs_cli/service/auth/__init__.py

@@ -0,0 +1 @@
+from . import admin as auth, user as user

hcs_cli-0.1.352/hcs_cli/service/auth/user.py

@@ -0,0 +1,53 @@
+"""HCS end-user authentication API."""
+
+from typing import Optional
+
+import httpx
+
+from hcs_core.ctxp import CtxpException
+from hcs_core.sglib.user_client import user_client
+
+
+def login(idp: str, username: str, password: str) -> dict:
+    """Authenticate an end user through HCS Auth."""
+    try:
+        return (
+            user_client()
+            .post(
+                "/auth/v1/authorize",
+                json={"userName": username, "password": password, "idpTenantDomain": idp},
+                authenticated=False,
+            )
+            .json()
+        )
+    except httpx.HTTPStatusError as error:
+        raise CtxpException(f"HCS user login failed: HTTP {error.response.status_code}") from error
+    except httpx.RequestError as error:
+        raise CtxpException(f"HCS user login failed: {error}") from error
+
+
+def logout(
+    idp: str,
+    post_logout_uri: str,
+    refresh_token: Optional[str],
+    id_token: str,
+) -> dict:
+    """Log out an end user through HCS Auth."""
+    try:
+        return (
+            user_client()
+            .post(
+                "/auth/v2/client/users/logout",
+                json={
+                    "idpTenantDomain": idp,
+                    "postLogoutUri": post_logout_uri,
+                    "refreshToken": refresh_token,
+                    "idToken": id_token,
+                },
+            )
+            .json()
+        )
+    except httpx.HTTPStatusError as error:
+        raise CtxpException(f"HCS user logout failed: HTTP {error.response.status_code}") from error
+    except httpx.RequestError as error:
+        raise CtxpException(f"HCS user logout failed: {error}") from error

hcs_cli-0.1.352/hcs_cli/service/portal/__init__.py

@@ -0,0 +1 @@
+from . import entitlement, pool, site, user

hcs_cli-0.1.352/hcs_cli/service/portal/user.py

@@ -0,0 +1,84 @@
+"""Portal APIs for the authenticated end user."""
+
+import httpx
+
+from hcs_core.ctxp import CtxpException
+from hcs_core.sglib.user_client import user_client
+
+
+def list_desktops() -> list[dict]:
+    """Return desktop and application entitlements for the logged-in user."""
+    try:
+        result = user_client().get("/portal/v3/users/launchitems").json()
+    except httpx.HTTPStatusError as error:
+        raise CtxpException(f"Failed to list HCS user desktops: HTTP {error.response.status_code}") from error
+    except httpx.RequestError as error:
+        raise CtxpException(f"Failed to list HCS user desktops: {error}") from error
+
+    if not isinstance(result, list):
+        raise CtxpException("HCS user desktops response was not a list")
+    return result
+
+
+def list_sessions() -> list[dict]:
+    """Return active sessions for logged-in user."""
+    try:
+        result = user_client().get("/portal/v2/users/sessions").json()
+    except httpx.HTTPStatusError as error:
+        raise CtxpException(f"Failed to list HCS user sessions: HTTP {error.response.status_code}") from error
+    except httpx.RequestError as error:
+        raise CtxpException(f"Failed to list HCS user sessions: {error}") from error
+
+    if not isinstance(result, list):
+        raise CtxpException("HCS user sessions response was not a list")
+    return result
+
+
+def launch(desktop_id: str) -> dict:
+    """Generate a desktop spec for an entitled desktop."""
+    desktop = next((item for item in list_desktops() if item.get("id") == desktop_id), None)
+    if not desktop:
+        raise CtxpException(f"HCS user desktop not found: {desktop_id}")
+    if desktop.get("entitlementType") != "DESKTOP":
+        raise CtxpException(f"HCS user launch item is not a desktop: {desktop_id}")
+
+    body = {"entitlementId": desktop_id, "nativeClient": False}
+    vm = desktop.get("vm") or {}
+    if vm.get("templateId"):
+        body["templateId"] = vm["templateId"]
+    if vm.get("vmId"):
+        body["vmId"] = vm["vmId"]
+
+    try:
+        return user_client().post("/portal/v3/users/spec", json=body).json()
+    except httpx.HTTPStatusError as error:
+        raise CtxpException(f"Failed to launch HCS user desktop: HTTP {error.response.status_code}") from error
+    except httpx.RequestError as error:
+        raise CtxpException(f"Failed to launch HCS user desktop: {error}") from error
+
+
+def perform_action(resource_id: str, action: str) -> dict:
+    """Request a supported action for an end-user desktop or session."""
+    body = {"id": resource_id, "actionType": action}
+    try:
+        response = user_client().post("/portal/v2/users/action", json=body)
+        return {
+            "id": resource_id,
+            "actionType": action,
+            "status": "SUCCESS" if response.status_code == 201 else "PENDING",
+            "statusUrl": response.headers.get("Location"),
+        }
+    except httpx.HTTPStatusError as error:
+        raise CtxpException(f"Failed HCS user {action.lower()}: HTTP {error.response.status_code}") from error
+    except httpx.RequestError as error:
+        raise CtxpException(f"Failed HCS user {action.lower()}: {error}") from error
+
+
+def logoff(session_id: str) -> dict:
+    """Log off an end-user session."""
+    return perform_action(session_id, "LOGOFF")
+
+
+def restart(desktop_id: str) -> dict:
+    """Restart an entitled end-user desktop."""
+    return perform_action(desktop_id, "RESTART")

hcs_cli-0.1.352/hcs_cli/support/user_auth.py

@@ -0,0 +1,96 @@
+"""End-user authentication state and workflows."""
+
+import time
+
+import jwt
+
+from hcs_core.ctxp import CtxpException, profile
+from hcs_core.sglib.client_util import resolve_hcs_base_url
+from hcs_core.sglib.user_client import refresh_user_tokens, user_access_token
+
+from hcs_cli.service.auth import user as auth_service
+
+
+def auth_state() -> dict:
+    """Return saved end-user authentication state for current profile."""
+    return profile.auth_user.get()
+
+
+def access_token() -> str:
+    """Return valid saved end-user access token for current profile."""
+    return user_access_token()
+
+
+def token_details() -> dict:
+    """Decode saved end-user JWT without verifying its signature."""
+    token = auth_state().get("access_token")
+    if not token:
+        raise CtxpException("HCS user is not logged in. Run 'hcs user login'.")
+    try:
+        return {
+            "header": jwt.get_unverified_header(token),
+            "payload": jwt.decode(token, options={"verify_signature": False}),
+        }
+    except jwt.PyJWTError as error:
+        raise CtxpException("Saved HCS user access token is not a valid JWT.") from error
+
+
+def status() -> dict:
+    """Summarize current end-user authentication state."""
+    state = auth_state()
+    token = state.get("access_token")
+    if not token:
+        return {"loggedIn": False, "user": None, "orgId": None, "ttl": 0}
+
+    try:
+        payload = jwt.decode(token, options={"verify_signature": False})
+    except jwt.PyJWTError as error:
+        raise CtxpException("Saved HCS user access token is not a valid JWT.") from error
+    context = payload.get("context", {})
+    org_ids = context.get("orgIds") or []
+    expires_at = state.get("expires_at") or payload.get("exp") or 0
+    ttl = max(0, int(expires_at - time.time()))
+    return {
+        "loggedIn": ttl > 0,
+        "user": context.get("userPrincipalName") or context.get("userName"),
+        "orgId": org_ids[0] if org_ids else None,
+        "ttl": ttl,
+    }
+
+
+def login(idp: str, username: str, password: str) -> str:
+    """Authenticate and persist end-user state for current profile."""
+    result = auth_service.login(idp, username, password)
+    token = result.get("access_token")
+    if not token:
+        raise CtxpException("HCS user login response did not contain access_token")
+    if result.get("expires_in") and not result.get("expires_at"):
+        result["expires_at"] = int(time.time() + result["expires_in"])
+    result["idpTenantDomain"] = idp
+    profile.auth_user.set(result)
+    return token
+
+
+def refresh() -> dict:
+    """Refresh and persist end-user state for current profile."""
+    refresh_user_tokens()
+    return status()
+
+
+def logout() -> dict:
+    """Log out and remove saved end-user state after remote success."""
+    user_access_token()
+    state = auth_state()
+    idp = state.get("idpTenantDomain")
+    id_token = state.get("id_token")
+    if not idp or not id_token:
+        raise CtxpException("Saved HCS user login lacks logout state. Run 'hcs user login' again.")
+
+    result = auth_service.logout(
+        idp,
+        resolve_hcs_base_url().rstrip("/"),
+        state.get("refresh_token"),
+        id_token,
+    )
+    profile.auth_user.delete()
+    return result

{hcs_cli-0.1.349 → hcs_cli-0.1.352}/pyproject.toml

@@ -21,7 +21,7 @@ keywords = [
 ]
 dynamic = ["version"]
 dependencies = [
-    "hcs-core>=0.1.350",
+    "hcs-core>=0.1.352",
     "reportlab>=4.0.0",
     "InquirerPy>=0.3.4",
     "paho-mqtt>=2.1.0"
@@ -80,6 +80,9 @@ exclude = [
 line-length = 140
 target-version = "py39"
 
+[tool.ruff.lint]
+ignore = ["F401"]
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = ["test_*.py"]

hcs_cli-0.1.349/hcs_cli/service/auth/__init__.py

@@ -1 +0,0 @@
-from . import admin

hcs_cli-0.1.349/hcs_cli/service/portal/__init__.py

@@ -1 +0,0 @@
-from . import entitlement, pool, site