mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-01 01:51:44 +00:00
feat: secure skill env setup on load (core #688)
When a skill declares required_environment_variables in its YAML frontmatter, missing env vars trigger a secure TUI prompt (identical to the sudo password widget) when the skill is loaded. Secrets flow directly to ~/.hermes/.env, never entering LLM context. Key changes: - New required_environment_variables frontmatter field for skills - Secure TUI widget (masked input, 120s timeout) - Gateway safety: messaging platforms show local setup guidance - Legacy prerequisites.env_vars normalized into new format - Remote backend handling: conservative setup_needed=True - Env var name validation, file permissions hardened to 0o600 - Redact patterns extended for secret-related JSON fields - 12 existing skills updated with prerequisites declarations - ~48 new tests covering skip, timeout, gateway, remote backends - Dynamic panel widget sizing (fixes hardcoded width from original PR) Cherry-picked from PR #723 by kshitijk4poor, rebased onto current main with conflict resolution. Fixes #688 Co-authored-by: kshitijk4poor <kshitijk4poor@users.noreply.github.com>
This commit is contained in:
parent
c097e56142
commit
ccfbf42844
34 changed files with 2419 additions and 403 deletions
|
|
@ -1,12 +1,15 @@
|
|||
"""Tests for agent/skill_commands.py — skill slash command scanning and platform filtering."""
|
||||
|
||||
from pathlib import Path
|
||||
import os
|
||||
from unittest.mock import patch
|
||||
|
||||
import tools.skills_tool as skills_tool_module
|
||||
from agent.skill_commands import scan_skill_commands, build_skill_invocation_message
|
||||
|
||||
|
||||
def _make_skill(skills_dir, name, frontmatter_extra="", body="Do the thing.", category=None):
|
||||
def _make_skill(
|
||||
skills_dir, name, frontmatter_extra="", body="Do the thing.", category=None
|
||||
):
|
||||
"""Helper to create a minimal skill directory with SKILL.md."""
|
||||
if category:
|
||||
skill_dir = skills_dir / category / name
|
||||
|
|
@ -42,8 +45,10 @@ class TestScanSkillCommands:
|
|||
|
||||
def test_excludes_incompatible_platform(self, tmp_path):
|
||||
"""macOS-only skills should not register slash commands on Linux."""
|
||||
with patch("tools.skills_tool.SKILLS_DIR", tmp_path), \
|
||||
patch("tools.skills_tool.sys") as mock_sys:
|
||||
with (
|
||||
patch("tools.skills_tool.SKILLS_DIR", tmp_path),
|
||||
patch("tools.skills_tool.sys") as mock_sys,
|
||||
):
|
||||
mock_sys.platform = "linux"
|
||||
_make_skill(tmp_path, "imessage", frontmatter_extra="platforms: [macos]\n")
|
||||
_make_skill(tmp_path, "web-search")
|
||||
|
|
@ -53,8 +58,10 @@ class TestScanSkillCommands:
|
|||
|
||||
def test_includes_matching_platform(self, tmp_path):
|
||||
"""macOS-only skills should register slash commands on macOS."""
|
||||
with patch("tools.skills_tool.SKILLS_DIR", tmp_path), \
|
||||
patch("tools.skills_tool.sys") as mock_sys:
|
||||
with (
|
||||
patch("tools.skills_tool.SKILLS_DIR", tmp_path),
|
||||
patch("tools.skills_tool.sys") as mock_sys,
|
||||
):
|
||||
mock_sys.platform = "darwin"
|
||||
_make_skill(tmp_path, "imessage", frontmatter_extra="platforms: [macos]\n")
|
||||
result = scan_skill_commands()
|
||||
|
|
@ -62,8 +69,10 @@ class TestScanSkillCommands:
|
|||
|
||||
def test_universal_skill_on_any_platform(self, tmp_path):
|
||||
"""Skills without platforms field should register on any platform."""
|
||||
with patch("tools.skills_tool.SKILLS_DIR", tmp_path), \
|
||||
patch("tools.skills_tool.sys") as mock_sys:
|
||||
with (
|
||||
patch("tools.skills_tool.SKILLS_DIR", tmp_path),
|
||||
patch("tools.skills_tool.sys") as mock_sys,
|
||||
):
|
||||
mock_sys.platform = "win32"
|
||||
_make_skill(tmp_path, "generic-tool")
|
||||
result = scan_skill_commands()
|
||||
|
|
@ -71,6 +80,30 @@ class TestScanSkillCommands:
|
|||
|
||||
|
||||
class TestBuildSkillInvocationMessage:
|
||||
def test_loads_skill_by_stored_path_when_frontmatter_name_differs(self, tmp_path):
|
||||
skill_dir = tmp_path / "mlops" / "audiocraft"
|
||||
skill_dir.mkdir(parents=True, exist_ok=True)
|
||||
(skill_dir / "SKILL.md").write_text(
|
||||
"""\
|
||||
---
|
||||
name: audiocraft-audio-generation
|
||||
description: Generate audio with AudioCraft.
|
||||
---
|
||||
|
||||
# AudioCraft
|
||||
|
||||
Generate some audio.
|
||||
"""
|
||||
)
|
||||
|
||||
with patch("tools.skills_tool.SKILLS_DIR", tmp_path):
|
||||
scan_skill_commands()
|
||||
msg = build_skill_invocation_message("/audiocraft-audio-generation", "compose")
|
||||
|
||||
assert msg is not None
|
||||
assert "AudioCraft" in msg
|
||||
assert "compose" in msg
|
||||
|
||||
def test_builds_message(self, tmp_path):
|
||||
with patch("tools.skills_tool.SKILLS_DIR", tmp_path):
|
||||
_make_skill(tmp_path, "test-skill")
|
||||
|
|
@ -85,3 +118,126 @@ class TestBuildSkillInvocationMessage:
|
|||
scan_skill_commands()
|
||||
msg = build_skill_invocation_message("/nonexistent")
|
||||
assert msg is None
|
||||
|
||||
def test_uses_shared_skill_loader_for_secure_setup(self, tmp_path, monkeypatch):
|
||||
monkeypatch.delenv("TENOR_API_KEY", raising=False)
|
||||
calls = []
|
||||
|
||||
def fake_secret_callback(var_name, prompt, metadata=None):
|
||||
calls.append((var_name, prompt, metadata))
|
||||
os.environ[var_name] = "stored-in-test"
|
||||
return {
|
||||
"success": True,
|
||||
"stored_as": var_name,
|
||||
"validated": False,
|
||||
"skipped": False,
|
||||
}
|
||||
|
||||
monkeypatch.setattr(
|
||||
skills_tool_module,
|
||||
"_secret_capture_callback",
|
||||
fake_secret_callback,
|
||||
raising=False,
|
||||
)
|
||||
|
||||
with patch("tools.skills_tool.SKILLS_DIR", tmp_path):
|
||||
_make_skill(
|
||||
tmp_path,
|
||||
"test-skill",
|
||||
frontmatter_extra=(
|
||||
"required_environment_variables:\n"
|
||||
" - name: TENOR_API_KEY\n"
|
||||
" prompt: Tenor API key\n"
|
||||
),
|
||||
)
|
||||
scan_skill_commands()
|
||||
msg = build_skill_invocation_message("/test-skill", "do stuff")
|
||||
|
||||
assert msg is not None
|
||||
assert "test-skill" in msg
|
||||
assert len(calls) == 1
|
||||
assert calls[0][0] == "TENOR_API_KEY"
|
||||
|
||||
def test_gateway_still_loads_skill_but_returns_setup_guidance(
|
||||
self, tmp_path, monkeypatch
|
||||
):
|
||||
monkeypatch.delenv("TENOR_API_KEY", raising=False)
|
||||
|
||||
def fail_if_called(var_name, prompt, metadata=None):
|
||||
raise AssertionError(
|
||||
"gateway flow should not try secure in-band secret capture"
|
||||
)
|
||||
|
||||
monkeypatch.setattr(
|
||||
skills_tool_module,
|
||||
"_secret_capture_callback",
|
||||
fail_if_called,
|
||||
raising=False,
|
||||
)
|
||||
|
||||
with patch.dict(
|
||||
os.environ, {"HERMES_SESSION_PLATFORM": "telegram"}, clear=False
|
||||
):
|
||||
with patch("tools.skills_tool.SKILLS_DIR", tmp_path):
|
||||
_make_skill(
|
||||
tmp_path,
|
||||
"test-skill",
|
||||
frontmatter_extra=(
|
||||
"required_environment_variables:\n"
|
||||
" - name: TENOR_API_KEY\n"
|
||||
" prompt: Tenor API key\n"
|
||||
),
|
||||
)
|
||||
scan_skill_commands()
|
||||
msg = build_skill_invocation_message("/test-skill", "do stuff")
|
||||
|
||||
assert msg is not None
|
||||
assert "hermes setup" in msg.lower()
|
||||
|
||||
def test_preserves_remaining_remote_setup_warning(self, tmp_path, monkeypatch):
|
||||
monkeypatch.setenv("TERMINAL_ENV", "ssh")
|
||||
monkeypatch.delenv("TENOR_API_KEY", raising=False)
|
||||
|
||||
def fake_secret_callback(var_name, prompt, metadata=None):
|
||||
os.environ[var_name] = "stored-in-test"
|
||||
return {
|
||||
"success": True,
|
||||
"stored_as": var_name,
|
||||
"validated": False,
|
||||
"skipped": False,
|
||||
}
|
||||
|
||||
monkeypatch.setattr(
|
||||
skills_tool_module,
|
||||
"_secret_capture_callback",
|
||||
fake_secret_callback,
|
||||
raising=False,
|
||||
)
|
||||
|
||||
with patch("tools.skills_tool.SKILLS_DIR", tmp_path):
|
||||
_make_skill(
|
||||
tmp_path,
|
||||
"test-skill",
|
||||
frontmatter_extra=(
|
||||
"required_environment_variables:\n"
|
||||
" - name: TENOR_API_KEY\n"
|
||||
" prompt: Tenor API key\n"
|
||||
),
|
||||
)
|
||||
scan_skill_commands()
|
||||
msg = build_skill_invocation_message("/test-skill", "do stuff")
|
||||
|
||||
assert msg is not None
|
||||
assert "remote environment" in msg.lower()
|
||||
|
||||
def test_supporting_file_hint_uses_file_path_argument(self, tmp_path):
|
||||
with patch("tools.skills_tool.SKILLS_DIR", tmp_path):
|
||||
skill_dir = _make_skill(tmp_path, "test-skill")
|
||||
references = skill_dir / "references"
|
||||
references.mkdir()
|
||||
(references / "api.md").write_text("reference")
|
||||
scan_skill_commands()
|
||||
msg = build_skill_invocation_message("/test-skill", "do stuff")
|
||||
|
||||
assert msg is not None
|
||||
assert 'file_path="<path>"' in msg
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue