Skip to content

Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active

🛡️ fix: Filter `user_provided` Sentinel in Tool Credential Loading (#12840)

Yorgos Kf2df0ea62bce
diff --git a/api/server/services/Tools/credentials.js b/api/server/services/Tools/credentials.js
index b50a2460d4..a289134a5a 100644
--- a/api/server/services/Tools/credentials.js
+++ b/api/server/services/Tools/credentials.js
@@ -1,3 +1,4 @@
+const { AuthType } = require('librechat-data-provider');
const { getUserPluginAuthValue } = require('~/server/services/PluginService');
/**
@@ -19,17 +20,18 @@ const loadAuthValues = async ({ userId, authFields, optional, throwError = true
*/
const findAuthValue = async (fields) => {
for (const field of fields) {
- let value = process.env[field];
- if (value) {
- return { authField: field, authValue: value };
+ const envValue = process.env[field];
+ if (envValue && envValue.trim() !== '' && envValue !== AuthType.USER_PROVIDED) {
+ return { authField: field, authValue: envValue };
}
+ let value;
try {
value = await getUserPluginAuthValue(userId, field, throwError);
} catch (err) {
if (optional && optional.has(field)) {
return { authField: field, authValue: undefined };
}
- if (field === fields[fields.length - 1] && !value) {
+ if (field === fields[fields.length - 1]) {
throw err;
}
}
diff --git a/api/server/services/Tools/credentials.spec.js b/api/server/services/Tools/credentials.spec.js
new file mode 100644
index 0000000000..727edbd9f3
--- /dev/null
+++ b/api/server/services/Tools/credentials.spec.js
@@ -0,0 +1,134 @@
+const { AuthType } = require('librechat-data-provider');
+
+jest.mock('~/server/services/PluginService', () => ({
+ getUserPluginAuthValue: jest.fn(),
+}));
+
+const { getUserPluginAuthValue } = require('~/server/services/PluginService');
+const { loadAuthValues } = require('./credentials');
+
+describe('loadAuthValues', () => {
+ const originalEnv = process.env;
+
+ beforeEach(() => {
+ jest.resetAllMocks();
+ process.env = { ...originalEnv };
+ });
+
+ afterEach(() => {
+ process.env = originalEnv;
+ });
+
+ it('should return env value when set to a real key', async () => {
+ process.env.MY_API_KEY = 'real-key-123';
+
+ const result = await loadAuthValues({
+ userId: 'user1',
+ authFields: ['MY_API_KEY'],
+ });
+
+ expect(result).toEqual({ MY_API_KEY: 'real-key-123' });
+ });
+
+ it('should skip user_provided sentinel and try user DB value', async () => {
+ process.env.GOOGLE_KEY = AuthType.USER_PROVIDED;
+ getUserPluginAuthValue.mockResolvedValue('user-stored-key');
+
+ const result = await loadAuthValues({
+ userId: 'user1',
+ authFields: ['GOOGLE_KEY'],
+ });
+
+ expect(getUserPluginAuthValue).toHaveBeenCalledWith('user1', 'GOOGLE_KEY', true);
+ expect(result).toEqual({ GOOGLE_KEY: 'user-stored-key' });
+ });
+
+ it('should skip user_provided and continue to next field in fallback chain', async () => {
+ process.env.GOOGLE_KEY = AuthType.USER_PROVIDED;
+ process.env.GOOGLE_SERVICE_KEY_FILE = '/path/to/service-account.json';
+ getUserPluginAuthValue.mockRejectedValue(new Error('No auth found'));
+
+ const result = await loadAuthValues({
+ userId: 'user1',
+ authFields: ['GEMINI_API_KEY||GOOGLE_KEY||GOOGLE_SERVICE_KEY_FILE'],
+ });
+
+ expect(result).toEqual({ GOOGLE_SERVICE_KEY_FILE: '/path/to/service-account.json' });
+ });
+
+ it('should skip empty and whitespace-only env values', async () => {
+ process.env.EMPTY_KEY = '';
+ process.env.WHITESPACE_KEY = ' ';
+ process.env.REAL_KEY = 'valid';
+
+ const result = await loadAuthValues({
+ userId: 'user1',
+ authFields: ['EMPTY_KEY||WHITESPACE_KEY||REAL_KEY'],
+ });
+
+ expect(result).toEqual({ REAL_KEY: 'valid' });
+ });
+
+ it('should not return user_provided as an auth value', async () => {
+ process.env.GOOGLE_KEY = AuthType.USER_PROVIDED;
+ getUserPluginAuthValue.mockResolvedValue(null);
+
+ const result = await loadAuthValues({
+ userId: 'user1',
+ authFields: ['GOOGLE_KEY'],
+ throwError: false,
+ });
+
+ expect(result).toEqual({});
+ });
+
+ it('should return env value without calling DB when env is valid', async () => {
+ process.env.MY_KEY = 'valid-key';
+
+ const result = await loadAuthValues({
+ userId: 'user1',
+ authFields: ['MY_KEY'],
+ });
+
+ expect(result).toEqual({ MY_KEY: 'valid-key' });
+ expect(getUserPluginAuthValue).not.toHaveBeenCalled();
+ });
+
+ it('should return real env value from first matching field in fallback chain', async () => {
+ process.env.GEMINI_API_KEY = 'gemini-key';
+ process.env.GOOGLE_KEY = 'google-key';
+
+ const result = await loadAuthValues({
+ userId: 'user1',
+ authFields: ['GEMINI_API_KEY||GOOGLE_KEY'],
+ });
+
+ expect(result).toEqual({ GEMINI_API_KEY: 'gemini-key' });
+ });
+
+ it('should return undefined for optional field when sentinel is filtered and DB throws', async () => {
+ process.env.GOOGLE_KEY = AuthType.USER_PROVIDED;
+ getUserPluginAuthValue.mockRejectedValue(new Error('No auth found'));
+
+ const optional = new Set(['GOOGLE_KEY']);
+ const result = await loadAuthValues({
+ userId: 'user1',
+ authFields: ['GOOGLE_KEY'],
+ optional,
+ });
+
+ expect(result).toEqual({ GOOGLE_KEY: undefined });
+ });
+
+ it('should not leak sentinel through catch path when DB lookup throws', async () => {
+ process.env.GOOGLE_KEY = AuthType.USER_PROVIDED;
+ getUserPluginAuthValue.mockRejectedValue(new Error('No auth found'));
+
+ await expect(
+ loadAuthValues({
+ userId: 'user1',
+ authFields: ['GOOGLE_KEY'],
+ }),
+ ).rejects.toThrow('No auth found');
+ });
+});