Skip to content

OpenRAG is a comprehensive, single package Retrieval-Augmented Generation platform built on Langflow, Docling, and Opensearch.

Python

removed ibm secrets manager, environment variables and tests

Lucas Oliveira8a7cebbba3e4
diff --git a/pyproject.toml b/pyproject.toml
index a11f27f0a..047c16099 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -42,7 +42,6 @@ dependencies = [
"textual-fspicker>=0.6.0",
"structlog>=25.4.0",
"zxcvbn>=4.5.0",
- "ibm-secrets-manager-sdk>=2.1.19",
"openai>=1.0.0",
"pyyaml>=6.0",
"tiktoken>=0.7.0",
diff --git a/src/utils/encryption.py b/src/utils/encryption.py
index 6c43513f1..9825e194e 100644
--- a/src/utils/encryption.py
+++ b/src/utils/encryption.py
@@ -19,66 +19,18 @@ KDF_ITERATIONS = 100000
_cached_master_secret: Optional[str] = None
def get_master_secret() -> str | None:
- """Retrieve the master secret string from IBM Secrets Manager or local environment."""
+ """Retrieve the master secret string from local environment."""
global _cached_master_secret
if _cached_master_secret is not None:
return _cached_master_secret
- secret_str = None
- ibm_auth_enabled = os.environ.get("IBM_AUTH_ENABLED", "false").lower() in ("true", "1", "yes")
-
- if ibm_auth_enabled:
- ibm_api_key = os.environ.get("IBM_CLOUD_API_KEY")
- ibm_secret_id = os.environ.get("IBM_SECRETS_MANAGER_SECRET_ID")
-
- trusted_profile_id = os.environ.get("IBM_CLOUD_TRUSTED_PROFILE_ID")
- instance_id = os.environ.get("SECRET_MANAGER_INSTANCE_ID")
- region = os.environ.get("SECRET_MANAGER_REGION", "us-south")
- cr_token_file = os.environ.get("IBM_CLOUD_CR_TOKEN_FILE", "/var/run/secrets/tokens/sa-token")
-
- if instance_id and ibm_secret_id:
- try:
- from ibm_secrets_manager_sdk.secrets_manager_v2 import SecretsManagerV2
-
- authenticator = None
- if ibm_api_key:
- from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
- authenticator = IAMAuthenticator(ibm_api_key)
- elif trusted_profile_id:
- from ibm_cloud_sdk_core.authenticators import ContainerAuthenticator
- authenticator = ContainerAuthenticator(
- cr_token_filename=cr_token_file,
- iam_profile_id=trusted_profile_id
- )
- else:
- raise ValueError("Neither IBM_CLOUD_API_KEY nor IBM_CLOUD_TRUSTED_PROFILE_ID provided")
-
- secrets_manager = SecretsManagerV2(authenticator=authenticator)
- secrets_manager.set_service_url(f"https://{instance_id}.{region}.secrets-manager.appdomain.cloud")
-
- # Retrieve the secret
- response = secrets_manager.get_secret(id=ibm_secret_id).get_result()
-
- secret_data = response.get("secret_data")
- if not secret_data and "resources" in response and len(response["resources"]) > 0:
- secret_data = response["resources"][0].get("secret_data")
-
- if secret_data and "payload" in secret_data:
- secret_str = secret_data["payload"]
- logger.debug("Successfully retrieved master secret from IBM Secrets Manager.")
- else:
- logger.warning("IBM Secrets Manager: 'payload' not found in secret_data.")
- except Exception as e:
- logger.warning(f"Failed to retrieve encryption key from IBM Secrets Manager: {e}. Falling back to OPENRAG_ENCRYPTION_KEY.")
-
- if not secret_str:
- secret_str = os.environ.get("OPENRAG_ENCRYPTION_KEY")
+ secret_str = os.environ.get("OPENRAG_ENCRYPTION_KEY")
if not secret_str:
if os.environ.get("OPENRAG_ENFORCE_PREREQUISITES", "false").lower() in ("true", "1", "yes"):
raise RuntimeError(
"CRITICAL: OPENRAG_ENFORCE_PREREQUISITES is enabled but no master encryption key "
- "could be retrieved from IBM Secrets Manager or OPENRAG_ENCRYPTION_KEY. "
+ "could be retrieved from OPENRAG_ENCRYPTION_KEY. "
"Application will not start in unencrypted mode."
)
return None
diff --git a/tests/unit/test_ibm_encryption.py b/tests/unit/test_ibm_encryption.py
deleted file mode 100644
index 906118e24..000000000
--- a/tests/unit/test_ibm_encryption.py
+++ /dev/null
@@ -1,59 +0,0 @@
-import base64
-
-import pytest
-
-from utils import encryption
-
-def run_env(monkeypatch):
- monkeypatch.setenv("OPENRAG_ENCRYPTION_KEY", base64.b64encode(b"B" * 32).decode("ascii"))
- monkeypatch.delenv("IBM_CLOUD_API_KEY", raising=False)
- monkeypatch.delenv("IBM_CLOUD_TRUSTED_PROFILE_ID", raising=False)
- monkeypatch.setattr(encryption, "_cached_master_secret", None)
- return monkeypatch
-
-def test_fallback_when_credentials_missing(run_env):
- # No IBM keys set here
- key = encryption.get_master_secret()
- assert key == base64.b64encode(b"B" * 32).decode("ascii")
- print("Fallback with missing IBM creds successful")
-
-def test_cache_mechanism(run_env):
- k1 = encryption.get_master_secret()
- assert encryption._cached_master_secret is not None
-
- # Remove local env ensuring it hits cache
- run_env.delenv("OPENRAG_ENCRYPTION_KEY", raising=False)
- k2 = encryption.get_master_secret()
- assert k2 == k1
- print("Caching optimization successful")
-
-def test_ibm_exception_handling(run_env):
- run_env.setenv("IBM_AUTH_ENABLED", "true")
- run_env.setenv("IBM_CLOUD_API_KEY", "fake")
- run_env.setenv("SECRET_MANAGER_INSTANCE_ID", "fake")
- run_env.setenv("IBM_SECRETS_MANAGER_SECRET_ID", "fake")
- run_env.setenv("OPENRAG_ENCRYPTION_KEY", base64.b64encode(b"C" * 32).decode("ascii"))
-
- from unittest.mock import patch
- with patch("ibm_secrets_manager_sdk.secrets_manager_v2.SecretsManagerV2", side_effect=ValueError("Simulating SDK crash")):
- key = encryption.get_master_secret()
- assert key == base64.b64encode(b"C" * 32).decode("ascii")
- print("IBM SDK exception intercept successful")
-
-def test_trusted_profiles_fallback(run_env):
- run_env.delenv("IBM_CLOUD_API_KEY", raising=False)
-
- run_env.setenv("IBM_AUTH_ENABLED", "true")
- run_env.setenv("SECRET_MANAGER_INSTANCE_ID", "fake")
- run_env.setenv("IBM_SECRETS_MANAGER_SECRET_ID", "fake")
- run_env.setenv("IBM_CLOUD_TRUSTED_PROFILE_ID", "my-profile")
- run_env.setenv("SECRET_MANAGER_REGION", "us-east")
- run_env.setenv("OPENRAG_ENCRYPTION_KEY", base64.b64encode(b"D" * 32).decode("ascii"))
-
- from unittest.mock import patch
- with patch("ibm_secrets_manager_sdk.secrets_manager_v2.SecretsManagerV2", side_effect=ValueError("Simulating SDK crash")):
- key = encryption.get_master_secret()
- assert key == base64.b64encode(b"D" * 32).decode("ascii")
- print("Trusted Profile exception intercept successful")
-
diff --git a/uv.lock b/uv.lock
index 96bd0e129..469a857be 100644
--- a/uv.lock
+++ b/uv.lock
@@ -682,21 +682,6 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/2a/39/e50c7c3a983047577ee07d2a9e53faf5a69493943ec3f6a384bdc792deb2/httpx-0.28.1-py3-none-any.whl", hash = "sha256:d909fcccc110f8c7faf814ca82a9a4d816bc5a6dbfea25d6591d6985b8ba59ad", size = 73517, upload-time = "2024-12-06T15:37:21.509Z" },
]
-[[package]]
-name = "ibm-cloud-sdk-core"
-version = "3.24.4"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
- { name = "pyjwt" },
- { name = "python-dateutil" },
- { name = "requests" },
- { name = "urllib3" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/4a/0c/965f4f4b34f1a9a2210bec224ac489c631153f18ef75c6e694750efda654/ibm_cloud_sdk_core-3.24.4.tar.gz", hash = "sha256:20498959ce0177a58938e1855ee09f08b9712e43cc3209e95010c046e8c6d2a6", size = 81778, upload-time = "2026-02-03T08:44:42.217Z" }
-wheels = [
- { url = "https://files.pythonhosted.org/packages/5e/8d/90cf967468fd81f9fd22bd42dbf3b1fbb1234485d1f81b6f17c8de138fff/ibm_cloud_sdk_core-3.24.4-py3-none-any.whl", hash = "sha256:4c3487ed5eb5180770ea2d07d95cfed1e69002ed249bbbc7d155226985c0b785", size = 75786, upload-time = "2026-02-03T08:44:41.094Z" },
-]
-
[[package]]
name = "ibm-cos-sdk"
version = "2.16.0"
@@ -729,21 +714,6 @@ dependencies = [
]
sdist = { url = "https://files.pythonhosted.org/packages/b3/6f/660a6e0b7015a512304487c17c4ac87c280180b0a6142ee196570efc221e/ibm_cos_sdk_s3transfer-2.16.0.tar.gz", hash = "sha256:5cca69c48dcb7a1442b39cadb3a635162fbc2cf002820c8cd6cb170056d27c5c", size = 141138, upload-time = "2026-01-06T10:30:06.375Z" }
-[[package]]
-name = "ibm-secrets-manager-sdk"
-version = "2.1.19"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
- { name = "ibm-cloud-sdk-core" },
- { name = "python-dateutil" },
- { name = "requests" },
- { name = "urllib3" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/21/67/7427f602cf32fb5eeff72ab5d05b8805235ef16b0c49ea92e65c3470534a/ibm_secrets_manager_sdk-2.1.19.tar.gz", hash = "sha256:8f945c3ec2245aced6956510c891355b6f28ef4f1c84c1aea2ec138d08b8694d", size = 251807, upload-time = "2026-03-17T19:33:56.075Z" }
-wheels = [
- { url = "https://files.pythonhosted.org/packages/be/73/2ba3e270f1d095b5dfba7d2e32b125e70f842a4438f5bacf04d2c8d04a60/ibm_secrets_manager_sdk-2.1.19-py3-none-any.whl", hash = "sha256:82293fa1c7357b5fe203afc676db654a807696064c7ff5807f56044dd19f8e5a", size = 150219, upload-time = "2026-03-17T19:33:55.118Z" },
-]
-
[[package]]
name = "idna"
version = "3.11"
@@ -1009,7 +979,6 @@ dependencies = [
{ name = "google-auth-oauthlib" },
{ name = "httpx" },
{ name = "ibm-cos-sdk" },
- { name = "ibm-secrets-manager-sdk" },
{ name = "msal" },
{ name = "openai" },
{ name = "opensearch-py", extra = ["async"] },
@@ -1046,7 +1015,6 @@ requires-dist = [
{ name = "google-auth-oauthlib", specifier = ">=1.2.0" },
{ name = "httpx", specifier = ">=0.27.0" },
{ name = "ibm-cos-sdk", specifier = ">=2.13.0" },
- { name = "ibm-secrets-manager-sdk", specifier = ">=2.1.19" },
{ name = "msal", specifier = ">=1.29.0" },
{ name = "openai", specifier = ">=1.0.0" },
{ name = "opensearch-py", extras = ["async"], specifier = ">=3.0.0" },