# Conflicts: # AGENTS.md # acp_adapter/edit_approval.py # acp_adapter/server.py # agent/agent_init.py # agent/anthropic_adapter.py # agent/anthropic_credentials.py # agent/auxiliary_client.py # agent/azure_identity_adapter.py # agent/bedrock_adapter.py # agent/browser_registry.py # agent/chat_completion_helpers.py # agent/coding_context.py # agent/context_references.py # agent/conversation_loop.py # agent/copilot_acp_client.py # agent/credits_tracker.py # agent/curator.py # agent/curator_backup.py # agent/deadline.py # agent/display.py # agent/errors.py # agent/estop.py # agent/i18n.py # agent/image_gen_registry.py # agent/image_routing.py # agent/learning_graph.py # agent/learning_mutations.py # agent/lsp/servers.py # agent/model_metadata.py # agent/models_dev.py # agent/monitoring/gateway_health_export.py # agent/monitoring/otlp_exporter.py # agent/pet/store.py # agent/process_bootstrap.py # agent/prompt_builder.py # agent/proxy_sources/iron_proxy.py # agent/secret_sources/_cache.py # agent/secret_sources/bitwarden.py # agent/secret_sources/registry.py # agent/shell_hooks.py # agent/skill_bundles.py # agent/skill_commands.py # agent/skill_utils.py # agent/ssl_guard.py # agent/ssl_verify.py # agent/system_prompt.py # agent/terminal_env_registry.py # agent/trace_upload.py # agent/transcription_registry.py # agent/tts_registry.py # agent/verify/environment.py # agent/vertex_adapter.py # agent/video_gen_registry.py # agent/web_search_registry.py # cli.py # cron/jobs.py # cron/scheduler.py # gateway/agent_cache_pressure.py # gateway/cgroup_cleanup.py # gateway/channel_directory.py # gateway/config.py # gateway/control_socket.py # gateway/dead_targets.py # gateway/drain_control.py # gateway/hooks.py # gateway/kanban_watchers.py # gateway/lifecycle_ledger.py # gateway/mirror.py # gateway/pairing.py # gateway/platform_registry.py # gateway/platforms/helpers.py # gateway/platforms/weixin.py # gateway/readiness.py # gateway/restart_loop_guard.py # gateway/rich_sent_store.py # gateway/run.py # gateway/session.py # gateway/shutdown_flush.py # gateway/shutdown_forensics.py # gateway/slash_commands.py # gateway/status.py # gateway/sticker_cache.py # gateway/whatsapp_identity.py # hermes_bootstrap.py # hermes_cli/_early_recovery.py # hermes_cli/_install_repair.py # hermes_cli/_startup_fast.py # hermes_cli/_subprocess_compat.py # hermes_cli/agent_plugins.py # hermes_cli/auth.py # hermes_cli/backup.py # hermes_cli/banner.py # hermes_cli/browser_connect.py # hermes_cli/build_info.py # hermes_cli/cli_agent_setup_mixin.py # hermes_cli/cli_commands_mixin.py # hermes_cli/codex_models.py # hermes_cli/config.py # hermes_cli/config_defaults.py # hermes_cli/config_migrations.py # hermes_cli/container_boot.py # hermes_cli/dashboard_auth/registry.py # hermes_cli/debug.py # hermes_cli/dep_ensure.py # hermes_cli/doctor.py # hermes_cli/doctor_live.py # hermes_cli/dump.py # hermes_cli/env_loader.py # hermes_cli/foreign_sessions.py # hermes_cli/gateway.py # hermes_cli/gateway_windows.py # hermes_cli/gui_uninstall.py # hermes_cli/image_provenance.py # hermes_cli/install_identity.py # hermes_cli/kanban.py # hermes_cli/kanban_db.py # hermes_cli/linux_desktop_entry.py # hermes_cli/local_runtime/binaries.py # hermes_cli/local_runtime/endpoint.py # hermes_cli/local_runtime/growth.py # hermes_cli/local_runtime/supervisor.py # hermes_cli/logs.py # hermes_cli/macos_tcc_anchor.py # hermes_cli/main.py # hermes_cli/memory_setup.py # hermes_cli/model_catalog.py # hermes_cli/models.py # hermes_cli/nous_subscription.py # hermes_cli/npm_engine.py # hermes_cli/plugin_index.py # hermes_cli/plugins.py # hermes_cli/plugins_cmd.py # hermes_cli/profile_distribution.py # hermes_cli/profiles.py # hermes_cli/prompt_size.py # hermes_cli/psutil_android.py # hermes_cli/runtime_repair.py # hermes_cli/security_advisories.py # hermes_cli/security_audit.py # hermes_cli/security_audit_startup.py # hermes_cli/service_manager.py # hermes_cli/session_export_md.py # hermes_cli/setup.py # hermes_cli/skills_hub.py # hermes_cli/slack_cli.py # hermes_cli/status.py # hermes_cli/subcommands/gateway.py # hermes_cli/subcommands/uninstall.py # hermes_cli/tools_config.py # hermes_cli/uninstall.py # hermes_cli/update_cmd.py # hermes_cli/update_contract.py # hermes_cli/update_inventory.py # hermes_cli/update_lock.py # hermes_cli/update_receipt.py # hermes_cli/urllib_security.py # hermes_cli/web_routers/local_models.py # hermes_cli/web_routers/profiles.py # hermes_cli/web_routers/skills.py # hermes_cli/web_server.py # hermes_constants.py # hermes_state.py # plugins/disk-cleanup/__init__.py # plugins/disk-cleanup/disk_cleanup.py # plugins/google_meet/node/registry.py # plugins/google_meet/node/server.py # plugins/google_meet/process_manager.py # plugins/google_meet/realtime/openai_client.py # plugins/hermes-achievements/dashboard/plugin_api.py # plugins/memory/hindsight/__init__.py # plugins/memory/honcho/__init__.py # plugins/memory/honcho/cli.py # plugins/memory/honcho/client.py # plugins/memory/honcho/oauth.py # plugins/memory/honcho/session.py # plugins/memory/mem0/__init__.py # plugins/memory/mem0/_setup.py # plugins/memory/openviking/__init__.py # plugins/memory/retaindb/__init__.py # plugins/memory/supermemory/__init__.py # plugins/platforms/a2a/protocol.py # plugins/platforms/dingtalk/adapter.py # plugins/platforms/discord/adapter.py # plugins/platforms/feishu/adapter.py # plugins/platforms/google_chat/adapter.py # plugins/platforms/matrix/adapter.py # plugins/platforms/photon/adapter.py # plugins/platforms/photon/auth.py # plugins/platforms/photon/cli.py # plugins/platforms/slack/adapter.py # plugins/platforms/teams/adapter.py # plugins/platforms/telegram/adapter.py # plugins/platforms/wecom/callback_adapter.py # plugins/platforms/whatsapp/adapter.py # plugins/teams_pipeline/store.py # plugins/video_gen/fal/__init__.py # plugins/web/ddgs/provider.py # plugins/web/exa/provider.py # plugins/web/firecrawl/provider.py # plugins/web/parallel/provider.py # tests/agent/test_ssl_ca_guard.py # tests/hermes_cli/test_certifi_repair.py # tests/hermes_cli/test_cmd_update.py # tests/hermes_cli/test_cmd_update_apt.py # tests/hermes_cli/test_dashboard_unified_launch.py # tests/hermes_cli/test_dep_ensure.py # tests/hermes_cli/test_doctor.py # tests/hermes_cli/test_doctor_live.py # tests/hermes_cli/test_gui_command.py # tests/hermes_cli/test_kanban_boards.py # tests/hermes_cli/test_kanban_db.py # tests/hermes_cli/test_lazy_refresh_venv_repair.py # tests/hermes_cli/test_memory_setup_provider_arg.py # tests/hermes_cli/test_nous_subscription.py # tests/hermes_cli/test_pip_install_detection.py # tests/hermes_cli/test_profile_export_credentials.py # tests/hermes_cli/test_psutil_android_extract.py # tests/hermes_cli/test_status.py # tests/hermes_cli/test_tui_npm_install.py # tests/hermes_cli/test_update_fleet_restart_pending.py # tests/hermes_cli/test_update_head_moved_gate.py # tests/hermes_cli/test_update_interrupted_recovery.py # tests/hermes_cli/test_web_server.py # tests/hermes_cli/test_web_ui_build.py # tests/test_hermes_logging.py # tests/test_managed_runtime_resolution.py # tests/tools/test_browser_chromium_autoinstall.py # tests/tools/test_browser_chromium_check.py # tests/tools/test_browser_homebrew_paths.py # tests/tools/test_browser_lightpanda.py # tests/tools/test_browser_npx_warmup.py # tests/tools/test_browser_open_timeout.py # tests/tools/test_browser_orphan_reaper.py # tests/tools/test_browser_real_profile.py # tests/tools/test_browser_suspect_recycle.py # tests/tools/test_find_shell.py # tests/tools/test_local_env_blocklist.py # tests/tools/test_macos_protected_search.py # tests/tui_gateway/test_compute_host.py # tools/approval.py # tools/blueprints.py # tools/bot_mode_dm.py # tools/bot_mode_probe.py # tools/bot_relay.py # tools/browser_tool.py # tools/browser_use_cli.py # tools/checkpoint_manager.py # tools/code_execution_tool.py # tools/code_kernel.py # tools/computer_use/cua_backend.py # tools/cronjob_tools.py # tools/discord_tool.py # tools/environments/base.py # tools/environments/daytona.py # tools/environments/local.py # tools/environments/modal.py # tools/environments/vercel_sandbox.py # tools/fal_common.py # tools/file_operations.py # tools/lazy_deps.py # tools/mcp_tool.py # tools/neutts_synth.py # tools/process_registry.py # tools/read_extract.py # tools/registry.py # tools/skill_ledger.py # tools/skill_linter.py # tools/skill_manager_tool.py # tools/skill_usage.py # tools/skills_ast_audit.py # tools/skills_guard.py # tools/skills_hub.py # tools/skills_sync.py # tools/skills_sync_client.py # tools/skills_tool.py # tools/terminal_scope.py # tools/terminal_tool.py # tools/tirith_security.py # tools/transcription_tools.py # tools/tts_tool.py # tools/vision_tools.py # tools/voice_mode.py # tools/wake_word.py # tools/web_result_cache.py # tools/website_policy.py # tools/working_diff.py # tools/write_approval.py # tui_gateway/entry.py # tui_gateway/methods_tools.py # tui_gateway/server.py
200 lines
8.8 KiB
Python
200 lines
8.8 KiB
Python
"""Vertex AI (Google Cloud) auth + base-URL resolution for its OpenAI-compatible endpoint.
|
|
|
|
Requires ``google-auth`` (lazy-installed). Secrets: GOOGLE_APPLICATION_CREDENTIALS /
|
|
VERTEX_CREDENTIALS_PATH (SA JSON path; the latter wins), VERTEX_PROJECT_ID,
|
|
VERTEX_REGION. project_id/region may also live in config.yaml ``vertex:``;
|
|
env wins over config.
|
|
"""
|
|
|
|
import hashlib
|
|
import json
|
|
import logging
|
|
import os
|
|
import time
|
|
from typing import Any, Optional, Tuple
|
|
|
|
from agent.secret_scope import get_secret as _get_secret, is_multiplex_active
|
|
|
|
# Ensure google-auth is installed before importing. The [vertex] extra is no
|
|
# longer in [all] per the lazy-install policy added 2026-05-12 — pm
|
|
# handles on-demand installation so the Vertex provider still works for users
|
|
# who installed plain `hermes-agent` and only later selected a Gemini model.
|
|
try:
|
|
from pm import ensure_import as _ensure_import
|
|
_ensure_import("vertex")
|
|
except Exception:
|
|
pass # pm unavailable or install failed — fall through to the real ImportError below
|
|
try:
|
|
import google.auth
|
|
import google.auth.transport.requests
|
|
from google.oauth2 import service_account
|
|
except ImportError:
|
|
google = None # type: ignore[assignment]
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
DEFAULT_REGION = "global"
|
|
_CLOUD_PLATFORM_SCOPES = ["https://www.googleapis.com/auth/cloud-platform"]
|
|
|
|
_creds_cache: dict = {}
|
|
|
|
|
|
def _vertex_config() -> dict:
|
|
"""Return the ``vertex:`` section of config.yaml, or {} on any failure."""
|
|
try:
|
|
from hermes_cli.config import load_config
|
|
|
|
section = load_config().get("vertex")
|
|
return section if isinstance(section, dict) else {}
|
|
except Exception:
|
|
return {}
|
|
|
|
|
|
def _env_or_config(env_var: str, config_key: str) -> str:
|
|
"""Setting precedence: env/secret > config.yaml; "" when neither is set."""
|
|
return (_get_secret(env_var) or "").strip() or str(_vertex_config().get(config_key) or "").strip()
|
|
|
|
|
|
def _resolve_region(explicit: Optional[str] = None) -> str:
|
|
"""Region precedence: explicit arg > VERTEX_REGION env > config.yaml > default."""
|
|
return explicit or _env_or_config("VERTEX_REGION", "region") or DEFAULT_REGION
|
|
|
|
|
|
def _resolve_project_override() -> Optional[str]:
|
|
"""Project-ID override (VERTEX_PROJECT_ID env > config.yaml), or None to use the creds' embedded project_id."""
|
|
return _env_or_config("VERTEX_PROJECT_ID", "project_id") or None
|
|
|
|
|
|
def _resolve_credentials_path(explicit: Optional[str]) -> Optional[str]:
|
|
if explicit and os.path.exists(explicit):
|
|
return explicit
|
|
# get_secret, not os.environ: under a multiplex gateway os.environ reflects whichever
|
|
# .env loaded at boot, and a raw read could mint (and bill) another profile's SA tokens.
|
|
for env_var in ("VERTEX_CREDENTIALS_PATH", "GOOGLE_APPLICATION_CREDENTIALS"):
|
|
path = _get_secret(env_var)
|
|
if path and os.path.exists(path):
|
|
return path
|
|
return None
|
|
|
|
|
|
def _sa_snapshot(resolved_path: Optional[str]) -> Tuple[Optional[bytes], Tuple[Any, ...]]:
|
|
"""Resolve (bytes-or-None, cache key) for one credential attempt.
|
|
|
|
- No path (ADC): (None, ("__adc__",)) sentinel key.
|
|
- Readable file: (bytes, (path, sha256)).
|
|
- Unreadable file: (None, (path,)) — the caller falls back to the SDK's own file read.
|
|
|
|
The key fingerprints file CONTENT, not stat metadata (a metadata-preserving
|
|
atomic replacement can swap the private key under an identical stat signature,
|
|
and this cache guards an identity). Returning the bytes lets the caller build
|
|
credentials from the SAME snapshot the key was computed from (no stat->read TOCTOU).
|
|
"""
|
|
if not resolved_path:
|
|
return None, ("__adc__",)
|
|
try:
|
|
with open(resolved_path, "rb") as fh:
|
|
raw = fh.read()
|
|
except OSError:
|
|
return None, (resolved_path,)
|
|
return raw, (resolved_path, hashlib.sha256(raw).hexdigest())
|
|
|
|
|
|
def _load_credentials(resolved_path: Optional[str], sa_raw: Optional[bytes]) -> Optional[Tuple[Any, Optional[str]]]:
|
|
"""Build (credentials, project_id) for a cache miss; None when ADC must be refused."""
|
|
if resolved_path:
|
|
if sa_raw is not None:
|
|
creds = service_account.Credentials.from_service_account_info(json.loads(sa_raw), scopes=_CLOUD_PLATFORM_SCOPES)
|
|
else:
|
|
# Unreadable at key time: let the SDK try the file directly.
|
|
creds = service_account.Credentials.from_service_account_file(resolved_path, scopes=_CLOUD_PLATFORM_SCOPES)
|
|
return creds, creds.project_id
|
|
# google.auth.default() reads GOOGLE_APPLICATION_CREDENTIALS from os.environ (set by whichever
|
|
# profile loaded first); this profile doesn't define it, so refuse a stranger's identity.
|
|
if is_multiplex_active() and os.environ.get("GOOGLE_APPLICATION_CREDENTIALS"):
|
|
logger.warning(
|
|
"Vertex ADC skipped for this profile: GOOGLE_APPLICATION_CREDENTIALS is set in the process environment "
|
|
"(from another profile's .env) but not in this profile's own config. Set VERTEX_CREDENTIALS_PATH in this "
|
|
"profile's .env instead of relying on ADC."
|
|
)
|
|
return None
|
|
return google.auth.default(scopes=_CLOUD_PLATFORM_SCOPES)
|
|
|
|
|
|
def _needs_refresh(creds) -> bool:
|
|
"""No token, expired, or within 5 minutes of expiry."""
|
|
return (
|
|
not getattr(creds, "token", None)
|
|
or getattr(creds, "expired", False)
|
|
or (getattr(creds, "expiry", None) is not None and (creds.expiry.timestamp() - time.time()) < 300)
|
|
)
|
|
|
|
|
|
def get_vertex_credentials(credentials_path: Optional[str] = None) -> Tuple[Optional[str], Optional[str]]:
|
|
"""Return (fresh access_token, project_id) or (None, None); Credentials cached per file content."""
|
|
if google is None:
|
|
logger.warning("google-auth package not installed. Cannot use Vertex AI.")
|
|
return None, None
|
|
|
|
resolved_path = _resolve_credentials_path(credentials_path)
|
|
# One read serves both the cache key and credential construction (creds always match the fingerprint).
|
|
sa_raw, cache_key = _sa_snapshot(resolved_path)
|
|
|
|
try:
|
|
cached = _creds_cache.get(cache_key)
|
|
if cached is None:
|
|
cached = _load_credentials(resolved_path, sa_raw)
|
|
if cached is None:
|
|
return None, None
|
|
_creds_cache[cache_key] = cached
|
|
# A rotation leaves the old signature's entry behind; keep at most
|
|
# one Credentials per file so stale identities can't be reused.
|
|
for k in [k for k in _creds_cache if k != cache_key and k[0] == cache_key[0]]:
|
|
_creds_cache.pop(k, None)
|
|
creds, project_id = cached
|
|
if _needs_refresh(creds):
|
|
creds.refresh(google.auth.transport.requests.Request())
|
|
return creds.token, _resolve_project_override() or project_id
|
|
except Exception as e:
|
|
logger.error(f"Failed to resolve Vertex AI credentials: {e}")
|
|
_creds_cache.pop(cache_key, None)
|
|
# If ADC failed (e.g. expired refresh token), try the SA file before giving
|
|
# up — it may have been added after startup. Keyed on this attempt being ADC.
|
|
sa_path = None if resolved_path else _resolve_credentials_path(credentials_path)
|
|
if sa_path:
|
|
logger.info("ADC failed, retrying with service account: %s", sa_path)
|
|
return get_vertex_credentials(sa_path)
|
|
return None, None
|
|
|
|
|
|
def build_vertex_base_url(project_id: str, region: str = DEFAULT_REGION) -> str:
|
|
"""OpenAI-compatible Vertex base URL; ``global`` uses the bare host (Gemini 3.x preview is global-only)."""
|
|
host = "aiplatform.googleapis.com" if region == "global" else f"{region}-aiplatform.googleapis.com"
|
|
return f"https://{host}/v1beta1/projects/{project_id}/locations/{region}/endpoints/openapi"
|
|
|
|
|
|
def get_vertex_config(
|
|
credentials_path: Optional[str] = None, region: Optional[str] = None
|
|
) -> Tuple[Optional[str], Optional[str]]:
|
|
"""Resolve (access_token, base_url) for Vertex AI, or (None, None) on failure."""
|
|
token, project_id = get_vertex_credentials(credentials_path)
|
|
if not token or not project_id:
|
|
return None, None
|
|
return token, build_vertex_base_url(project_id, _resolve_region(region))
|
|
|
|
|
|
def has_vertex_credentials() -> bool:
|
|
"""Fast check (no network): a resolvable SA JSON path, or an explicit project ID (implies ADC)."""
|
|
return bool(_resolve_credentials_path(None) or _resolve_project_override())
|
|
|
|
|
|
def has_explicit_vertex_config() -> bool:
|
|
"""True only when the user deliberately pointed Hermes at Vertex.
|
|
|
|
Stricter than :func:`has_vertex_credentials`: an ambient ``GOOGLE_APPLICATION_CREDENTIALS``
|
|
must NOT gate the model picker open (unknowing spend). Only Hermes-scoped signals count.
|
|
"""
|
|
if _resolve_project_override():
|
|
return True
|
|
sa_path = _get_secret("VERTEX_CREDENTIALS_PATH")
|
|
return bool(sa_path and os.path.isfile(sa_path) and os.access(sa_path, os.R_OK))
|