@tmar/sti-plugin
v1.2.3
Published
NPM module for standardizing SIEM plugins for Sentinel SIEM plugins.
Downloads
6
Readme
NPM module for standardizing SIEM plugins for Sentinel SIEM plugins.
Requirements
The following environment variables are recognized and used to allow the plugin to self-configure. These will usually be set by Docker but may need to be set programmatically when developing:
- STI_PLUGIN_ENV: set to a JSON filename to set environment variables
- API_SERVER: set this to the SIEM Agent API: xxxxxxxx:8443
- API_KEY: This is the API key of the sensor.
- API_SECRET: The API secret key.
- API_FILTER: A filter to use when retrieving service information.
- NODE_TLS_REJECT_UNAUTHORIZED: Define (set to 0) if self-signed certificates should be allowed
Quick Start
Add the plugin to the Node.js project: npm install --save @tmar/sti-plugin
Reference the plugin in code: const plugin = require('@tmar/sti-plugin);
Use the plugin methods.