obsidian-mcp-server 1.5.8 → 2.0.2

package/dist/mcp-server/transports/authentication/authContext.js

@@ -0,0 +1,24 @@
+/**
+ * @fileoverview Defines the AsyncLocalStorage context for authentication information.
+ * This module provides a mechanism to store and retrieve authentication details
+ * (like scopes and client ID) across asynchronous operations, making it available
+ * from the middleware layer down to the tool and resource handlers without
+ * drilling props.
+ *
+ * @module src/mcp-server/transports/authentication/authContext
+ */
+import { AsyncLocalStorage } from "async_hooks";
+/**
+ * An instance of AsyncLocalStorage to hold the authentication context (`AuthStore`).
+ * This allows `authInfo` to be accessible throughout the async call chain of a request
+ * after being set in the authentication middleware.
+ *
+ * @example
+ * // In middleware:
+ * await authContext.run({ authInfo }, next);
+ *
+ * // In a deeper handler:
+ * const store = authContext.getStore();
+ * const scopes = store?.authInfo.scopes;
+ */
+export const authContext = new AsyncLocalStorage();

package/dist/mcp-server/transports/authentication/authMiddleware.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @fileoverview MCP Authentication Middleware for Bearer Token Validation (JWT) for Hono.
+ *
+ * This middleware validates JSON Web Tokens (JWT) passed via the 'Authorization' header
+ * using the 'Bearer' scheme (e.g., "Authorization: Bearer <your_token>").
+ * It verifies the token's signature and expiration using the secret key defined
+ * in the configuration (`config.mcpAuthSecretKey`).
+ *
+ * If the token is valid, an object conforming to the MCP SDK's `AuthInfo` type
+ * is attached to `c.env.incoming.auth`. This direct attachment to the raw Node.js
+ * request object is for compatibility with the underlying SDK transport, which is
+ * not Hono-context-aware.
+ * If the token is missing, invalid, or expired, it returns an HTTP 401 Unauthorized response.
+ *
+ * @see {@link https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/basic/authorization.mdx | MCP Authorization Specification}
+ * @module src/mcp-server/transports/authentication/authMiddleware
+ */
+import { HttpBindings } from "@hono/node-server";
+import { Context, Next } from "hono";
+/**
+ * Hono middleware for verifying JWT Bearer token authentication.
+ * It attaches authentication info to `c.env.incoming.auth` for SDK compatibility with the node server.
+ */
+export declare function mcpAuthMiddleware(c: Context<{
+    Bindings: HttpBindings;
+}>, next: Next): Promise<void | (Response & import("hono").TypedResponse<{
+    error: string;
+}, 500, "json">) | (Response & import("hono").TypedResponse<{
+    error: string;
+}, 401, "json">)>;

package/dist/mcp-server/transports/authentication/authMiddleware.js

@@ -0,0 +1,145 @@
+/**
+ * @fileoverview MCP Authentication Middleware for Bearer Token Validation (JWT) for Hono.
+ *
+ * This middleware validates JSON Web Tokens (JWT) passed via the 'Authorization' header
+ * using the 'Bearer' scheme (e.g., "Authorization: Bearer <your_token>").
+ * It verifies the token's signature and expiration using the secret key defined
+ * in the configuration (`config.mcpAuthSecretKey`).
+ *
+ * If the token is valid, an object conforming to the MCP SDK's `AuthInfo` type
+ * is attached to `c.env.incoming.auth`. This direct attachment to the raw Node.js
+ * request object is for compatibility with the underlying SDK transport, which is
+ * not Hono-context-aware.
+ * If the token is missing, invalid, or expired, it returns an HTTP 401 Unauthorized response.
+ *
+ * @see {@link https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/basic/authorization.mdx | MCP Authorization Specification}
+ * @module src/mcp-server/transports/authentication/authMiddleware
+ */
+import jwt from "jsonwebtoken";
+import { config, environment } from "../../../config/index.js";
+import { logger, requestContextService } from "../../../utils/index.js";
+import { authContext } from "./authContext.js";
+// Startup Validation: Validate secret key presence on module load.
+if (environment === "production" && !config.mcpAuthSecretKey) {
+    logger.fatal("CRITICAL: MCP_AUTH_SECRET_KEY is not set in production environment. Authentication cannot proceed securely.");
+    throw new Error("MCP_AUTH_SECRET_KEY must be set in production environment for JWT authentication.");
+}
+else if (!config.mcpAuthSecretKey) {
+    logger.warning("MCP_AUTH_SECRET_KEY is not set. Authentication middleware will bypass checks (DEVELOPMENT ONLY). This is insecure for production.");
+}
+/**
+ * Hono middleware for verifying JWT Bearer token authentication.
+ * It attaches authentication info to `c.env.incoming.auth` for SDK compatibility with the node server.
+ */
+export async function mcpAuthMiddleware(c, next) {
+    const context = requestContextService.createRequestContext({
+        operation: "mcpAuthMiddleware",
+        method: c.req.method,
+        path: c.req.path,
+    });
+    logger.debug("Running MCP Authentication Middleware (Bearer Token Validation)...", context);
+    const reqWithAuth = c.env.incoming;
+    // Development Mode Bypass
+    if (!config.mcpAuthSecretKey) {
+        if (environment !== "production") {
+            logger.warning("Bypassing JWT authentication: MCP_AUTH_SECRET_KEY is not set (DEVELOPMENT ONLY).", context);
+            reqWithAuth.auth = {
+                token: "dev-mode-placeholder-token",
+                clientId: "dev-client-id",
+                scopes: ["dev-scope"],
+            };
+            const authInfo = reqWithAuth.auth;
+            logger.debug("Dev mode auth object created.", {
+                ...context,
+                authDetails: authInfo,
+            });
+            return await authContext.run({ authInfo }, next);
+        }
+        else {
+            logger.error("FATAL: MCP_AUTH_SECRET_KEY is missing in production. Cannot bypass auth.", context);
+            return c.json({ error: "Server configuration error: Authentication key missing." }, 500);
+        }
+    }
+    const authHeader = c.req.header("Authorization");
+    if (!authHeader || !authHeader.startsWith("Bearer ")) {
+        logger.warning("Authentication failed: Missing or malformed Authorization header (Bearer scheme required).", context);
+        return c.json({
+            error: "Unauthorized: Missing or invalid authentication token format.",
+        }, 401);
+    }
+    const tokenParts = authHeader.split(" ");
+    if (tokenParts.length !== 2 || tokenParts[0] !== "Bearer" || !tokenParts[1]) {
+        logger.warning("Authentication failed: Malformed Bearer token.", context);
+        return c.json({ error: "Unauthorized: Malformed authentication token." }, 401);
+    }
+    const rawToken = tokenParts[1];
+    try {
+        const decoded = jwt.verify(rawToken, config.mcpAuthSecretKey);
+        if (typeof decoded === "string") {
+            logger.warning("Authentication failed: JWT decoded to a string, expected an object payload.", context);
+            return c.json({ error: "Unauthorized: Invalid token payload format." }, 401);
+        }
+        const clientIdFromToken = typeof decoded.cid === "string"
+            ? decoded.cid
+            : typeof decoded.client_id === "string"
+                ? decoded.client_id
+                : undefined;
+        if (!clientIdFromToken) {
+            logger.warning("Authentication failed: JWT 'cid' or 'client_id' claim is missing or not a string.", { ...context, jwtPayloadKeys: Object.keys(decoded) });
+            return c.json({ error: "Unauthorized: Invalid token, missing client identifier." }, 401);
+        }
+        let scopesFromToken = [];
+        if (Array.isArray(decoded.scp) &&
+            decoded.scp.every((s) => typeof s === "string")) {
+            scopesFromToken = decoded.scp;
+        }
+        else if (typeof decoded.scope === "string" &&
+            decoded.scope.trim() !== "") {
+            scopesFromToken = decoded.scope.split(" ").filter((s) => s);
+            if (scopesFromToken.length === 0 && decoded.scope.trim() !== "") {
+                scopesFromToken = [decoded.scope.trim()];
+            }
+        }
+        if (scopesFromToken.length === 0) {
+            logger.warning("Authentication failed: Token resulted in an empty scope array, and scopes are required.", { ...context, jwtPayloadKeys: Object.keys(decoded) });
+            return c.json({ error: "Unauthorized: Token must contain valid, non-empty scopes." }, 401);
+        }
+        reqWithAuth.auth = {
+            token: rawToken,
+            clientId: clientIdFromToken,
+            scopes: scopesFromToken,
+        };
+        const subClaimForLogging = typeof decoded.sub === "string" ? decoded.sub : undefined;
+        const authInfo = reqWithAuth.auth;
+        logger.debug("JWT verified successfully. AuthInfo attached to request.", {
+            ...context,
+            mcpSessionIdContext: subClaimForLogging,
+            clientId: authInfo.clientId,
+            scopes: authInfo.scopes,
+        });
+        await authContext.run({ authInfo }, next);
+    }
+    catch (error) {
+        let errorMessage = "Invalid token";
+        if (error instanceof jwt.TokenExpiredError) {
+            errorMessage = "Token expired";
+            logger.warning("Authentication failed: Token expired.", {
+                ...context,
+                expiredAt: error.expiredAt,
+            });
+        }
+        else if (error instanceof jwt.JsonWebTokenError) {
+            errorMessage = `Invalid token: ${error.message}`;
+            logger.warning(`Authentication failed: ${errorMessage}`, { ...context });
+        }
+        else if (error instanceof Error) {
+            errorMessage = `Verification error: ${error.message}`;
+            logger.error("Authentication failed: Unexpected error during token verification.", { ...context, error: error.message });
+        }
+        else {
+            errorMessage = "Unknown verification error";
+            logger.error("Authentication failed: Unexpected non-error exception during token verification.", { ...context, error });
+        }
+        return c.json({ error: `Unauthorized: ${errorMessage}.` }, 401);
+    }
+}

package/dist/mcp-server/transports/authentication/authUtils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @fileoverview Provides utility functions for authorization, specifically for
+ * checking token scopes against required permissions for a given operation.
+ * @module src/mcp-server/transports/authentication/authUtils
+ */
+/**
+ * Checks if the current authentication context contains all the specified scopes.
+ * This function is designed to be called within tool or resource handlers to
+ * enforce scope-based access control. It retrieves the authentication information
+ * from `authContext` (AsyncLocalStorage).
+ *
+ * @param requiredScopes - An array of scope strings that are mandatory for the operation.
+ * @throws {McpError} Throws an error with `BaseErrorCode.INTERNAL_ERROR` if the
+ *   authentication context is missing, which indicates a server configuration issue.
+ * @throws {McpError} Throws an error with `BaseErrorCode.FORBIDDEN` if one or
+ *   more required scopes are not present in the validated token.
+ */
+export declare function withRequiredScopes(requiredScopes: string[]): void;

package/dist/mcp-server/transports/authentication/authUtils.js

@@ -0,0 +1,45 @@
+/**
+ * @fileoverview Provides utility functions for authorization, specifically for
+ * checking token scopes against required permissions for a given operation.
+ * @module src/mcp-server/transports/authentication/authUtils
+ */
+import { BaseErrorCode, McpError } from "../../../types-global/errors.js";
+import { logger, requestContextService } from "../../../utils/index.js";
+import { authContext } from "./authContext.js";
+/**
+ * Checks if the current authentication context contains all the specified scopes.
+ * This function is designed to be called within tool or resource handlers to
+ * enforce scope-based access control. It retrieves the authentication information
+ * from `authContext` (AsyncLocalStorage).
+ *
+ * @param requiredScopes - An array of scope strings that are mandatory for the operation.
+ * @throws {McpError} Throws an error with `BaseErrorCode.INTERNAL_ERROR` if the
+ *   authentication context is missing, which indicates a server configuration issue.
+ * @throws {McpError} Throws an error with `BaseErrorCode.FORBIDDEN` if one or
+ *   more required scopes are not present in the validated token.
+ */
+export function withRequiredScopes(requiredScopes) {
+    const store = authContext.getStore();
+    if (!store || !store.authInfo) {
+        // This is a server-side logic error; the auth middleware should always populate this.
+        throw new McpError(BaseErrorCode.INTERNAL_ERROR, "Authentication context is missing. This indicates a server configuration error.", requestContextService.createRequestContext({
+            operation: "withRequiredScopesCheck",
+            error: "AuthStore not found in AsyncLocalStorage.",
+        }));
+    }
+    const { scopes: grantedScopes, clientId } = store.authInfo;
+    const grantedScopeSet = new Set(grantedScopes);
+    const missingScopes = requiredScopes.filter((scope) => !grantedScopeSet.has(scope));
+    if (missingScopes.length > 0) {
+        const context = requestContextService.createRequestContext({
+            operation: "withRequiredScopesCheck",
+            required: requiredScopes,
+            granted: grantedScopes,
+            missing: missingScopes,
+            clientId: clientId,
+            subject: store.authInfo.subject,
+        });
+        logger.warning("Authorization failed: Missing required scopes.", context);
+        throw new McpError(BaseErrorCode.FORBIDDEN, `Insufficient permissions. Missing required scopes: ${missingScopes.join(", ")}`, { requiredScopes, missingScopes });
+    }
+}

package/dist/mcp-server/transports/authentication/oauthMiddleware.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @fileoverview Hono middleware for OAuth 2.1 Bearer Token validation.
+ * This middleware extracts a JWT from the Authorization header, validates it against
+ * a remote JWKS (JSON Web Key Set), and checks its issuer and audience claims.
+ * On success, it populates an AuthInfo object and stores it in an AsyncLocalStorage
+ * context for use in downstream handlers.
+ *
+ * @module src/mcp-server/transports/authentication/oauthMiddleware
+ */
+import { HttpBindings } from "@hono/node-server";
+import { Context, Next } from "hono";
+/**
+ * Hono middleware for verifying OAuth 2.1 JWT Bearer tokens.
+ * It validates the token and uses AsyncLocalStorage to pass auth info.
+ * @param c - The Hono context object.
+ * @param next - The function to call to proceed to the next middleware.
+ */
+export declare function oauthMiddleware(c: Context<{
+    Bindings: HttpBindings;
+}>, next: Next): Promise<(Response & import("hono").TypedResponse<{
+    error: string;
+}, 500, "json">) | (Response & import("hono").TypedResponse<{
+    error: string;
+}, 401, "json">) | undefined>;

package/dist/mcp-server/transports/authentication/oauthMiddleware.js

@@ -0,0 +1,109 @@
+/**
+ * @fileoverview Hono middleware for OAuth 2.1 Bearer Token validation.
+ * This middleware extracts a JWT from the Authorization header, validates it against
+ * a remote JWKS (JSON Web Key Set), and checks its issuer and audience claims.
+ * On success, it populates an AuthInfo object and stores it in an AsyncLocalStorage
+ * context for use in downstream handlers.
+ *
+ * @module src/mcp-server/transports/authentication/oauthMiddleware
+ */
+import { createRemoteJWKSet, jwtVerify } from "jose";
+import { config } from "../../../config/index.js";
+import { BaseErrorCode, McpError } from "../../../types-global/errors.js";
+import { ErrorHandler } from "../../../utils/internal/errorHandler.js";
+import { logger, requestContextService } from "../../../utils/index.js";
+import { authContext } from "./authContext.js";
+// --- Startup Validation ---
+// Ensures that necessary OAuth configuration is present when the mode is 'oauth'.
+if (config.mcpAuthMode === "oauth") {
+    if (!config.oauthIssuerUrl) {
+        throw new Error("OAUTH_ISSUER_URL must be set when MCP_AUTH_MODE is 'oauth'");
+    }
+    if (!config.oauthAudience) {
+        throw new Error("OAUTH_AUDIENCE must be set when MCP_AUTH_MODE is 'oauth'");
+    }
+    logger.info("OAuth 2.1 mode enabled. Verifying tokens against issuer.", requestContextService.createRequestContext({
+        issuer: config.oauthIssuerUrl,
+        audience: config.oauthAudience,
+    }));
+}
+// --- JWKS Client Initialization ---
+// The remote JWK set is fetched and cached to avoid network calls on every request.
+let jwks;
+if (config.mcpAuthMode === "oauth" && config.oauthIssuerUrl) {
+    try {
+        const jwksUrl = new URL(config.oauthJwksUri ||
+            `${config.oauthIssuerUrl.replace(/\/$/, "")}/.well-known/jwks.json`);
+        jwks = createRemoteJWKSet(jwksUrl, {
+            cooldownDuration: 300000, // 5 minutes
+            timeoutDuration: 5000, // 5 seconds
+        });
+        logger.info(`JWKS client initialized for URL: ${jwksUrl.href}`, requestContextService.createRequestContext({
+            operation: "oauthMiddlewareSetup",
+        }));
+    }
+    catch (error) {
+        logger.fatal("Failed to initialize JWKS client.", error, requestContextService.createRequestContext({
+            operation: "oauthMiddlewareSetup",
+        }));
+        // Prevent server from starting if JWKS setup fails in oauth mode
+        process.exit(1);
+    }
+}
+/**
+ * Hono middleware for verifying OAuth 2.1 JWT Bearer tokens.
+ * It validates the token and uses AsyncLocalStorage to pass auth info.
+ * @param c - The Hono context object.
+ * @param next - The function to call to proceed to the next middleware.
+ */
+export async function oauthMiddleware(c, next) {
+    const context = requestContextService.createRequestContext({
+        operation: "oauthMiddleware",
+        httpMethod: c.req.method,
+        httpPath: c.req.path,
+    });
+    if (!jwks) {
+        // This should not happen if startup validation is correct, but it's a safeguard.
+        const error = new McpError(BaseErrorCode.CONFIGURATION_ERROR, "OAuth middleware is active, but JWKS client is not initialized.", context);
+        ErrorHandler.handleError(error, { operation: "oauthMiddleware", context });
+        return c.json({ error: "Server configuration error." }, 500);
+    }
+    const authHeader = c.req.header("Authorization");
+    if (!authHeader || !authHeader.startsWith("Bearer ")) {
+        return c.json({ error: "Unauthorized: Missing or invalid token format." }, 401);
+    }
+    const token = authHeader.substring(7);
+    try {
+        const { payload } = await jwtVerify(token, jwks, {
+            issuer: config.oauthIssuerUrl,
+            audience: config.oauthAudience,
+        });
+        // The 'scope' claim is typically a space-delimited string in OAuth 2.1.
+        const scopes = typeof payload.scope === "string" ? payload.scope.split(" ") : [];
+        const clientId = typeof payload.client_id === "string" ? payload.client_id : undefined;
+        if (!clientId) {
+            logger.warning("Authentication failed: OAuth token 'client_id' claim is missing or not a string.", { ...context, jwtPayloadKeys: Object.keys(payload) });
+            return c.json({ error: "Unauthorized: Invalid token, missing client identifier." }, 401);
+        }
+        const authInfo = {
+            token,
+            clientId,
+            scopes,
+            subject: typeof payload.sub === "string" ? payload.sub : undefined,
+        };
+        // Attach to the raw request for potential legacy compatibility and
+        // store in AsyncLocalStorage for modern, safe access in handlers.
+        c.env.incoming.auth = authInfo;
+        await authContext.run({ authInfo }, next);
+    }
+    catch (error) {
+        logger.warning("OAuth token validation failed", {
+            ...context,
+            errorName: error.name,
+            errorMessage: error.message,
+        });
+        // The `jose` library provides specific error codes like 'ERR_JWT_EXPIRED' or 'ERR_JWS_INVALID'
+        const message = `Unauthorized: ${error.message || "Invalid token"}`;
+        return c.json({ error: message }, 401);
+    }
+}

package/dist/mcp-server/transports/authentication/types.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @fileoverview Shared types for authentication middleware.
+ * @module src/mcp-server/transports/authentication/types
+ */
+import type { AuthInfo as SdkAuthInfo } from "@modelcontextprotocol/sdk/server/auth/types.js";
+/**
+ * Defines the structure for authentication information derived from a token.
+ * It extends the base SDK type to include common optional claims.
+ */
+export type AuthInfo = SdkAuthInfo & {
+    subject?: string;
+};
+declare module "http" {
+    interface IncomingMessage {
+        auth?: AuthInfo;
+    }
+}

package/dist/mcp-server/transports/authentication/types.js

@@ -0,0 +1,5 @@
+/**
+ * @fileoverview Shared types for authentication middleware.
+ * @module src/mcp-server/transports/authentication/types
+ */
+export {};

package/dist/mcp-server/transports/httpTransport.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @fileoverview Handles the setup and management of the Streamable HTTP MCP transport using Hono.
+ * Implements the MCP Specification 2025-03-26 for Streamable HTTP.
+ * This includes creating a Hono server, configuring middleware (CORS, Authentication),
+ * defining request routing for the single MCP endpoint (POST/GET/DELETE),
+ * managing server-side sessions, handling Server-Sent Events (SSE) for streaming,
+ * and binding to a network port with retry logic for port conflicts.
+ *
+ * Specification Reference:
+ * https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/basic/transports.mdx#streamable-http
+ * @module src/mcp-server/transports/httpTransport
+ */
+import { ServerType } from "@hono/node-server";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { RequestContext } from "../../utils/index.js";
+/**
+ * Sets up and starts the Streamable HTTP transport layer for the MCP server.
+ *
+ * @param createServerInstanceFn - An asynchronous factory function that returns a new `McpServer` instance.
+ * @param parentContext - Logging context from the main server startup process.
+ * @returns A promise that resolves with the Node.js `http.Server` instance when the HTTP server is successfully listening.
+ * @throws {Error} If the server fails to start after all port retries.
+ */
+export declare function startHttpTransport(createServerInstanceFn: () => Promise<McpServer>, parentContext: RequestContext): Promise<ServerType>;