doksu / splunk_auditd

Splunk App for Linux Auditd
58 stars 11 forks source link

TA naming scheme #11

Open brandonganem opened 8 years ago

brandonganem commented 8 years ago

Just a quick note - Splunk Enterprise Security has an import filter for TAs: appregex = (search)|([ST]A-.)|(Splunk[ST]A.)|(DA-ESS-.)|(SplunkDA-ESS._)

This means when the TA is named "TA_" it will not import into ESS. It would be great if the name was updated to use "TA-" for auto import in ESS.

doksu commented 8 years ago

Hi Brandon,

Thanks very much for opening this issue.

The Linux Auditd app for Splunk was originally developed for the vendor's first "Apptitude" competition. One of the rules in the competition was that this document (http://challenges.s3.amazonaws.com/splunk/Best%20Practices%20App%20building.pdf) was to be followed exactly. On page 4 it specified the convention 'TAvendor-product' so I used that even though at the time I thought it was at odds with the more widely accepted 'TA-' convention. It seemed the vendor was moving in the 'TA' convention direction, similar to the sourcetype naming convention change they made from _ to :.

I considered renaming the app to resolve the issue you've raised, but that too could be problematic and so I raised an RFE with support to add '|(TA_.)' to the app_regex. In the interim, my suggestion would be to create a local appregex with 'TA'; I should add this to the documentation :).

Thanks, Doksu

brandonganem commented 8 years ago

Thanks doksu. It isn't entirely surprising that their best practices for some things are out of alignment with their communication for other best practices.

For example, their new addon builder utilizes the "TA_" naming scheme: http://docs.splunk.com/Documentation/AddonBuilder/latest/UserGuide/NameProject

Ultimately it isn't a huge deal either way. The work around you suggested is fine, but not entirely upgrade safe for ES (what if they change the whitelist? The whole key gets overridden in local so your changes are immortal). That's not really this app's fault, it's more of a design fault with ES. The other work around is to rename the TA which is what i've done. Not a big deal.

Thanks!

doksu commented 8 years ago

Just putting a note here with a link to an issue someone else was having with the TA's naming convention and ES: https://answers.splunk.com/answers/418287/cim-is-not-getting-validated-after-splunk-upgrade.html#answer-419124

doksu commented 8 years ago

I've asked Jack Coates (PM for the add-on builder app) about this issue and he informed me that use of the 'TA_' convention has been "fixed" as a bug: http://docs.splunk.com/Documentation/AddonBuilder/1.0.1/UserGuide/Fixedissues