n8n/packages/nodes-base/nodes/Webhook.node.ts

337 lines
8.1 KiB
TypeScript
Raw Normal View History

2019-06-23 03:35:23 -07:00
import {
IWebhookFunctions,
} from 'n8n-core';
import {
IDataObject,
2019-12-21 17:03:24 -08:00
INodeExecutionData,
2019-06-23 03:35:23 -07:00
INodeTypeDescription,
INodeType,
IWebhookResponseData,
2019-06-23 03:35:23 -07:00
} from 'n8n-workflow';
import * as basicAuth from 'basic-auth';
import { Response } from 'express';
function authorizationError(resp: Response, realm: string, responseCode: number, message?: string) {
if (message === undefined) {
message = 'Authorization problem!';
if (responseCode === 401) {
message = 'Authorization is required!';
} else if (responseCode === 403) {
message = 'Authorization data is wrong!';
}
}
resp.writeHead(responseCode, { 'WWW-Authenticate': `Basic realm="${realm}"` });
resp.end(message);
return {
noWebhookResponse: true,
};
}
export class Webhook implements INodeType {
description: INodeTypeDescription = {
displayName: 'Webhook',
name: 'webhook',
group: ['trigger'],
version: 1,
description: 'Starts the workflow when a webhook got called.',
defaults: {
name: 'Webhook',
color: '#885577',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'httpBasicAuth',
required: true,
displayOptions: {
show: {
authentication: [
'basicAuth',
],
},
},
},
{
name: 'httpHeaderAuth',
required: true,
displayOptions: {
show: {
authentication: [
'headerAuth',
],
},
},
},
],
webhooks: [
{
name: 'default',
httpMethod: '={{$parameter["httpMethod"]}}',
responseCode: '={{$parameter["responseCode"]}}',
2019-08-28 08:16:09 -07:00
responseMode: '={{$parameter["responseMode"]}}',
responseData: '={{$parameter["responseData"]}}',
2019-06-23 03:35:23 -07:00
responseBinaryPropertyName: '={{$parameter["responseBinaryPropertyName"]}}',
responseContentType: '={{$parameter["options"]["responseContentType"]}}',
responsePropertyName: '={{$parameter["options"]["responsePropertyName"]}}',
2019-06-23 03:35:23 -07:00
path: '={{$parameter["path"]}}',
},
],
properties: [
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
name: 'Basic Auth',
value: 'basicAuth'
},
{
name: 'Header Auth',
value: 'headerAuth'
},
{
name: 'None',
value: 'none'
},
],
default: 'none',
description: 'The way to authenticate.',
},
{
displayName: 'HTTP Method',
name: 'httpMethod',
type: 'options',
options: [
{
name: 'GET',
value: 'GET',
},
{
name: 'POST',
value: 'POST',
},
],
default: 'GET',
description: 'The HTTP method to liste to.',
},
{
displayName: 'Path',
name: 'path',
type: 'string',
default: '',
placeholder: 'webhook',
2019-06-23 03:35:23 -07:00
required: true,
description: 'The path to listen to. Slashes("/") in the path are not allowed.',
2019-06-23 03:35:23 -07:00
},
{
displayName: 'Response Code',
name: 'responseCode',
type: 'number',
typeOptions: {
minValue: 100,
maxValue: 599,
},
default: 200,
description: 'The HTTP Response code to return',
},
2019-06-23 03:35:23 -07:00
{
2019-08-28 08:16:09 -07:00
displayName: 'Response Mode',
name: 'responseMode',
2019-06-23 03:35:23 -07:00
type: 'options',
options: [
{
name: 'On Received',
value: 'onReceived',
description: 'Returns directly with defined Response Code',
2019-06-23 03:35:23 -07:00
},
{
name: 'Last Node',
value: 'lastNode',
description: 'Returns data of the last executed node',
},
],
default: 'onReceived',
description: 'When and how to respond to the webhook.',
},
{
2019-08-28 08:16:09 -07:00
displayName: 'Response Data',
name: 'responseData',
2019-06-23 03:35:23 -07:00
type: 'options',
displayOptions: {
show: {
2019-08-28 08:16:09 -07:00
responseMode: [
2019-06-23 03:35:23 -07:00
'lastNode',
],
},
},
options: [
{
name: 'All Entries',
value: 'allEntries',
description: 'Returns all the entries of the last node. Always returns an array.',
},
{
name: 'First Entry JSON',
value: 'firstEntryJson',
description: 'Returns the JSON data of the first entry of the last node. Always returns a JSON object.',
},
{
name: 'First Entry Binary',
value: 'firstEntryBinary',
description: 'Returns the binary data of the first entry of the last node. Always returns a binary file.',
},
],
default: 'firstEntryJson',
description: 'What data should be returned. If it should return<br />all the itemsas array or only the first item as object.',
},
{
displayName: 'Property Name',
name: 'responseBinaryPropertyName',
type: 'string',
required: true,
default: 'data',
displayOptions: {
show: {
2019-08-28 08:16:09 -07:00
responseData: [
2019-06-23 03:35:23 -07:00
'firstEntryBinary'
],
},
},
description: 'Name of the binary property to return',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
options: [
{
displayName: 'Response Content-Type',
name: 'responseContentType',
type: 'string',
2019-12-21 17:03:24 -08:00
displayOptions: {
show: {
'/responseData': [
'firstEntryJson',
],
'/responseMode': [
'lastNode',
],
},
},
default: '',
placeholder: 'application/xml',
description: 'Set a custom content-type to return if another one as the "application/json" should be returned.',
},
{
displayName: 'Property Name',
name: 'responsePropertyName',
type: 'string',
2019-12-21 17:03:24 -08:00
displayOptions: {
show: {
'/responseData': [
'firstEntryJson',
],
'/responseMode': [
'lastNode',
],
},
},
default: 'data',
description: 'Name of the property to return the data of instead of the whole JSON.',
},
2019-12-21 12:36:08 -08:00
{
displayName: 'Raw Body',
name: 'rawBody',
type: 'boolean',
default: false,
description: 'Raw body (binary)',
},
],
},
2019-06-23 03:35:23 -07:00
],
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
2019-06-23 03:35:23 -07:00
const authentication = this.getNodeParameter('authentication', 0) as string;
2019-12-21 17:03:24 -08:00
const options = this.getNodeParameter('options', 0) as IDataObject;
2019-06-23 03:35:23 -07:00
const req = this.getRequestObject();
const resp = this.getResponseObject();
const headers = this.getHeaderData();
const realm = 'Webhook';
if (authentication === 'basicAuth') {
// Basic authorization is needed to call webhook
const httpBasicAuth = this.getCredentials('httpBasicAuth');
if (httpBasicAuth === undefined || !httpBasicAuth.user || !httpBasicAuth.password) {
// Data is not defined on node so can not authenticate
return authorizationError(resp, realm, 500, 'No authentication data defined on node!');
}
const basicAuthData = basicAuth(req);
if (basicAuthData === undefined) {
// Authorization data is missing
return authorizationError(resp, realm, 401);
}
if (basicAuthData.name !== httpBasicAuth!.user || basicAuthData.pass !== httpBasicAuth!.password) {
// Provided authentication data is wrong
return authorizationError(resp, realm, 403);
}
} else if (authentication === 'headerAuth') {
// Special header with value is needed to call webhook
const httpHeaderAuth = this.getCredentials('httpHeaderAuth');
if (httpHeaderAuth === undefined || !httpHeaderAuth.name || !httpHeaderAuth.value) {
// Data is not defined on node so can not authenticate
return authorizationError(resp, realm, 500, 'No authentication data defined on node!');
}
const headerName = (httpHeaderAuth.name as string).toLowerCase();
const headerValue = (httpHeaderAuth.value as string);
if (!headers.hasOwnProperty(headerName) || (headers as IDataObject)[headerName] !== headerValue) {
// Provided authentication data is wrong
return authorizationError(resp, realm, 403);
}
}
2019-12-21 17:03:24 -08:00
// @ts-ignore
const mimeType = headers['content-type'] || 'application/json';
const response: INodeExecutionData = {
2019-12-21 12:36:08 -08:00
json: {
2019-06-23 03:35:23 -07:00
body: this.getBodyData(),
headers,
query: this.getQueryData(),
2019-12-21 12:36:08 -08:00
},
};
if (options.rawBody) {
response.binary = {
2019-12-21 17:03:24 -08:00
data: {
// @ts-ignore
data: req.rawBody.toString('base64'),
mimeType,
}
2019-12-21 12:36:08 -08:00
};
}
2019-06-23 03:35:23 -07:00
return {
workflowData: [
2019-12-21 12:36:08 -08:00
[
response,
],
2019-06-23 03:35:23 -07:00
],
};
}
}