2.2.10 • Published 4 years ago
@securecodebox/scanner-scaffolding v2.2.10
SecureCodeBox Scanner Scaffolding
A wrapper to easily integrate new scanner into the secureCodeBox.
This bundles a few basic concernes every worker service should fullfill:
- Fetching and completing Tasks
- Healthcheck endpoints
- Error handeling
Requirements
This libary is compatible with Node 8 and beyond.
Installation
npm install @securecodebox/scanner-scaffolding
Example
This example shows how this libary can be used:
const SecureCodeBoxScannerScaffolding = require('@securecodebox/scanner-scaffolding');
const worker = new SecureCodeBoxScannerScaffolding(
// Callback function which will be called when a new scan should be performed
async targets => {
return { raw: [], result: [] };
},
{
engineAddress: 'http://localhost:8080',
// Name of the External Task specified in the Engine
topic: 'nmap_portscan',
// Used to generate the worker id. This Example would look something like this: securebox.portscan.60a6ac0c-4e26-40ea-908e-598e9c807887
workername: 'portscan',
// Used in the status page and logged on startup to check if the connection to the scanner is successful
// Needs to return a object with to attribtues version and testRun
async testScannerFunctionality() {
return { version: '1.5.3', testRun: 'successful' };
},
}
);
/**
* Starts a small server with two endpoints:
*
* "/" basic endpoint for healthchecks returns the worker id as a string
* "/status" returns a json object containing basic information about this worker
*/
worker.startStatusServer();
Handeling Errors
In case of a scan failure you can throw Errors from the Callback function. The Error message will be submitted back to the engine.
2.2.10
4 years ago
2.2.9
4 years ago
2.2.8
4 years ago
2.2.7
4 years ago
2.2.6
5 years ago
2.2.5
5 years ago
2.2.5-0
5 years ago
2.2.4
5 years ago
2.2.3
5 years ago
2.2.2
5 years ago
2.2.1
5 years ago
2.2.1-0
5 years ago
2.2.0
5 years ago
2.1.3
6 years ago
2.1.2
6 years ago
2.1.0
6 years ago
2.0.1
6 years ago
2.0.0
6 years ago
1.1.0
6 years ago
1.0.0
6 years ago
1.0.2-0
6 years ago
1.0.1-0
6 years ago
1.0.0-0
6 years ago
0.1.10
6 years ago
0.1.9
6 years ago
0.1.8
6 years ago
0.1.7
6 years ago
0.1.6
6 years ago
0.1.5
6 years ago
0.1.1
6 years ago