Skip to content

fix(onboard): reject the reserved Hermes API port as the dashboard port - #5015

Merged
cv merged 3 commits into
NVIDIA:mainfrom
rluo8:fix/4984-dashboard-port-reserved
Jun 9, 2026
Merged

fix(onboard): reject the reserved Hermes API port as the dashboard port#5015
cv merged 3 commits into
NVIDIA:mainfrom
rluo8:fix/4984-dashboard-port-reserved

Conversation

@rluo8

@rluo8 rluo8 commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

NemoHermes onboarding accepted NEMOCLAW_DASHBOARD_PORT=8642 (the port reserved for the Hermes OpenAI-compatible API) and built the sandbox instead of failing the security check. This adds a host-side guard that rejects the reserved port before any sandbox is created.

Related Issue

Fixes #4984

Changes

  • Reject a dashboard port equal to the Hermes OpenAI-compatible API port (8642) in resolveHermesDashboardOnboardState (src/lib/onboard/hermes-dashboard.ts), emitting [SECURITY] Invalid Hermes dashboard port 8642 - reserved for the Hermes OpenAI-compatible API and exiting non-zero before sandbox creation — the same message as the in-sandbox guard in agents/hermes/start.sh.
  • Cover both entry points that can set the dashboard port to 8642: the resolved effectivePort (--control-ui-port, CHAT_UI_URL, or a persisted registry port) and the raw NEMOCLAW_DASHBOARD_PORT env (which the host otherwise silently drops to the agent default, so effectivePort alone would miss it).
  • Add unit tests for both entry points plus the no-override and non-hermes cases; update two existing tests that passed 8642 as a placeholder dashboard port (it is the reserved API port, never a valid dashboard port) to the realistic 18789.

Type of Change

  • [√] Code change (feature, bug fix, or refactor)
  • Code change with doc updates
  • Doc only (prose changes, no code sample modifications)
  • Doc only (includes code sample changes)

Verification

  • [√] npx prek run --all-files passes
  • [√] npm test passes
  • [√] Tests added or updated for new or changed behavior
  • [√] No secrets, API keys, or credentials committed
  • Docs updated for user-facing behavior changes
  • npm run docs builds without warnings (doc changes only)
  • Doc pages follow the style guide (doc changes only)
  • New doc pages include SPDX header and frontmatter (new pages only)

Signed-off-by: rluo8 ruluo@nvidia.com

Summary by CodeRabbit

  • Bug Fixes

    • Added validation to prevent dashboard port configuration to the reserved Hermes API port (8642), with explicit security error messaging when this occurs.
    • Validation checks both environment variable overrides and computed port resolution from configuration.
  • Tests

    • Updated dashboard onboarding tests to validate reserved port rejection behavior and reflect realistic port configurations.

@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9ad6bb0e-0f93-451b-9d0b-41b44368d04f

📥 Commits

Reviewing files that changed from the base of the PR and between ab983f2 and 81854a4.

📒 Files selected for processing (2)
  • src/lib/onboard/hermes-dashboard.test.ts
  • src/lib/onboard/hermes-dashboard.ts

📝 Walkthrough

Walkthrough

This PR hardens Hermes onboarding against port 8642 (reserved for the OpenAI-compatible API) being used as a dashboard port. It adds a reserved-port constant and pre-sandbox validation that checks both the effective port and environment override, plus comprehensive test coverage including whitespace handling and control UI derivation.

Changes

Reserved Port Validation and Testing

Layer / File(s) Summary
Reserved port constant and validation logic
src/lib/onboard/hermes-dashboard.ts
Introduces HERMES_OPENAI_API_PORT constant (8642) and extends resolveHermesDashboardOnboardState with pre-sandbox validation that rejects configurations where either the effective dashboard port or raw NEMOCLAW_DASHBOARD_PORT environment override equals 8642, producing a [SECURITY] error.
Test coverage for reserved port validation
src/lib/onboard/hermes-dashboard.test.ts
Updates existing drift-tracking and rollback tests to use realistic port 18789; adds new test cases verifying rejection of port 8642 from environment variables (including whitespace-padded values), derivation via control UI inputs with empty raw env, acceptance of non-reserved ports, and exclusion of the guard for non-Hermes agents.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • NVIDIA/NemoClaw#4931: Updates resolveHermesDashboardOnboardState to reject dashboard configurations when a port collides with the Hermes API effective port.

Suggested labels

integration: hermes, area: onboarding, bug-fix, v0.0.61

Suggested reviewers

  • cv

Poem

🐰 A port in the night, 8642 bright,
Was taken for dash, but it's API's right!
We validate now, with a [SECURITY] cry,
No sandbox for you with that port—goodbye! 🔐

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly summarizes the main change: rejecting the reserved Hermes API port (8642) as the dashboard port, which is the primary objective of the PR.
Linked Issues check ✅ Passed The PR fully addresses issue #4984 by implementing reserved-port validation in resolveHermesDashboardOnboardState, rejecting port 8642 with a [SECURITY] error message and non-zero exit before sandbox creation.
Out of Scope Changes check ✅ Passed All changes are directly scoped to implementing the reserved-port guard: validation logic in hermes-dashboard.ts and comprehensive test coverage in hermes-dashboard.test.ts with no unrelated modifications.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@wscurran wscurran added the bug-fix PR fixes a bug or regression label Jun 9, 2026
@rluo8 rluo8 added the v0.0.62 label Jun 9, 2026
@cv
cv merged commit f8712a6 into NVIDIA:main Jun 9, 2026
37 checks passed
jyaunches pushed a commit that referenced this pull request Jun 10, 2026
## Summary
- Add v0.0.62 release notes from Discussion #5100 and link release
highlights to the relevant docs pages.
- Document the release's GPU sandbox recreation, sandbox-side local
inference verification, and Hermes dashboard port guard in the command
and inference references.
- Refresh generated NemoClaw user skills for the release-prep docs set.

## Source Summary
- #4956 -> `docs/reference/commands.mdx`: Document CDI-first Docker GPU
recreation behavior for Linux Docker-driver sandboxes.
- #5024 -> `docs/inference/use-local-inference.mdx`: Document
sandbox-runtime verification of the `inference.local` local inference
route.
- #5018 -> `docs/reference/commands.mdx`: Document Jetson/Tegra
device-node group propagation for sandbox CUDA initialization.
- #5012, #4763, #4706, #5030, #5015 -> `docs/about/release-notes.mdx`:
Summarize onboarding and recovery reliability fixes, including the
reserved Hermes API port guard.
- #5017 and #5043 -> `docs/about/release-notes.mdx`,
`docs/reference/commands.mdx`: Summarize mutable OpenClaw config
recovery and host-side `agents list` coverage.
- #5010 and #5016 -> `docs/about/release-notes.mdx`: Summarize Hermes
upstream metadata visibility and WhatsApp QR rendering reliability.
- #5045 and prior source docs in the v0.0.62 range -> `.agents/skills/`:
Refresh generated user-skill references from the current docs source.

## Skipped
- #5019 -> skipped for new prose because it touched
`openclaw-sandbox-permissive.yaml`, which matches `docs/.docs-skip`.
Existing source docs remain the source for generated skill
synchronization.

## Verification
- `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix
nemoclaw-user --doc-platform fern-mdx`
- `npm run docs` (passes; Fern reports 0 errors and 1 hidden warning)
- Pre-commit hooks passed during commit, including docs-to-skills
verification, markdown lint, gitleaks, and skills YAML tests.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
  * Added `nemoclaw <name> agents list` command.
* v0.0.62 release notes added summarizing onboarding and recovery
improvements.

* **Bug Fixes**
* Improved GPU sandbox onboarding reliability (NVIDIA CDI path,
Jetson/Tegra device handling).
* Better local inference verification and recovery for Linux
Docker-driver GPU sandboxes.
  * Quieter/earlier handling of onboarding drift and port collisions.

* **Documentation**
* Expanded GPU passthrough, inference verification, writable paths
(`/dev/pts`), port 8642 restriction, and command examples.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Prekshi Vyas <34834085+prekshivyas@users.noreply.github.com>
cv added a commit that referenced this pull request Jun 13, 2026
<!-- markdownlint-disable MD041 -->
## Summary
<!-- 1-3 sentences: what this PR does and why. -->
Extends the #4984 reserved-port guard (PR #5015) to all agents, and adds
a fail-fast preflight check. The shipped guard was hermes-gated, so a
plain `nemoclaw onboard` (default OpenClaw agent) still accepted
`NEMOCLAW_DASHBOARD_PORT=8642` — and, being a single-port agent,
actually bound host port 8642. That silently breaks a later `nemoclaw
onboard --agent hermes`, whose OpenAI-compatible API must forward 8642
(it warns "cannot be reallocated" but still exits 0, leaving the API
unreachable).

## Related Issue
<!-- Fixes #NNN or Closes #NNN. Remove this section if none. -->
Fixes  #4984

## Changes
<!-- Bullet list of key changes. -->
- `core/ports.ts`: add `HERMES_OPENAI_API_PORT` (8642) and a shared,
agent-neutral rejection message `RESERVED_HERMES_DASHBOARD_PORT_MESSAGE`
as the single source of truth for both guards.
- New `onboard/preflight-ports.ts`: `buildRequiredPreflightPorts()`
(extracted from the inline onboard.ts array) and
`assertDashboardPortNotReserved()`.
- `onboard.ts` preflight ([1/8]) now rejects an explicit reserved
dashboard port fast — before gateway/inference — instead of printing "✓
available" and then hard-failing later. Net change to `onboard.ts` is
negative (no growth).
- `resolveHermesDashboardOnboardState` ([6/8]) rejection made
agent-agnostic
(catches deferred `CHAT_UI_URL` / persisted-port paths the preflight
can't see).
- Message is now agent-neutral ("Invalid dashboard port 8642 - reserved
for the
Hermes OpenAI-compatible API") since the dashboard belongs to whichever
agent is onboarding; the reason still names Hermes.
- Tests: new `onboard/preflight-ports` tests + flipped the non-Hermes
guard test.

## Type of Change

- [√] Code change (feature, bug fix, or refactor)
- [ ] Code change with doc updates
- [ ] Doc only (prose changes, no code sample modifications)
- [ ] Doc only (includes code sample changes)

## Verification
<!-- Check each item you ran and confirmed. Leave unchecked items you
skipped. Doc-only changes do not require npm test unless you ran it. -->
- [√] `npx prek run --all-files` passes
- [√] `npm test` passes
- [√] Tests added or updated for new or changed behavior
- [√] No secrets, API keys, or credentials committed
- [ ] Docs updated for user-facing behavior changes
- [ ] `npm run docs` builds without warnings (doc changes only)
- [ ] Doc pages follow the [style
guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md)
(doc changes only)
- [ ] New doc pages include SPDX header and frontmatter (new pages only)

---
<!-- DCO sign-off required by CI. Run: git config user.name && git
config user.email -->
Signed-off-by: rluo8 <ruluo@nvidia.com>


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Bug Fixes**
* Onboarding now rejects the reserved dashboard port 8642 for all agent
types (non-Hermes agents no longer bypass this guard).
* Explicit dashboard-port preflight checks now fail fast when 8642 is
provided.
* Error message standardized to begin with "[SECURITY] Invalid dashboard
port 8642..." when the reserved port is used.

* **Tests**
* Added/updated tests to assert the reserved-port rejection and
required-port preflight behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Signed-off-by: Rui Luo <ruluo@nvidia.com>
Co-authored-by: Carlos Villela <cvillela@nvidia.com>
@wscurran wscurran added the NV QA Bugs found by the NVIDIA QA Team label Jun 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug-fix PR fixes a bug or regression NV QA Bugs found by the NVIDIA QA Team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[All Platforms][Security] Hermes: NEMOCLAW_DASHBOARD_PORT=8642 not rejected, onboarding proceeds instead of failing security check

3 participants