Skip to content

Commit

Permalink
Version 1.0.0
Browse files Browse the repository at this point in the history
* initial creation
  • Loading branch information
ZachChristensen28 authored Sep 30, 2022
1 parent 8d881ea commit 3c7f129
Show file tree
Hide file tree
Showing 52 changed files with 1,055 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Versions (please complete the following information):**
- Splunk Version: [e.g. 9.0]
- SA-SentinelOneDevices Version: [e.g. 1.0.0]
- [SentinelOne App For Splunk Version](https://splunkbase.splunk.com/app/5433): [e.g. 5.1.7]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
56 changes: 56 additions & 0 deletions .github/workflows/appinspect.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: splunk-appinspect
on:
pull_request:
branches:
- main
- master
paths:
- "src/**"
types: [opened, ready_for_review]
jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.7
- name: install dependencies
run: sudo apt-get install -y jq curl wget
- name: Download packaging toolkit
run: wget https://download.splunk.com/misc/packaging-toolkit/splunk-packaging-toolkit-1.0.1.tar.gz
- name: Install packaging toolkit
run: pip install splunk-packaging-toolkit-1.0.1.tar.gz
- name: Package app
run: |
cd src
slim package -o ~/build/packages SA-SentinelOneDevices
- name: Download and run helper script
run: |
mkdir -p ~/.local/bin
cd ~/.local/bin
wget https://raw.githubusercontent.com/ZachChristensen28/splunk-app-dev/master/validate.sh && chmod +x validate.sh
- name: Validate credentials
run: |
API_USER='${{ secrets.API_USER }}' API_PASS='${{ secrets.API_PASS }}' validate.sh -v
- name: Submit App for vetting
run: |
cd ~/build/packages
validate.sh submit $(ls)
- name: Check Status
run: validate.sh status
- name: Get report
run: |
validate.sh report
- name: Collect report
uses: actions/upload-artifact@v3
with:
name: Appinspect-report
path: ~/build/reports/
- name: Collect app package
uses: actions/upload-artifact@v3
with:
name: App-package
path: ~/build/packages/
- name: Check Appinspect for issues
run: validate.sh get_errors
22 changes: 22 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: docs
on:
push:
branches:
- master
- main
paths:
- "docs/**"
- "mkdocs.yml"
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- name: Install Python dependencies
uses: py-actions/py-dependency-install@v3
with:
path: "docs/requirements.txt"
- run: mkdocs gh-deploy --force
26 changes: 26 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: release
on:
push:
branches:
- master
- main
paths:
- "src/**"
jobs:
release:
name: Create Release
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Install dependencies
run: sudo apt-get install -y jq
- name: Get version
id: version
run: echo "::set-output name=version::$(cat src/SA-SentinelOneDevices/app.manifest | jq -r .info.id.version)"
- name: Create release
uses: softprops/action-gh-release@v1
with:
draft: true
name: SA-SentinelOneDevices v${{ steps.version.outputs.version }}
tag_name: v${{ steps.version.outputs.version }}
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.DS_STORE
**/local
local.meta
__pycache__/
.vscode
venv
.idea
Pipfile**
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Zachary Christensen (ZachTheSplunker)

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.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[![SA-SentinelOneDevices](./docs/assets/sa-sentinelone-logo-dark.svg)](https://splunk-sa-sentinelone.ztsplunker.com)

![GitHub](https://img.shields.io/github/license/zachchristensen28/SA-SentinelOneDevices)
[![Docs](https://github.com/ZachChristensen28/SA-SentinelOneDevices/actions/workflows/docs.yml/badge.svg)](https://splunk-sa-sentinelone.ztsplunker.com)
![Appinspect](https://github.com/ZachChristensen28/SA-SentinelOneDevices/actions/workflows/appinspect.yml/badge.svg)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/ZachChristensen28/SA-SentinelOneDevices)
[![Splunkbase App](https://img.shields.io/badge/Splunkbase-SA--SentinelOneDevices-blue)](SPLUNKBASE_URL_Placeholder)
[![Splunk ES Compatibility](https://img.shields.io/badge/Splunk%20ES%20Compatibility-7.x%20|%206.x-success)](https://splunkbase.splunk.com/app/263)
[![SentinelOne App Compatibility](https://img.shields.io/badge/SentinelOne%20App%20Compatibility-5.1.x-blueviolet)](https://splunkbase.splunk.com/app/5433)
![Splunk Cloud Compatibility](https://img.shields.io/badge/Splunk%20Cloud%20Ready-Victoria%20|%20Classic-informational?logo=splunk)

This supporting add-on comes with prebuilt content for SentinelOne device data to be easily used with Splunk Enterprise Security's asset database.

```markdown
** This supporting add-on is only intended to work with Splunk Enterprise Security deployments **
```

## Documentation

Full documentation can be found at [https://splunk-sa-sentinelone.ztsplunker.com](https://splunk-sa-sentinelone.ztsplunker.com).

## Disclaimer

> *This Splunk Supporting Add-on is __not__ affiliated with [__SentinelOne, Inc.__](https://www.sentinelone.com/) and is not sponsored or sanctioned by the SentinelOne team. As such, the included documentation does not contain information on how to get started with SentinelOne. Rather, this documentation serves as a guide to use SentinelOne device data with Splunk Enterprise Security. Please visit [https://www.sentinelone.com/](https://www.sentinelone.com/) for more information about SentinelOne.*
## About

Info | Description
------|----------
SA-SentinelOneDevices | 1.0.0 - [Splunkbase](SPLUNKBASE_URL_Placeholder) \| [GitHub](https://github.com/ZachChristensen28/SA-SentinelOneDevices)
Splunk Enterprise Security Version (Required) | [7.x \| 6.x](https://splunkbase.splunk.com/app/263)
SentinelOne App For Splunk (Required) | [5.1.x](https://splunkbase.splunk.com/app/5433)
Add-on has a web UI | No, this add-on does not contain views.

```text
Version 1.0.0
- Initial creation
```

## Issues or Feature Requests

Please open an issue or feature request on [GitHub](https://github.com/ZachChristensen28/SA-SentinelOneDevices/issues).
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
splunk-sa-sentinelone.ztsplunker.com
Binary file added docs/assets/asset-merege-error.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/sa-sentinelone-example-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/sa-sentinelone-example-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/sa-sentinelone-logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/sa-sentinelone-logo-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3c7f129

Please sign in to comment.