| const fetch = require('node-fetch');
|
| const jwtDecode = require('jsonwebtoken/decode');
|
| const { ErrorTypes } = require('librechat-data-provider');
|
| const { findUser, createUser, updateUser } = require('~/models');
|
| const { setupOpenId } = require('./openidStrategy');
|
|
|
|
|
| jest.mock('node-fetch');
|
| jest.mock('jsonwebtoken/decode');
|
| jest.mock('~/server/services/Files/strategies', () => ({
|
| getStrategyFunctions: jest.fn(() => ({
|
| saveBuffer: jest.fn().mockResolvedValue('/fake/path/to/avatar.png'),
|
| })),
|
| }));
|
| jest.mock('~/server/services/Config', () => ({
|
| getAppConfig: jest.fn().mockResolvedValue({}),
|
| }));
|
| jest.mock('@librechat/api', () => ({
|
| ...jest.requireActual('@librechat/api'),
|
| isEnabled: jest.fn(() => false),
|
| isEmailDomainAllowed: jest.fn(() => true),
|
| findOpenIDUser: jest.requireActual('@librechat/api').findOpenIDUser,
|
| getBalanceConfig: jest.fn(() => ({
|
| enabled: false,
|
| })),
|
| }));
|
| jest.mock('~/models', () => ({
|
| findUser: jest.fn(),
|
| createUser: jest.fn(),
|
| updateUser: jest.fn(),
|
| }));
|
| jest.mock('@librechat/data-schemas', () => ({
|
| ...jest.requireActual('@librechat/api'),
|
| logger: {
|
| info: jest.fn(),
|
| warn: jest.fn(),
|
| debug: jest.fn(),
|
| error: jest.fn(),
|
| },
|
| hashToken: jest.fn().mockResolvedValue('hashed-token'),
|
| }));
|
| jest.mock('~/cache/getLogStores', () =>
|
| jest.fn(() => ({
|
| get: jest.fn(),
|
| set: jest.fn(),
|
| })),
|
| );
|
|
|
|
|
| jest.mock('openid-client', () => {
|
| return {
|
| discovery: jest.fn().mockResolvedValue({
|
| clientId: 'fake_client_id',
|
| clientSecret: 'fake_client_secret',
|
| issuer: 'https://fake-issuer.com',
|
|
|
| }),
|
| fetchUserInfo: jest.fn().mockImplementation(() => {
|
|
|
| return Promise.resolve({});
|
| }),
|
| customFetch: Symbol('customFetch'),
|
| };
|
| });
|
|
|
| jest.mock('openid-client/passport', () => {
|
| let verifyCallback;
|
| const mockStrategy = jest.fn((options, verify) => {
|
| verifyCallback = verify;
|
| return { name: 'openid', options, verify };
|
| });
|
|
|
| return {
|
| Strategy: mockStrategy,
|
| __getVerifyCallback: () => verifyCallback,
|
| };
|
| });
|
|
|
|
|
| jest.mock('passport', () => ({
|
| use: jest.fn(),
|
| }));
|
|
|
| describe('setupOpenId', () => {
|
|
|
| let verifyCallback;
|
|
|
|
|
| const validate = (tokenset) =>
|
| new Promise((resolve, reject) => {
|
| verifyCallback(tokenset, (err, user, details) => {
|
| if (err) {
|
| reject(err);
|
| } else {
|
| resolve({ user, details });
|
| }
|
| });
|
| });
|
|
|
| const tokenset = {
|
| id_token: 'fake_id_token',
|
| access_token: 'fake_access_token',
|
| claims: () => ({
|
| sub: '1234',
|
| email: 'test@example.com',
|
| email_verified: true,
|
| given_name: 'First',
|
| family_name: 'Last',
|
| name: 'My Full',
|
| preferred_username: 'testusername',
|
| username: 'flast',
|
| picture: 'https://example.com/avatar.png',
|
| }),
|
| };
|
|
|
| beforeEach(async () => {
|
|
|
| jest.clearAllMocks();
|
|
|
|
|
| process.env.OPENID_ISSUER = 'https://fake-issuer.com';
|
| process.env.OPENID_CLIENT_ID = 'fake_client_id';
|
| process.env.OPENID_CLIENT_SECRET = 'fake_client_secret';
|
| process.env.DOMAIN_SERVER = 'https://example.com';
|
| process.env.OPENID_CALLBACK_URL = '/callback';
|
| process.env.OPENID_SCOPE = 'openid profile email';
|
| process.env.OPENID_REQUIRED_ROLE = 'requiredRole';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'roles';
|
| process.env.OPENID_REQUIRED_ROLE_TOKEN_KIND = 'id';
|
| process.env.OPENID_ADMIN_ROLE = 'admin';
|
| process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH = 'permissions';
|
| process.env.OPENID_ADMIN_ROLE_TOKEN_KIND = 'id';
|
| delete process.env.OPENID_USERNAME_CLAIM;
|
| delete process.env.OPENID_NAME_CLAIM;
|
| delete process.env.PROXY;
|
| delete process.env.OPENID_USE_PKCE;
|
|
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| permissions: ['admin'],
|
| });
|
|
|
|
|
| findUser.mockResolvedValue(null);
|
| createUser.mockImplementation(async (userData) => {
|
|
|
| return { _id: 'newUserId', ...userData };
|
| });
|
| updateUser.mockImplementation(async (id, userData) => {
|
| return { _id: id, ...userData };
|
| });
|
|
|
|
|
| const fakeBuffer = Buffer.from('fake image');
|
| const fakeResponse = {
|
| ok: true,
|
| buffer: jest.fn().mockResolvedValue(fakeBuffer),
|
| };
|
| fetch.mockResolvedValue(fakeResponse);
|
|
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
| });
|
|
|
| it('should create a new user with correct username when preferred_username claim exists', async () => {
|
|
|
| const userinfo = tokenset.claims();
|
|
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(user.username).toBe(userinfo.preferred_username);
|
| expect(createUser).toHaveBeenCalledWith(
|
| expect.objectContaining({
|
| provider: 'openid',
|
| openidId: userinfo.sub,
|
| username: userinfo.preferred_username,
|
| email: userinfo.email,
|
| name: `${userinfo.given_name} ${userinfo.family_name}`,
|
| }),
|
| { enabled: false },
|
| true,
|
| true,
|
| );
|
| });
|
|
|
| it('should use username as username when preferred_username claim is missing', async () => {
|
|
|
| const userinfo = { ...tokenset.claims() };
|
| delete userinfo.preferred_username;
|
|
|
| const expectUsername = userinfo.username;
|
|
|
|
|
| const { user } = await validate({ ...tokenset, claims: () => userinfo });
|
|
|
|
|
| expect(user.username).toBe(expectUsername);
|
| expect(createUser).toHaveBeenCalledWith(
|
| expect.objectContaining({ username: expectUsername }),
|
| { enabled: false },
|
| true,
|
| true,
|
| );
|
| });
|
|
|
| it('should use email as username when username and preferred_username are missing', async () => {
|
|
|
| const userinfo = { ...tokenset.claims() };
|
| delete userinfo.username;
|
| delete userinfo.preferred_username;
|
| const expectUsername = userinfo.email;
|
|
|
|
|
| const { user } = await validate({ ...tokenset, claims: () => userinfo });
|
|
|
|
|
| expect(user.username).toBe(expectUsername);
|
| expect(createUser).toHaveBeenCalledWith(
|
| expect.objectContaining({ username: expectUsername }),
|
| { enabled: false },
|
| true,
|
| true,
|
| );
|
| });
|
|
|
| it('should override username with OPENID_USERNAME_CLAIM when set', async () => {
|
|
|
| process.env.OPENID_USERNAME_CLAIM = 'sub';
|
| const userinfo = tokenset.claims();
|
|
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(user.username).toBe(userinfo.sub);
|
| expect(createUser).toHaveBeenCalledWith(
|
| expect.objectContaining({ username: userinfo.sub }),
|
| { enabled: false },
|
| true,
|
| true,
|
| );
|
| });
|
|
|
| it('should set the full name correctly when given_name and family_name exist', async () => {
|
|
|
| const userinfo = tokenset.claims();
|
| const expectedFullName = `${userinfo.given_name} ${userinfo.family_name}`;
|
|
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(user.name).toBe(expectedFullName);
|
| });
|
|
|
| it('should override full name with OPENID_NAME_CLAIM when set', async () => {
|
|
|
| process.env.OPENID_NAME_CLAIM = 'name';
|
| const userinfo = { ...tokenset.claims(), name: 'Custom Name' };
|
|
|
|
|
| const { user } = await validate({ ...tokenset, claims: () => userinfo });
|
|
|
|
|
| expect(user.name).toBe('Custom Name');
|
| });
|
|
|
| it('should update an existing user on login', async () => {
|
|
|
| const existingUser = {
|
| _id: 'existingUserId',
|
| provider: 'openid',
|
| email: tokenset.claims().email,
|
| openidId: '',
|
| username: '',
|
| name: '',
|
| };
|
| findUser.mockImplementation(async (query) => {
|
| if (query.openidId === tokenset.claims().sub || query.email === tokenset.claims().email) {
|
| return existingUser;
|
| }
|
| return null;
|
| });
|
|
|
| const userinfo = tokenset.claims();
|
|
|
|
|
| await validate(tokenset);
|
|
|
|
|
| expect(updateUser).toHaveBeenCalledWith(
|
| existingUser._id,
|
| expect.objectContaining({
|
| provider: 'openid',
|
| openidId: userinfo.sub,
|
| username: userinfo.preferred_username,
|
| name: `${userinfo.given_name} ${userinfo.family_name}`,
|
| }),
|
| );
|
| });
|
|
|
| it('should block login when email exists with different provider', async () => {
|
|
|
| const existingUser = {
|
| _id: 'existingUserId',
|
| provider: 'google',
|
| email: tokenset.claims().email,
|
| googleId: 'some-google-id',
|
| username: 'existinguser',
|
| name: 'Existing User',
|
| };
|
| findUser.mockImplementation(async (query) => {
|
| if (query.email === tokenset.claims().email && !query.provider) {
|
| return existingUser;
|
| }
|
| return null;
|
| });
|
|
|
|
|
| const result = await validate(tokenset);
|
|
|
|
|
| expect(result.user).toBe(false);
|
| expect(result.details.message).toBe(ErrorTypes.AUTH_FAILED);
|
| expect(createUser).not.toHaveBeenCalled();
|
| expect(updateUser).not.toHaveBeenCalled();
|
| });
|
|
|
| it('should enforce the required role and reject login if missing', async () => {
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['SomeOtherRole'],
|
| });
|
|
|
|
|
| const { user, details } = await validate(tokenset);
|
|
|
|
|
| expect(user).toBe(false);
|
| 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 () => {
|
|
|
|
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole', 'anotherRole'],
|
| });
|
|
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| 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 () => {
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(fetch).toHaveBeenCalled();
|
|
|
| expect(user.avatar).toBe('/fake/path/to/avatar.png');
|
| });
|
|
|
| it('should not attempt to download avatar if picture is not provided', async () => {
|
|
|
| const userinfo = { ...tokenset.claims() };
|
| delete userinfo.picture;
|
|
|
|
|
| await validate({ ...tokenset, claims: () => userinfo });
|
|
|
|
|
| expect(fetch).not.toHaveBeenCalled();
|
|
|
| });
|
|
|
| it('should support comma-separated multiple roles', async () => {
|
|
|
| process.env.OPENID_REQUIRED_ROLE = 'someRole,anotherRole,admin';
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
| jwtDecode.mockReturnValue({
|
| roles: ['anotherRole', 'aThirdRole'],
|
| });
|
|
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(user).toBeTruthy();
|
| expect(user.email).toBe(tokenset.claims().email);
|
| });
|
|
|
| it('should reject login when user has none of the required multiple roles', async () => {
|
|
|
| process.env.OPENID_REQUIRED_ROLE = 'someRole,anotherRole,admin';
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
| jwtDecode.mockReturnValue({
|
| roles: ['aThirdRole', 'aFourthRole'],
|
| });
|
|
|
|
|
| const { user, details } = await validate(tokenset);
|
|
|
|
|
| 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 () => {
|
|
|
| process.env.OPENID_REQUIRED_ROLE = ' someRole , anotherRole , admin ';
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
| jwtDecode.mockReturnValue({
|
| roles: ['someRole'],
|
| });
|
|
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(user).toBeTruthy();
|
| });
|
|
|
| it('should default to usePKCE false when OPENID_USE_PKCE is not defined', async () => {
|
| const OpenIDStrategy = require('openid-client/passport').Strategy;
|
|
|
| delete process.env.OPENID_USE_PKCE;
|
| await setupOpenId();
|
|
|
| const callOptions = OpenIDStrategy.mock.calls[OpenIDStrategy.mock.calls.length - 1][0];
|
| expect(callOptions.usePKCE).toBe(false);
|
| expect(callOptions.params?.code_challenge_method).toBeUndefined();
|
| });
|
|
|
| it('should attach federatedTokens to user object for token propagation', async () => {
|
|
|
| const tokensetWithTokens = {
|
| ...tokenset,
|
| access_token: 'mock_access_token_abc123',
|
| refresh_token: 'mock_refresh_token_xyz789',
|
| expires_at: 1234567890,
|
| };
|
|
|
|
|
| const { user } = await validate(tokensetWithTokens);
|
|
|
|
|
| expect(user.federatedTokens).toBeDefined();
|
| expect(user.federatedTokens).toEqual({
|
| access_token: 'mock_access_token_abc123',
|
| refresh_token: 'mock_refresh_token_xyz789',
|
| expires_at: 1234567890,
|
| });
|
| });
|
|
|
| it('should include tokenset along with federatedTokens', async () => {
|
|
|
| const tokensetWithTokens = {
|
| ...tokenset,
|
| access_token: 'test_access_token',
|
| refresh_token: 'test_refresh_token',
|
| expires_at: 9999999999,
|
| };
|
|
|
|
|
| const { user } = await validate(tokensetWithTokens);
|
|
|
|
|
| expect(user.tokenset).toBeDefined();
|
| expect(user.federatedTokens).toBeDefined();
|
| expect(user.tokenset.access_token).toBe('test_access_token');
|
| expect(user.federatedTokens.access_token).toBe('test_access_token');
|
| });
|
|
|
| it('should set role to "ADMIN" if OPENID_ADMIN_ROLE is set and user has that role', async () => {
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(user.role).toBe('ADMIN');
|
| });
|
|
|
| it('should not set user role if OPENID_ADMIN_ROLE is set but the user does not have that role', async () => {
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| permissions: ['not-admin'],
|
| });
|
|
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(user.role).toBeUndefined();
|
| });
|
|
|
| it('should demote existing admin user when admin role is removed from token', async () => {
|
|
|
| const existingAdminUser = {
|
| _id: 'existingAdminId',
|
| provider: 'openid',
|
| email: tokenset.claims().email,
|
| openidId: tokenset.claims().sub,
|
| username: 'adminuser',
|
| name: 'Admin User',
|
| role: 'ADMIN',
|
| };
|
|
|
| findUser.mockImplementation(async (query) => {
|
| if (query.openidId === tokenset.claims().sub || query.email === tokenset.claims().email) {
|
| return existingAdminUser;
|
| }
|
| return null;
|
| });
|
|
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| permissions: ['not-admin'],
|
| });
|
|
|
| const { logger } = require('@librechat/data-schemas');
|
|
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(user.role).toBe('USER');
|
| expect(updateUser).toHaveBeenCalledWith(
|
| existingAdminUser._id,
|
| expect.objectContaining({
|
| role: 'USER',
|
| }),
|
| );
|
| expect(logger.info).toHaveBeenCalledWith(
|
| expect.stringContaining('demoted from admin - role no longer present in token'),
|
| );
|
| });
|
|
|
| it('should NOT demote admin user when admin role env vars are not configured', async () => {
|
|
|
| delete process.env.OPENID_ADMIN_ROLE;
|
| delete process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH;
|
| delete process.env.OPENID_ADMIN_ROLE_TOKEN_KIND;
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
|
|
| const existingAdminUser = {
|
| _id: 'existingAdminId',
|
| provider: 'openid',
|
| email: tokenset.claims().email,
|
| openidId: tokenset.claims().sub,
|
| username: 'adminuser',
|
| name: 'Admin User',
|
| role: 'ADMIN',
|
| };
|
|
|
| findUser.mockImplementation(async (query) => {
|
| if (query.openidId === tokenset.claims().sub || query.email === tokenset.claims().email) {
|
| return existingAdminUser;
|
| }
|
| return null;
|
| });
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| });
|
|
|
|
|
| const { user } = await validate(tokenset);
|
|
|
|
|
| expect(user.role).toBe('ADMIN');
|
| expect(updateUser).toHaveBeenCalledWith(
|
| existingAdminUser._id,
|
| expect.objectContaining({
|
| role: 'ADMIN',
|
| }),
|
| );
|
| });
|
|
|
| describe('lodash get - nested path extraction', () => {
|
| it('should extract roles from deeply nested token path', async () => {
|
| process.env.OPENID_REQUIRED_ROLE = 'app-user';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'resource_access.my-client.roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| resource_access: {
|
| 'my-client': {
|
| roles: ['app-user', 'viewer'],
|
| },
|
| },
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(user).toBeTruthy();
|
| expect(user.email).toBe(tokenset.claims().email);
|
| });
|
|
|
| it('should extract roles from three-level nested path', async () => {
|
| process.env.OPENID_REQUIRED_ROLE = 'editor';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'data.access.permissions.roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| data: {
|
| access: {
|
| permissions: {
|
| roles: ['editor', 'reader'],
|
| },
|
| },
|
| },
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(user).toBeTruthy();
|
| });
|
|
|
| it('should log error and reject login when required role path does not exist in token', async () => {
|
| const { logger } = require('@librechat/data-schemas');
|
| process.env.OPENID_REQUIRED_ROLE = 'app-user';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'resource_access.nonexistent.roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| resource_access: {
|
| 'my-client': {
|
| roles: ['app-user'],
|
| },
|
| },
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user, details } = await validate(tokenset);
|
|
|
| expect(logger.error).toHaveBeenCalledWith(
|
| expect.stringContaining(
|
| "Key 'resource_access.nonexistent.roles' not found or invalid type in id token!",
|
| ),
|
| );
|
| expect(user).toBe(false);
|
| expect(details.message).toContain('role to log in');
|
| });
|
|
|
| it('should handle missing intermediate nested path gracefully', async () => {
|
| const { logger } = require('@librechat/data-schemas');
|
| process.env.OPENID_REQUIRED_ROLE = 'user';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'org.team.roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| org: {
|
| other: 'value',
|
| },
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(logger.error).toHaveBeenCalledWith(
|
| expect.stringContaining("Key 'org.team.roles' not found or invalid type in id token!"),
|
| );
|
| expect(user).toBe(false);
|
| });
|
|
|
| it('should extract admin role from nested path in access token', async () => {
|
| process.env.OPENID_ADMIN_ROLE = 'admin';
|
| process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH = 'realm_access.roles';
|
| process.env.OPENID_ADMIN_ROLE_TOKEN_KIND = 'access';
|
|
|
| jwtDecode.mockImplementation((token) => {
|
| if (token === 'fake_access_token') {
|
| return {
|
| realm_access: {
|
| roles: ['admin', 'user'],
|
| },
|
| };
|
| }
|
| return {
|
| roles: ['requiredRole'],
|
| };
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(user.role).toBe('ADMIN');
|
| });
|
|
|
| it('should extract admin role from nested path in userinfo', async () => {
|
| process.env.OPENID_ADMIN_ROLE = 'admin';
|
| process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH = 'organization.permissions';
|
| process.env.OPENID_ADMIN_ROLE_TOKEN_KIND = 'userinfo';
|
|
|
| const userinfoWithNestedGroups = {
|
| ...tokenset.claims(),
|
| organization: {
|
| permissions: ['admin', 'write'],
|
| },
|
| };
|
|
|
| require('openid-client').fetchUserInfo.mockResolvedValue({
|
| organization: {
|
| permissions: ['admin', 'write'],
|
| },
|
| });
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate({
|
| ...tokenset,
|
| claims: () => userinfoWithNestedGroups,
|
| });
|
|
|
| expect(user.role).toBe('ADMIN');
|
| });
|
|
|
| it('should handle boolean admin role value', async () => {
|
| process.env.OPENID_ADMIN_ROLE = 'admin';
|
| process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH = 'is_admin';
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| is_admin: true,
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(user.role).toBe('ADMIN');
|
| });
|
|
|
| it('should handle string admin role value matching exactly', async () => {
|
| process.env.OPENID_ADMIN_ROLE = 'super-admin';
|
| process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH = 'role';
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| role: 'super-admin',
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(user.role).toBe('ADMIN');
|
| });
|
|
|
| it('should not set admin role when string value does not match', async () => {
|
| process.env.OPENID_ADMIN_ROLE = 'super-admin';
|
| process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH = 'role';
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| role: 'regular-user',
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(user.role).toBeUndefined();
|
| });
|
|
|
| it('should handle array admin role value', async () => {
|
| process.env.OPENID_ADMIN_ROLE = 'site-admin';
|
| process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH = 'app_roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| app_roles: ['user', 'site-admin', 'moderator'],
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(user.role).toBe('ADMIN');
|
| });
|
|
|
| it('should not set admin when role is not in array', async () => {
|
| process.env.OPENID_ADMIN_ROLE = 'site-admin';
|
| process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH = 'app_roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole'],
|
| app_roles: ['user', 'moderator'],
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(user.role).toBeUndefined();
|
| });
|
|
|
| it('should handle nested path with special characters in keys', async () => {
|
| process.env.OPENID_REQUIRED_ROLE = 'app-user';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'resource_access.my-app-123.roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| resource_access: {
|
| 'my-app-123': {
|
| roles: ['app-user'],
|
| },
|
| },
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(user).toBeTruthy();
|
| });
|
|
|
| it('should handle empty object at nested path', async () => {
|
| const { logger } = require('@librechat/data-schemas');
|
| process.env.OPENID_REQUIRED_ROLE = 'user';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'access.roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| access: {},
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(logger.error).toHaveBeenCalledWith(
|
| expect.stringContaining("Key 'access.roles' not found or invalid type in id token!"),
|
| );
|
| expect(user).toBe(false);
|
| });
|
|
|
| it('should handle null value at intermediate path', async () => {
|
| const { logger } = require('@librechat/data-schemas');
|
| process.env.OPENID_REQUIRED_ROLE = 'user';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'data.roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| data: null,
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(logger.error).toHaveBeenCalledWith(
|
| expect.stringContaining("Key 'data.roles' not found or invalid type in id token!"),
|
| );
|
| expect(user).toBe(false);
|
| });
|
|
|
| it('should reject login with invalid admin role token kind', async () => {
|
| process.env.OPENID_ADMIN_ROLE = 'admin';
|
| process.env.OPENID_ADMIN_ROLE_PARAMETER_PATH = 'roles';
|
| process.env.OPENID_ADMIN_ROLE_TOKEN_KIND = 'invalid';
|
|
|
| const { logger } = require('@librechat/data-schemas');
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: ['requiredRole', 'admin'],
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| await expect(validate(tokenset)).rejects.toThrow('Invalid admin role token kind');
|
|
|
| expect(logger.error).toHaveBeenCalledWith(
|
| expect.stringContaining(
|
| "Invalid admin role token kind: invalid. Must be one of 'access', 'id', or 'userinfo'",
|
| ),
|
| );
|
| });
|
|
|
| it('should reject login when roles path returns invalid type (object)', async () => {
|
| const { logger } = require('@librechat/data-schemas');
|
| process.env.OPENID_REQUIRED_ROLE = 'app-user';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'roles';
|
|
|
| jwtDecode.mockReturnValue({
|
| roles: { admin: true, user: false },
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user, details } = await validate(tokenset);
|
|
|
| expect(logger.error).toHaveBeenCalledWith(
|
| expect.stringContaining("Key 'roles' not found or invalid type in id token!"),
|
| );
|
| expect(user).toBe(false);
|
| expect(details.message).toContain('role to log in');
|
| });
|
|
|
| it('should reject login when roles path returns invalid type (number)', async () => {
|
| const { logger } = require('@librechat/data-schemas');
|
| process.env.OPENID_REQUIRED_ROLE = 'user';
|
| process.env.OPENID_REQUIRED_ROLE_PARAMETER_PATH = 'roleCount';
|
|
|
| jwtDecode.mockReturnValue({
|
| roleCount: 5,
|
| });
|
|
|
| await setupOpenId();
|
| verifyCallback = require('openid-client/passport').__getVerifyCallback();
|
|
|
| const { user } = await validate(tokenset);
|
|
|
| expect(logger.error).toHaveBeenCalledWith(
|
| expect.stringContaining("Key 'roleCount' not found or invalid type in id token!"),
|
| );
|
| expect(user).toBe(false);
|
| });
|
| });
|
| });
|
|
|