Giter VIP home page Giter VIP logo

security-content's Introduction

Splunk Security Content

security-content

branch build status
develop develop status
master master status

Welcome to the Splunk Security Content

This project gives you access to our repository of Analytic Stories that are security guides which provide background on TTPs, mapped to the MITRE framework, the Lockheed Martin Kill Chain, and CIS controls. They include Splunk searches, machine-learning algorithms, and Splunk Phantom playbooks (where available)—all designed to work together to detect, investigate, and respond to threats.

Usage

The Splunk Security Content can be used via:

Grab the latest release of DA-ESS-ContentUpdate and install it on a Splunk Enterprise instance.

curl -s https://content.splunkresearch.com | jq
{
  "hello": "welcome to Splunks Research security content api"
}

Create your customized version of Security Content by forking this project and following this guide.

What's in an Analytic Story?

Analytic Stories and their corresponding searches are composed of .yml files (manifests) and associated .conf files. The stories reside in /stories and the searches live in /detections.

Manifests contain a number of mandatory and optional fields. You can see the full field list for each piece of content here.

Customize to your Environment

After release 1.0.46 we introduced a concept of input(pre-filter) and output(post-filter) macros for each of our detection search. The intention behind introducing these macros is primarily to help our users to update the macro definition “once” and those changes will be applicable across all detections that leverage that macro and local to your Splunk Environment.

input(pre-filter): This macro is to specify your environment-specific configurations (index, source, sourcetype, etc.) to get the specific data sources that you would like to bring in. Replace the macro definition with configurations for your Splunk environment. For example the sysmon input macro can be modified to the local splunk deployments index or sourcetype.

output(post-filter): This macro is to specify your environment-specific values (eg: dest, user), to filter out known false positives.. Replace the macro definition with values that you’d like to exclude from detection results. Think of this as a whitelisting/blacklisting using macros. A good example

Execute an Analytic Story

Download and install the latest version of [Splunk Analytic Story Execution] (https://github.com/splunk/analytic_story_execution/releases). This Splunk application will help the user do the following:

  1. Execute an analytic story in an adhoc mode and view the results.
  2. Schedule all the detection searches in an analytic story.
  3. Update security-content via an API

Writing Content

Before you begin, follow the steps to install dependencies and pre-commit hooks under "Developing".

Security Content

Content Parts

  • stories/: All Analytic Stories
  • detections/: Splunk Enterprise, Splunk UBA, and Splunk Phantom detections that power Analytic Stories
  • response_tasks/: Splunk Enterprise and Splunk Phantom investigative searches and playbooks employed by Analytic Stories
  • responses/: Automated Splunk Enterprise and Splunk Phantom responses triggered by Analytic Stories
  • baselines/: Splunk Phantom and Splunk Enterprise baseline searches needed to support detection searches in Analytic Stories

Supporting Parts

  • package/: Splunk content app-source files, including lookups, binaries, and default config files
  • bin/: All binaries required to produce and test content

Contribution

We welcome feedback and contributions from the community! Please see our contribution guidelines for more information on how to get involved.

Support

Please use the GitHub Issue Tracker to submit bugs or request features.

If you have questions or need support, you can:

security-content's People

Contributors

josehelps avatar dependabot-preview[bot] avatar patel-bhavin avatar rvaldez617 avatar briannablacet avatar rosplk avatar philroyer-phantom avatar jzsplunk avatar p4t12ick avatar bblacet avatar muralith-xilinx avatar jwindley-splunk avatar russnolen avatar carroyod avatar seanmalloy-crest avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.