mirror of
https://github.com/jmagar/unraid-mcp.git
synced 2026-03-23 12:39:24 -07:00
feat(oidc): add unraid_oidc tool with providers, provider, configuration, public_providers, validate_session
This commit is contained in:
66
tests/test_oidc.py
Normal file
66
tests/test_oidc.py
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
# tests/test_oidc.py
|
||||||
|
"""Tests for unraid_oidc tool."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from unittest.mock import AsyncMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from conftest import make_tool_fn
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def _mock_graphql():
|
||||||
|
with patch("unraid_mcp.tools.oidc.make_graphql_request", new_callable=AsyncMock) as m:
|
||||||
|
yield m
|
||||||
|
|
||||||
|
|
||||||
|
def _make_tool():
|
||||||
|
return make_tool_fn(
|
||||||
|
"unraid_mcp.tools.oidc",
|
||||||
|
"register_oidc_tool",
|
||||||
|
"unraid_oidc",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_providers_returns_list(_mock_graphql):
|
||||||
|
_mock_graphql.return_value = {
|
||||||
|
"oidcProviders": [
|
||||||
|
{"id": "1:local", "name": "Google", "clientId": "abc", "scopes": ["openid"]}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
result = await _make_tool()(action="providers")
|
||||||
|
assert result["success"] is True
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_public_providers(_mock_graphql):
|
||||||
|
_mock_graphql.return_value = {"publicOidcProviders": []}
|
||||||
|
result = await _make_tool()(action="public_providers")
|
||||||
|
assert result["success"] is True
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_provider_requires_provider_id(_mock_graphql):
|
||||||
|
from unraid_mcp.core.exceptions import ToolError
|
||||||
|
|
||||||
|
with pytest.raises(ToolError, match="provider_id"):
|
||||||
|
await _make_tool()(action="provider")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_validate_session_requires_token(_mock_graphql):
|
||||||
|
from unraid_mcp.core.exceptions import ToolError
|
||||||
|
|
||||||
|
with pytest.raises(ToolError, match="token"):
|
||||||
|
await _make_tool()(action="validate_session")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_configuration(_mock_graphql):
|
||||||
|
_mock_graphql.return_value = {
|
||||||
|
"oidcConfiguration": {"providers": [], "defaultAllowedOrigins": []}
|
||||||
|
}
|
||||||
|
result = await _make_tool()(action="configuration")
|
||||||
|
assert result["success"] is True
|
||||||
@@ -70,6 +70,7 @@ def register_all_modules() -> None:
|
|||||||
register_settings_tool,
|
register_settings_tool,
|
||||||
register_live_tool,
|
register_live_tool,
|
||||||
register_customization_tool,
|
register_customization_tool,
|
||||||
|
register_oidc_tool,
|
||||||
]
|
]
|
||||||
for registrar in registrars:
|
for registrar in registrars:
|
||||||
registrar(mcp)
|
registrar(mcp)
|
||||||
|
|||||||
117
unraid_mcp/tools/oidc.py
Normal file
117
unraid_mcp/tools/oidc.py
Normal file
@@ -0,0 +1,117 @@
|
|||||||
|
"""OIDC/SSO provider management and session validation.
|
||||||
|
|
||||||
|
Provides the `unraid_oidc` tool with 5 read-only actions for querying
|
||||||
|
OIDC provider configuration and validating sessions.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Any, Literal, get_args
|
||||||
|
|
||||||
|
from fastmcp import FastMCP
|
||||||
|
|
||||||
|
from ..config.logging import logger
|
||||||
|
from ..core.client import make_graphql_request
|
||||||
|
from ..core.exceptions import ToolError, tool_error_handler
|
||||||
|
|
||||||
|
|
||||||
|
QUERIES: dict[str, str] = {
|
||||||
|
"providers": """
|
||||||
|
query GetOidcProviders {
|
||||||
|
oidcProviders {
|
||||||
|
id name clientId issuer authorizationEndpoint tokenEndpoint jwksUri
|
||||||
|
scopes authorizationRules { claim operator value }
|
||||||
|
authorizationRuleMode buttonText buttonIcon buttonVariant buttonStyle
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""",
|
||||||
|
"provider": """
|
||||||
|
query GetOidcProvider($id: PrefixedID!) {
|
||||||
|
oidcProvider(id: $id) {
|
||||||
|
id name clientId issuer scopes
|
||||||
|
authorizationRules { claim operator value }
|
||||||
|
authorizationRuleMode buttonText buttonIcon
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""",
|
||||||
|
"configuration": """
|
||||||
|
query GetOidcConfiguration {
|
||||||
|
oidcConfiguration {
|
||||||
|
providers { id name clientId scopes }
|
||||||
|
defaultAllowedOrigins
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""",
|
||||||
|
"public_providers": """
|
||||||
|
query GetPublicOidcProviders {
|
||||||
|
publicOidcProviders { id name buttonText buttonIcon buttonVariant buttonStyle }
|
||||||
|
}
|
||||||
|
""",
|
||||||
|
"validate_session": """
|
||||||
|
query ValidateOidcSession($token: String!) {
|
||||||
|
validateOidcSession(token: $token) { valid username }
|
||||||
|
}
|
||||||
|
""",
|
||||||
|
}
|
||||||
|
|
||||||
|
ALL_ACTIONS = set(QUERIES)
|
||||||
|
|
||||||
|
OIDC_ACTIONS = Literal[
|
||||||
|
"configuration",
|
||||||
|
"provider",
|
||||||
|
"providers",
|
||||||
|
"public_providers",
|
||||||
|
"validate_session",
|
||||||
|
]
|
||||||
|
|
||||||
|
if set(get_args(OIDC_ACTIONS)) != ALL_ACTIONS:
|
||||||
|
_missing = ALL_ACTIONS - set(get_args(OIDC_ACTIONS))
|
||||||
|
_extra = set(get_args(OIDC_ACTIONS)) - ALL_ACTIONS
|
||||||
|
raise RuntimeError(
|
||||||
|
f"OIDC_ACTIONS and ALL_ACTIONS are out of sync. "
|
||||||
|
f"Missing: {_missing or 'none'}. Extra: {_extra or 'none'}"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def register_oidc_tool(mcp: FastMCP) -> None:
|
||||||
|
"""Register the unraid_oidc tool with the FastMCP instance."""
|
||||||
|
|
||||||
|
@mcp.tool()
|
||||||
|
async def unraid_oidc(
|
||||||
|
action: OIDC_ACTIONS,
|
||||||
|
provider_id: str | None = None,
|
||||||
|
token: str | None = None,
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Query Unraid OIDC/SSO provider configuration and validate sessions.
|
||||||
|
|
||||||
|
Actions:
|
||||||
|
providers - List all configured OIDC providers (admin only)
|
||||||
|
provider - Get a specific OIDC provider by ID (requires provider_id)
|
||||||
|
configuration - Get full OIDC configuration including default origins (admin only)
|
||||||
|
public_providers - Get public OIDC provider info for login buttons (no auth)
|
||||||
|
validate_session - Validate an OIDC session token (requires token)
|
||||||
|
"""
|
||||||
|
if action not in ALL_ACTIONS:
|
||||||
|
raise ToolError(f"Invalid action '{action}'. Must be one of: {sorted(ALL_ACTIONS)}")
|
||||||
|
|
||||||
|
if action == "provider" and not provider_id:
|
||||||
|
raise ToolError("provider_id is required for 'provider' action")
|
||||||
|
|
||||||
|
if action == "validate_session" and not token:
|
||||||
|
raise ToolError("token is required for 'validate_session' action")
|
||||||
|
|
||||||
|
with tool_error_handler("oidc", action, logger):
|
||||||
|
logger.info(f"Executing unraid_oidc action={action}")
|
||||||
|
|
||||||
|
if action == "provider":
|
||||||
|
data = await make_graphql_request(QUERIES[action], {"id": provider_id})
|
||||||
|
return {"success": True, "action": action, "data": data}
|
||||||
|
|
||||||
|
if action == "validate_session":
|
||||||
|
data = await make_graphql_request(QUERIES[action], {"token": token})
|
||||||
|
return {"success": True, "action": action, "data": data}
|
||||||
|
|
||||||
|
data = await make_graphql_request(QUERIES[action])
|
||||||
|
return {"success": True, "action": action, "data": data}
|
||||||
|
|
||||||
|
logger.info("OIDC tool registered successfully")
|
||||||
Reference in New Issue
Block a user