import jwt from 'jsonwebtoken'; import { mock } from 'jest-mock-extended'; import type { NextFunction, Response } from 'express'; import { AuthService } from '@/auth/auth.service'; import config from '@/config'; import { AUTH_COOKIE_NAME, Time } from '@/constants'; import type { User } from '@db/entities/User'; import type { UserRepository } from '@db/repositories/user.repository'; import { JwtService } from '@/services/jwt.service'; import type { UrlService } from '@/services/url.service'; import type { AuthenticatedRequest } from '@/requests'; describe('AuthService', () => { config.set('userManagement.jwtSecret', 'random-secret'); const browserId = 'test-browser-id'; const userData = { id: '123', email: 'test@example.com', password: 'passwordHash', disabled: false, mfaEnabled: false, }; const user = mock(userData); const jwtService = new JwtService(mock()); const urlService = mock(); const userRepository = mock(); const authService = new AuthService(mock(), mock(), jwtService, urlService, userRepository); const now = new Date('2024-02-01T01:23:45.678Z'); jest.useFakeTimers({ now }); const validToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjEyMyIsImhhc2giOiJtSkFZeDRXYjdrIiwiYnJvd3NlcklkIjoiOFpDVXE1YU1uSFhnMFZvcURLcm9hMHNaZ0NwdWlPQ1AzLzB2UmZKUXU0MD0iLCJpYXQiOjE3MDY3NTA2MjUsImV4cCI6MTcwNzM1NTQyNX0.YE-ZGGIQRNQ4DzUe9rjXvOOFFN9ufU34WibsCxAsc4o'; // Generated using `authService.issueJWT(user, browserId)` beforeEach(() => { jest.clearAllMocks(); jest.setSystemTime(now); config.set('userManagement.jwtSessionDurationHours', 168); config.set('userManagement.jwtRefreshTimeoutHours', 0); }); describe('createJWTHash', () => { it('should generate unique hashes', () => { expect(authService.createJWTHash(user)).toEqual('mJAYx4Wb7k'); expect( authService.createJWTHash(mock({ email: user.email, password: 'newPasswordHash' })), ).toEqual('FVALtU7AE0'); expect( authService.createJWTHash( mock({ email: 'test1@example.com', password: user.password }), ), ).toEqual('y8ha6X01jd'); }); }); describe('authMiddleware', () => { const req = mock({ cookies: {}, user: undefined, browserId, }); const res = mock(); const next = jest.fn() as NextFunction; beforeEach(() => { res.status.mockReturnThis(); }); it('should 401 if no cookie is set', async () => { req.cookies[AUTH_COOKIE_NAME] = undefined; await authService.authMiddleware(req, res, next); expect(next).not.toHaveBeenCalled(); expect(res.status).toHaveBeenCalledWith(401); }); it('should 401 and clear the cookie if the JWT is expired', async () => { req.cookies[AUTH_COOKIE_NAME] = validToken; jest.advanceTimersByTime(365 * Time.days.toMilliseconds); await authService.authMiddleware(req, res, next); expect(next).not.toHaveBeenCalled(); expect(res.status).toHaveBeenCalledWith(401); expect(res.clearCookie).toHaveBeenCalledWith(AUTH_COOKIE_NAME); }); it('should refresh the cookie before it expires', async () => { req.cookies[AUTH_COOKIE_NAME] = validToken; jest.advanceTimersByTime(6 * Time.days.toMilliseconds); userRepository.findOne.mockResolvedValue(user); await authService.authMiddleware(req, res, next); expect(next).toHaveBeenCalled(); expect(res.cookie).toHaveBeenCalledWith('n8n-auth', expect.any(String), { httpOnly: true, maxAge: 604800000, sameSite: 'lax', secure: false, }); }); }); describe('issueJWT', () => { describe('when not setting userManagement.jwtSessionDuration', () => { it('should default to expire in 7 days', () => { const defaultInSeconds = 7 * Time.days.toSeconds; const token = authService.issueJWT(user, browserId); expect(authService.jwtExpiration).toBe(defaultInSeconds); const decodedToken = jwtService.verify(token); if (decodedToken.exp === undefined || decodedToken.iat === undefined) { fail('Expected exp and iat to be defined'); } expect(decodedToken.exp - decodedToken.iat).toBe(defaultInSeconds); }); }); describe('when setting userManagement.jwtSessionDuration', () => { const testDurationHours = 1; const testDurationSeconds = testDurationHours * Time.hours.toSeconds; it('should apply it to tokens', () => { config.set('userManagement.jwtSessionDurationHours', testDurationHours); const token = authService.issueJWT(user, browserId); const decodedToken = jwtService.verify(token); if (decodedToken.exp === undefined || decodedToken.iat === undefined) { fail('Expected exp and iat to be defined on decodedToken'); } expect(decodedToken.exp - decodedToken.iat).toBe(testDurationSeconds); }); }); }); describe('resolveJwt', () => { const req = mock({ cookies: {}, user: undefined, browserId, }); const res = mock(); it('should throw on invalid tokens', async () => { await expect(authService.resolveJwt('random-string', req, res)).rejects.toThrow( 'jwt malformed', ); expect(res.cookie).not.toHaveBeenCalled(); }); it('should throw on expired tokens', async () => { jest.advanceTimersByTime(365 * Time.days.toMilliseconds); await expect(authService.resolveJwt(validToken, req, res)).rejects.toThrow('jwt expired'); expect(res.cookie).not.toHaveBeenCalled(); }); it('should throw on tampered tokens', async () => { const [header, payload, signature] = validToken.split('.'); const tamperedToken = [header, payload, signature + '123'].join('.'); await expect(authService.resolveJwt(tamperedToken, req, res)).rejects.toThrow( 'invalid signature', ); expect(res.cookie).not.toHaveBeenCalled(); }); it('should throw on hijacked tokens', async () => { userRepository.findOne.mockResolvedValue(user); const req = mock({ browserId: 'another-browser' }); await expect(authService.resolveJwt(validToken, req, res)).rejects.toThrow('Unauthorized'); expect(res.cookie).not.toHaveBeenCalled(); }); test.each([ ['no user is found', null], ['the user is disabled', { ...userData, disabled: true }], [ 'user password does not match the one on the token', { ...userData, password: 'something else' }, ], [ 'user email does not match the one on the token', { ...userData, email: 'someone@example.com' }, ], ])('should throw if %s', async (_, data) => { userRepository.findOne.mockResolvedValueOnce(data && mock(data)); await expect(authService.resolveJwt(validToken, req, res)).rejects.toThrow('Unauthorized'); expect(res.cookie).not.toHaveBeenCalled(); }); it('should refresh the cookie before it expires', async () => { userRepository.findOne.mockResolvedValue(user); expect(await authService.resolveJwt(validToken, req, res)).toEqual(user); expect(res.cookie).not.toHaveBeenCalled(); jest.advanceTimersByTime(6 * Time.days.toMilliseconds); // 6 Days expect(await authService.resolveJwt(validToken, req, res)).toEqual(user); expect(res.cookie).toHaveBeenCalledWith('n8n-auth', expect.any(String), { httpOnly: true, maxAge: 604800000, sameSite: 'lax', secure: false, }); }); it('should refresh the cookie only if less than 1/4th of time is left', async () => { userRepository.findOne.mockResolvedValue(user); expect(await authService.resolveJwt(validToken, req, res)).toEqual(user); expect(res.cookie).not.toHaveBeenCalled(); jest.advanceTimersByTime(5 * Time.days.toMilliseconds); expect(await authService.resolveJwt(validToken, req, res)).toEqual(user); expect(res.cookie).not.toHaveBeenCalled(); jest.advanceTimersByTime(1 * Time.days.toMilliseconds); expect(await authService.resolveJwt(validToken, req, res)).toEqual(user); expect(res.cookie).toHaveBeenCalled(); }); it('should not refresh the cookie if jwtRefreshTimeoutHours is set to -1', async () => { config.set('userManagement.jwtRefreshTimeoutHours', -1); userRepository.findOne.mockResolvedValue(user); expect(await authService.resolveJwt(validToken, req, res)).toEqual(user); expect(res.cookie).not.toHaveBeenCalled(); jest.advanceTimersByTime(6 * Time.days.toMilliseconds); // 6 Days expect(await authService.resolveJwt(validToken, req, res)).toEqual(user); expect(res.cookie).not.toHaveBeenCalled(); }); }); describe('generatePasswordResetUrl', () => { it('should generate a valid url', () => { urlService.getInstanceBaseUrl.mockReturnValue('https://n8n.instance'); const url = authService.generatePasswordResetUrl(user); expect(url).toEqual( 'https://n8n.instance/change-password?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjMiLCJoYXNoIjoibUpBWXg0V2I3ayIsImlhdCI6MTcwNjc1MDYyNSwiZXhwIjoxNzA2NzUxODI1fQ.rg90I7MKjc_KC77mov59XYAeRc-CoW9ka4mt1dCfrnk&mfaEnabled=false', ); }); }); describe('generatePasswordResetToken', () => { it('should generate valid password-reset tokens', () => { const token = authService.generatePasswordResetToken(user); const decoded = jwt.decode(token) as jwt.JwtPayload; if (!decoded.exp) fail('Token does not contain expiry'); if (!decoded.iat) fail('Token does not contain issued-at'); expect(decoded.sub).toEqual(user.id); expect(decoded.exp - decoded.iat).toEqual(1200); // Expires in 20 minutes expect(decoded.hash).toEqual('mJAYx4Wb7k'); }); }); describe('resolvePasswordResetToken', () => { it('should not return a user if the token in invalid', async () => { const resolvedUser = await authService.resolvePasswordResetToken('invalid-token'); expect(resolvedUser).toBeUndefined(); }); it('should not return a user if the token in expired', async () => { const token = authService.generatePasswordResetToken(user, '-1h'); const resolvedUser = await authService.resolvePasswordResetToken(token); expect(resolvedUser).toBeUndefined(); }); it('should not return a user if the user does not exist in the DB', async () => { userRepository.findOne.mockResolvedValueOnce(null); const token = authService.generatePasswordResetToken(user); const resolvedUser = await authService.resolvePasswordResetToken(token); expect(resolvedUser).toBeUndefined(); }); it('should not return a user if the password sha does not match', async () => { const token = authService.generatePasswordResetToken(user); const updatedUser = Object.create(user); updatedUser.password = 'something-else'; userRepository.findOne.mockResolvedValueOnce(updatedUser); const resolvedUser = await authService.resolvePasswordResetToken(token); expect(resolvedUser).toBeUndefined(); }); it('should not return the user if all checks pass', async () => { const token = authService.generatePasswordResetToken(user); userRepository.findOne.mockResolvedValueOnce(user); const resolvedUser = await authService.resolvePasswordResetToken(token); expect(resolvedUser).toEqual(user); }); }); });