Skip to content

Commit

Permalink
Version submitted to Splunk Apptitude competition.
Browse files Browse the repository at this point in the history
  • Loading branch information
doksu committed Jan 20, 2015
1 parent d847002 commit e5747a9
Show file tree
Hide file tree
Showing 28 changed files with 2,574 additions and 2 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Douglas Graeme Brown

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
15 changes: 15 additions & 0 deletions README
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
About:

Auditd logs are the single richest and most precise source of auditing information available in GNU/Linux, however they are too often underutilised due to their complexity. This app and its TA make that information readily accessible at enterprise-scale in three mobile-friendly dashboards together with various field extractions, lookups and CIM mappings for Enterprise Security. For example, the event below is mostly comprised of easily parsed key-value pairs, however this app uses the "arch" and "syscall" number to resolve the system call made and determine the posix user from the auid ("actual uid" of the user who executed the process) for searching and correlation in Enterprise Security.

type=SYSCALL msg=audit(1321390138.034:228150): arch=c000003e syscall=62 success=yes exit=0 a0=14a3 a1=0 a2=7fcfa39 a3=12a0 items=0 ppid=19051 pid=19128 auid=3045 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=0 fsgid=0 tty=(none) ses=7643 comm="splunkd" exe="/opt/splunk/bin/splunkd" subj=system_u:system_r:splunk_t:s0 key=(null)

Installation:

Auditd events (sourcetype=linux:audit OR sourcetype=linux_audit) are collected using the Splunk App for Unix and Linux's "Splunk_TA_nix" app deployed to forwarders. This linux-auditd app and its TA_linux-auditd app need only be installed on search heads; if desired, the TA can be installed without this linux-auditd app on Enterprise Security search heads. To install the TA_linux-audit app, simply copy it from linux-auditd/appserver/addons/ to $SPLUNK_HOME/etc/apps/; restart Splunk; and the "TA Status" window below should change from "N/A" to "Working". N.B. Neither this app nor the TA have any mandatory collection, cook, or index-time configurations (ie. it is not necessary to deploy them to forwarders or indexers), however for your convenience, should it be necessary (ie. for collecting auditd events via syslog), we have included a syslog transform; in that case, uncomment the provided prop in TA_linux-auditd and deploy to your syslog collection heavyforwarder/indexer servers.

As noted above, the TA will resolve uid values to posix usernames. For this to occur, two lookups require populating. The first contains local users (typically created by package management) and can be extracted from /etc/passwd using the following command: awk -F ':' 'BEGIN {print "uid,user"} {print $3","$1}' /etc/passwd > /opt/splunk/etc/apps/TA_linux-audit/lookups/local_posix_identities.csv

The second lookup contains directory users and can be populated by scheduling the following search to run periodically with the SA-ldapsearch app: |ldapsearch search="(&(objectclass=user)(uidNumber=*))" attrs="sAMAccountName,uidNumber" | rename sAMAccountName as user, uidNumber as uid | table uid user | outputlookup directory_posix_identities

For improved dashboard performance in large environments, it's recommended to create a local eventtypes.conf in the TA_linux-auditd app to override the default "index=*", explicitly specifying the indices where auditd events are stored in your environment.
2 changes: 0 additions & 2 deletions README.md

This file was deleted.

21 changes: 21 additions & 0 deletions appserver/addons/TA_linux-auditd/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Douglas Graeme Brown

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 5 additions & 0 deletions appserver/addons/TA_linux-auditd/README
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This TA provides field extractions, lookups and CIM mapping for Linux Auditd events (sourcetype=linux:audit)

Audit event type descriptions in the audit_types.csv lookup are derived from: https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Security_Guide/sec-Audit_Record_Types.html

The setrans.csv lookup content is sourced from /etc/selinux/targeted/setrans.conf on Enterprise Linux 6.
14 changes: 14 additions & 0 deletions appserver/addons/TA_linux-auditd/default/app.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[install]
is_configured = 0

[ui]
is_visible = 0
label = Linux Auditd Add-On

[launcher]
author = doksu
description = Linux auditing log field extractions for the Linux Auditd app and CIM mappings for ES.
version = 1.0

[package]
id = TA_linux-auditd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<nav search_view="search" color="#65A637">
<view name="search" default='true' />
<view name="data_models" />
<view name="reports" />
<view name="alerts" />
<view name="dashboards" />
</nav>
Loading

0 comments on commit e5747a9

Please sign in to comment.