Skip to content

Self-evolving Context Database for AI Agents. Unify Agent Memory, Knowledge RAG and Skills.

fix(crypto): 禁止重写 Vault root key on 临时 (503) read failures (#3423)

Zayn Jarvis0ea581574821
diff --git a/openviking/crypto/providers.py b/openviking/crypto/providers.py
index bbc7c1d0e..2b5be4a2c 100644
--- a/openviking/crypto/providers.py
+++ b/openviking/crypto/providers.py
@@ -415,6 +415,8 @@ class VaultProvider(BaseProvider):
client = await self._get_client()
import base64
+ from hvac.exceptions import InvalidPath
+
try:
# Try to read encrypted root key from Vault kv
if self.kv_version == 2:
@@ -423,27 +425,25 @@ class VaultProvider(BaseProvider):
path=self.encrypted_root_key_key,
mount_point=self.kv_mount_path,
)
- encrypted_root_key_b64 = response["data"]["data"]["encrypted_root_key"]
else:
response = await asyncio.to_thread(
client.secrets.kv.v1.read_secret,
path=self.encrypted_root_key_key,
mount_point=self.kv_mount_path,
)
- encrypted_root_key_b64 = response["data"]["encrypted_root_key"]
-
- encrypted_root_key = base64.b64decode(encrypted_root_key_b64)
- self._root_key = await self._decrypt_with_vault(encrypted_root_key)
- logger.info("Loaded existing root key from Vault")
- except Exception:
+ except InvalidPath:
# Generate new root key
import secrets
self._root_key = secrets.token_bytes(32)
- # Encrypt and store root key in Vault kv
- encrypted_root_key = await self._encrypt_with_vault(self._root_key)
+ # Encrypt and store root key in Vault kv. Any failure here (transit
+ # encrypt down, KV write outage) must clear the cached ephemeral key
+ # before raising: otherwise a retried get_root_key() hits the
+ # `self._root_key is not None` fast path and encrypts data with a key
+ # that was never persisted — the data-loss class this provider guards.
try:
+ encrypted_root_key = await self._encrypt_with_vault(self._root_key)
if self.kv_version == 2:
await asyncio.to_thread(
client.secrets.kv.v2.create_or_update_secret,
@@ -468,10 +468,20 @@ class VaultProvider(BaseProvider):
)
logger.info("Created and stored new root key in Vault")
except Exception as e:
+ self._root_key = None
raise ConfigError(
f"Failed to persist root key to Vault. "
f"Refusing to start with ephemeral key (data loss risk): {e}"
)
+ return self._root_key
+
+ if self.kv_version == 2:
+ encrypted_root_key_b64 = response["data"]["data"]["encrypted_root_key"]
+ else:
+ encrypted_root_key_b64 = response["data"]["encrypted_root_key"]
+ encrypted_root_key = base64.b64decode(encrypted_root_key_b64)
+ self._root_key = await self._decrypt_with_vault(encrypted_root_key)
+ logger.info("Loaded existing root key from Vault")
return self._root_key
diff --git a/tests/unit/crypto/test_providers_mock.py b/tests/unit/crypto/test_providers_mock.py
index 192489db1..13b3b5cb9 100644
--- a/tests/unit/crypto/test_providers_mock.py
+++ b/tests/unit/crypto/test_providers_mock.py
@@ -15,7 +15,9 @@ import base64
import os
import secrets
import struct
+import sys
import tempfile
+from types import ModuleType
from unittest.mock import AsyncMock, Mock, patch
import pytest
@@ -26,6 +28,7 @@ from openviking.crypto.providers import (
PROVIDER_LOCAL,
PROVIDER_VAULT,
PROVIDER_VOLCENGINE,
+ ConfigError,
LocalFileProvider,
VaultProvider,
VolcengineKMSProvider,
@@ -65,6 +68,20 @@ def vault_mock_provider():
yield provider
+def vault_invalid_path(monkeypatch):
+ class InvalidPath(Exception):
+ pass
+
+ hvac = ModuleType("hvac")
+ exceptions = ModuleType("hvac.exceptions")
+ exceptions.InvalidPath = InvalidPath
+ hvac.exceptions = exceptions
+ monkeypatch.setitem(sys.modules, "hvac", hvac)
+ monkeypatch.setitem(sys.modules, "hvac.exceptions", exceptions)
+ return InvalidPath
+
+
@pytest.fixture
def volcengine_mock_provider():
"""Create a VolcengineKMSProvider with mocked methods."""
@@ -198,6 +215,68 @@ class TestVaultProviderMock:
assert ciphertext.startswith(b"OVE1")
assert ciphertext[5] == PROVIDER_VAULT
+ @pytest.mark.asyncio
+ async def test_root_key_read_failure_never_creates(
+ self, vault_mock_provider, vault_invalid_path
+ ):
+ client = Mock()
+ client.secrets.kv.v1.read_secret.side_effect = RuntimeError("Vault unavailable")
+ vault_mock_provider._get_client = AsyncMock(return_value=client)
+
+ with pytest.raises(RuntimeError, match="Vault unavailable"):
+ await vault_mock_provider._get_or_create_root_key()
+
+ client.secrets.kv.v1.create_or_update_secret.assert_not_called()
+
+ @pytest.mark.asyncio
+ async def test_missing_root_key_is_created(self, vault_mock_provider, vault_invalid_path):
+ client = Mock()
+ client.secrets.kv.v1.read_secret.side_effect = vault_invalid_path()
+ vault_mock_provider._get_client = AsyncMock(return_value=client)
+ vault_mock_provider._encrypt_with_vault = AsyncMock(return_value=b"vault:ciphertext")
+
+ root_key = await vault_mock_provider._get_or_create_root_key()
+
+ assert len(root_key) == 32
+ client.secrets.kv.v1.create_or_update_secret.assert_called_once()
+
+ @pytest.mark.asyncio
+ async def test_persist_failure_clears_cache_and_retries(
+ self, vault_mock_provider, vault_invalid_path
+ ):
+ """A failed persist must not leave an unpersisted ephemeral key cached."""
+ client = Mock()
+ client.secrets.kv.v1.read_secret.side_effect = vault_invalid_path()
+ client.secrets.kv.v1.create_or_update_secret.side_effect = RuntimeError("write outage")
+ vault_mock_provider._get_client = AsyncMock(return_value=client)
+ vault_mock_provider._encrypt_with_vault = AsyncMock(return_value=b"vault:ciphertext")
+
+ with pytest.raises(ConfigError, match="data loss risk"):
+ await vault_mock_provider.get_root_key()
+
+ # Cache must be cleared so a retry re-reads Vault instead of returning
+ # via the get_root_key fast path a key that was never persisted.
+ assert vault_mock_provider._root_key is None
+ with pytest.raises(ConfigError, match="data loss risk"):
+ await vault_mock_provider.get_root_key()
+ assert client.secrets.kv.v1.read_secret.call_count == 2
+
+ @pytest.mark.asyncio
+ async def test_root_key_decrypt_failure_never_creates(
+ self, vault_mock_provider, vault_invalid_path
+ ):
+ client = Mock()
+ client.secrets.kv.v1.read_secret.return_value = {
+ "data": {"encrypted_root_key": base64.b64encode(b"vault:ciphertext").decode()}
+ }
+ vault_mock_provider._get_client = AsyncMock(return_value=client)
+ vault_mock_provider._decrypt_with_vault = AsyncMock(side_effect=RuntimeError("bad key"))
+
+ with pytest.raises(RuntimeError, match="bad key"):
+ await vault_mock_provider._get_or_create_root_key()
+
+ client.secrets.kv.v1.create_or_update_secret.assert_not_called()
+
class TestVolcengineKMSProviderMock:
"""Tests for VolcengineKMSProvider with mocked methods."""