mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-03-05 20:50:17 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(core): Do not send credentials to browser console (#5031)

Browse source
This commit is contained in:
Jan Oberhauser 2022-12-23 16:25:59 -06:00 committed by GitHub
parent a229788d4b
commit afc529799d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 67 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
packages/nodes-base/nodes/HttpRequest/GenericFunctions.ts
View file

@ -1,4 +1,9 @@
import { INodeExecutionData, IOAuth2Options } from 'n8n-workflow'; import { IDataObject, INodeExecutionData, IOAuth2Options } from 'n8n-workflow';
import { OptionsWithUri } from 'request-promise-native';
export type IAuthDataSanitizeKeys = {
[key: string]: string[];
};
export const replaceNullValues = (item: INodeExecutionData) => { export const replaceNullValues = (item: INodeExecutionData) => {
if (item.json === null) { if (item.json === null) {
@ -7,6 +12,37 @@ export const replaceNullValues = (item: INodeExecutionData) => {
return item; return item;
}; };
export function sanitizeUiMessage(request: OptionsWithUri, authDataKeys: IAuthDataSanitizeKeys) {
let sendRequest = request as unknown as IDataObject;
// Protect browser from sending large binary data
if (Buffer.isBuffer(sendRequest.body) && sendRequest.body.length > 250000) {
sendRequest = {
...request,
body: `Binary data got replaced with this text. Original was a Buffer with a size of ${request.body.length} byte.`,
};
}
// Remove credential information
for (const requestProperty of Object.keys(authDataKeys)) {
sendRequest = {
...sendRequest,
[requestProperty]: Object.keys(sendRequest[requestProperty] as object).reduce(
// eslint-disable-next-line @typescript-eslint/no-loop-func
(acc: IDataObject, curr) => {
acc[curr] = authDataKeys[requestProperty].includes(curr)
? '** hidden **'
: (sendRequest[requestProperty] as IDataObject)[curr];
return acc;
},
{},
),
};
}
return sendRequest;
}
export const getOAuth2AdditionalParameters = (nodeCredentialType: string) => { export const getOAuth2AdditionalParameters = (nodeCredentialType: string) => {
const oAuth2Options: { [credentialType: string]: IOAuth2Options } = { const oAuth2Options: { [credentialType: string]: IOAuth2Options } = {
bitlyOAuth2Api: { bitlyOAuth2Api: {

18
packages/nodes-base/nodes/HttpRequest/V1/HttpRequestV1.node.ts
View file

@ -13,7 +13,7 @@ import {
} from 'n8n-workflow'; } from 'n8n-workflow';
import { OptionsWithUri } from 'request'; import { OptionsWithUri } from 'request';
import { replaceNullValues } from '../GenericFunctions'; import { IAuthDataSanitizeKeys, replaceNullValues, sanitizeUiMessage } from '../GenericFunctions';
interface OptionData { interface OptionData {
name: string; name: string;
@ -914,21 +914,26 @@ export class HttpRequestV1 implements INodeType {
requestOptions.headers['Content-Type'] = options.bodyContentCustomMimeType; requestOptions.headers['Content-Type'] = options.bodyContentCustomMimeType;
} }
const authDataKeys: IAuthDataSanitizeKeys = {};
// Add credentials if any are set // Add credentials if any are set
if (httpBasicAuth !== undefined) { if (httpBasicAuth !== undefined) {
requestOptions.auth = { requestOptions.auth = {
user: httpBasicAuth.user as string, user: httpBasicAuth.user as string,
pass: httpBasicAuth.password as string, pass: httpBasicAuth.password as string,
}; };
authDataKeys.auth = ['pass'];
} }
if (httpHeaderAuth !== undefined) { if (httpHeaderAuth !== undefined) {
requestOptions.headers![httpHeaderAuth.name as string] = httpHeaderAuth.value; requestOptions.headers![httpHeaderAuth.name as string] = httpHeaderAuth.value;
authDataKeys.headers = [httpHeaderAuth.name as string];
} }
if (httpQueryAuth !== undefined) { if (httpQueryAuth !== undefined) {
if (!requestOptions.qs) { if (!requestOptions.qs) {
requestOptions.qs = {}; requestOptions.qs = {};
} }
requestOptions.qs[httpQueryAuth.name as string] = httpQueryAuth.value; requestOptions.qs[httpQueryAuth.name as string] = httpQueryAuth.value;
authDataKeys.qs = [httpQueryAuth.name as string];
} }
if (httpDigestAuth !== undefined) { if (httpDigestAuth !== undefined) {
requestOptions.auth = { requestOptions.auth = {
@ -936,6 +941,7 @@ export class HttpRequestV1 implements INodeType {
pass: httpDigestAuth.password as string, pass: httpDigestAuth.password as string,
sendImmediately: false, sendImmediately: false,
}; };
authDataKeys.auth = ['pass'];
} }
if (requestOptions.headers!.accept === undefined) { if (requestOptions.headers!.accept === undefined) {
@ -951,15 +957,7 @@ export class HttpRequestV1 implements INodeType {
} }
try { try {
let sendRequest: any = requestOptions; this.sendMessageToUI(sanitizeUiMessage(requestOptions, authDataKeys));
// Protect browser from sending large binary data
if (Buffer.isBuffer(sendRequest.body) && sendRequest.body.length > 250000) {
sendRequest = {
...requestOptions,
body: `Binary data got replaced with this text. Original was a Buffer with a size of ${requestOptions.body.length} byte.`,
};
}
this.sendMessageToUI(sendRequest);
} catch (e) {} } catch (e) {}
if (oAuth1Api) { if (oAuth1Api) {

23
packages/nodes-base/nodes/HttpRequest/V2/HttpRequestV2.node.ts
View file

@ -11,7 +11,12 @@ import {
} from 'n8n-workflow'; } from 'n8n-workflow';
import { OptionsWithUri } from 'request'; import { OptionsWithUri } from 'request';
import { getOAuth2AdditionalParameters, replaceNullValues } from '../GenericFunctions'; import {
getOAuth2AdditionalParameters,
IAuthDataSanitizeKeys,
replaceNullValues,
sanitizeUiMessage,
} from '../GenericFunctions';
interface OptionData { interface OptionData {
name: string; name: string;
@ -948,21 +953,26 @@ export class HttpRequestV2 implements INodeType {
requestOptions.headers['Content-Type'] = options.bodyContentCustomMimeType; requestOptions.headers['Content-Type'] = options.bodyContentCustomMimeType;
} }
const authDataKeys: IAuthDataSanitizeKeys = {};
// Add credentials if any are set // Add credentials if any are set
if (httpBasicAuth !== undefined) { if (httpBasicAuth !== undefined) {
requestOptions.auth = { requestOptions.auth = {
user: httpBasicAuth.user as string, user: httpBasicAuth.user as string,
pass: httpBasicAuth.password as string, pass: httpBasicAuth.password as string,
}; };
authDataKeys.auth = ['pass'];
} }
if (httpHeaderAuth !== undefined) { if (httpHeaderAuth !== undefined) {
requestOptions.headers![httpHeaderAuth.name as string] = httpHeaderAuth.value; requestOptions.headers![httpHeaderAuth.name as string] = httpHeaderAuth.value;
authDataKeys.headers = [httpHeaderAuth.name as string];
} }
if (httpQueryAuth !== undefined) { if (httpQueryAuth !== undefined) {
if (!requestOptions.qs) { if (!requestOptions.qs) {
requestOptions.qs = {}; requestOptions.qs = {};
} }
requestOptions.qs[httpQueryAuth.name as string] = httpQueryAuth.value; requestOptions.qs[httpQueryAuth.name as string] = httpQueryAuth.value;
authDataKeys.qs = [httpQueryAuth.name as string];
} }
if (httpDigestAuth !== undefined) { if (httpDigestAuth !== undefined) {
requestOptions.auth = { requestOptions.auth = {
@ -970,6 +980,7 @@ export class HttpRequestV2 implements INodeType {
pass: httpDigestAuth.password as string, pass: httpDigestAuth.password as string,
sendImmediately: false, sendImmediately: false,
}; };
authDataKeys.auth = ['pass'];
} }
if (requestOptions.headers!.accept === undefined) { if (requestOptions.headers!.accept === undefined) {
@ -985,15 +996,7 @@ export class HttpRequestV2 implements INodeType {
} }
try { try {
let sendRequest: any = requestOptions; this.sendMessageToUI(sanitizeUiMessage(requestOptions, authDataKeys));
// Protect browser from sending large binary data
if (Buffer.isBuffer(sendRequest.body) && sendRequest.body.length > 250000) {
sendRequest = {
...requestOptions,
body: `Binary data got replaced with this text. Original was a Buffer with a size of ${requestOptions.body.length} byte.`,
};
}
this.sendMessageToUI(sendRequest);
} catch (e) {} } catch (e) {}
if (authentication === 'genericCredentialType' || authentication === 'none') { if (authentication === 'genericCredentialType' || authentication === 'none') {

18
packages/nodes-base/nodes/HttpRequest/V3/HttpRequestV3.node.ts
View file

@ -17,7 +17,9 @@ import { OptionsWithUri } from 'request-promise-native';
import { import {
binaryContentTypes, binaryContentTypes,
getOAuth2AdditionalParameters, getOAuth2AdditionalParameters,
IAuthDataSanitizeKeys,
replaceNullValues, replaceNullValues,
sanitizeUiMessage,
} from '../GenericFunctions'; } from '../GenericFunctions';
export class HttpRequestV3 implements INodeType { export class HttpRequestV3 implements INodeType {
description: INodeTypeDescription; description: INodeTypeDescription;
@ -1208,21 +1210,26 @@ export class HttpRequestV3 implements INodeType {
requestOptions.headers['Content-Type'] = rawContentType; requestOptions.headers['Content-Type'] = rawContentType;
} }
const authDataKeys: IAuthDataSanitizeKeys = {};
// Add credentials if any are set // Add credentials if any are set
if (httpBasicAuth !== undefined) { if (httpBasicAuth !== undefined) {
requestOptions.auth = { requestOptions.auth = {
user: httpBasicAuth.user as string, user: httpBasicAuth.user as string,
pass: httpBasicAuth.password as string, pass: httpBasicAuth.password as string,
}; };
authDataKeys.auth = ['pass'];
} }
if (httpHeaderAuth !== undefined) { if (httpHeaderAuth !== undefined) {
requestOptions.headers![httpHeaderAuth.name as string] = httpHeaderAuth.value; requestOptions.headers![httpHeaderAuth.name as string] = httpHeaderAuth.value;
authDataKeys.headers = [httpHeaderAuth.name as string];
} }
if (httpQueryAuth !== undefined) { if (httpQueryAuth !== undefined) {
if (!requestOptions.qs) { if (!requestOptions.qs) {
requestOptions.qs = {}; requestOptions.qs = {};
} }
requestOptions.qs[httpQueryAuth.name as string] = httpQueryAuth.value; requestOptions.qs[httpQueryAuth.name as string] = httpQueryAuth.value;
authDataKeys.qs = [httpQueryAuth.name as string];
} }
if (httpDigestAuth !== undefined) { if (httpDigestAuth !== undefined) {
requestOptions.auth = { requestOptions.auth = {
@ -1230,6 +1237,7 @@ export class HttpRequestV3 implements INodeType {
pass: httpDigestAuth.password as string, pass: httpDigestAuth.password as string,
sendImmediately: false, sendImmediately: false,
}; };
authDataKeys.auth = ['pass'];
} }
if (requestOptions.headers!.accept === undefined) { if (requestOptions.headers!.accept === undefined) {
@ -1245,15 +1253,7 @@ export class HttpRequestV3 implements INodeType {
} }
try { try {
let sendRequest: any = requestOptions; this.sendMessageToUI(sanitizeUiMessage(requestOptions, authDataKeys));
// Protect browser from sending large binary data
if (Buffer.isBuffer(sendRequest.body) && sendRequest.body.length > 250000) {
sendRequest = {
...requestOptions,
body: `Binary data got replaced with this text. Original was a Buffer with a size of ${requestOptions.body.length} byte.`,
};
}
this.sendMessageToUI(sendRequest);
} catch (e) {} } catch (e) {}
if (authentication === 'genericCredentialType' || authentication === 'none') { if (authentication === 'genericCredentialType' || authentication === 'none') {