wehub-resource-sync
2.6 KiB
2.6 KiB
@redeye/parser-core / ParserInfo
Interface: ParserInfo
Table of contents
Properties
Properties
description
• Optional description: string
An optional description of the parser
Example
description = 'This parser is super cool and does all the things';
Defined in
id
• id: string
ID for parser, should match the standard name of the binary file or command // The parser binary is named 'my-parser' id = 'my-parser'
Defined in
name
• name: string
The display name of the parser
Example
// The parser binary is named 'my-parser'
name = 'My Super Cool Parser';
Defined in
uploadForm
• uploadForm: UploadForm
An object that configures the upload form in RedEye's UI
Example
// upload a directory of files that are organized by server name and date in the format: <FOLDER_TO_UPLOAD>/<SERVER_NAME>/<YYYYMMDD>/
uploadForm = {
tabTitle: '<C2_NAME>',
enabledInBlueTeam: false,
serverDelineation: ServerDelineationTypes.Folder,
fileUpload: {
type: UploadType.Directory,
description:
'Upload a directory of files that are organized by server name and date in the format: <FOLDER_TO_UPLOAD>/<SERVER_NAME>/<YYYYMMDD>/',
example: `Campaign_Folder
- Server_Folder_1
- 200101
- 200102
- 200103`,
validate: ValidationMode.Parser,
},
fileDisplay: {
editable: true,
},
};
Defined in
version
• version: number
The version of the RedEye parser config that the parser is compatible with
Example
// RedEye parser schema was updated with new fields and commands, bumping from version 1 to 2
version = 2;
// If you haven't updated your parser to use the new fields and commands, you can still use the old version
version = 1;