Skip to content

Latest commit

 

History

History
87 lines (55 loc) · 3.54 KB

README.md

File metadata and controls

87 lines (55 loc) · 3.54 KB
Raw

TA-spur Splunk addon

About

This addon provides a custom search command for interracting with SPUR APIs.

SPUR is an IP lookup website featuring Proxy/VPN detection. The API is available, so you can perform fraud checks on online stores, detect malicious players on online games and much more!

Ref: https://spur.us/products/context-api

  • Author: Cameron Just
  • Version: 1.1.7
  • Splunkbase URL: n/a
  • Source type(s): n/a
  • Has index-time operations: No
  • Input requirements: None
  • Supported product(s): Search Heads

Usage

On installation you will need to go to the apps setup page and enter your SPUR API key.

Once setup just run any search which contains IP addresses and feed them into the custom search command.

Usage:

<search command with ip address> | spuripscan field=[field_name_with_ip_address]

Example:

| makeresults count=10 | eval dest_ip = if((random()%3) == 1, "8.8.8.8", "4.4.4.4") | spuripscan field=dest_ip

Clearing KVStore

/opt/splunk/bin/splunk clean kvstore -app TA-spur -collection spur_cache

Troubleshooting

Try this search to see what sort of errors might be thrown by spuripscan.py script that runs the search command.

index=_internal source=spur

Developer Tips

Setup pages use a ridiculous number of files so make sure you edit them all when making changes. This is the most painful part of the whole app creation. Good luck!!!

  • bin/spur_setup_handler.py - Writes conf files to local/spur.conf and stores the API key in the password store
  • default/restmap.conf - Defines the Splunk REST endpoints related to configurations
  • default/data/ui/views/setup_page.xml - Renders the form for entering setup config in the web GUI
  • appserver/static/setup_page.css - Make config page pretty
  • appserver/static/setup_page.js - Javascript which pulls the existing app config from Splunk via a call to Splunk REST endpoints
  • default/web.conf - Allows the setup endpoints to be visible externally so the javascript on the configuration page can poll the API for previously configred settings

The search commands that actually does all the useful things use less files

  • default/commands.conf - Tells Splunk about the search command
  • bin/spur.py - Runs the search command

Troubleshooting errors with setup page not saving correctly index=_internal source=*TA-spur_setuphandler.log

If things arenot working with setup pages make sure you have a default/spur.conf as there are issues with unconfigured apps.

Try to get to the endpoint for the config files https://192.168.64.60:8089/servicesNS/nobody/TA-spur/configs/conf-spur/spur_config?output_mode=json

Changelog

  • 1.0.0 - Initial development (2022-05-11)
  • 1.1.1 - Added in proxy server options and health dashboard(2022-05-30)
  • 1.1.2 - Added in detection of setup page completion (2022-05-31)
  • 1.1.3 - Fixed bug with proxy server logging of success (2022-05-31)
  • 1.1.4 - Updated Splunklib and fixed some python upgrade readiness issues (2022-06-07) - https://github.com/splunk/splunk-sdk-python
  • 1.1.5 - More sanity checking for optional boolean parameters (2022-06-15)
  • 1.1.6 - Fixed issue with proxy config
  • 1.1.7 - Better API error detection and warnings in Splunk GUI for incorrect API key. Also added more robust proxy erro reporting in GUI. (20230927)

ToDo

  • Include option for modifying the cache expiry date
  • Ensure functionality exists for no KVStore Usage
  • Improvements to Error Reporting

Splunk App Inspect Results