mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-11-16 13:00:55 +00:00
* fix: Encrypt User Plugin Credentials With Random-IV v3 Format * test: Cover Credential Encryption Formats in Mock E2E Scenarios * test: Round-Trip Real Credential Helpers in PluginService Spec * 🙈 fix: Remove SharePoint Picker Payload Logging (#16997) * fix: Add credentials.writeFormat to Gate v3 Credential Writes During Rollouts * test: Expect 201 When the Legacy Write Format Override Is Created * 🔊 fix: Clear TTS Audio Cache On Session End and Hash Its Keys (#16998) * fix: Clear TTS Audio Cache On Session End and Hash Its Keys * fix: Read Manual TTS Replays From the Hashed Cache Key * fix: Purge Legacy TTS Cache Keys and Fence Writes Across Logout * fix: Keep TTS Cache Writes Off the Playback Path * test: Expect Hashed Keys in the StreamAudio Cache Lookup * test: Use a Single-Token Reply Label in the TTS Cache Scenario * fix: Settle TTS Cache Clear Before IdP Logout and Across Tabs * test: Cover the TTS Cache Fence When Another Tab Logs Out * test: Wait for the Second Tab Before Logging Out in the TTS Scenario * fix: Latch TTS Cache Writes Shut Until the Tab Authenticates Again * fix: Reopen TTS Cache Writes When Authentication Completes In Place * fix: Leave for the IdP Even When TTS Cache Cleanup Fails * fix: Retry a Failed Legacy TTS Purge and Fence Other Tabs on Manual Clear * fix: Rerun the Legacy TTS Purge After Each Clear and Sign-In * fix: Rerun the Legacy TTS Purge When Another Tab Clears * fix: Fence Pre-Auth TTS Writes, Retry Failed Clears, and Fall Back to Storage Events * fix: Version the Hashed TTS Cache Key Path * fix: Move TTS Audio to a New Cache and Keep It Closed Until a Failed Clear Succeeds * fix: Persist a Pending TTS Cache Delete Across Navigation * fix: Reopen TTS Caching Only on Session Start and Fence Cache Reads * fix: Keep the TTS Delete Fence in Cache Storage and Close Reads After Logout * refactor: Keep Read-Aloud Audio in Tab Memory Instead of Cache Storage * test: Return to the Conversation After Re-Login in the TTS Logout Scenario * test: Close the Phone Sidebar Before Replaying in the TTS Logout Scenario * fix: Bound the In-Memory TTS Cache by Size as Well as Count * fix: Scope Cached TTS Audio to the Signed-In User * fix: Keep the Settings Cache Delete Available While Legacy Audio Remains * fix: Recheck Legacy TTS Audio After a Settings Clear and on Unowned Handoff * fix: Fence TTS Writes Started Before an Account Signs In * test: Opt the Fresh TTS Account Into Enter-to-Send
144 lines
4.8 KiB
JavaScript
144 lines
4.8 KiB
JavaScript
const { logger } = require('@librechat/data-schemas');
|
|
const { encryptCredential, decryptCredential } = 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`.
|
|
* @param {string} [pluginKey] - Optional plugin key to make the lookup more specific to a particular plugin.
|
|
* @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);
|
|
* });
|
|
*
|
|
* @example
|
|
* // To get the decrypted value of the 'API_KEY' field for a specific plugin:
|
|
* getUserPluginAuthValue('12345', 'API_KEY', true, 'mcp-server-name').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, pluginKey) => {
|
|
try {
|
|
const searchParams = { userId, authField };
|
|
if (pluginKey) {
|
|
searchParams.pluginKey = pluginKey;
|
|
}
|
|
|
|
const pluginAuth = await findOnePluginAuth(searchParams);
|
|
if (!pluginAuth) {
|
|
const pluginInfo = pluginKey ? ` for plugin ${pluginKey}` : '';
|
|
const error = new Error(`No plugin auth ${authField} found for user ${userId}${pluginInfo}`);
|
|
error.code = 'PLUGIN_AUTH_NOT_FOUND';
|
|
throw error;
|
|
}
|
|
|
|
const decryptedValue = await decryptCredential(pluginAuth.value);
|
|
return decryptedValue;
|
|
} catch (err) {
|
|
if (!throwError) {
|
|
return null;
|
|
}
|
|
if (err?.code !== 'PLUGIN_AUTH_NOT_FOUND') {
|
|
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
|
|
* @param {'v3' | 'legacy'} [writeFormat] - `credentials.writeFormat` from the app config
|
|
* @returns {Promise<IPluginAuth>}
|
|
* @throws {Error}
|
|
*/
|
|
const updateUserPluginAuth = async (userId, authField, pluginKey, value, writeFormat) => {
|
|
try {
|
|
const encryptedValue = await encryptCredential(value, writeFormat);
|
|
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,
|
|
};
|