refactor(core): Move some request DTOs to @n8n/api-types (no-changelog) (#10880)

This commit is contained in:
कारतोफ्फेलस्क्रिप्ट™
2024-09-20 21:14:06 +02:00
committed by GitHub
parent 583d3a7acb
commit 769ddfdd1d
35 changed files with 648 additions and 316 deletions

View File

@@ -33,6 +33,9 @@
"enabled": false "enabled": false
}, },
"javascript": { "javascript": {
"parser": {
"unsafeParameterDecoratorsEnabled": true
},
"formatter": { "formatter": {
"jsxQuoteStyle": "double", "jsxQuoteStyle": "double",
"quoteProperties": "asNeeded", "quoteProperties": "asNeeded",

View File

@@ -42,7 +42,7 @@ describe('Personal Settings', () => {
cy.getByTestId('personal-data-form').find('input[name="firstName"]').clear().type(name); cy.getByTestId('personal-data-form').find('input[name="firstName"]').clear().type(name);
cy.getByTestId('personal-data-form').find('input[name="lastName"]').clear().type(name); cy.getByTestId('personal-data-form').find('input[name="lastName"]').clear().type(name);
cy.getByTestId('save-settings-button').click(); cy.getByTestId('save-settings-button').click();
errorToast().should('contain', 'Potentially malicious string | Potentially malicious string'); errorToast().should('contain', 'Potentially malicious string');
errorToast().find('.el-notification__closeBtn').click(); errorToast().find('.el-notification__closeBtn').click();
}); });
}); });

View File

@@ -11,7 +11,8 @@
"lint": "eslint .", "lint": "eslint .",
"lintfix": "eslint . --fix", "lintfix": "eslint . --fix",
"watch": "tsc -p tsconfig.build.json --watch", "watch": "tsc -p tsconfig.build.json --watch",
"test": "echo \"No tests yet\" && exit 0" "test": "jest",
"test:dev": "jest --watch"
}, },
"main": "dist/index.js", "main": "dist/index.js",
"module": "src/index.ts", "module": "src/index.ts",
@@ -21,5 +22,10 @@
], ],
"devDependencies": { "devDependencies": {
"n8n-workflow": "workspace:*" "n8n-workflow": "workspace:*"
},
"dependencies": {
"xss": "catalog:",
"zod": "catalog:",
"zod-class": "0.0.15"
} }
} }

View File

@@ -0,0 +1,4 @@
export { PasswordUpdateRequestDto } from './user/password-update-request.dto';
export { RoleChangeRequestDto } from './user/role-change-request.dto';
export { SettingsUpdateRequestDto } from './user/settings-update-request.dto';
export { UserUpdateRequestDto } from './user/user-update-request.dto';

View File

@@ -0,0 +1,50 @@
import { PasswordUpdateRequestDto } from '../password-update-request.dto';
describe('PasswordUpdateRequestDto', () => {
it('should fail validation with missing currentPassword', () => {
const data = {
newPassword: 'newPassword123',
mfaCode: '123456',
};
const result = PasswordUpdateRequestDto.safeParse(data);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path[0]).toBe('currentPassword');
});
it('should fail validation with missing newPassword', () => {
const data = {
currentPassword: 'oldPassword123',
mfaCode: '123456',
};
const result = PasswordUpdateRequestDto.safeParse(data);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path[0]).toBe('newPassword');
});
it('should pass validation with missing mfaCode', () => {
const data = {
currentPassword: 'oldPassword123',
newPassword: 'newPassword123',
};
const result = PasswordUpdateRequestDto.safeParse(data);
expect(result.success).toBe(true);
});
it('should pass validation with valid data', () => {
const data = {
currentPassword: 'oldPassword123',
newPassword: 'newPassword123',
mfaCode: '123456',
};
const result = PasswordUpdateRequestDto.safeParse(data);
expect(result.success).toBe(true);
});
});

View File

@@ -0,0 +1,37 @@
import { RoleChangeRequestDto } from '../role-change-request.dto';
describe('RoleChangeRequestDto', () => {
it('should fail validation with missing newRoleName', () => {
const data = {};
const result = RoleChangeRequestDto.safeParse(data);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path[0]).toBe('newRoleName');
expect(result.error?.issues[0].message).toBe('New role is required');
});
it('should fail validation with invalid newRoleName', () => {
const data = {
newRoleName: 'invalidRole',
};
const result = RoleChangeRequestDto.safeParse(data);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path[0]).toBe('newRoleName');
expect(result.error?.issues[0].message).toBe(
"Invalid enum value. Expected 'global:admin' | 'global:member', received 'invalidRole'",
);
});
it('should pass validation with valid data', () => {
const data = {
newRoleName: 'global:admin',
};
const result = RoleChangeRequestDto.safeParse(data);
expect(result.success).toBe(true);
});
});

View File

@@ -0,0 +1,68 @@
import { SettingsUpdateRequestDto } from '../settings-update-request.dto';
describe('SettingsUpdateRequestDto', () => {
it('should pass validation with missing userActivated', () => {
const data = {
allowSSOManualLogin: false,
};
const result = SettingsUpdateRequestDto.safeParse(data);
expect(result.success).toBe(true);
});
it('should pass validation with missing allowSSOManualLogin', () => {
const data = {
userActivated: true,
};
const result = SettingsUpdateRequestDto.safeParse(data);
expect(result.success).toBe(true);
});
it('should pass validation with missing userActivated and allowSSOManualLogin', () => {
const data = {};
const result = SettingsUpdateRequestDto.safeParse(data);
expect(result.success).toBe(true);
});
it('should fail validation with invalid userActivated', () => {
const data = {
userActivated: 'invalid',
allowSSOManualLogin: false,
};
const result = SettingsUpdateRequestDto.safeParse(data);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path[0]).toBe('userActivated');
expect(result.error?.issues[0].message).toBe('Expected boolean, received string');
});
it('should fail validation with invalid allowSSOManualLogin', () => {
const data = {
userActivated: true,
allowSSOManualLogin: 'invalid',
};
const result = SettingsUpdateRequestDto.safeParse(data);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path[0]).toBe('allowSSOManualLogin');
expect(result.error?.issues[0].message).toBe('Expected boolean, received string');
});
it('should pass validation with valid data', () => {
const data = {
userActivated: true,
allowSSOManualLogin: false,
};
const result = SettingsUpdateRequestDto.safeParse(data);
expect(result.success).toBe(true);
});
});

View File

@@ -0,0 +1,86 @@
import { UserUpdateRequestDto } from '../user-update-request.dto';
describe('UserUpdateRequestDto', () => {
it('should fail validation for an invalid email', () => {
const invalidRequest = {
email: 'invalid-email',
firstName: 'John',
lastName: 'Doe',
mfaCode: '123456',
};
const result = UserUpdateRequestDto.safeParse(invalidRequest);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path).toEqual(['email']);
});
it('should fail validation for a firstName with potential XSS attack', () => {
const invalidRequest = {
email: 'test@example.com',
firstName: '<script>alert("XSS")</script>',
lastName: 'Doe',
mfaCode: '123456',
};
const result = UserUpdateRequestDto.safeParse(invalidRequest);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path).toEqual(['firstName']);
});
it('should fail validation for a firstName with a URL', () => {
const invalidRequest = {
email: 'test@example.com',
firstName: 'test http://malicious.com',
lastName: 'Doe',
mfaCode: '123456',
};
const result = UserUpdateRequestDto.safeParse(invalidRequest);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path).toEqual(['firstName']);
});
it('should fail validation for a lastName with potential XSS attack', () => {
const invalidRequest = {
email: 'test@example.com',
firstName: 'John',
lastName: '<script>alert("XSS")</script>',
mfaCode: '123456',
};
const result = UserUpdateRequestDto.safeParse(invalidRequest);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path).toEqual(['lastName']);
});
it('should fail validation for a lastName with a URL', () => {
const invalidRequest = {
email: 'test@example.com',
firstName: 'John',
lastName: 'testing http://malicious.com',
mfaCode: '123456',
};
const result = UserUpdateRequestDto.safeParse(invalidRequest);
expect(result.success).toBe(false);
expect(result.error?.issues[0].path).toEqual(['lastName']);
});
it('should validate a valid user update request', () => {
const validRequest = {
email: 'test@example.com',
firstName: 'John',
lastName: 'Doe',
mfaCode: '123456',
};
const result = UserUpdateRequestDto.safeParse(validRequest);
expect(result.success).toBe(true);
});
});

View File

@@ -0,0 +1,8 @@
import { z } from 'zod';
import { Z } from 'zod-class';
export class PasswordUpdateRequestDto extends Z.class({
currentPassword: z.string(),
newPassword: z.string(),
mfaCode: z.string().optional(),
}) {}

View File

@@ -0,0 +1,8 @@
import { z } from 'zod';
import { Z } from 'zod-class';
export class RoleChangeRequestDto extends Z.class({
newRoleName: z.enum(['global:admin', 'global:member'], {
required_error: 'New role is required',
}),
}) {}

View File

@@ -0,0 +1,7 @@
import { z } from 'zod';
import { Z } from 'zod-class';
export class SettingsUpdateRequestDto extends Z.class({
userActivated: z.boolean().optional(),
allowSSOManualLogin: z.boolean().optional(),
}) {}

View File

@@ -0,0 +1,31 @@
import xss from 'xss';
import { z } from 'zod';
import { Z } from 'zod-class';
const xssCheck = (value: string) =>
value ===
xss(value, {
whiteList: {}, // no tags are allowed
});
const URL_REGEX = /^(https?:\/\/|www\.)|(\.[\p{L}\d-]+)/iu;
const urlCheck = (value: string) => !URL_REGEX.test(value);
const nameSchema = () =>
z
.string()
.min(1)
.max(32)
.refine(xssCheck, {
message: 'Potentially malicious string',
})
.refine(urlCheck, {
message: 'Potentially malicious string',
});
export class UserUpdateRequestDto extends Z.class({
email: z.string().email(),
firstName: nameSchema().optional(),
lastName: nameSchema().optional(),
mfaCode: z.string().optional(),
}) {}

View File

@@ -1,4 +1,5 @@
export type * from './datetime'; export type * from './datetime';
export * from './dto';
export type * from './push'; export type * from './push';
export type * from './scaling'; export type * from './scaling';
export type * from './frontend-settings'; export type * from './frontend-settings';

View File

@@ -174,7 +174,7 @@
"ws": "8.17.1", "ws": "8.17.1",
"xml2js": "catalog:", "xml2js": "catalog:",
"xmllint-wasm": "3.0.1", "xmllint-wasm": "3.0.1",
"xss": "^1.0.14", "xss": "catalog:",
"yamljs": "0.3.0", "yamljs": "0.3.0",
"zod": "catalog:" "zod": "catalog:"
} }

View File

@@ -1,3 +1,4 @@
import { UserUpdateRequestDto } from '@n8n/api-types';
import type { Response } from 'express'; import type { Response } from 'express';
import { mock, anyObject } from 'jest-mock-extended'; import { mock, anyObject } from 'jest-mock-extended';
import jwt from 'jsonwebtoken'; import jwt from 'jsonwebtoken';
@@ -35,20 +36,6 @@ describe('MeController', () => {
const controller = Container.get(MeController); const controller = Container.get(MeController);
describe('updateCurrentUser', () => { describe('updateCurrentUser', () => {
it('should throw BadRequestError if email is missing in the payload', async () => {
const req = mock<MeRequest.UserUpdate>({});
await expect(controller.updateCurrentUser(req, mock())).rejects.toThrowError(
new BadRequestError('Email is mandatory'),
);
});
it('should throw BadRequestError if email is invalid', async () => {
const req = mock<MeRequest.UserUpdate>({ body: { email: 'invalid-email' } });
await expect(controller.updateCurrentUser(req, mock())).rejects.toThrowError(
new BadRequestError('Invalid email address'),
);
});
it('should update the user in the DB, and issue a new cookie', async () => { it('should update the user in the DB, and issue a new cookie', async () => {
const user = mock<User>({ const user = mock<User>({
id: '123', id: '123',
@@ -58,24 +45,24 @@ describe('MeController', () => {
role: 'global:owner', role: 'global:owner',
mfaEnabled: false, mfaEnabled: false,
}); });
const req = mock<MeRequest.UserUpdate>({ user, browserId }); const payload = new UserUpdateRequestDto({
req.body = {
email: 'valid@email.com', email: 'valid@email.com',
firstName: 'John', firstName: 'John',
lastName: 'Potato', lastName: 'Potato',
}; });
const req = mock<AuthenticatedRequest>({ user, browserId });
const res = mock<Response>(); const res = mock<Response>();
userRepository.findOneByOrFail.mockResolvedValue(user); userRepository.findOneByOrFail.mockResolvedValue(user);
userRepository.findOneOrFail.mockResolvedValue(user); userRepository.findOneOrFail.mockResolvedValue(user);
jest.spyOn(jwt, 'sign').mockImplementation(() => 'signed-token'); jest.spyOn(jwt, 'sign').mockImplementation(() => 'signed-token');
userService.toPublic.mockResolvedValue({} as unknown as PublicUser); userService.toPublic.mockResolvedValue({} as unknown as PublicUser);
await controller.updateCurrentUser(req, res); await controller.updateCurrentUser(req, res, payload);
expect(externalHooks.run).toHaveBeenCalledWith('user.profile.beforeUpdate', [ expect(externalHooks.run).toHaveBeenCalledWith('user.profile.beforeUpdate', [
user.id, user.id,
user.email, user.email,
req.body, payload,
]); ]);
expect(userService.update).toHaveBeenCalled(); expect(userService.update).toHaveBeenCalled();
@@ -100,35 +87,6 @@ describe('MeController', () => {
]); ]);
}); });
it('should not allow updating any other fields on a user besides email and name', async () => {
const user = mock<User>({
id: '123',
password: 'password',
authIdentities: [],
role: 'global:member',
mfaEnabled: false,
});
const req = mock<MeRequest.UserUpdate>({ user, browserId });
req.body = { email: 'valid@email.com', firstName: 'John', lastName: 'Potato' };
const res = mock<Response>();
userRepository.findOneOrFail.mockResolvedValue(user);
jest.spyOn(jwt, 'sign').mockImplementation(() => 'signed-token');
// Add invalid data to the request payload
Object.assign(req.body, { id: '0', role: 'global:owner' });
await controller.updateCurrentUser(req, res);
expect(userService.update).toHaveBeenCalled();
const updatePayload = userService.update.mock.calls[0][1];
expect(updatePayload.email).toBe(req.body.email);
expect(updatePayload.firstName).toBe(req.body.firstName);
expect(updatePayload.lastName).toBe(req.body.lastName);
expect(updatePayload.id).toBeUndefined();
expect(updatePayload.role).toBeUndefined();
});
it('should throw BadRequestError if beforeUpdate hook throws BadRequestError', async () => { it('should throw BadRequestError if beforeUpdate hook throws BadRequestError', async () => {
const user = mock<User>({ const user = mock<User>({
id: '123', id: '123',
@@ -137,9 +95,7 @@ describe('MeController', () => {
role: 'global:owner', role: 'global:owner',
mfaEnabled: false, mfaEnabled: false,
}); });
const reqBody = { email: 'valid@email.com', firstName: 'John', lastName: 'Potato' }; const req = mock<AuthenticatedRequest>({ user });
const req = mock<MeRequest.UserUpdate>({ user, body: reqBody });
req.body = reqBody; // We don't want the body to be a mock object
externalHooks.run.mockImplementationOnce(async (hookName) => { externalHooks.run.mockImplementationOnce(async (hookName) => {
if (hookName === 'user.profile.beforeUpdate') { if (hookName === 'user.profile.beforeUpdate') {
@@ -147,9 +103,13 @@ describe('MeController', () => {
} }
}); });
await expect(controller.updateCurrentUser(req, mock())).rejects.toThrowError( await expect(
new BadRequestError('Invalid email address'), controller.updateCurrentUser(
); req,
mock(),
mock({ email: 'valid@email.com', firstName: 'John', lastName: 'Potato' }),
),
).rejects.toThrowError(new BadRequestError('Invalid email address'));
}); });
describe('when mfa is enabled', () => { describe('when mfa is enabled', () => {
@@ -162,12 +122,19 @@ describe('MeController', () => {
role: 'global:owner', role: 'global:owner',
mfaEnabled: true, mfaEnabled: true,
}); });
const req = mock<MeRequest.UserUpdate>({ user, browserId }); const req = mock<AuthenticatedRequest>({ user, browserId });
req.body = { email: 'new@email.com', firstName: 'John', lastName: 'Potato' };
await expect(controller.updateCurrentUser(req, mock())).rejects.toThrowError( await expect(
new BadRequestError('Two-factor code is required to change email'), controller.updateCurrentUser(
); req,
mock(),
new UserUpdateRequestDto({
email: 'new@email.com',
firstName: 'John',
lastName: 'Potato',
}),
),
).rejects.toThrowError(new BadRequestError('Two-factor code is required to change email'));
}); });
it('should throw InvalidMfaCodeError if mfa code is invalid', async () => { it('should throw InvalidMfaCodeError if mfa code is invalid', async () => {
@@ -179,18 +146,21 @@ describe('MeController', () => {
role: 'global:owner', role: 'global:owner',
mfaEnabled: true, mfaEnabled: true,
}); });
const req = mock<MeRequest.UserUpdate>({ user, browserId }); const req = mock<AuthenticatedRequest>({ user, browserId });
req.body = { mockMfaService.validateMfa.mockResolvedValue(false);
await expect(
controller.updateCurrentUser(
req,
mock(),
mock({
email: 'new@email.com', email: 'new@email.com',
firstName: 'John', firstName: 'John',
lastName: 'Potato', lastName: 'Potato',
mfaCode: 'invalid', mfaCode: 'invalid',
}; }),
mockMfaService.validateMfa.mockResolvedValue(false); ),
).rejects.toThrow(InvalidMfaCodeError);
await expect(controller.updateCurrentUser(req, mock())).rejects.toThrow(
InvalidMfaCodeError,
);
}); });
it("should update the user's email if mfa code is valid", async () => { it("should update the user's email if mfa code is valid", async () => {
@@ -202,13 +172,7 @@ describe('MeController', () => {
role: 'global:owner', role: 'global:owner',
mfaEnabled: true, mfaEnabled: true,
}); });
const req = mock<MeRequest.UserUpdate>({ user, browserId }); const req = mock<AuthenticatedRequest>({ user, browserId });
req.body = {
email: 'new@email.com',
firstName: 'John',
lastName: 'Potato',
mfaCode: '123456',
};
const res = mock<Response>(); const res = mock<Response>();
userRepository.findOneByOrFail.mockResolvedValue(user); userRepository.findOneByOrFail.mockResolvedValue(user);
userRepository.findOneOrFail.mockResolvedValue(user); userRepository.findOneOrFail.mockResolvedValue(user);
@@ -216,7 +180,16 @@ describe('MeController', () => {
userService.toPublic.mockResolvedValue({} as unknown as PublicUser); userService.toPublic.mockResolvedValue({} as unknown as PublicUser);
mockMfaService.validateMfa.mockResolvedValue(true); mockMfaService.validateMfa.mockResolvedValue(true);
const result = await controller.updateCurrentUser(req, res); const result = await controller.updateCurrentUser(
req,
res,
mock({
email: 'new@email.com',
firstName: 'John',
lastName: 'Potato',
mfaCode: '123456',
}),
);
expect(result).toEqual({}); expect(result).toEqual({});
}); });
@@ -227,51 +200,59 @@ describe('MeController', () => {
const passwordHash = '$2a$10$ffitcKrHT.Ls.m9FfWrMrOod76aaI0ogKbc3S96Q320impWpCbgj6'; // Hashed 'old_password' const passwordHash = '$2a$10$ffitcKrHT.Ls.m9FfWrMrOod76aaI0ogKbc3S96Q320impWpCbgj6'; // Hashed 'old_password'
it('should throw if the user does not have a password set', async () => { it('should throw if the user does not have a password set', async () => {
const req = mock<MeRequest.Password>({ const req = mock<AuthenticatedRequest>({
user: mock({ password: undefined }), user: mock({ password: undefined }),
body: { currentPassword: '', newPassword: '' },
}); });
await expect(controller.updatePassword(req, mock())).rejects.toThrowError( await expect(
new BadRequestError('Requesting user not set up.'), controller.updatePassword(req, mock(), mock({ currentPassword: '', newPassword: '' })),
); ).rejects.toThrowError(new BadRequestError('Requesting user not set up.'));
}); });
it("should throw if currentPassword does not match the user's password", async () => { it("should throw if currentPassword does not match the user's password", async () => {
const req = mock<MeRequest.Password>({ const req = mock<AuthenticatedRequest>({
user: mock({ password: passwordHash }), user: mock({ password: passwordHash }),
body: { currentPassword: 'not_old_password', newPassword: '' },
}); });
await expect(controller.updatePassword(req, mock())).rejects.toThrowError( await expect(
new BadRequestError('Provided current password is incorrect.'), controller.updatePassword(
); req,
mock(),
mock({ currentPassword: 'not_old_password', newPassword: '' }),
),
).rejects.toThrowError(new BadRequestError('Provided current password is incorrect.'));
}); });
describe('should throw if newPassword is not valid', () => { describe('should throw if newPassword is not valid', () => {
Object.entries(badPasswords).forEach(([newPassword, errorMessage]) => { Object.entries(badPasswords).forEach(([newPassword, errorMessage]) => {
it(newPassword, async () => { it(newPassword, async () => {
const req = mock<MeRequest.Password>({ const req = mock<AuthenticatedRequest>({
user: mock({ password: passwordHash }), user: mock({ password: passwordHash }),
body: { currentPassword: 'old_password', newPassword },
browserId, browserId,
}); });
await expect(controller.updatePassword(req, mock())).rejects.toThrowError( await expect(
new BadRequestError(errorMessage), controller.updatePassword(
); req,
mock(),
mock({ currentPassword: 'old_password', newPassword }),
),
).rejects.toThrowError(new BadRequestError(errorMessage));
}); });
}); });
}); });
it('should update the password in the DB, and issue a new cookie', async () => { it('should update the password in the DB, and issue a new cookie', async () => {
const req = mock<MeRequest.Password>({ const req = mock<AuthenticatedRequest>({
user: mock({ password: passwordHash, mfaEnabled: false }), user: mock({ password: passwordHash, mfaEnabled: false }),
body: { currentPassword: 'old_password', newPassword: 'NewPassword123' },
browserId, browserId,
}); });
const res = mock<Response>(); const res = mock<Response>();
userRepository.save.calledWith(req.user).mockResolvedValue(req.user); userRepository.save.calledWith(req.user).mockResolvedValue(req.user);
jest.spyOn(jwt, 'sign').mockImplementation(() => 'new-signed-token'); jest.spyOn(jwt, 'sign').mockImplementation(() => 'new-signed-token');
await controller.updatePassword(req, res); await controller.updatePassword(
req,
res,
mock({ currentPassword: 'old_password', newPassword: 'NewPassword123' }),
);
expect(req.user.password).not.toBe(passwordHash); expect(req.user.password).not.toBe(passwordHash);
@@ -299,34 +280,43 @@ describe('MeController', () => {
describe('mfa enabled', () => { describe('mfa enabled', () => {
it('should throw BadRequestError if mfa code is missing', async () => { it('should throw BadRequestError if mfa code is missing', async () => {
const req = mock<MeRequest.Password>({ const req = mock<AuthenticatedRequest>({
user: mock({ password: passwordHash, mfaEnabled: true }), user: mock({ password: passwordHash, mfaEnabled: true }),
body: { currentPassword: 'old_password', newPassword: 'NewPassword123' },
}); });
await expect(controller.updatePassword(req, mock())).rejects.toThrowError( await expect(
controller.updatePassword(
req,
mock(),
mock({ currentPassword: 'old_password', newPassword: 'NewPassword123' }),
),
).rejects.toThrowError(
new BadRequestError('Two-factor code is required to change password.'), new BadRequestError('Two-factor code is required to change password.'),
); );
}); });
it('should throw InvalidMfaCodeError if invalid mfa code is given', async () => { it('should throw InvalidMfaCodeError if invalid mfa code is given', async () => {
const req = mock<MeRequest.Password>({ const req = mock<AuthenticatedRequest>({
user: mock({ password: passwordHash, mfaEnabled: true }), user: mock({ password: passwordHash, mfaEnabled: true }),
body: { currentPassword: 'old_password', newPassword: 'NewPassword123', mfaCode: '123' },
}); });
mockMfaService.validateMfa.mockResolvedValue(false); mockMfaService.validateMfa.mockResolvedValue(false);
await expect(controller.updatePassword(req, mock())).rejects.toThrow(InvalidMfaCodeError); await expect(
controller.updatePassword(
req,
mock(),
mock({
currentPassword: 'old_password',
newPassword: 'NewPassword123',
mfaCode: '123',
}),
),
).rejects.toThrow(InvalidMfaCodeError);
}); });
it('should succeed when mfa code is correct', async () => { it('should succeed when mfa code is correct', async () => {
const req = mock<MeRequest.Password>({ const req = mock<AuthenticatedRequest>({
user: mock({ password: passwordHash, mfaEnabled: true }), user: mock({ password: passwordHash, mfaEnabled: true }),
body: {
currentPassword: 'old_password',
newPassword: 'NewPassword123',
mfaCode: 'valid',
},
browserId, browserId,
}); });
const res = mock<Response>(); const res = mock<Response>();
@@ -334,7 +324,15 @@ describe('MeController', () => {
jest.spyOn(jwt, 'sign').mockImplementation(() => 'new-signed-token'); jest.spyOn(jwt, 'sign').mockImplementation(() => 'new-signed-token');
mockMfaService.validateMfa.mockResolvedValue(true); mockMfaService.validateMfa.mockResolvedValue(true);
const result = await controller.updatePassword(req, res); const result = await controller.updatePassword(
req,
res,
mock({
currentPassword: 'old_password',
newPassword: 'NewPassword123',
mfaCode: 'valid',
}),
);
expect(result).toEqual({ success: true }); expect(result).toEqual({ success: true });
expect(req.user.password).not.toBe(passwordHash); expect(req.user.password).not.toBe(passwordHash);
@@ -411,18 +409,6 @@ describe('MeController', () => {
}); });
}); });
describe('updateCurrentUserSettings', () => {
it('should throw BadRequestError on XSS attempt', async () => {
const req = mock<AuthenticatedRequest>({
body: {
userActivated: '<script>alert("XSS")</script>',
},
});
await expect(controller.updateCurrentUserSettings(req)).rejects.toThrowError(BadRequestError);
});
});
describe('API Key methods', () => { describe('API Key methods', () => {
let req: AuthenticatedRequest; let req: AuthenticatedRequest;
beforeAll(() => { beforeAll(() => {

View File

@@ -3,7 +3,7 @@ import { mock } from 'jest-mock-extended';
import type { User } from '@/databases/entities/user'; import type { User } from '@/databases/entities/user';
import type { UserRepository } from '@/databases/repositories/user.repository'; import type { UserRepository } from '@/databases/repositories/user.repository';
import type { EventService } from '@/events/event.service'; import type { EventService } from '@/events/event.service';
import type { UserRequest } from '@/requests'; import type { AuthenticatedRequest } from '@/requests';
import type { ProjectService } from '@/services/project.service'; import type { ProjectService } from '@/services/project.service';
import { UsersController } from '../users.controller'; import { UsersController } from '../users.controller';
@@ -33,15 +33,18 @@ describe('UsersController', () => {
describe('changeGlobalRole', () => { describe('changeGlobalRole', () => {
it('should emit event user-changed-role', async () => { it('should emit event user-changed-role', async () => {
const request = mock<UserRequest.ChangeRole>({ const request = mock<AuthenticatedRequest>({
user: { id: '123' }, user: { id: '123' },
params: { id: '456' },
body: { newRoleName: 'global:member' },
}); });
userRepository.findOne.mockResolvedValue(mock<User>({ id: '456' })); userRepository.findOneBy.mockResolvedValue(mock<User>({ id: '456' }));
projectService.getUserOwnedOrAdminProjects.mockResolvedValue([]); projectService.getUserOwnedOrAdminProjects.mockResolvedValue([]);
await controller.changeGlobalRole(request); await controller.changeGlobalRole(
request,
mock(),
mock({ newRoleName: 'global:member' }),
'456',
);
expect(eventService.emit).toHaveBeenCalledWith('user-changed-role', { expect(eventService.emit).toHaveBeenCalledWith('user-changed-role', {
userId: '123', userId: '123',

View File

@@ -1,12 +1,16 @@
import {
PasswordUpdateRequestDto,
SettingsUpdateRequestDto,
UserUpdateRequestDto,
} from '@n8n/api-types';
import { plainToInstance } from 'class-transformer'; import { plainToInstance } from 'class-transformer';
import { randomBytes } from 'crypto'; import { randomBytes } from 'crypto';
import { type RequestHandler, Response } from 'express'; import { type RequestHandler, Response } from 'express';
import validator from 'validator';
import { AuthService } from '@/auth/auth.service'; import { AuthService } from '@/auth/auth.service';
import type { User } from '@/databases/entities/user'; import type { User } from '@/databases/entities/user';
import { UserRepository } from '@/databases/repositories/user.repository'; import { UserRepository } from '@/databases/repositories/user.repository';
import { Delete, Get, Patch, Post, RestController } from '@/decorators'; import { Body, Delete, Get, Patch, Post, RestController } from '@/decorators';
import { BadRequestError } from '@/errors/response-errors/bad-request.error'; import { BadRequestError } from '@/errors/response-errors/bad-request.error';
import { InvalidMfaCodeError } from '@/errors/response-errors/invalid-mfa-code.error'; import { InvalidMfaCodeError } from '@/errors/response-errors/invalid-mfa-code.error';
import { EventService } from '@/events/event.service'; import { EventService } from '@/events/event.service';
@@ -16,12 +20,7 @@ import type { PublicUser } from '@/interfaces';
import { Logger } from '@/logger'; import { Logger } from '@/logger';
import { MfaService } from '@/mfa/mfa.service'; import { MfaService } from '@/mfa/mfa.service';
import { isApiEnabled } from '@/public-api'; import { isApiEnabled } from '@/public-api';
import { import { AuthenticatedRequest, MeRequest } from '@/requests';
AuthenticatedRequest,
MeRequest,
UserSettingsUpdatePayload,
UserUpdatePayload,
} from '@/requests';
import { PasswordUtility } from '@/services/password.utility'; import { PasswordUtility } from '@/services/password.utility';
import { UserService } from '@/services/user.service'; import { UserService } from '@/services/user.service';
import { isSamlLicensedAndEnabled } from '@/sso/saml/saml-helpers'; import { isSamlLicensedAndEnabled } from '@/sso/saml/saml-helpers';
@@ -55,30 +54,14 @@ export class MeController {
* Update the logged-in user's properties, except password. * Update the logged-in user's properties, except password.
*/ */
@Patch('/') @Patch('/')
async updateCurrentUser(req: MeRequest.UserUpdate, res: Response): Promise<PublicUser> { async updateCurrentUser(
req: AuthenticatedRequest,
res: Response,
@Body payload: UserUpdateRequestDto,
): Promise<PublicUser> {
const { id: userId, email: currentEmail, mfaEnabled } = req.user; const { id: userId, email: currentEmail, mfaEnabled } = req.user;
const payload = plainToInstance(UserUpdatePayload, req.body, { excludeExtraneousValues: true });
const { email } = payload; const { email } = payload;
if (!email) {
this.logger.debug('Request to update user email failed because of missing email in payload', {
userId,
payload,
});
throw new BadRequestError('Email is mandatory');
}
if (!validator.isEmail(email)) {
this.logger.debug('Request to update user email failed because of invalid email in payload', {
userId,
invalidEmail: email,
});
throw new BadRequestError('Invalid email address');
}
await validateEntity(payload);
const isEmailBeingChanged = email !== currentEmail; const isEmailBeingChanged = email !== currentEmail;
// If SAML is enabled, we don't allow the user to change their email address // If SAML is enabled, we don't allow the user to change their email address
@@ -134,9 +117,13 @@ export class MeController {
* Update the logged-in user's password. * Update the logged-in user's password.
*/ */
@Patch('/password', { rateLimit: true }) @Patch('/password', { rateLimit: true })
async updatePassword(req: MeRequest.Password, res: Response) { async updatePassword(
req: AuthenticatedRequest,
res: Response,
@Body payload: PasswordUpdateRequestDto,
) {
const { user } = req; const { user } = req;
const { currentPassword, newPassword, mfaCode } = req.body; const { currentPassword, newPassword, mfaCode } = payload;
// If SAML is enabled, we don't allow the user to change their password // If SAML is enabled, we don't allow the user to change their password
if (isSamlLicensedAndEnabled()) { if (isSamlLicensedAndEnabled()) {
@@ -270,13 +257,11 @@ export class MeController {
* Update the logged-in user's settings. * Update the logged-in user's settings.
*/ */
@Patch('/settings') @Patch('/settings')
async updateCurrentUserSettings(req: MeRequest.UserSettingsUpdate): Promise<User['settings']> { async updateCurrentUserSettings(
const payload = plainToInstance(UserSettingsUpdatePayload, req.body, { req: AuthenticatedRequest,
excludeExtraneousValues: true, _: Response,
}); @Body payload: SettingsUpdateRequestDto,
): Promise<User['settings']> {
await validateEntity(payload);
const { id } = req.user; const { id } = req.user;
await this.userService.updateSettings(id, payload); await this.userService.updateSettings(id, payload);

View File

@@ -1,4 +1,5 @@
import { plainToInstance } from 'class-transformer'; import { RoleChangeRequestDto, SettingsUpdateRequestDto } from '@n8n/api-types';
import { Response } from 'express';
import { AuthService } from '@/auth/auth.service'; import { AuthService } from '@/auth/auth.service';
import { CredentialsService } from '@/credentials/credentials.service'; import { CredentialsService } from '@/credentials/credentials.service';
@@ -9,22 +10,17 @@ import { ProjectRepository } from '@/databases/repositories/project.repository';
import { SharedCredentialsRepository } from '@/databases/repositories/shared-credentials.repository'; import { SharedCredentialsRepository } from '@/databases/repositories/shared-credentials.repository';
import { SharedWorkflowRepository } from '@/databases/repositories/shared-workflow.repository'; import { SharedWorkflowRepository } from '@/databases/repositories/shared-workflow.repository';
import { UserRepository } from '@/databases/repositories/user.repository'; import { UserRepository } from '@/databases/repositories/user.repository';
import { GlobalScope, Delete, Get, RestController, Patch, Licensed } from '@/decorators'; import { GlobalScope, Delete, Get, RestController, Patch, Licensed, Body } from '@/decorators';
import { Param } from '@/decorators/args';
import { BadRequestError } from '@/errors/response-errors/bad-request.error'; import { BadRequestError } from '@/errors/response-errors/bad-request.error';
import { ForbiddenError } from '@/errors/response-errors/forbidden.error'; import { ForbiddenError } from '@/errors/response-errors/forbidden.error';
import { NotFoundError } from '@/errors/response-errors/not-found.error'; import { NotFoundError } from '@/errors/response-errors/not-found.error';
import { EventService } from '@/events/event.service'; import { EventService } from '@/events/event.service';
import { ExternalHooks } from '@/external-hooks'; import { ExternalHooks } from '@/external-hooks';
import { validateEntity } from '@/generic-helpers';
import type { PublicUser } from '@/interfaces'; import type { PublicUser } from '@/interfaces';
import { Logger } from '@/logger'; import { Logger } from '@/logger';
import { listQueryMiddleware } from '@/middlewares'; import { listQueryMiddleware } from '@/middlewares';
import { import { AuthenticatedRequest, ListQuery, UserRequest } from '@/requests';
ListQuery,
UserRequest,
UserRoleChangePayload,
UserSettingsUpdatePayload,
} from '@/requests';
import { ProjectService } from '@/services/project.service'; import { ProjectService } from '@/services/project.service';
import { UserService } from '@/services/user.service'; import { UserService } from '@/services/user.service';
import { WorkflowService } from '@/workflows/workflow.service'; import { WorkflowService } from '@/workflows/workflow.service';
@@ -124,13 +120,12 @@ export class UsersController {
@Patch('/:id/settings') @Patch('/:id/settings')
@GlobalScope('user:update') @GlobalScope('user:update')
async updateUserSettings(req: UserRequest.UserSettingsUpdate) { async updateUserSettings(
const payload = plainToInstance(UserSettingsUpdatePayload, req.body, { _req: AuthenticatedRequest,
excludeExtraneousValues: true, _res: Response,
}); @Body payload: SettingsUpdateRequestDto,
@Param('id') id: string,
const id = req.params.id; ) {
await this.userService.updateSettings(id, payload); await this.userService.updateSettings(id, payload);
const user = await this.userRepository.findOneOrFail({ const user = await this.userRepository.findOneOrFail({
@@ -263,18 +258,16 @@ export class UsersController {
@Patch('/:id/role') @Patch('/:id/role')
@GlobalScope('user:changeRole') @GlobalScope('user:changeRole')
@Licensed('feat:advancedPermissions') @Licensed('feat:advancedPermissions')
async changeGlobalRole(req: UserRequest.ChangeRole) { async changeGlobalRole(
req: AuthenticatedRequest,
_: Response,
@Body payload: RoleChangeRequestDto,
@Param('id') id: string,
) {
const { NO_ADMIN_ON_OWNER, NO_USER, NO_OWNER_ON_OWNER } = const { NO_ADMIN_ON_OWNER, NO_USER, NO_OWNER_ON_OWNER } =
UsersController.ERROR_MESSAGES.CHANGE_ROLE; UsersController.ERROR_MESSAGES.CHANGE_ROLE;
const payload = plainToInstance(UserRoleChangePayload, req.body, { const targetUser = await this.userRepository.findOneBy({ id });
excludeExtraneousValues: true,
});
await validateEntity(payload);
const targetUser = await this.userRepository.findOne({
where: { id: req.params.id },
});
if (targetUser === null) { if (targetUser === null) {
throw new NotFoundError(NO_USER); throw new NotFoundError(NO_USER);
} }

View File

@@ -12,6 +12,8 @@ import { ControllerRegistry, Get, Licensed, RestController } from '@/decorators'
import type { License } from '@/license'; import type { License } from '@/license';
import type { SuperAgentTest } from '@test-integration/types'; import type { SuperAgentTest } from '@test-integration/types';
import { Param } from '../args';
describe('ControllerRegistry', () => { describe('ControllerRegistry', () => {
const license = mock<License>(); const license = mock<License>();
const authService = mock<AuthService>(); const authService = mock<AuthService>();
@@ -114,4 +116,26 @@ describe('ControllerRegistry', () => {
expect(license.isFeatureEnabled).toHaveBeenCalled(); expect(license.isFeatureEnabled).toHaveBeenCalled();
}); });
}); });
describe('Args', () => {
@RestController('/test')
// @ts-expect-error tsc complains about unused class
class TestController {
@Get('/args/:id')
args(req: express.Request, res: express.Response, @Param('id') id: string) {
res.setHeader('Testing', 'true');
return { url: req.url, id };
}
}
beforeEach(() => {
authService.authMiddleware.mockImplementation(async (_req, _res, next) => next());
});
it('should pass in correct args to the route handler', async () => {
const { headers, body } = await agent.get('/rest/test/args/1234').expect(200);
expect(headers.testing).toBe('true');
expect(body.data).toEqual({ url: '/args/1234', id: '1234' });
});
});
}); });

View File

@@ -0,0 +1,18 @@
import { getRouteMetadata } from './controller.registry';
import type { Arg, Controller } from './types';
const ArgDecorator =
(arg: Arg): ParameterDecorator =>
(target, handlerName, parameterIndex) => {
const routeMetadata = getRouteMetadata(target.constructor as Controller, String(handlerName));
routeMetadata.args[parameterIndex] = arg;
};
/** Injects the request body into the handler */
export const Body = ArgDecorator({ type: 'body' });
/** Injects the request query into the handler */
export const Query = ArgDecorator({ type: 'query' });
/** Injects a request parameter into the handler */
export const Param = (key: string) => ArgDecorator({ type: 'param', key });

View File

@@ -2,7 +2,9 @@ import { GlobalConfig } from '@n8n/config';
import { Router } from 'express'; import { Router } from 'express';
import type { Application, Request, Response, RequestHandler } from 'express'; import type { Application, Request, Response, RequestHandler } from 'express';
import { rateLimit as expressRateLimit } from 'express-rate-limit'; import { rateLimit as expressRateLimit } from 'express-rate-limit';
import { ApplicationError } from 'n8n-workflow';
import { Container, Service } from 'typedi'; import { Container, Service } from 'typedi';
import type { ZodClass } from 'zod-class';
import { AuthService } from '@/auth/auth.service'; import { AuthService } from '@/auth/auth.service';
import { inProduction, RESPONSE_ERROR_MESSAGES } from '@/constants'; import { inProduction, RESPONSE_ERROR_MESSAGES } from '@/constants';
@@ -42,6 +44,7 @@ export const getRouteMetadata = (controllerClass: Controller, handlerName: Handl
let route = metadata.routes.get(handlerName); let route = metadata.routes.get(handlerName);
if (!route) { if (!route) {
route = {} as RouteMetadata; route = {} as RouteMetadata;
route.args = [];
metadata.routes.set(handlerName, route); metadata.routes.set(handlerName, route);
} }
return route; return route;
@@ -76,8 +79,31 @@ export class ControllerRegistry {
); );
for (const [handlerName, route] of metadata.routes) { for (const [handlerName, route] of metadata.routes) {
const handler = async (req: Request, res: Response) => const argTypes = Reflect.getMetadata(
await controller[handlerName](req, res); 'design:paramtypes',
controller,
handlerName,
) as unknown[];
// eslint-disable-next-line @typescript-eslint/no-loop-func
const handler = async (req: Request, res: Response) => {
const args: unknown[] = [req, res];
for (let index = 0; index < route.args.length; index++) {
const arg = route.args[index];
if (!arg) continue; // Skip args without any decorators
if (arg.type === 'param') args.push(req.params[arg.key]);
else if (['body', 'query'].includes(arg.type)) {
const paramType = argTypes[index] as ZodClass;
if (paramType && 'parse' in paramType) {
const output = paramType.safeParse(req[arg.type]);
if (output.success) args.push(output.data);
else {
return res.status(400).json(output.error.errors[0]);
}
}
} else throw new ApplicationError('Unknown arg type: ' + arg.type);
}
return await controller[handlerName](...args);
};
router[route.method]( router[route.method](
route.path, route.path,

View File

@@ -1,3 +1,4 @@
export { Body } from './args';
export { RestController } from './rest-controller'; export { RestController } from './rest-controller';
export { Get, Post, Put, Patch, Delete } from './route'; export { Get, Post, Put, Patch, Delete } from './route';
export { Middleware } from './middleware'; export { Middleware } from './middleware';

View File

@@ -6,6 +6,8 @@ import type { BooleanLicenseFeature } from '@/interfaces';
export type Method = 'get' | 'post' | 'put' | 'patch' | 'delete'; export type Method = 'get' | 'post' | 'put' | 'patch' | 'delete';
export type Arg = { type: 'body' | 'query' } | { type: 'param'; key: string };
export interface RateLimit { export interface RateLimit {
/** /**
* The maximum number of requests to allow during the `window` before rate limiting the client. * The maximum number of requests to allow during the `window` before rate limiting the client.
@@ -35,6 +37,7 @@ export interface RouteMetadata {
rateLimit?: boolean | RateLimit; rateLimit?: boolean | RateLimit;
licenseFeature?: BooleanLicenseFeature; licenseFeature?: BooleanLicenseFeature;
accessScope?: AccessScope; accessScope?: AccessScope;
args: Arg[];
} }
export interface ControllerMetadata { export interface ControllerMetadata {

View File

@@ -5,11 +5,6 @@ import type { CredentialsEntity } from '@/databases/entities/credentials-entity'
import type { TagEntity } from '@/databases/entities/tag-entity'; import type { TagEntity } from '@/databases/entities/tag-entity';
import type { User } from '@/databases/entities/user'; import type { User } from '@/databases/entities/user';
import type { WorkflowEntity } from '@/databases/entities/workflow-entity'; import type { WorkflowEntity } from '@/databases/entities/workflow-entity';
import type {
UserRoleChangePayload,
UserSettingsUpdatePayload,
UserUpdatePayload,
} from '@/requests';
import type { PersonalizationSurveyAnswersV4 } from './controllers/survey-answers.dto'; import type { PersonalizationSurveyAnswersV4 } from './controllers/survey-answers.dto';
import { BadRequestError } from './errors/response-errors/bad-request.error'; import { BadRequestError } from './errors/response-errors/bad-request.error';
@@ -21,9 +16,6 @@ export async function validateEntity(
| TagEntity | TagEntity
| AnnotationTagEntity | AnnotationTagEntity
| User | User
| UserUpdatePayload
| UserRoleChangePayload
| UserSettingsUpdatePayload
| PersonalizationSurveyAnswersV4, | PersonalizationSurveyAnswersV4,
): Promise<void> { ): Promise<void> {
const errors = await validate(entity); const errors = await validate(entity);

View File

@@ -1,3 +1,4 @@
import { RoleChangeRequestDto } from '@n8n/api-types';
import type express from 'express'; import type express from 'express';
import type { Response } from 'express'; import type { Response } from 'express';
import { Container } from 'typedi'; import { Container } from 'typedi';
@@ -6,7 +7,7 @@ import { InvitationController } from '@/controllers/invitation.controller';
import { UsersController } from '@/controllers/users.controller'; import { UsersController } from '@/controllers/users.controller';
import { ProjectRelationRepository } from '@/databases/repositories/project-relation.repository'; import { ProjectRelationRepository } from '@/databases/repositories/project-relation.repository';
import { EventService } from '@/events/event.service'; import { EventService } from '@/events/event.service';
import type { UserRequest } from '@/requests'; import type { AuthenticatedRequest, UserRequest } from '@/requests';
import { clean, getAllUsersAndCount, getUser } from './users.service.ee'; import { clean, getAllUsersAndCount, getUser } from './users.service.ee';
import { import {
@@ -19,7 +20,7 @@ import { encodeNextCursor } from '../../shared/services/pagination.service';
type Create = UserRequest.Invite; type Create = UserRequest.Invite;
type Delete = UserRequest.Delete; type Delete = UserRequest.Delete;
type ChangeRole = UserRequest.ChangeRole; type ChangeRole = AuthenticatedRequest<{ id: string }, {}, RoleChangeRequestDto, {}>;
export = { export = {
getUser: [ getUser: [
@@ -98,7 +99,19 @@ export = {
isLicensed('feat:advancedPermissions'), isLicensed('feat:advancedPermissions'),
globalScope('user:changeRole'), globalScope('user:changeRole'),
async (req: ChangeRole, res: Response) => { async (req: ChangeRole, res: Response) => {
await Container.get(UsersController).changeGlobalRole(req); const validation = RoleChangeRequestDto.safeParse(req.body);
if (validation.error) {
return res.status(400).json({
message: validation.error.errors[0],
});
}
await Container.get(UsersController).changeGlobalRole(
req,
res,
validation.data,
req.params.id,
);
return res.status(204).send(); return res.status(204).send();
}, },

View File

@@ -1,7 +1,5 @@
import type { Scope } from '@n8n/permissions'; import type { Scope } from '@n8n/permissions';
import type { AiAssistantSDK } from '@n8n_io/ai-assistant-sdk'; import type { AiAssistantSDK } from '@n8n_io/ai-assistant-sdk';
import { Expose } from 'class-transformer';
import { IsBoolean, IsEmail, IsIn, IsOptional, IsString, Length } from 'class-validator';
import type express from 'express'; import type express from 'express';
import type { import type {
BannerName, BannerName,
@@ -18,61 +16,15 @@ import type {
import type { CredentialsEntity } from '@/databases/entities/credentials-entity'; import type { CredentialsEntity } from '@/databases/entities/credentials-entity';
import type { Project, ProjectType } from '@/databases/entities/project'; import type { Project, ProjectType } from '@/databases/entities/project';
import { AssignableRole } from '@/databases/entities/user'; import type { AssignableRole, GlobalRole, User } from '@/databases/entities/user';
import type { GlobalRole, User } from '@/databases/entities/user';
import type { Variables } from '@/databases/entities/variables'; import type { Variables } from '@/databases/entities/variables';
import type { WorkflowEntity } from '@/databases/entities/workflow-entity'; import type { WorkflowEntity } from '@/databases/entities/workflow-entity';
import type { WorkflowHistory } from '@/databases/entities/workflow-history'; import type { WorkflowHistory } from '@/databases/entities/workflow-history';
import type { PublicUser, SecretsProvider, SecretsProviderState } from '@/interfaces'; import type { PublicUser, SecretsProvider, SecretsProviderState } from '@/interfaces';
import { NoUrl } from '@/validators/no-url.validator';
import { NoXss } from '@/validators/no-xss.validator';
import type { ProjectRole } from './databases/entities/project-relation'; import type { ProjectRole } from './databases/entities/project-relation';
import type { ScopesField } from './services/role.service'; import type { ScopesField } from './services/role.service';
export class UserUpdatePayload implements Pick<User, 'email' | 'firstName' | 'lastName'> {
@Expose()
@IsEmail()
email: string;
@Expose()
@NoXss()
@NoUrl()
@IsString({ message: 'First name must be of type string.' })
@Length(1, 32, { message: 'First name must be $constraint1 to $constraint2 characters long.' })
firstName: string;
@Expose()
@NoXss()
@NoUrl()
@IsString({ message: 'Last name must be of type string.' })
@Length(1, 32, { message: 'Last name must be $constraint1 to $constraint2 characters long.' })
lastName: string;
@IsOptional()
@Expose()
@IsString({ message: 'Two factor code must be a string.' })
mfaCode?: string;
}
export class UserSettingsUpdatePayload {
@Expose()
@IsBoolean({ message: 'userActivated should be a boolean' })
@IsOptional()
userActivated?: boolean;
@Expose()
@IsBoolean({ message: 'allowSSOManualLogin should be a boolean' })
@IsOptional()
allowSSOManualLogin?: boolean;
}
export class UserRoleChangePayload {
@Expose()
@IsIn(['global:admin', 'global:member'])
newRoleName: AssignableRole;
}
export type APIRequest< export type APIRequest<
RouteParams = {}, RouteParams = {},
ResponseBody = {}, ResponseBody = {},
@@ -230,13 +182,6 @@ export declare namespace CredentialRequest {
// ---------------------------------- // ----------------------------------
export declare namespace MeRequest { export declare namespace MeRequest {
export type UserSettingsUpdate = AuthenticatedRequest<{}, {}, UserSettingsUpdatePayload>;
export type UserUpdate = AuthenticatedRequest<{}, {}, UserUpdatePayload>;
export type Password = AuthenticatedRequest<
{},
{},
{ currentPassword: string; newPassword: string; mfaCode?: string }
>;
export type SurveyAnswers = AuthenticatedRequest<{}, {}, IPersonalizationSurveyAnswersV4>; export type SurveyAnswers = AuthenticatedRequest<{}, {}, IPersonalizationSurveyAnswersV4>;
} }
@@ -311,8 +256,6 @@ export declare namespace UserRequest {
{ transferId?: string; includeRole: boolean } { transferId?: string; includeRole: boolean }
>; >;
export type ChangeRole = AuthenticatedRequest<{ id: string }, {}, UserRoleChangePayload, {}>;
export type Get = AuthenticatedRequest< export type Get = AuthenticatedRequest<
{ id: string; email: string; identifier: string }, { id: string; email: string; identifier: string },
{}, {},
@@ -322,12 +265,6 @@ export declare namespace UserRequest {
export type PasswordResetLink = AuthenticatedRequest<{ id: string }, {}, {}, {}>; export type PasswordResetLink = AuthenticatedRequest<{ id: string }, {}, {}, {}>;
export type UserSettingsUpdate = AuthenticatedRequest<
{ id: string },
{},
UserSettingsUpdatePayload
>;
export type Reinvite = AuthenticatedRequest<{ id: string }>; export type Reinvite = AuthenticatedRequest<{ id: string }>;
export type Update = AuthlessRequest< export type Update = AuthlessRequest<

View File

@@ -225,6 +225,29 @@ describe('Users in Public API', () => {
expect(response.body).toHaveProperty('message', 'Forbidden'); expect(response.body).toHaveProperty('message', 'Forbidden');
}); });
it('should return a 400 on invalid payload', async () => {
/**
* Arrange
*/
testServer.license.enable('feat:advancedPermissions');
const owner = await createOwner({ withApiKey: true });
const member = await createMember();
const payload = { newRoleName: 'invalid' };
/**
* Act
*/
const response = await testServer
.publicApiAgentFor(owner)
.patch(`/users/${member.id}/role`)
.send(payload);
/**
* Assert
*/
expect(response.status).toBe(400);
});
it("should change a user's role", async () => { it("should change a user's role", async () => {
/** /**
* Arrange * Arrange

View File

@@ -22,9 +22,11 @@ const testServer = utils.setupTestServer({
enabledFeatures: ['feat:saml'], enabledFeatures: ['feat:saml'],
}); });
const memberPassword = randomValidPassword();
beforeAll(async () => { beforeAll(async () => {
owner = await createOwner(); owner = await createOwner();
someUser = await createUser(); someUser = await createUser({ password: memberPassword });
authOwnerAgent = testServer.authAgentFor(owner); authOwnerAgent = testServer.authAgentFor(owner);
authMemberAgent = testServer.authAgentFor(someUser); authMemberAgent = testServer.authAgentFor(someUser);
}); });
@@ -60,10 +62,11 @@ describe('Instance owner', () => {
describe('PATCH /password', () => { describe('PATCH /password', () => {
test('should throw BadRequestError if password is changed when SAML is enabled', async () => { test('should throw BadRequestError if password is changed when SAML is enabled', async () => {
await enableSaml(true); await enableSaml(true);
await authOwnerAgent await authMemberAgent
.patch('/me/password') .patch('/me/password')
.send({ .send({
password: randomValidPassword(), currentPassword: memberPassword,
newPassword: randomValidPassword(),
}) })
.expect(400, { .expect(400, {
code: 400, code: 400,

View File

@@ -672,9 +672,6 @@ describe('PATCH /users/:id/role', () => {
])('%s', async (_, payload) => { ])('%s', async (_, payload) => {
const response = await adminAgent.patch(`/users/${member.id}/role`).send(payload); const response = await adminAgent.patch(`/users/${member.id}/role`).send(payload);
expect(response.statusCode).toBe(400); expect(response.statusCode).toBe(400);
expect(response.body.message).toBe(
'newRoleName must be one of the following values: global:admin, global:member',
);
}); });
}); });

View File

@@ -54,6 +54,6 @@
"vue": "catalog:frontend", "vue": "catalog:frontend",
"vue-boring-avatars": "^1.3.0", "vue-boring-avatars": "^1.3.0",
"vue-router": "catalog:frontend", "vue-router": "catalog:frontend",
"xss": "^1.0.14" "xss": "catalog:"
} }
} }

View File

@@ -77,7 +77,7 @@
"vue-markdown-render": "catalog:frontend", "vue-markdown-render": "catalog:frontend",
"vue-router": "catalog:frontend", "vue-router": "catalog:frontend",
"vue3-touch-events": "^4.1.3", "vue3-touch-events": "^4.1.3",
"xss": "^1.0.14" "xss": "catalog:"
}, },
"devDependencies": { "devDependencies": {
"@faker-js/faker": "^8.0.2", "@faker-js/faker": "^8.0.2",

View File

@@ -1,3 +1,8 @@
import type {
PasswordUpdateRequestDto,
SettingsUpdateRequestDto,
UserUpdateRequestDto,
} from '@n8n/api-types';
import type { import type {
CurrentUserResponse, CurrentUserResponse,
IPersonalizationLatestVersion, IPersonalizationLatestVersion,
@@ -8,11 +13,6 @@ import type {
import type { IDataObject, IUserSettings } from 'n8n-workflow'; import type { IDataObject, IUserSettings } from 'n8n-workflow';
import { makeRestApiRequest } from '@/utils/apiUtils'; import { makeRestApiRequest } from '@/utils/apiUtils';
export interface IUpdateUserSettingsReqPayload {
allowSSOManualLogin?: boolean;
userActivated?: boolean;
}
export async function loginCurrentUser( export async function loginCurrentUser(
context: IRestApiContext, context: IRestApiContext,
): Promise<CurrentUserResponse | null> { ): Promise<CurrentUserResponse | null> {
@@ -89,23 +89,16 @@ export async function changePassword(
await makeRestApiRequest(context, 'POST', '/change-password', params); await makeRestApiRequest(context, 'POST', '/change-password', params);
} }
export type UpdateCurrentUserParams = {
firstName?: string;
lastName?: string;
email: string;
mfaCode?: string;
};
export async function updateCurrentUser( export async function updateCurrentUser(
context: IRestApiContext, context: IRestApiContext,
params: UpdateCurrentUserParams, params: UserUpdateRequestDto,
): Promise<IUserResponse> { ): Promise<IUserResponse> {
return await makeRestApiRequest(context, 'PATCH', '/me', params); return await makeRestApiRequest(context, 'PATCH', '/me', params);
} }
export async function updateCurrentUserSettings( export async function updateCurrentUserSettings(
context: IRestApiContext, context: IRestApiContext,
settings: IUpdateUserSettingsReqPayload, settings: SettingsUpdateRequestDto,
): Promise<IUserSettings> { ): Promise<IUserSettings> {
return await makeRestApiRequest(context, 'PATCH', '/me/settings', settings); return await makeRestApiRequest(context, 'PATCH', '/me/settings', settings);
} }
@@ -113,20 +106,14 @@ export async function updateCurrentUserSettings(
export async function updateOtherUserSettings( export async function updateOtherUserSettings(
context: IRestApiContext, context: IRestApiContext,
userId: string, userId: string,
settings: IUpdateUserSettingsReqPayload, settings: SettingsUpdateRequestDto,
): Promise<IUserSettings> { ): Promise<IUserSettings> {
return await makeRestApiRequest(context, 'PATCH', `/users/${userId}/settings`, settings); return await makeRestApiRequest(context, 'PATCH', `/users/${userId}/settings`, settings);
} }
export type UpdateUserPasswordParams = {
newPassword: string;
currentPassword: string;
mfaCode?: string;
};
export async function updateCurrentUserPassword( export async function updateCurrentUserPassword(
context: IRestApiContext, context: IRestApiContext,
params: UpdateUserPasswordParams, params: PasswordUpdateRequestDto,
): Promise<void> { ): Promise<void> {
return await makeRestApiRequest(context, 'PATCH', '/me/password', params); return await makeRestApiRequest(context, 'PATCH', '/me/password', params);
} }

View File

@@ -1,4 +1,9 @@
import type { IUpdateUserSettingsReqPayload, UpdateGlobalRolePayload } from '@/api/users'; import type {
PasswordUpdateRequestDto,
SettingsUpdateRequestDto,
UserUpdateRequestDto,
} from '@n8n/api-types';
import type { UpdateGlobalRolePayload } from '@/api/users';
import * as usersApi from '@/api/users'; import * as usersApi from '@/api/users';
import { BROWSER_ID_STORAGE_KEY, PERSONALIZATION_MODAL_KEY, STORES, ROLE } from '@/constants'; import { BROWSER_ID_STORAGE_KEY, PERSONALIZATION_MODAL_KEY, STORES, ROLE } from '@/constants';
import type { import type {
@@ -226,12 +231,12 @@ export const useUsersStore = defineStore(STORES.USERS, () => {
await usersApi.changePassword(rootStore.restApiContext, params); await usersApi.changePassword(rootStore.restApiContext, params);
}; };
const updateUser = async (params: usersApi.UpdateCurrentUserParams) => { const updateUser = async (params: UserUpdateRequestDto) => {
const user = await usersApi.updateCurrentUser(rootStore.restApiContext, params); const user = await usersApi.updateCurrentUser(rootStore.restApiContext, params);
addUsers([user]); addUsers([user]);
}; };
const updateUserSettings = async (settings: IUpdateUserSettingsReqPayload) => { const updateUserSettings = async (settings: SettingsUpdateRequestDto) => {
const updatedSettings = await usersApi.updateCurrentUserSettings( const updatedSettings = await usersApi.updateCurrentUserSettings(
rootStore.restApiContext, rootStore.restApiContext,
settings, settings,
@@ -242,10 +247,7 @@ export const useUsersStore = defineStore(STORES.USERS, () => {
} }
}; };
const updateOtherUserSettings = async ( const updateOtherUserSettings = async (userId: string, settings: SettingsUpdateRequestDto) => {
userId: string,
settings: IUpdateUserSettingsReqPayload,
) => {
const updatedSettings = await usersApi.updateOtherUserSettings( const updatedSettings = await usersApi.updateOtherUserSettings(
rootStore.restApiContext, rootStore.restApiContext,
userId, userId,
@@ -255,7 +257,7 @@ export const useUsersStore = defineStore(STORES.USERS, () => {
addUsers([usersById.value[userId]]); addUsers([usersById.value[userId]]);
}; };
const updateCurrentUserPassword = async (params: usersApi.UpdateUserPasswordParams) => { const updateCurrentUserPassword = async (params: PasswordUpdateRequestDto) => {
await usersApi.updateCurrentUserPassword(rootStore.restApiContext, params); await usersApi.updateCurrentUserPassword(rootStore.restApiContext, params);
}; };

47
pnpm-lock.yaml generated
View File

@@ -54,6 +54,9 @@ catalogs:
xml2js: xml2js:
specifier: 0.6.2 specifier: 0.6.2
version: 0.6.2 version: 0.6.2
xss:
specifier: 1.0.15
version: 1.0.15
zod: zod:
specifier: 3.23.8 specifier: 3.23.8
version: 3.23.8 version: 3.23.8
@@ -233,6 +236,16 @@ importers:
version: link:../packages/workflow version: link:../packages/workflow
packages/@n8n/api-types: packages/@n8n/api-types:
dependencies:
xss:
specifier: 'catalog:'
version: 1.0.15
zod:
specifier: 'catalog:'
version: 3.23.8
zod-class:
specifier: 0.0.15
version: 0.0.15(zod@3.23.8)
devDependencies: devDependencies:
n8n-workflow: n8n-workflow:
specifier: workspace:* specifier: workspace:*
@@ -938,8 +951,8 @@ importers:
specifier: 3.0.1 specifier: 3.0.1
version: 3.0.1 version: 3.0.1
xss: xss:
specifier: ^1.0.14 specifier: 'catalog:'
version: 1.0.14 version: 1.0.15
yamljs: yamljs:
specifier: 0.3.0 specifier: 0.3.0
version: 0.3.0 version: 0.3.0
@@ -1171,8 +1184,8 @@ importers:
specifier: catalog:frontend specifier: catalog:frontend
version: 4.4.2(vue@3.4.21(typescript@5.6.2)) version: 4.4.2(vue@3.4.21(typescript@5.6.2))
xss: xss:
specifier: ^1.0.14 specifier: 'catalog:'
version: 1.0.14 version: 1.0.15
devDependencies: devDependencies:
'@n8n/storybook': '@n8n/storybook':
specifier: workspace:* specifier: workspace:*
@@ -1430,8 +1443,8 @@ importers:
specifier: ^4.1.3 specifier: ^4.1.3
version: 4.1.3 version: 4.1.3
xss: xss:
specifier: ^1.0.14 specifier: 'catalog:'
version: 1.0.14 version: 1.0.15
devDependencies: devDependencies:
'@faker-js/faker': '@faker-js/faker':
specifier: ^8.0.2 specifier: ^8.0.2
@@ -11844,6 +11857,10 @@ packages:
resolution: {integrity: sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==} resolution: {integrity: sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==}
engines: {node: '>=12.20'} engines: {node: '>=12.20'}
type-fest@4.26.1:
resolution: {integrity: sha512-yOGpmOAL7CkKe/91I5O3gPICmJNLJ1G4zFYVAsRHg7M64biSnPtRj0WNQt++bRkjYOqjWXrhnUw1utzmVErAdg==}
engines: {node: '>=16'}
type-is@1.6.18: type-is@1.6.18:
resolution: {integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==} resolution: {integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==}
engines: {node: '>= 0.6'} engines: {node: '>= 0.6'}
@@ -12528,8 +12545,8 @@ packages:
xregexp@2.0.0: xregexp@2.0.0:
resolution: {integrity: sha512-xl/50/Cf32VsGq/1R8jJE5ajH1yMCQkpmoS10QbFZWl2Oor4H0Me64Pu2yxvsRWK3m6soJbmGfzSR7BYmDcWAA==} resolution: {integrity: sha512-xl/50/Cf32VsGq/1R8jJE5ajH1yMCQkpmoS10QbFZWl2Oor4H0Me64Pu2yxvsRWK3m6soJbmGfzSR7BYmDcWAA==}
xss@1.0.14: xss@1.0.15:
resolution: {integrity: sha512-og7TEJhXvn1a7kzZGQ7ETjdQVS2UfZyTlsEdDOqvQF7GoxNfY+0YLCzBy1kPdsDDx4QuNAonQPddpsn6Xl/7sw==} resolution: {integrity: sha512-FVdlVVC67WOIPvfOwhoMETV72f6GbW7aOabBC3WxN/oUdoEMDyLz4OgRv5/gck2ZeNqEQu+Tb0kloovXOfpYVg==}
engines: {node: '>= 0.10.0'} engines: {node: '>= 0.10.0'}
hasBin: true hasBin: true
@@ -12609,6 +12626,11 @@ packages:
engines: {node: '>=8.0.0'} engines: {node: '>=8.0.0'}
hasBin: true hasBin: true
zod-class@0.0.15:
resolution: {integrity: sha512-CD5B4e9unKPj1hiy7JOSwRV01WqbEBkFOlhws0C9s9wB0FSpECOnlKXOAkjo9tKYX2enQsXWyyOIBNPPNUHWRA==}
peerDependencies:
zod: ^3
zod-to-json-schema@3.23.2: zod-to-json-schema@3.23.2:
resolution: {integrity: sha512-uSt90Gzc/tUfyNqxnjlfBs8W6WSGpNBv0rVsNxP/BVSMHMKGdthPYff4xtCHYloJGM0CFxFsb3NbC0eqPhfImw==} resolution: {integrity: sha512-uSt90Gzc/tUfyNqxnjlfBs8W6WSGpNBv0rVsNxP/BVSMHMKGdthPYff4xtCHYloJGM0CFxFsb3NbC0eqPhfImw==}
peerDependencies: peerDependencies:
@@ -25550,6 +25572,8 @@ snapshots:
type-fest@2.19.0: {} type-fest@2.19.0: {}
type-fest@4.26.1: {}
type-is@1.6.18: type-is@1.6.18:
dependencies: dependencies:
media-typer: 0.3.0 media-typer: 0.3.0
@@ -26278,7 +26302,7 @@ snapshots:
xregexp@2.0.0: {} xregexp@2.0.0: {}
xss@1.0.14: xss@1.0.15:
dependencies: dependencies:
commander: 2.20.3 commander: 2.20.3
cssfilter: 0.0.10 cssfilter: 0.0.10
@@ -26376,6 +26400,11 @@ snapshots:
optionalDependencies: optionalDependencies:
commander: 9.4.1 commander: 9.4.1
zod-class@0.0.15(zod@3.23.8):
dependencies:
type-fest: 4.26.1
zod: 3.23.8
zod-to-json-schema@3.23.2(zod@3.23.8): zod-to-json-schema@3.23.2(zod@3.23.8):
dependencies: dependencies:
zod: 3.23.8 zod: 3.23.8

View File

@@ -20,6 +20,7 @@ catalog:
typedi: 0.10.0 typedi: 0.10.0
uuid: 10.0.0 uuid: 10.0.0
xml2js: 0.6.2 xml2js: 0.6.2
xss: 1.0.15
zod: 3.23.8 zod: 3.23.8
'@langchain/core': 0.2.31 '@langchain/core': 0.2.31