n8n/packages/nodes-base/nodes/Crypto.node.ts
2020-02-07 22:55:58 -08:00

410 lines
7.9 KiB
TypeScript

import { set } from 'lodash';
import { IExecuteFunctions } from 'n8n-core';
import {
INodeExecutionData,
INodeType,
INodeTypeDescription,
IDataObject,
ILoadOptionsFunctions,
INodePropertyOptions,
} from 'n8n-workflow';
import {
createHash,
createHmac,
createSign,
getHashes,
HexBase64Latin1Encoding,
} from 'crypto';
export class Crypto implements INodeType {
description: INodeTypeDescription = {
displayName: 'Crypto',
name: 'crypto',
icon: 'fa:key',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["action"]}}',
description: 'Provide cryptographic utilities',
defaults: {
name: 'Crypto',
color: '#408000',
},
inputs: ['main'],
outputs: ['main'],
properties: [
{
displayName: 'Action',
name: 'action',
type: 'options',
options: [
{
name: 'Hash',
description: 'Hash a text in a specified format.',
value: 'hash'
},
{
name: 'Hmac',
description: 'Hmac a text in a specified format.',
value: 'hmac'
},
{
name: 'Sign',
description: 'Sign a string using a private key.',
value: 'sign'
},
],
default: 'hash',
},
{
displayName: 'Type',
name: 'type',
displayOptions: {
show: {
action:[
'hash'
],
},
},
type: 'options',
options: [
{
name: 'MD5',
value: 'MD5',
},
{
name: 'SHA256',
value: 'SHA256',
},
{
name: 'SHA512',
value: 'SHA512',
},
],
default: 'MD5',
description: 'The hash type to use',
required: true,
},
{
displayName: 'Value',
name: 'value',
displayOptions: {
show: {
action:[
'hash'
],
},
},
type: 'string',
default: '',
description: 'The value that should be hashed.',
required: true,
},
{
displayName: 'Property Name',
name: 'dataPropertyName',
type: 'string',
default: 'data',
required: true,
displayOptions: {
show: {
action: [
'hash'
],
},
},
description: 'Name of the property to which to write the hash.',
},
{
displayName: 'Encoding',
name: 'encoding',
displayOptions: {
show: {
action:[
'hash'
],
},
},
type: 'options',
options: [
{
name: 'BASE64',
value: 'base64',
},
{
name: 'HEX',
value: 'hex',
},
],
default: 'hex',
required: true,
},
{
displayName: 'Type',
name: 'type',
displayOptions: {
show: {
action:[
'hmac'
],
},
},
type: 'options',
options: [
{
name: 'MD5',
value: 'MD5',
},
{
name: 'SHA256',
value: 'SHA256',
},
{
name: 'SHA512',
value: 'SHA512',
},
],
default: 'MD5',
description: 'The hash type to use',
required: true,
},
{
displayName: 'Value',
name: 'value',
displayOptions: {
show: {
action:[
'hmac'
],
},
},
type: 'string',
default: '',
description: 'The value of which the hmac should be created.',
required: true,
},
{
displayName: 'Property Name',
name: 'dataPropertyName',
type: 'string',
default: 'data',
required: true,
displayOptions: {
show: {
action: [
'hmac'
],
},
},
description: 'Name of the property to which to write the hmac.',
},
{
displayName: 'Secret',
name: 'secret',
displayOptions: {
show: {
action:[
'hmac'
],
},
},
type: 'string',
default: '',
required: true,
},
{
displayName: 'Encoding',
name: 'encoding',
displayOptions: {
show: {
action:[
'hmac',
],
},
},
type: 'options',
options: [
{
name: 'BASE64',
value: 'base64',
},
{
name: 'HEX',
value: 'hex',
},
],
default: 'hex',
required: true,
},
{
displayName: 'Value',
name: 'value',
displayOptions: {
show: {
action:[
'sign'
],
},
},
type: 'string',
default: '',
description: 'The value that should be signed.',
required: true,
},
{
displayName: 'Property Name',
name: 'dataPropertyName',
type: 'string',
default: 'data',
required: true,
displayOptions: {
show: {
action: [
'sign'
],
},
},
description: 'Name of the property to which to write the signed value.',
},
{
displayName: 'Algorithm',
name: 'algorithm',
displayOptions: {
show: {
action:[
'sign',
],
},
},
type: 'options',
typeOptions: {
loadOptionsMethod: 'getHashes',
},
default: '',
required: true,
},
{
displayName: 'Encoding',
name: 'encoding',
displayOptions: {
show: {
action:[
'sign',
],
},
},
type: 'options',
options: [
{
name: 'BASE64',
value: 'base64',
},
{
name: 'HEX',
value: 'hex',
},
],
default: 'hex',
required: true,
},
{
displayName: 'Private Key',
name: 'privateKey',
displayOptions: {
show: {
action:[
'sign'
],
},
},
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
description: 'Private key to use when signing the string.',
default: '',
required: true,
},
],
};
methods = {
loadOptions: {
// Get all the hashes to display them to user so that he can
// select them easily
async getHashes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const hashes = getHashes();
for (const hash of hashes) {
const hashName = hash;
const hashId = hash;
returnData.push({
name: hashName,
value: hashId,
});
}
return returnData;
},
}
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: INodeExecutionData[] = [];
const length = items.length as unknown as number;
const action = this.getNodeParameter('action', 0) as string;
let item: INodeExecutionData;
for (let i = 0; i < length; i++) {
item = items[i];
const dataPropertyName = this.getNodeParameter('dataPropertyName', i) as string;
const value = this.getNodeParameter('value', i) as string;
let newValue;
if (action === 'hash') {
const type = this.getNodeParameter('type', i) as string;
const encoding = this.getNodeParameter('encoding', i) as HexBase64Latin1Encoding;
newValue = createHash(type).update(value).digest(encoding);
}
if (action === 'hmac') {
const type = this.getNodeParameter('type', i) as string;
const secret = this.getNodeParameter('secret', i) as string;
const encoding = this.getNodeParameter('encoding', i) as HexBase64Latin1Encoding;
newValue = createHmac(type, secret).update(value).digest(encoding);
}
if (action === 'sign') {
const algorithm = this.getNodeParameter('algorithm', i) as string;
const encoding = this.getNodeParameter('encoding', i) as HexBase64Latin1Encoding;
const privateKey = this.getNodeParameter('privateKey', i) as string;
const sign = createSign(algorithm);
sign.write(value as string);
sign.end();
newValue = sign.sign(privateKey, encoding);
}
let newItem: INodeExecutionData;
if (dataPropertyName.includes('.')) {
// Uses dot notation so copy all data
newItem = {
json: JSON.parse(JSON.stringify(item.json)),
};
} else {
// Does not use dot notation so shallow copy is enough
newItem = {
json: { ...item.json },
};
}
if (item.binary !== undefined) {
newItem.binary = item.binary;
}
set(newItem, `json.${dataPropertyName}`, newValue);
returnData.push(newItem);
}
return this.prepareOutputData(returnData);
}
}