n8n/packages/nodes-base/nodes/Cortex/ResponderDescription.ts
Iván Ovejero 0448feec56
refactor: Apply eslint-plugin-n8n-nodes-base autofixable rules (#3174)
*  Initial setup

* 👕 Update `.eslintignore`

* 👕 Autofix node-param-default-missing (#3173)

* 🔥 Remove duplicate key

* 👕 Add exceptions

* 📦 Update package-lock.json

* 👕 Apply `node-class-description-inputs-wrong-trigger-node` (#3176)

* 👕 Apply `node-class-description-inputs-wrong-regular-node` (#3177)

* 👕 Apply `node-class-description-outputs-wrong` (#3178)

* 👕 Apply `node-execute-block-double-assertion-for-items` (#3179)

* 👕 Apply `node-param-default-wrong-for-collection` (#3180)

* 👕 Apply node-param-default-wrong-for-boolean (#3181)

* Autofixed default missing

* Autofixed booleans, worked well

*  Fix params

*  Undo exempted autofixes

* 📦 Update package-lock.json

* 👕 Apply node-class-description-missing-subtitle (#3182)

*  Fix missing comma

* 👕 Apply `node-param-default-wrong-for-fixed-collection` (#3184)

* 👕 Add exception for `node-class-description-missing-subtitle`

* 👕 Apply `node-param-default-wrong-for-multi-options` (#3185)

* 👕 Apply `node-param-collection-type-unsorted-items` (#3186)

* Missing coma

* 👕 Apply `node-param-default-wrong-for-simplify` (#3187)

* 👕 Apply `node-param-description-comma-separated-hyphen` (#3190)

* 👕 Apply `node-param-description-empty-string` (#3189)

* 👕 Apply `node-param-description-excess-inner-whitespace` (#3191)

* Rule looks good

* Add whitespace rule in eslint config

* :zao: fix

* 👕 Apply `node-param-description-identical-to-display-name` (#3193)

* 👕 Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195)

*  Revert ":zao: fix"

This reverts commit ef8a76f3df.

* 👕 Apply `node-param-description-missing-for-simplify`  (#3196)

* 👕 Apply `node-param-description-missing-final-period` (#3194)

* Rule working as intended

* Add rule to eslint

* 👕 Apply node-param-description-missing-for-return-all (#3197)

*  Restore `lintfix` command

Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
Co-authored-by: Omar Ajoue <krynble@gmail.com>
Co-authored-by: agobrech <ael.gobrecht@gmail.com>
Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 18:29:51 +02:00

888 lines
16 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
import {
TLP,
} from './AnalyzerInterface';
export const respondersOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
required: true,
description: 'Choose an operation.',
displayOptions: {
show: {
resource: [
'responder',
],
},
},
options: [
{
name: 'Execute',
value: 'execute',
description: 'Execute Responder',
},
],
default: 'execute',
},
];
export const responderFields: INodeProperties[] = [
{
displayName: 'Responder Type',
name: 'responder',
type: 'options',
required: true,
typeOptions: {
loadOptionsMethod: 'loadActiveResponders',
},
default: '',
displayOptions: {
show: {
resource: [
'responder',
],
},
},
description: 'Choose the responder.',
},
{
displayName: 'Entity Type',
name: 'entityType',
type: 'options',
required: true,
displayOptions: {
show: {
resource: [
'responder',
],
},
},
typeOptions: {
loadOptionsMethod: 'loadDataTypeOptions',
loadOptionsDependsOn: [
'responder',
],
},
default: '',
description: 'Choose the Data type.',
},
{
displayName: 'JSON Parameters',
name: 'jsonObject',
type: 'boolean',
default: false,
description: 'Choose between providing JSON object or seperated attributes.',
displayOptions: {
show: {
resource: [
'responder',
],
},
},
},
{
displayName: 'Entity Object (JSON)',
name: 'objectData',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'responder',
],
jsonObject: [
true,
],
},
},
default: '',
},
{
displayName: 'Parameters',
name: 'parameters',
type: 'fixedCollection',
placeholder: 'Add Parameter',
required: false,
options: [
{
displayName: 'Case Attributes',
name: 'values',
values: [
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Title of the case',
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'Description of the case',
},
{
displayName: 'Severity',
name: 'severity',
type: 'options',
default: 2,
options: [
{
name: 'Low',
value: 1,
},
{
name: 'Medium',
value: 2,
},
{
name: 'High',
value: 3,
},
],
description: 'Severity of the case. Default=Medium.',
},
{
displayName: 'Start Date',
name: 'startDate',
type: 'dateTime',
default: '',
description: 'Date and time of the begin of the case default=now',
},
{
displayName: 'Owner',
name: 'owner',
type: 'string',
default: '',
description: `User who owns the case. This is automatically set to current user when status is set to InProgress.`,
},
{
displayName: 'Flag',
name: 'flag',
type: 'boolean',
default: false,
description: 'Flag of the case default=false.',
},
{
displayName: 'TLP',
name: 'tlp',
type: 'options',
default: 2,
options: [
{
name: 'White',
value: TLP.white,
},
{
name: 'Green',
value: TLP.green,
},
{
name: 'Amber',
value: TLP.amber,
},
{
name: 'Red',
value: TLP.red,
},
],
description: 'Traffict Light Protocol (TLP). Default=Amber.',
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
default: '',
placeholder: 'tag1,tag2,...',
},
],
},
],
typeOptions: {
loadOptionsDependsOn: [
'entityType',
],
},
displayOptions: {
show: {
resource: [
'responder',
],
jsonObject: [
false,
],
entityType: [
'case',
],
},
hide: {
entityType: [
'',
'alert',
'case_artifact',
'case_task',
'case_task_log',
],
},
},
default: {},
},
{
displayName: 'Parameters',
name: 'parameters',
type: 'fixedCollection',
placeholder: 'Add Parameter',
required: false,
options: [
{
displayName: 'Alert Attributes',
name: 'values',
values: [
{
displayName: 'Title',
name: 'title',
type: 'string',
default: '',
description: 'Title of the alert',
},
{
displayName: 'Description',
name: 'description',
type: 'string',
default: '',
description: 'Description of the alert',
},
{
displayName: 'Severity',
name: 'severity',
type: 'options',
default: 2,
options: [
{
name: 'Low',
value: 1,
},
{
name: 'Medium',
value: 2,
},
{
name: 'High',
value: 3,
},
],
description: 'Severity of the case. Default=Medium.',
},
{
displayName: 'Date',
name: 'date',
type: 'dateTime',
default: '',
description: 'Date and time when the alert was raised default=now.',
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
placeholder: 'tag1,tag2,...',
default: '',
},
{
displayName: 'TLP',
name: 'tlp',
type: 'options',
default: 2,
options: [
{
name: 'White',
value: TLP.white,
},
{
name: 'Green',
value: TLP.green,
},
{
name: 'Amber',
value: TLP.amber,
}, {
name: 'Red',
value: TLP.red,
},
],
description: 'Traffict Light Protocol (TLP). Default=Amber.',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
default: 'New',
options: [
{
name: 'New',
value: 'New',
},
{
name: 'Updated',
value: 'Updated',
},
{
name: 'Ignored',
value: 'Ignored',
},
{
name: 'Imported',
value: 'Imported',
},
],
description: 'Status of the alert. Default=New.',
},
{
displayName: 'Type',
name: 'type',
type: 'string',
default: '',
description: 'Type of the alert.',
},
{
displayName: 'Source',
name: 'source',
type: 'string',
default: '',
description: 'Source of the alert.',
},
{
displayName: 'SourceRef',
name: 'sourceRef',
type: 'string',
default: '',
description: 'Source reference of the alert',
},
{
displayName: 'Follow',
name: 'follow',
type: 'boolean',
default: false,
},
{
displayName: 'Artifacts',
name: 'artifacts',
type: 'fixedCollection',
placeholder: 'Add an artifact',
required: false,
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add an Artifact',
},
default: [],
options: [
{
displayName: 'Artifact',
name: 'artifactValues',
values: [
{
displayName: 'Data Type',
name: 'dataType',
type: 'options',
default: '',
options: [
{
name: 'Domain',
value: 'domain',
},
{
name: 'File',
value: 'file',
},
{
name: 'Filename',
value: 'filename',
},
{
name: 'Fqdn',
value: 'fqdn',
},
{
name: 'Hash',
value: 'hash',
},
{
name: 'IP',
value: 'ip',
},
{
name: 'Mail',
value: 'mail',
},
{
name: 'Mail Subject',
value: 'mail_subject',
},
{
name: 'Other',
value: 'other',
},
{
name: 'Regexp',
value: 'regexp',
},
{
name: 'Registry',
value: 'registry',
},
{
name: 'Uri Path',
value: 'uri_path',
},
{
name: 'URL',
value: 'url',
},
{
name: 'User Agent',
value: 'user-agent',
},
],
},
{
displayName: 'Data',
name: 'data',
type: 'string',
displayOptions: {
hide: {
dataType: [
'file',
],
},
},
default: '',
},
{
displayName: 'Binary Property',
name: 'binaryProperty',
type: 'string',
displayOptions: {
show: {
dataType: [
'file',
],
},
},
default: 'data',
},
{
displayName: 'Message',
name: 'message',
type: 'string',
default: '',
},
{
displayName: 'Tags',
name: 'tags',
type: 'string',
default: '',
},
],
},
],
},
],
},
],
typeOptions: {
loadOptionsDependsOn: [
'entityType',
],
},
displayOptions: {
show: {
resource: [
'responder',
],
jsonObject: [
false,
],
entityType: [
'alert',
],
},
hide: {
responder: [
'',
],
entityType: [
'',
'case',
'case_artifact',
'case_task',
'case_task_log',
],
},
},
default: {},
},
{
displayName: 'Parameters',
name: 'parameters',
type: 'fixedCollection',
placeholder: 'Add Parameter',
required: false,
options: [
{
displayName: 'Observable Attributes',
name: 'values',
values: [
{
displayName: 'DataType',
name: 'dataType',
type: 'options',
default: '',
options: [
{
name: 'Domain',
value: 'domain',
},
{
name: 'File',
value: 'file',
},
{
name: 'Filename',
value: 'filename',
},
{
name: 'Fqdn',
value: 'fqdn',
},
{
name: 'Hash',
value: 'hash',
},
{
name: 'IP',
value: 'ip',
},
{
name: 'Mail',
value: 'mail',
},
{
name: 'Mail Subject',
value: 'mail_subject',
},
{
name: 'Other',
value: 'other',
},
{
name: 'Regexp',
value: 'regexp',
},
{
name: 'Registry',
value: 'registry',
},
{
name: 'Uri Path',
value: 'uri_path',
},
{
name: 'URL',
value: 'url',
},
{
name: 'User Agent',
value: 'user-agent',
},
],
},
{
displayName: 'Data',
name: 'data',
type: 'string',
default: '',
displayOptions: {
hide: {
dataType: [
'file',
],
},
},
},
{
displayName: 'Binary Property',
name: 'binaryPropertyName',
type: 'string',
default: 'data',
displayOptions: {
show: {
dataType: [
'file',
],
},
},
description: 'Name of the binary property which contains the attachement data.',
},
{
displayName: 'Message',
name: 'message',
type: 'string',
default: '',
},
{
displayName: 'Start Date',
name: 'startDate',
type: 'dateTime',
default: '',
description: 'Date and time of the begin of the case default=now.',
},
{
displayName: 'TLP',
name: 'tlp',
type: 'options',
default: 2,
options: [
{
name: 'White',
value: TLP.white,
},
{
name: 'Green',
value: TLP.green,
},
{
name: 'Amber',
value: TLP.amber,
}, {
name: 'Red',
value: TLP.red,
},
],
description: 'Traffict Light Protocol (TLP). Default=Amber.',
},
{
displayName: 'IOC',
name: 'ioc',
type: 'boolean',
default: false,
description: 'Indicates if the observable is an IOC (Indicator of compromise).',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
default: '',
options: [
{
name: 'Ok',
value: 'Ok',
},
{
name: 'Deleted',
value: 'Deleted',
},
],
description: 'Status of the observable (Ok or Deleted) default=Ok.',
},
],
},
],
typeOptions: {
loadOptionsDependsOn: [
'entityType',
],
},
displayOptions: {
show: {
resource: [
'responder',
],
jsonObject: [
false,
],
entityType: [
'case_artifact',
],
},
hide: {
responder: [
'',
],
entityType: [
'',
'case',
'alert',
'case_task',
'case_task_log',
],
},
},
default: {},
},
{
displayName: 'Parameters',
name: 'parameters',
type: 'fixedCollection',
placeholder: 'Add Parameter',
required: false,
options: [
{
displayName: 'Task Attributes',
name: 'values',
values: [
{
displayName: 'Title',
name: 'title',
type: 'string',
required: false,
default: '',
description: 'Title of the task.',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
default: 'Waiting',
options: [
{
name: 'Waiting',
value: 'Waiting',
},
{
name: 'InProgress',
value: 'InProgress',
},
{
name: 'Completed',
value: 'Completed',
},
{
name: 'Cancel',
value: 'Cancel',
},
],
},
{
displayName: 'Flag',
name: 'flag',
type: 'boolean',
default: false,
},
],
},
],
typeOptions: {
loadOptionsDependsOn: [
'entityType',
],
},
displayOptions: {
show: {
resource: [
'responder',
],
jsonObject: [
false,
],
entityType: [
'case_task',
],
},
hide: {
responder: [
'',
],
entityType: [
'',
'case',
'alert',
'case_artifact',
'case_task_log',
],
},
},
default: {},
},
{
displayName: 'Parameters',
name: 'parameters',
type: 'fixedCollection',
placeholder: 'Add Parameter',
required: false,
options: [
{
displayName: 'Log Attributes',
name: 'values',
values: [
{
displayName: 'Message',
name: 'message',
type: 'string',
default: '',
},
{
displayName: 'Start Date',
name: 'startDate',
type: 'dateTime',
default: '',
description: 'Date and time of the begin of the case default=now',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
required: true,
default: '',
options: [
{
name: 'Ok',
value: 'Ok',
},
{
name: 'Deleted',
value: 'Deleted',
},
],
},
],
},
],
typeOptions: {
loadOptionsDependsOn: [
'entityType',
],
},
displayOptions: {
show: {
resource: [
'responder',
],
jsonObject: [
false,
],
entityType: [
'case_task_log',
],
},
hide: {
responder: [
'',
],
entityType: [
'',
'case',
'alert',
'case_artifact',
'case_task',
],
},
},
default: {},
},
];