Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update existing credentials routes #3672

Merged
merged 17 commits into from
Jul 21, 2022
Merged

Update existing credentials routes #3672

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
23e018c
🎉 initial design
BHesseldieck Jun 16, 2022
a16e282
✨ sharing/unsharing of credentials
BHesseldieck Jun 24, 2022
e76b945
:recycle: split credential update route into controller and service
valya Jul 7, 2022
d607446
:fire: remove credentials test that is no longer applicable
valya Jul 7, 2022
fc3b72d
:recycle: split credential creation route into controller and service
valya Jul 11, 2022
46e57fb
:recycle: split single credential get
valya Jul 11, 2022
ce76c72
:recycle: split delete credentials route
valya Jul 11, 2022
5783652
:recycle: split get all credentials route
valya Jul 11, 2022
2fc21cb
:fire: remove unused imports in credentials contoller
valya Jul 11, 2022
1536458
Merge remote-tracking branch 'origin/user-management-p2' into n8n-395…
valya Jul 11, 2022
1d45f3a
:fire: remove console.log
valya Jul 12, 2022
2692d13
Merge remote-tracking branch 'origin/user-management-p2' into n8n-395…
valya Jul 14, 2022
5cc03cb
:refactor: changes to credentials controller and service from review
valya Jul 19, 2022
929881d
Merge remote-tracking branch 'origin/user-management-p2' into n8n-395…
valya Jul 19, 2022
42a5748
:recycle: move filtered credentials selected fields to variable
valya Jul 20, 2022
0b1b9fe
:recycle: remove unneeded merges in credentials service
valya Jul 20, 2022
c80330e
Merge branch 'user-management-p2' into n8n-3959-update-existing-crede…
BHesseldieck Jul 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/cli/src/credentials/credentials.controller.ee.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ EECredentialsController.post('/:id/share', async (req: CredentialRequest.Share,
const { id } = req.params;
const { shareeId } = req.body;

const isOwned = EECredentials.isOwned(req.user.id, id);
const isOwned = EECredentials.isOwned(req.user, id);
BHesseldieck marked this conversation as resolved.
Show resolved Hide resolved
const getSharee = UserService.get({ id: shareeId });

// parallelize DB requests and destructure results
Expand Down Expand Up @@ -57,7 +57,7 @@ EECredentialsController.delete('/:id/share', async (req: CredentialRequest.Share
const { id } = req.params;
const { shareeId } = req.body;

const { ownsCredential } = await EECredentials.isOwned(req.user.id, id);
const { ownsCredential } = await EECredentials.isOwned(req.user, id);
BHesseldieck marked this conversation as resolved.
Show resolved Hide resolved

if (!ownsCredential) {
return res.status(403).send();
Expand Down
254 changes: 44 additions & 210 deletions packages/cli/src/credentials/credentials.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,13 @@
/* eslint-disable @typescript-eslint/no-non-null-assertion */
/* eslint-disable import/no-cycle */
import express from 'express';
import { In } from 'typeorm';
import { UserSettings, Credentials } from 'n8n-core';
import { INodeCredentialTestResult, LoggerProxy } from 'n8n-workflow';
import { getLogger } from '../Logger';

import {
CredentialsHelper,
Db,
GenericHelpers,
ICredentialsDb,
ICredentialsResponse,
whereClause,
ResponseHelper,
} from '..';

import { RESPONSE_ERROR_MESSAGES } from '../constants';
import { CredentialsEntity } from '../databases/entities/CredentialsEntity';
import { SharedCredentials } from '../databases/entities/SharedCredentials';
import { validateEntity } from '../GenericHelpers';
import { createCredentialsFromCredentialsEntity } from '../CredentialsHelper';
import { GenericHelpers, ICredentialsResponse, ResponseHelper } from '..';

import type { CredentialRequest } from '../requests';
import * as config from '../../config';
import { externalHooks } from '../Server';
import { CredentialsService } from './credentials.service';
import { EECredentialsController } from './credentials.controller.ee';

Expand All @@ -52,38 +36,9 @@ credentialsController.use('/', EECredentialsController);
credentialsController.get(
'/',
ResponseHelper.send(async (req: CredentialRequest.GetAll): Promise<ICredentialsResponse[]> => {
let credentials: ICredentialsDb[] = [];

const filter = req.query.filter ? (JSON.parse(req.query.filter) as Record<string, string>) : {};

try {
if (req.user.globalRole.name === 'owner') {
credentials = await Db.collections.Credentials.find({
select: ['id', 'name', 'type', 'nodesAccess', 'createdAt', 'updatedAt'],
where: filter,
});
} else {
const shared = await Db.collections.SharedCredentials.find({
where: whereClause({
user: req.user,
entityType: 'credentials',
}),
});

if (!shared.length) return [];

credentials = await Db.collections.Credentials.find({
select: ['id', 'name', 'type', 'nodesAccess', 'createdAt', 'updatedAt'],
where: {
id: In(shared.map(({ credentialId }) => credentialId)),
...filter,
},
});
}
} catch (error) {
LoggerProxy.error('Request to list credentials failed', error);
throw error;
}
const credentials = await CredentialsService.getFilteredCredentials(req.user, filter);
valya marked this conversation as resolved.
Show resolved Hide resolved

return credentials.map((credential) => {
// eslint-disable-next-line no-param-reassign
Expand Down Expand Up @@ -122,20 +77,8 @@ credentialsController.post(
ResponseHelper.send(async (req: CredentialRequest.Test): Promise<INodeCredentialTestResult> => {
const { credentials, nodeToTestWith } = req.body;

let encryptionKey: string;
try {
encryptionKey = await UserSettings.getEncryptionKey();
} catch (error) {
throw new ResponseHelper.ResponseError(
RESPONSE_ERROR_MESSAGES.NO_ENCRYPTION_KEY,
undefined,
500,
);
}

const helper = new CredentialsHelper(encryptionKey);

return helper.testCredentials(req.user, credentials.type, credentials, nodeToTestWith);
const encryptionKey = await CredentialsService.getEncryptionKey();
return CredentialsService.testCredentials(req.user, encryptionKey, credentials, nodeToTestWith);
}),
);

Expand All @@ -145,68 +88,20 @@ credentialsController.post(
credentialsController.post(
'/',
ResponseHelper.send(async (req: CredentialRequest.Create) => {
delete req.body.id; // delete if sent

const newCredential = new CredentialsEntity();

Object.assign(newCredential, req.body);

await validateEntity(newCredential);

// Add the added date for node access permissions
for (const nodeAccess of newCredential.nodesAccess) {
nodeAccess.date = new Date();
}

let encryptionKey: string;
try {
encryptionKey = await UserSettings.getEncryptionKey();
} catch (error) {
throw new ResponseHelper.ResponseError(
RESPONSE_ERROR_MESSAGES.NO_ENCRYPTION_KEY,
undefined,
500,
);
}

// Encrypt the data
const coreCredential = createCredentialsFromCredentialsEntity(newCredential, true);

// @ts-ignore
coreCredential.setData(newCredential.data, encryptionKey);

const encryptedData = coreCredential.getDataToSave() as ICredentialsDb;

Object.assign(newCredential, encryptedData);

await externalHooks.run('credentials.create', [encryptedData]);
const newCredential = await CredentialsService.prepareCredentialsCreateData(req.body);

const role = await Db.collections.Role.findOneOrFail({
name: 'owner',
scope: 'credential',
});

const { id, ...rest } = await Db.transaction(async (transactionManager) => {
const savedCredential = await transactionManager.save<CredentialsEntity>(newCredential);

savedCredential.data = newCredential.data;

const newSharedCredential = new SharedCredentials();

Object.assign(newSharedCredential, {
role,
user: req.user,
credentials: savedCredential,
});

await transactionManager.save<SharedCredentials>(newSharedCredential);
const encryptionKey = await CredentialsService.getEncryptionKey();
const encryptedData = CredentialsService.createEncryptedCredentialsData(
encryptionKey,
null,
newCredential,
);
const { id, ...rest } = await CredentialsService.saveCredentials(
newCredential,
encryptedData,
req.user,
);

return savedCredential;
});
LoggerProxy.verbose('New credential created', {
credentialId: newCredential.id,
ownerId: req.user.id,
});
return { id: id.toString(), ...rest };
}),
);
Expand All @@ -219,14 +114,9 @@ credentialsController.delete(
ResponseHelper.send(async (req: CredentialRequest.Delete) => {
const { id: credentialId } = req.params;

const shared = await Db.collections.SharedCredentials.findOne({
relations: ['credentials'],
where: whereClause({
user: req.user,
entityType: 'credentials',
entityId: credentialId,
}),
});
const shared = await CredentialsService.getSharedCredentials(req.user, credentialId, [
'credentials',
]);
valya marked this conversation as resolved.
Show resolved Hide resolved

if (!shared) {
LoggerProxy.info('Attempt to delete credential blocked due to lack of permissions', {
Expand All @@ -240,9 +130,7 @@ credentialsController.delete(
);
}

await externalHooks.run('credentials.delete', [credentialId]);

await Db.collections.Credentials.remove(shared.credentials);
await CredentialsService.deleteCredentials(shared.credentials);

return true;
}),
Expand All @@ -256,19 +144,9 @@ credentialsController.patch(
ResponseHelper.send(async (req: CredentialRequest.Update): Promise<ICredentialsResponse> => {
const { id: credentialId } = req.params;

const updateData = new CredentialsEntity();
Object.assign(updateData, req.body);

await validateEntity(updateData);

const shared = await Db.collections.SharedCredentials.findOne({
relations: ['credentials'],
where: whereClause({
user: req.user,
entityType: 'credentials',
entityId: credentialId,
}),
});
const shared = await CredentialsService.getSharedCredentials(req.user, credentialId, [
valya marked this conversation as resolved.
Show resolved Hide resolved
'credentials',
]);

if (!shared) {
LoggerProxy.info('Attempt to update credential blocked due to lack of permissions', {
Expand All @@ -284,58 +162,22 @@ credentialsController.patch(

const { credentials: credential } = shared;

// Add the date for newly added node access permissions
for (const nodeAccess of updateData.nodesAccess) {
if (!nodeAccess.date) {
nodeAccess.date = new Date();
}
}

let encryptionKey: string;
try {
encryptionKey = await UserSettings.getEncryptionKey();
} catch (error) {
throw new ResponseHelper.ResponseError(
RESPONSE_ERROR_MESSAGES.NO_ENCRYPTION_KEY,
undefined,
500,
);
}

const coreCredential = createCredentialsFromCredentialsEntity(credential);

const decryptedData = coreCredential.getData(encryptionKey);

// Do not overwrite the oauth data else data like the access or refresh token would get lost
// everytime anybody changes anything on the credentials even if it is just the name.
if (decryptedData.oauthTokenData) {
// @ts-ignore
updateData.data.oauthTokenData = decryptedData.oauthTokenData;
}

// Encrypt the data
const credentials = new Credentials(
{ id: credentialId, name: updateData.name },
updateData.type,
updateData.nodesAccess,
const encryptionKey = await CredentialsService.getEncryptionKey();
const decryptedData = await CredentialsService.decryptCredential(encryptionKey, credential);
const preparedCredentialData = await CredentialsService.prepareCredentialsUpdateData(
req.body,
decryptedData,
);
const newCredentialData = CredentialsService.createEncryptedCredentialsData(
encryptionKey,
credentialId,
preparedCredentialData,
);

// @ts-ignore
credentials.setData(updateData.data, encryptionKey);

const newCredentialData = credentials.getDataToSave() as ICredentialsDb;

// Add special database related data
newCredentialData.updatedAt = new Date();

await externalHooks.run('credentials.update', [newCredentialData]);

// Update the credentials in DB
await Db.collections.Credentials.update(credentialId, newCredentialData);

// We sadly get nothing back from "update". Neither if it updated a record
// nor the new value. So query now the updated entry.
const responseData = await Db.collections.Credentials.findOne(credentialId);
const responseData = await CredentialsService.updateCredentials(
credentialId,
newCredentialData,
);

if (responseData === undefined) {
throw new ResponseHelper.ResponseError(
Expand Down Expand Up @@ -365,7 +207,9 @@ credentialsController.get(
ResponseHelper.send(async (req: CredentialRequest.Get) => {
const { id: credentialId } = req.params;

const shared = await CredentialsService.getSharing(req.user.id, credentialId, ['credentials']);
const shared = await CredentialsService.getSharedCredentials(req.user, credentialId, [
'credentials',
]);

if (!shared) {
throw new ResponseHelper.ResponseError(
Expand All @@ -388,22 +232,12 @@ credentialsController.get(

const { data, id, ...rest } = credential;

let encryptionKey: string;
try {
encryptionKey = await UserSettings.getEncryptionKey();
} catch (error) {
throw new ResponseHelper.ResponseError(
RESPONSE_ERROR_MESSAGES.NO_ENCRYPTION_KEY,
undefined,
500,
);
}

const coreCredential = CredentialsService.createCredentialsFromCredentialsEntity(credential);
const encryptionKey = await CredentialsService.getEncryptionKey();
const decryptedData = await CredentialsService.decryptCredential(encryptionKey, credential);

return {
id: id.toString(),
data: coreCredential.getData(encryptionKey),
data: decryptedData,
...rest,
};
}),
Expand Down
4 changes: 2 additions & 2 deletions packages/cli/src/credentials/credentials.service.ee.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ import { RoleService } from '../role/role.service';

export class EECredentialsService extends CredentialsService {
static async isOwned(
userId: string,
user: User,
credentialId: string,
): Promise<{ ownsCredential: boolean; credential?: CredentialsEntity }> {
const sharing = await this.getSharing(userId, credentialId, ['credentials']);
const sharing = await this.getSharedCredentials(user, credentialId, ['credentials'], false);
valya marked this conversation as resolved.
Show resolved Hide resolved

return sharing
? { ownsCredential: true, credential: sharing.credentials }
Expand Down
Loading