🪐 feat: MCP OAuth 2.0 Discovery Support (#7924)
* chore: Update @modelcontextprotocol/sdk to version 1.12.3 in package.json and package-lock.json
- Bump version of @modelcontextprotocol/sdk to 1.12.3 to incorporate recent updates.
- Update dependencies for ajv and cross-spawn to their latest versions.
- Add ajv as a new dependency in the sdk module.
- Include json-schema-traverse as a new dependency in the sdk module.
* feat: @librechat/auth
* feat: Add crypto module exports to auth package
- Introduced a new crypto module by creating index.ts in the crypto directory.
- Updated the main index.ts of the auth package to export from the new crypto module.
* feat: Update package dependencies and build scripts for auth package
- Added @librechat/auth as a dependency in package.json and package-lock.json.
- Updated build scripts to include the auth package in both frontend and bun build processes.
- Removed unused mongoose and openid-client dependencies from package-lock.json for cleaner dependency management.
* refactor: Migrate crypto utility functions to @librechat/auth
- Replaced local crypto utility imports with the new @librechat/auth package across multiple files.
- Removed the obsolete crypto.js file and its exports.
- Updated relevant services and models to utilize the new encryption and decryption methods from @librechat/auth.
* feat: Enhance OAuth token handling and update dependencies in auth package
* chore: Remove Token model and TokenService due to restructuring of OAuth handling
- Deleted the Token.js model and TokenService.js, which were responsible for managing OAuth tokens.
- This change is part of a broader refactor to streamline OAuth token management and improve code organization.
* refactor: imports from '@librechat/auth' to '@librechat/api' and add OAuth token handling functionality
* refactor: Simplify logger usage in MCP and FlowStateManager classes
* chore: fix imports
* feat: Add OAuth configuration schema to MCP with token exchange method support
* feat: FIRST PASS Implement MCP OAuth flow with token management and error handling
- Added a new route for handling OAuth callbacks and token retrieval.
- Integrated OAuth token storage and retrieval mechanisms.
- Enhanced MCP connection to support automatic OAuth flow initiation on 401 errors.
- Implemented dynamic client registration and metadata discovery for OAuth.
- Updated MCPManager to manage OAuth tokens and handle authentication requirements.
- Introduced comprehensive logging for OAuth processes and error handling.
* refactor: Update MCPConnection and MCPManager to utilize new URL handling
- Added a `url` property to MCPConnection for better URL management.
- Refactored MCPManager to use the new `url` property instead of a deprecated method for OAuth handling.
- Changed logging from info to debug level for flow manager and token methods initialization.
- Improved comments for clarity on existing tokens and OAuth event listener setup.
* refactor: Improve connection timeout error messages in MCPConnection and MCPManager and use initTimeout for connection
- Updated the connection timeout error messages to include the duration of the timeout.
- Introduced a configurable `connectTimeout` variable in both MCPConnection and MCPManager for better flexibility.
* chore: cleanup MCP OAuth Token exchange handling; fix: erroneous use of flowsCache and remove verbose logs
* refactor: Update MCPManager and MCPTokenStorage to use TokenMethods for token management
- Removed direct token storage handling in MCPManager and replaced it with TokenMethods for better abstraction.
- Refactored MCPTokenStorage methods to accept parameters for token operations, enhancing flexibility and readability.
- Improved logging messages related to token persistence and retrieval processes.
* refactor: Update MCP OAuth handling to use static methods and improve flow management
- Refactored MCPOAuthHandler to utilize static methods for initiating and completing OAuth flows, enhancing clarity and reducing instance dependencies.
- Updated MCPManager to pass flowManager explicitly to OAuth handling methods, improving flexibility in flow state management.
- Enhanced comments and logging for better understanding of OAuth processes and flow state retrieval.
* refactor: Integrate token methods into createMCPTool for enhanced token management
* refactor: Change logging from info to debug level in MCPOAuthHandler for improved log management
* chore: clean up logging
* feat: first pass, auth URL from MCP OAuth flow
* chore: Improve logging format for OAuth authentication URL display
* chore: cleanup mcp manager comments
* feat: add connection reconnection logic in MCPManager
* refactor: reorganize token storage handling in MCP
- Moved token storage logic from MCPManager to a new MCPTokenStorage class for better separation of concerns.
- Updated imports to reflect the new token storage structure.
- Enhanced methods for storing, retrieving, updating, and deleting OAuth tokens, improving overall token management.
* chore: update comment for SYSTEM_USER_ID in MCPManager for clarity
* feat: implement refresh token functionality in MCP
- Added refresh token handling in MCPManager to support token renewal for both app-level and user-specific connections.
- Introduced a refreshTokens function to facilitate token refresh logic.
- Enhanced MCPTokenStorage to manage client information and refresh token processes.
- Updated logging for better traceability during token operations.
* chore: cleanup @librechat/auth
* feat: implement MCP server initialization in a separate service
- Added a new service to handle the initialization of MCP servers, improving code organization and readability.
- Refactored the server startup logic to utilize the new initializeMCP function.
- Removed redundant MCP initialization code from the main server file.
* fix: don't log auth url for user connections
* feat: enhance OAuth flow with success and error handling components
- Updated OAuth callback routes to redirect to new success and error pages instead of sending status messages.
- Introduced `OAuthSuccess` and `OAuthError` components to provide user feedback during authentication.
- Added localization support for success and error messages in the translation files.
- Implemented countdown functionality in the success component for a better user experience.
* fix: refresh token handling for user connections, add missing URL and methods
- add standard enum for system user id and helper for determining app-lvel vs. user-level connections
* refactor: update token handling in MCPManager and MCPTokenStorage
* fix: improve error logging in OAuth authentication handler
* fix: concurrency issues for both login url emission and concurrency of oauth flows for shared flows (same user, same server, multiple calls for same server)
* fix: properly fail shared flows for concurrent server calls and prevent duplication of tokens
* chore: remove unused auth package directory from update configuration
* ci: fix mocks in samlStrategy tests
* ci: add mcpConfig to AppService test setup
* chore: remove obsolete MCP OAuth implementation documentation
* fix: update build script for API to use correct command
* chore: bump version of @librechat/api to 1.2.4
* fix: update abort signal handling in createMCPTool function
* fix: add optional clientInfo parameter to refreshTokensFunction metadata
* refactor: replace app.locals.availableTools with getCachedTools in multiple services and controllers for improved tool management
* fix: concurrent refresh token handling issue
* refactor: add signal parameter to getUserConnection method for improved abort handling
* chore: JSDoc typing for `loadEphemeralAgent`
* refactor: update isConnectionActive method to use destructured parameters for improved readability
* feat: implement caching for MCP tools to handle app-level disconnects for loading list of tools
* ci: fix agent test
2025-06-17 13:50:33 -04:00
|
|
|
const { encryptV3 } = require('@librechat/api');
|
2025-05-30 22:18:13 -04:00
|
|
|
const { logger } = require('@librechat/data-schemas');
|
2025-02-18 01:09:36 +01:00
|
|
|
const {
|
2025-03-20 21:46:11 +01:00
|
|
|
verifyTOTP,
|
2025-02-19 19:33:29 +01:00
|
|
|
getTOTPSecret,
|
2025-05-30 22:18:13 -04:00
|
|
|
verifyBackupCode,
|
|
|
|
generateTOTPSecret,
|
|
|
|
generateBackupCodes,
|
2025-02-18 01:09:36 +01:00
|
|
|
} = require('~/server/services/twoFactorService');
|
2025-05-30 22:18:13 -04:00
|
|
|
const { getUserById, updateUser } = require('~/models');
|
2025-03-20 21:46:11 +01:00
|
|
|
|
|
|
|
const safeAppTitle = (process.env.APP_TITLE || 'LibreChat').replace(/\s+/g, '');
|
2025-02-18 01:09:36 +01:00
|
|
|
|
2025-03-20 21:46:11 +01:00
|
|
|
/**
|
|
|
|
* Enable 2FA for the user by generating a new TOTP secret and backup codes.
|
|
|
|
* The secret is encrypted and stored, and 2FA is marked as disabled until confirmed.
|
|
|
|
*/
|
|
|
|
const enable2FA = async (req, res) => {
|
2025-02-18 01:09:36 +01:00
|
|
|
try {
|
|
|
|
const userId = req.user.id;
|
|
|
|
const secret = generateTOTPSecret();
|
|
|
|
const { plainCodes, codeObjects } = await generateBackupCodes();
|
2025-03-20 21:46:11 +01:00
|
|
|
|
|
|
|
// Encrypt the secret with v3 encryption before saving.
|
|
|
|
const encryptedSecret = encryptV3(secret);
|
|
|
|
|
|
|
|
// Update the user record: store the secret & backup codes and set twoFactorEnabled to false.
|
2025-03-08 21:28:27 +01:00
|
|
|
const user = await updateUser(userId, {
|
|
|
|
totpSecret: encryptedSecret,
|
|
|
|
backupCodes: codeObjects,
|
|
|
|
twoFactorEnabled: false,
|
|
|
|
});
|
2025-02-18 01:09:36 +01:00
|
|
|
|
|
|
|
const otpauthUrl = `otpauth://totp/${safeAppTitle}:${user.email}?secret=${secret}&issuer=${safeAppTitle}`;
|
2025-03-20 21:46:11 +01:00
|
|
|
|
|
|
|
return res.status(200).json({ otpauthUrl, backupCodes: plainCodes });
|
2025-02-18 01:09:36 +01:00
|
|
|
} catch (err) {
|
2025-03-20 21:46:11 +01:00
|
|
|
logger.error('[enable2FA]', err);
|
|
|
|
return res.status(500).json({ message: err.message });
|
2025-02-18 01:09:36 +01:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2025-03-20 21:46:11 +01:00
|
|
|
/**
|
|
|
|
* Verify a 2FA code (either TOTP or backup code) during setup.
|
|
|
|
*/
|
|
|
|
const verify2FA = async (req, res) => {
|
2025-02-18 01:09:36 +01:00
|
|
|
try {
|
|
|
|
const userId = req.user.id;
|
|
|
|
const { token, backupCode } = req.body;
|
|
|
|
const user = await getUserById(userId);
|
2025-03-20 21:46:11 +01:00
|
|
|
|
2025-02-18 01:09:36 +01:00
|
|
|
if (!user || !user.totpSecret) {
|
|
|
|
return res.status(400).json({ message: '2FA not initiated' });
|
|
|
|
}
|
|
|
|
|
2025-02-19 19:33:29 +01:00
|
|
|
const secret = await getTOTPSecret(user.totpSecret);
|
2025-03-20 21:46:11 +01:00
|
|
|
let isVerified = false;
|
2025-02-19 19:33:29 +01:00
|
|
|
|
2025-03-20 21:46:11 +01:00
|
|
|
if (token) {
|
|
|
|
isVerified = await verifyTOTP(secret, token);
|
2025-02-18 01:09:36 +01:00
|
|
|
} else if (backupCode) {
|
2025-03-20 21:46:11 +01:00
|
|
|
isVerified = await verifyBackupCode({ user, backupCode });
|
2025-02-18 01:09:36 +01:00
|
|
|
}
|
2025-03-20 21:46:11 +01:00
|
|
|
|
|
|
|
if (isVerified) {
|
|
|
|
return res.status(200).json();
|
|
|
|
}
|
|
|
|
return res.status(400).json({ message: 'Invalid token or backup code.' });
|
2025-02-18 01:09:36 +01:00
|
|
|
} catch (err) {
|
2025-03-20 21:46:11 +01:00
|
|
|
logger.error('[verify2FA]', err);
|
|
|
|
return res.status(500).json({ message: err.message });
|
2025-02-18 01:09:36 +01:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2025-03-20 21:46:11 +01:00
|
|
|
/**
|
|
|
|
* Confirm and enable 2FA after a successful verification.
|
|
|
|
*/
|
|
|
|
const confirm2FA = async (req, res) => {
|
2025-02-18 01:09:36 +01:00
|
|
|
try {
|
|
|
|
const userId = req.user.id;
|
|
|
|
const { token } = req.body;
|
|
|
|
const user = await getUserById(userId);
|
|
|
|
|
|
|
|
if (!user || !user.totpSecret) {
|
|
|
|
return res.status(400).json({ message: '2FA not initiated' });
|
|
|
|
}
|
|
|
|
|
2025-02-19 19:33:29 +01:00
|
|
|
const secret = await getTOTPSecret(user.totpSecret);
|
|
|
|
if (await verifyTOTP(secret, token)) {
|
2025-03-08 21:28:27 +01:00
|
|
|
await updateUser(userId, { twoFactorEnabled: true });
|
2025-02-18 01:09:36 +01:00
|
|
|
return res.status(200).json();
|
|
|
|
}
|
|
|
|
return res.status(400).json({ message: 'Invalid token.' });
|
|
|
|
} catch (err) {
|
2025-03-20 21:46:11 +01:00
|
|
|
logger.error('[confirm2FA]', err);
|
|
|
|
return res.status(500).json({ message: err.message });
|
2025-02-18 01:09:36 +01:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2025-03-20 21:46:11 +01:00
|
|
|
/**
|
|
|
|
* Disable 2FA by clearing the stored secret and backup codes.
|
2025-08-10 15:05:16 -04:00
|
|
|
* Requires verification with either TOTP token or backup code if 2FA is fully enabled.
|
2025-03-20 21:46:11 +01:00
|
|
|
*/
|
|
|
|
const disable2FA = async (req, res) => {
|
2025-02-18 01:09:36 +01:00
|
|
|
try {
|
|
|
|
const userId = req.user.id;
|
2025-08-10 15:05:16 -04:00
|
|
|
const { token, backupCode } = req.body;
|
|
|
|
const user = await getUserById(userId);
|
|
|
|
|
|
|
|
if (!user || !user.totpSecret) {
|
|
|
|
return res.status(400).json({ message: '2FA is not setup for this user' });
|
|
|
|
}
|
|
|
|
|
|
|
|
if (user.twoFactorEnabled) {
|
|
|
|
const secret = await getTOTPSecret(user.totpSecret);
|
|
|
|
let isVerified = false;
|
|
|
|
|
|
|
|
if (token) {
|
|
|
|
isVerified = await verifyTOTP(secret, token);
|
|
|
|
} else if (backupCode) {
|
|
|
|
isVerified = await verifyBackupCode({ user, backupCode });
|
|
|
|
} else {
|
|
|
|
return res
|
|
|
|
.status(400)
|
|
|
|
.json({ message: 'Either token or backup code is required to disable 2FA' });
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!isVerified) {
|
|
|
|
return res.status(401).json({ message: 'Invalid token or backup code' });
|
|
|
|
}
|
|
|
|
}
|
2025-03-08 21:28:27 +01:00
|
|
|
await updateUser(userId, { totpSecret: null, backupCodes: [], twoFactorEnabled: false });
|
2025-03-20 21:46:11 +01:00
|
|
|
return res.status(200).json();
|
2025-02-18 01:09:36 +01:00
|
|
|
} catch (err) {
|
2025-03-20 21:46:11 +01:00
|
|
|
logger.error('[disable2FA]', err);
|
|
|
|
return res.status(500).json({ message: err.message });
|
2025-02-18 01:09:36 +01:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2025-03-20 21:46:11 +01:00
|
|
|
/**
|
|
|
|
* Regenerate backup codes for the user.
|
|
|
|
*/
|
|
|
|
const regenerateBackupCodes = async (req, res) => {
|
2025-02-18 01:09:36 +01:00
|
|
|
try {
|
|
|
|
const userId = req.user.id;
|
|
|
|
const { plainCodes, codeObjects } = await generateBackupCodes();
|
|
|
|
await updateUser(userId, { backupCodes: codeObjects });
|
2025-03-20 21:46:11 +01:00
|
|
|
return res.status(200).json({
|
2025-02-18 01:09:36 +01:00
|
|
|
backupCodes: plainCodes,
|
|
|
|
backupCodesHash: codeObjects,
|
|
|
|
});
|
|
|
|
} catch (err) {
|
2025-03-20 21:46:11 +01:00
|
|
|
logger.error('[regenerateBackupCodes]', err);
|
|
|
|
return res.status(500).json({ message: err.message });
|
2025-02-18 01:09:36 +01:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
module.exports = {
|
2025-03-20 21:46:11 +01:00
|
|
|
enable2FA,
|
|
|
|
verify2FA,
|
|
|
|
confirm2FA,
|
|
|
|
disable2FA,
|
|
|
|
regenerateBackupCodes,
|
2025-02-18 01:09:36 +01:00
|
|
|
};
|