n8n/packages/nodes-base/nodes/Misp/GenericFunctions.ts
2024-04-26 11:12:22 +03:00

171 lines
4 KiB
TypeScript

import { URL } from 'url';
import type {
IExecuteFunctions,
IDataObject,
ILoadOptionsFunctions,
JsonObject,
IHttpRequestMethods,
IRequestOptions,
} from 'n8n-workflow';
import { NodeApiError, NodeOperationError, jsonParse } from 'n8n-workflow';
import type { MispCredentials } from './types';
export async function mispApiRequest(
this: IExecuteFunctions | ILoadOptionsFunctions,
method: IHttpRequestMethods,
endpoint: string,
body: IDataObject = {},
qs: IDataObject = {},
) {
const { baseUrl, allowUnauthorizedCerts } = (await this.getCredentials(
'mispApi',
)) as MispCredentials;
const options: IRequestOptions = {
method,
body,
qs,
uri: `${baseUrl}${endpoint}`,
json: true,
rejectUnauthorized: !allowUnauthorizedCerts,
};
if (!Object.keys(body).length) {
delete options.body;
}
if (!Object.keys(qs).length) {
delete options.qs;
}
try {
return await this.helpers.requestWithAuthentication.call(this, 'mispApi', options);
} catch (error) {
// MISP API wrongly returns 403 for malformed requests
if (error.statusCode === 403) {
error.statusCode = 400;
}
const errors = error?.error?.errors;
if (errors) {
const key = Object.keys(errors as IDataObject)[0];
if (key !== undefined) {
let message = errors[key].join();
if (message.includes(' nter')) {
message = message.replace(' nter', ' enter');
}
error.error.message = `${error.error.message}: ${message}`;
}
}
throw new NodeApiError(this.getNode(), error as JsonObject);
}
}
export async function mispApiRequestAllItems(this: IExecuteFunctions, endpoint: string) {
const responseData = await mispApiRequest.call(this, 'GET', endpoint);
const returnAll = this.getNodeParameter('returnAll', 0);
if (!returnAll) {
const limit = this.getNodeParameter('limit', 0);
return responseData.slice(0, limit);
}
return responseData;
}
export async function mispApiRestSearch(
this: IExecuteFunctions,
resource: 'attributes' | 'events' | 'objects',
itemIndex: number,
) {
let body: IDataObject = {};
const useJson = this.getNodeParameter('useJson', itemIndex) as boolean;
if (useJson) {
const json = this.getNodeParameter('jsonOutput', itemIndex);
if (typeof json === 'string') {
body = jsonParse(json);
} else {
body = json as IDataObject;
}
} else {
const value = this.getNodeParameter('value', itemIndex) as string;
const additionalFields = this.getNodeParameter('additionalFields', itemIndex);
body.value = value;
if (Object.keys(additionalFields).length) {
if (additionalFields.tags) {
additionalFields.tags = (additionalFields.tags as string)
.split(',')
.map((tag) => tag.trim());
}
Object.assign(body, additionalFields);
}
}
const endpoint = `/${resource}/restSearch`;
const { response } = await mispApiRequest.call(this, 'POST', endpoint, body);
if (response) {
if (resource === 'attributes') {
return response.Attribute;
}
if (resource === 'events') {
return (response as IDataObject[]).map((event) => event.Event);
}
if (resource === 'objects') {
return (response as IDataObject[]).map((obj) => obj.Object);
}
} else {
return [];
}
}
export function throwOnEmptyUpdate(
this: IExecuteFunctions,
resource: string,
updateFields: IDataObject,
) {
if (!Object.keys(updateFields).length) {
throw new NodeOperationError(
this.getNode(),
`Please enter at least one field to update for the ${resource}.`,
);
}
}
const SHARING_GROUP_OPTION_ID = 4;
export function throwOnMissingSharingGroup(this: IExecuteFunctions, fields: IDataObject) {
if (fields.distribution === SHARING_GROUP_OPTION_ID && !fields.sharing_group_id) {
throw new NodeOperationError(this.getNode(), 'Please specify a sharing group');
}
}
const isValidUrl = (str: string) => {
try {
new URL(str);
return true;
} catch (error) {
return false;
}
};
export function throwOnInvalidUrl(this: IExecuteFunctions, str: string) {
if (!isValidUrl(str)) {
throw new NodeOperationError(
this.getNode(),
'Please specify a valid URL, protocol included. Example: https://site.com',
);
}
}