mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-26 13:14:07 -08:00
ca9a155c69
* ✨ Create Elastic Security node * 🔨 Place Elastic nodes in Elastic dir * ⚡ Improvements * 🔨 Split credentials * 🎨 Fix formatting * ⚡ Tolerate trailing slash * 👕 Fix lint * 👕 Fix lint * 🐛 Fix tags filter in case:getAll * 🔨 Refactor sort options in case:getAll * ✏️ Reword param descriptions * 🔥 Remove descriptions per feedback * 🐛 Fix case:getStatus operation * ✏️ Reword param and error message * ✏️ Reword param descriptions * 🔨 Account for empty string in owner * ✏️ Reword param description * ✏️ Add more tooltip descriptions * ⚡ Add cred test * ✏️ Add param description * ✏️ Add comment dividers * ⚡ Improve UX for third-party service params * 🔨 Minor tweaks per feedback * 🔨 Make getStatus naming consistent * ⚡ Fix operation Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Mutasem <mutdmour@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
164 lines
3.5 KiB
TypeScript
164 lines
3.5 KiB
TypeScript
import {
|
|
IExecuteFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
IDataObject,
|
|
ILoadOptionsFunctions,
|
|
NodeApiError,
|
|
NodeOperationError,
|
|
} from 'n8n-workflow';
|
|
|
|
import {
|
|
OptionsWithUri,
|
|
} from 'request';
|
|
|
|
import {
|
|
Connector,
|
|
ElasticSecurityApiCredentials,
|
|
} from './types';
|
|
|
|
export async function elasticSecurityApiRequest(
|
|
this: IExecuteFunctions | ILoadOptionsFunctions,
|
|
method: string,
|
|
endpoint: string,
|
|
body: IDataObject = {},
|
|
qs: IDataObject = {},
|
|
) {
|
|
const {
|
|
username,
|
|
password,
|
|
baseUrl: rawBaseUrl,
|
|
} = await this.getCredentials('elasticSecurityApi') as ElasticSecurityApiCredentials;
|
|
|
|
const baseUrl = tolerateTrailingSlash(rawBaseUrl);
|
|
|
|
const token = Buffer.from(`${username}:${password}`).toString('base64');
|
|
|
|
const options: OptionsWithUri = {
|
|
headers: {
|
|
Authorization: `Basic ${token}`,
|
|
'kbn-xsrf': true,
|
|
},
|
|
method,
|
|
body,
|
|
qs,
|
|
uri: `${baseUrl}/api${endpoint}`,
|
|
json: true,
|
|
};
|
|
|
|
if (!Object.keys(body).length) {
|
|
delete options.body;
|
|
}
|
|
|
|
if (!Object.keys(qs).length) {
|
|
delete options.qs;
|
|
}
|
|
|
|
try {
|
|
return await this.helpers.request!(options);
|
|
} catch (error) {
|
|
if (error?.error?.error === 'Not Acceptable' && error?.error?.message) {
|
|
error.error.error = `${error.error.error}: ${error.error.message}`;
|
|
}
|
|
|
|
throw new NodeApiError(this.getNode(), error);
|
|
}
|
|
}
|
|
|
|
export async function elasticSecurityApiRequestAllItems(
|
|
this: IExecuteFunctions,
|
|
method: string,
|
|
endpoint: string,
|
|
body: IDataObject = {},
|
|
qs: IDataObject = {},
|
|
) {
|
|
let page = 1;
|
|
const returnData: IDataObject[] = [];
|
|
let responseData: any; // tslint:disable-line
|
|
|
|
const resource = this.getNodeParameter('resource', 0) as 'case' | 'caseComment';
|
|
|
|
do {
|
|
responseData = await elasticSecurityApiRequest.call(this, method, endpoint, body, qs);
|
|
page++;
|
|
|
|
const items = resource === 'case'
|
|
? responseData.cases
|
|
: responseData;
|
|
|
|
returnData.push(...items);
|
|
} while (returnData.length < responseData.total);
|
|
|
|
return returnData;
|
|
}
|
|
|
|
export async function handleListing(
|
|
this: IExecuteFunctions,
|
|
method: string,
|
|
endpoint: string,
|
|
body: IDataObject = {},
|
|
qs: IDataObject = {},
|
|
) {
|
|
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
|
|
|
|
if (returnAll) {
|
|
return await elasticSecurityApiRequestAllItems.call(this, method, endpoint, body, qs);
|
|
}
|
|
|
|
const responseData = await elasticSecurityApiRequestAllItems.call(this, method, endpoint, body, qs);
|
|
const limit = this.getNodeParameter('limit', 0) as number;
|
|
|
|
return responseData.slice(0, limit);
|
|
}
|
|
|
|
/**
|
|
* Retrieve a connector name and type from a connector ID.
|
|
*
|
|
* https://www.elastic.co/guide/en/kibana/master/get-connector-api.html
|
|
*/
|
|
export async function getConnector(
|
|
this: IExecuteFunctions,
|
|
connectorId: string,
|
|
) {
|
|
const endpoint = `/actions/connector/${connectorId}`;
|
|
const {
|
|
id,
|
|
name,
|
|
connector_type_id: type,
|
|
} = await elasticSecurityApiRequest.call(this, 'GET', endpoint) as Connector;
|
|
|
|
return { id, name, type };
|
|
}
|
|
|
|
export function throwOnEmptyUpdate(
|
|
this: IExecuteFunctions,
|
|
resource: string,
|
|
) {
|
|
throw new NodeOperationError(
|
|
this.getNode(),
|
|
`Please enter at least one field to update for the ${resource}`,
|
|
);
|
|
}
|
|
|
|
export async function getVersion(
|
|
this: IExecuteFunctions,
|
|
endpoint: string,
|
|
) {
|
|
const { version } = await elasticSecurityApiRequest.call(this, 'GET', endpoint) as {
|
|
version?: string;
|
|
};
|
|
|
|
if (!version) {
|
|
throw new NodeOperationError(this.getNode(), 'Cannot retrieve version for resource');
|
|
}
|
|
|
|
return version;
|
|
}
|
|
|
|
export function tolerateTrailingSlash(baseUrl: string) {
|
|
return baseUrl.endsWith('/')
|
|
? baseUrl.substr(0, baseUrl.length - 1)
|
|
: baseUrl;
|
|
}
|