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

🔐 feat: Support Multiple Roles in `OPENID_REQUIRED_ROLE` (#9171)

Ihsan Soydemird83826b604ba
diff --git a/api/strategies/openidStrategy.js b/api/strategies/openidStrategy.js
index 011676ecad..6a4e783d4a 100644
--- a/api/strategies/openidStrategy.js
+++ b/api/strategies/openidStrategy.js
@@ -371,6 +371,10 @@ async function setupOpenId() {
const fullName = getFullName(userinfo);
if (requiredRole) {
+ const requiredRoles = requiredRole
+ .split(',')
+ .map((role) => role.trim())
+ .filter(Boolean);
let decodedToken = '';
if (requiredRoleTokenKind === 'access') {
decodedToken = jwtDecode(tokenset.access_token);
@@ -393,9 +397,13 @@ async function setupOpenId() {
);
}
- if (!roles.includes(requiredRole)) {
+ if (!requiredRoles.some((role) => roles.includes(role))) {
+ const rolesList =
+ requiredRoles.length === 1
+ ? `"${requiredRoles[0]}"`
+ : `one of: ${requiredRoles.map((r) => `"${r}"`).join(', ')}`;
return done(null, false, {
- message: `You must have the "${requiredRole}" role to log in.`,
+ message: `You must have ${rolesList} role to log in.`,
});
}
}
diff --git a/api/strategies/openidStrategy.spec.js b/api/strategies/openidStrategy.spec.js
index de033b01f8..35841e3783 100644
--- a/api/strategies/openidStrategy.spec.js
+++ b/api/strategies/openidStrategy.spec.js
@@ -338,7 +338,25 @@ describe('setupOpenId', () => {
// Assert – verify that the strategy rejects login
expect(user).toBe(false);
- expect(details.message).toBe('You must have the "requiredRole" role to log in.');
+ expect(details.message).toBe('You must have "requiredRole" role to log in.');
+ });
+
+ it('should allow login when single required role is present (backward compatibility)', async () => {
+ // Arrange – ensure single role configuration (as set in beforeEach)
+ // OPENID_REQUIRED_ROLE = 'requiredRole'
+ // Default jwtDecode mock in beforeEach already returns this role
+ jwtDecode.mockReturnValue({
+ roles: ['requiredRole', 'anotherRole'],
+ });
+
+ // Act
+ const { user } = await validate(tokenset);
+
+ // Assert – verify that login succeeds with single role configuration
+ expect(user).toBeTruthy();
+ expect(user.email).toBe(tokenset.claims().email);
+ expect(user.username).toBe(tokenset.claims().preferred_username);
+ expect(createUser).toHaveBeenCalled();
});
it('should attempt to download and save the avatar if picture is provided', async () => {
@@ -364,6 +382,58 @@ describe('setupOpenId', () => {
// Depending on your implementation, user.avatar may be undefined or an empty string.
});
+ it('should support comma-separated multiple roles', async () => {
+ // Arrange
+ process.env.OPENID_REQUIRED_ROLE = 'someRole,anotherRole,admin';
+ await setupOpenId(); // Re-initialize the strategy
+ verifyCallback = require('openid-client/passport').__getVerifyCallback();
+ jwtDecode.mockReturnValue({
+ roles: ['anotherRole', 'aThirdRole'],
+ });
+
+ // Act
+ const { user } = await validate(tokenset);
+
+ // Assert
+ expect(user).toBeTruthy();
+ expect(user.email).toBe(tokenset.claims().email);
+ });
+
+ it('should reject login when user has none of the required multiple roles', async () => {
+ // Arrange
+ process.env.OPENID_REQUIRED_ROLE = 'someRole,anotherRole,admin';
+ await setupOpenId(); // Re-initialize the strategy
+ verifyCallback = require('openid-client/passport').__getVerifyCallback();
+ jwtDecode.mockReturnValue({
+ roles: ['aThirdRole', 'aFourthRole'],
+ });
+
+ // Act
+ const { user, details } = await validate(tokenset);
+
+ // Assert
+ expect(user).toBe(false);
+ expect(details.message).toBe(
+ 'You must have one of: "someRole", "anotherRole", "admin" role to log in.',
+ );
+ });
+
+ it('should handle spaces in comma-separated roles', async () => {
+ // Arrange
+ process.env.OPENID_REQUIRED_ROLE = ' someRole , anotherRole , admin ';
+ await setupOpenId(); // Re-initialize the strategy
+ verifyCallback = require('openid-client/passport').__getVerifyCallback();
+ jwtDecode.mockReturnValue({
+ roles: ['someRole'],
+ });
+
+ // Act
+ const { user } = await validate(tokenset);
+
+ // Assert
+ expect(user).toBeTruthy();
+ });
+
it('should default to usePKCE false when OPENID_USE_PKCE is not defined', async () => {
const OpenIDStrategy = require('openid-client/passport').Strategy;