Exporting Rules & IOCs¶
IDSTower features an export functionality that can export IDSTower-managed IDS Rules and Indicators of Compromise (IOCs) in various formats to other tools/systems, including independently managed Suricata instances.
There is various use-cases for exporting rules and IOCs, some of them are:
Exporting IDS Rules to a standalone Suricata instance.
Exporting IDS Rules to a different IDSTower instance (eg: vendor to customer).
Exporting IDS Rules to various customers (eg: MSSP).
Exporting IOCs to a SIEM system.
Exporting IOCs to a Threat Intelligence Platform.
This export features allows you to export IDS Rules and IOCs in various formats, including:
Standard Suricata/Snort IDS Rules format (Text).
Suricata/Snort Rules in STIX 2.1 format (Json).
IOCs in text format (one per line).
IOCs in STIX 2.1 format (Json).
IOCs in Suricata Dataset format, this is used for efficient IOCs alerting in Suricata (Text).
IOCs in Suricata Datarep format, this is the old approach for IP Reputation alerting (Text).
IOCs as Suricata Rules, This allows you to convert IOCs to Suricata Rules and normally used for compatibility reasons (Text).
The export settings contains various options that allows you to customize the export process, some of the options are:
Transformation Settings: This allows you to customize the transformation settings of the exported IDS Rules, for example you can enable/disable the transformation of using heuristics to set the Target Keyword value.
Filtration Settings: This allows you to filter the exported IDS Rules/IOCs based on various criteria, for example you can filter the rules based on the Rule Category or IOCs based on their score.
Once the export is added, the exported data can be downloaded directly from IDSTower through an http(s) link protected by an authentication key, see Export URL below.
In the next guides we will showcase the various options and features available in IDSTower export feature.
Export URL¶
Each export is served at its own URL on the IDSTower server:
https://<idstower-server>/exports/<export-id>?authKey=<authentication-key>
If IDSTower runs under a PathPrefix, the prefix comes before /exports.
The “view” link in the exports list opens this URL with the export’s authentication key already filled in, so the easiest way to get the URL is to copy that link. No IDSTower login is needed to download an export, the authentication key is what protects it, so treat the URL as a secret.
The STIX 2.1 format is served as application/json and all other formats as text/plain. Text-based files start with a comment line beginning with #, which records when the file was generated and how many IDS Rules or IOCs it contains.
Caching¶
IDSTower caches each generated export and serves later requests from the cache. A new file is generated at the next request after any of these:
the export’s settings change;
the IDS Rules (for an IDS Rules export) or the IOCs (for an IOCs export) it selects are added, changed or deleted, including the automatic removal of expired IOCs;
for an IDS Rules export that uses the default transformation settings, those settings change (Settings -> Rules);
a license is activated, or the license changes to another tier, since the Standard license limits what an export contains (see Standard License Limit).
Otherwise the cached file is reused for up to 6 hours by default (the GeneratedPayloadCacheLifetimeMinutes option in the AdvancedSettings section of appsettings.json, see Configuration Guide).
To skip the cache and generate a fresh file, append &disableCache=true to the URL:
https://<idstower-server>/exports/<export-id>?authKey=<authentication-key>&disableCache=true
Every request with disableCache=true generates the export again, so use it for a one-off check rather than in a scheduled download.
Standard License Limit¶
Exports work on every license, but on a Standard license an export contains at most 10 IDS Rules or IOCs, however many match its filters. A Professional or Enterprise license exports the whole set.
The Exports tab shows a banner about this limit, but the system downloading the export never sees it. When the limit was reached, the comment line at the top of the file says that the export is limited by the Standard license. STIX 2.1 exports have no comment line, so they carry no such notice.
Error Responses¶
When IDSTower cannot serve an export, it answers with an HTTP error status and a short plain-text body that starts with #:
Request |
HTTP status |
|---|---|
IDSTower’s license is missing or expired |
402 |
The |
401 |
The export id does not exist |
404 |
The |
401 |
The export is disabled |
400 |
The export id or |
400 |
The export could not be generated |
500 |
Note
Because the error body is a # comment line, a system that ignores the HTTP status and skips comment lines would read a refused request as an empty export. Make sure the system downloading the export treats any status other than 200 as a failure.