mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-09-22 08:12:00 +02:00

* 🗝️ feat: Per-User Credentials for MCP Servers
chore: add aider to gitignore
feat: fill custom variables to MCP server
feat: replace placeholders with custom user MCP variables
feat: handle MCP install/uninstall (uses pluginauths)
feat: add MCP custom variables dialog to MCPSelect
feat: add MCP custom variables dialog to the side panel
feat: do not require to fill MCP credentials for in tools dialog
feat: add translations keys (en+cs) for custom MCP variables
fix: handle LIBRECHAT_USER_ID correctly during MCP var replacement
style: remove unused MCP translation keys
style: fix eslint for MCP custom vars
chore: move aider gitignore to AI section
* feat: Add Plugin Authentication Methods to data-schemas
* refactor: Replace PluginAuth model methods with new utility functions for improved code organization and maintainability
* refactor: Move IPluginAuth interface to types directory for better organization and update pluginAuth schema to use the new import
* refactor: Remove unused getUsersPluginsAuthValuesMap function and streamline PluginService.js; add new getPluginAuthMap function for improved plugin authentication handling
* chore: fix typing for optional tools property with GenericTool[] type
* chore: update librechat-data-provider version to 0.7.88
* refactor: optimize getUserMCPAuthMap function by reducing variable usage and improving server key collection logic
* refactor: streamline MCP tool creation by removing customUserVars parameter and enhancing user-specific authentication handling to avoid closure encapsulation
* refactor: extract processSingleValue function to streamline MCP environment variable processing and enhance readability
* refactor: enhance MCP tool processing logic by simplifying conditions and improving authentication handling for custom user variables
* ci: fix action tests
* chore: fix imports, remove comments
* chore: remove non-english translations
* fix: remove newline at end of translation.json file
---------
Co-authored-by: Aleš Kůtek <kutekales@gmail.com>
124 lines
3.9 KiB
JavaScript
124 lines
3.9 KiB
JavaScript
const { logger } = require('@librechat/data-schemas');
|
|
const { encrypt, decrypt } = require('@librechat/api');
|
|
const { findOnePluginAuth, updatePluginAuth, deletePluginAuth } = require('~/models');
|
|
|
|
/**
|
|
* Asynchronously retrieves and decrypts the authentication value for a user's plugin, based on a specified authentication field.
|
|
*
|
|
* @param {string} userId - The unique identifier of the user for whom the plugin authentication value is to be retrieved.
|
|
* @param {string} authField - The specific authentication field (e.g., 'API_KEY', 'URL') whose value is to be retrieved and decrypted.
|
|
* @param {boolean} throwError - Whether to throw an error if the authentication value does not exist. Defaults to `true`.
|
|
* @returns {Promise<string|null>} A promise that resolves to the decrypted authentication value if found, or `null` if no such authentication value exists for the given user and field.
|
|
*
|
|
* The function throws an error if it encounters any issue during the retrieval or decryption process, or if the authentication value does not exist.
|
|
*
|
|
* @example
|
|
* // To get the decrypted value of the 'token' field for a user with userId '12345':
|
|
* getUserPluginAuthValue('12345', 'token').then(value => {
|
|
* console.log(value);
|
|
* }).catch(err => {
|
|
* console.error(err);
|
|
* });
|
|
*
|
|
* @throws {Error} Throws an error if there's an issue during the retrieval or decryption process, or if the authentication value does not exist.
|
|
* @async
|
|
*/
|
|
const getUserPluginAuthValue = async (userId, authField, throwError = true) => {
|
|
try {
|
|
const pluginAuth = await findOnePluginAuth({ userId, authField });
|
|
if (!pluginAuth) {
|
|
throw new Error(`No plugin auth ${authField} found for user ${userId}`);
|
|
}
|
|
|
|
const decryptedValue = await decrypt(pluginAuth.value);
|
|
return decryptedValue;
|
|
} catch (err) {
|
|
if (!throwError) {
|
|
return null;
|
|
}
|
|
logger.error('[getUserPluginAuthValue]', err);
|
|
throw err;
|
|
}
|
|
};
|
|
|
|
// const updateUserPluginAuth = async (userId, authField, pluginKey, value) => {
|
|
// try {
|
|
// const encryptedValue = encrypt(value);
|
|
|
|
// const pluginAuth = await PluginAuth.findOneAndUpdate(
|
|
// { userId, authField },
|
|
// {
|
|
// $set: {
|
|
// value: encryptedValue,
|
|
// pluginKey
|
|
// }
|
|
// },
|
|
// {
|
|
// new: true,
|
|
// upsert: true
|
|
// }
|
|
// );
|
|
|
|
// return pluginAuth;
|
|
// } catch (err) {
|
|
// logger.error('[getUserPluginAuthValue]', err);
|
|
// return err;
|
|
// }
|
|
// };
|
|
|
|
/**
|
|
*
|
|
* @async
|
|
* @param {string} userId
|
|
* @param {string} authField
|
|
* @param {string} pluginKey
|
|
* @param {string} value
|
|
* @returns {Promise<IPluginAuth>}
|
|
* @throws {Error}
|
|
*/
|
|
const updateUserPluginAuth = async (userId, authField, pluginKey, value) => {
|
|
try {
|
|
const encryptedValue = await encrypt(value);
|
|
return await updatePluginAuth({
|
|
userId,
|
|
authField,
|
|
pluginKey,
|
|
value: encryptedValue,
|
|
});
|
|
} catch (err) {
|
|
logger.error('[updateUserPluginAuth]', err);
|
|
return err;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* @async
|
|
* @param {string} userId
|
|
* @param {string | null} authField - The specific authField to delete, or null if `all` is true.
|
|
* @param {boolean} [all=false] - Whether to delete all auths for the user (or for a specific pluginKey if provided).
|
|
* @param {string} [pluginKey] - Optional. If `all` is true and `pluginKey` is provided, delete all auths for this user and pluginKey.
|
|
* @returns {Promise<import('mongoose').DeleteResult>}
|
|
* @throws {Error}
|
|
*/
|
|
const deleteUserPluginAuth = async (userId, authField, all = false, pluginKey) => {
|
|
try {
|
|
return await deletePluginAuth({
|
|
userId,
|
|
authField,
|
|
pluginKey,
|
|
all,
|
|
});
|
|
} catch (err) {
|
|
logger.error(
|
|
`[deleteUserPluginAuth] Error deleting ${all ? 'all' : 'single'} auth(s) for userId: ${userId}${pluginKey ? ` and pluginKey: ${pluginKey}` : ''}`,
|
|
err,
|
|
);
|
|
return err;
|
|
}
|
|
};
|
|
|
|
module.exports = {
|
|
getUserPluginAuthValue,
|
|
updateUserPluginAuth,
|
|
deleteUserPluginAuth,
|
|
};
|