this is copied from [opnsenseETPRODocs][The OPNsense Docs]
First we need to install the required plugin, which is responsible for collecting the telemetry data and provides access to the ET Pro ruleset.
- Go to
System ‣ Firmware ‣ Updates
- Press “Check for updates” in the upper right corner.
- Open the tab “Plugins” and search for os-etpro-telemetry
- Click on the + sign on the right to install the plugin
- A screen containing the installation status should appear now and the plugin is ready for use.
The next step is to register your token in OPNsense and enable rulesets.
- Go to
Services ‣ Intrusion Detection ‣ Administration
- Click on the
- This should present you with a list of available rules.
- Enable all categories you would like to monitor in the “ET telemetry” section. if in doubt enable all and monitor the alerts later (select on the right and use the enable selected button on top)
- At the bottom of the page there is a block containing settings paste the token code you received via email in et_telemetry.token
- Press save to persist your token code
- Press Download & Update rules to fetch the current ruleset
To download the rulesets automatically on a daily bases, you can add a schedule for this task.
Go to Services ‣ Intrusion Detection ‣ Administration Click on the “Schedule” tab A popup for the update task appears, enable it using the checkbox on top, and click “save changes” Subscription status
To validate your subscription, we recommend to add the widget to the dashboard.
Go to the dashboard Lobby ‣ Dashboard Click on “Add widget” in the top right corner, click “Telemetry status” in the list Close dialog and click “Save settings” on the right top of the dashboard Open Lobby ‣ Dashboard again to refresh the content When everything is setup properly and the plugin can reach Proofpoint, it will show something like:
../_images/ETPRO_telemetry_widget_active.png The status determines which ruleset your sensor will receive, ACTIVE or DORMANT your sensor will receive ET Pro ruleset, when DISABLED the license conditions are not met and the ET Open ruleset will be served.
All timestamps underneath the status provide you with information when data was send or received from Proofpoint.
If your sensor will start sending events and heartbeats, it should switch to active after a certain amount of time. In case your sensor cant communicate to the outside world, the widget shows an error.
The system log (System ‣ Log Files ‣ General) might contain more information, search for emergingthreats Tip
Always check the token code first, a common mistake is adding leading or trailing spaces to the code, which will show an error in the log (http_code starting with a 4 usually). Information sent to Proofpoint ©
When the intrusion detection system logs events, they will be (partially) sent to Proofpoint in return for using the ET Pro Telemetry edition.
This paragraph describes the attributes from the eve.json log file that are collected to improve threat detection and the sensor health data to evaluate if the data is usable.
An example of an event is detailed below.
Network addresses are needed to identify hosts which pose a higher risk to your and other peoples network, but your internal addresses are kept secret.
For this reason we mask the addresses found in the log file and only send the last number(s) to identify the host. In the example above the src_ip is an internal IPv6 address, for IPv4 we only collect the last number (e.g. 0-255).
Fields collected (unmodified):
Threats change often, to keep statistics valuable, the list of fields is subject to change
The plugin comes with a small script to print eve output yourself, its called
when used with the -p parameter, it will output the data as it will be sent to Proofpoint.
All script code can be found in the following directory