Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shuffle/shuffle

Shuffle: A general purpose security automation platform. Our focus is on collaboration and resource sharing.
https://github.com/shuffle/shuffle

agplv3 automation cybersecurity discord hacktoberfest integrations mitre-attack openapi orchestration orchestrator orchestrator-gui security security-automation security-orchestrator shuffle soar workflow-editor

Last synced: 3 days ago
JSON representation

Shuffle: A general purpose security automation platform. Our focus is on collaboration and resource sharing.

Host: GitHub
URL: https://github.com/shuffle/shuffle
Owner: Shuffle
License: agpl-3.0
Created: 2020-05-07T12:28:51.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-10-29T12:37:09.000Z (about 2 months ago)
Last Synced: 2024-10-29T14:33:41.487Z (about 2 months ago)
Topics: agplv3, automation, cybersecurity, discord, hacktoberfest, integrations, mitre-attack, openapi, orchestration, orchestrator, orchestrator-gui, security, security-automation, security-orchestrator, shuffle, soar, workflow-editor
Language: Shell
Homepage: https://shuffler.io
Size: 58.9 MB
Stars: 1,726
Watchers: 41
Forks: 335
Open Issues: 498
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        


[![Shuffle Logo](https://github.com/Shuffle/Shuffle/blob/main/frontend/public/images/Shuffle_logo_new.png)](https://shuffler.io)

Shuffle Automation

[![CodeQL](https://github.com/Shuffle/Shuffle/actions/workflows/codeql-analysis.yml/badge.svg?branch=launch)](https://github.com/Shuffle/Shuffle/actions/workflows/codeql-analysis.yml)

[![Autobuild](https://github.com/Shuffle/Shuffle/actions/workflows/dockerbuild.yaml/badge.svg?branch=launch)](https://github.com/Shuffle/Shuffle/actions/workflows/dockerbuild.yaml)



[Shuffle](https://shuffler.io) is an open source automation platform, built for and by the security professionals. Security operations is complex, but it doesn't have to be. Built to work well with MSSP's and other service providers in mind.

[ Get training ](https://shuffler.io/training)

[_Key Features_](https://shuffler.io/docs/features) —

[_Community & Support_](https://discord.gg/B2CBzUm) —

[ Get training ](https://shuffler.io/training) -

[_Documentation_](https://shuffler.io/docs) —

[_Getting Started_](https://shuffler.io/docs/getting_started) —

[_Development_](https://github.com/shuffle/Shuffle/blob/master/.github/CONTRIBUTING.md) 

[ Set up a demo call ](https://shuffler.io/contact)

Follow us on Twitter at [@shuffleio](https://twitter.com/shuffleio).



![Example Shuffle webhook integration](https://github.com/shuffle/Shuffle/blob/main/frontend/src/assets/img/github_shuffle_img.png)

## Try it

* Self-hosted: Check out the [installation guide](https://github.com/shuffle/shuffle/blob/master/.github/install-guide.md)

* Cloud: Register at https://shuffler.io/register and get cooking (missing a lot of features)

Please consider [sponsoring](https://github.com/sponsors/frikky) the project if you want to see more rapid development.

## Support

* [Discord](https://discord.gg/B2CBzUm)

* [Twitter](https://twitter.com/shuffleio)

* [Email](mailto:[email protected])

* [Open issue](https://github.com/shuffle/Shuffle/issues/new)

* [Shuffler.io](https://shuffler.io/contact)

## Blogposts

* [1. Introducing Shuffle](https://medium.com/security-operation-capybara/introducing-shuffle-an-open-source-soar-platform-part-1-58a529de7d12)

* [2. Getting started with Shuffle](https://medium.com/security-operation-capybara/getting-started-with-shuffle-an-open-source-soar-platform-part-2-1d7c67a64244)

* [3. Integrating Shuffle with Virustotal and TheHive](https://medium.com/@Frikkylikeme/integrating-shuffle-with-virustotal-and-thehive-open-source-soar-part-3-8e2e0d3396a9)

* [4. Real-time executions with TheHive, Cortex and MISP](https://medium.com/@Frikkylikeme/indicators-and-webhooks-with-thehive-cortex-and-misp-open-source-soar-part-4-f70cde942e59)

## Documentation

[Documentation](https://shuffler.io/docs) can be found on [https://shuffler.io/docs](https://shuffler.io/docs) and is written here: [https://github.com/shuffle/shuffle-docs](https://github.com/shuffle/shuffle-docs).

### Setting up a local development environment

Please follow the steps mentioned [here](https://github.com/Shuffle/Shuffle/blob/main/.github/install-guide.md#local-development-installation)!

## Related repositories

* OpenAPI apps: [https://github.com/shuffle/security-openapis](https://github.com/shuffle/security-openapis)

* Documentation: [https://github.com/shuffle/shuffle-docs](https://github.com/shuffle/shuffle-docs)

* Workflows: [https://github.com/shuffle/shuffle-workflows](https://github.com/shuffle/shuffle-workflows)

* Python apps: [https://github.com/shuffle/shuffle-apps](https://github.com/shuffle/python-apps)

## Features

* Simple, feature rich [workflow editor](https://shuffler.io/docs/workflows)

* App creator using [OpenAPI](https://github.com/shuffle/OpenAPI-security-definitions)

* Premade apps for your security tools

* Organization and sub-organization control

* Hybrid resource sharing with shuffler.io (optional)

## Website

[https://shuffler.io](https://shuffler.io)

## Contributing

We want to make the world of cybersecurity more accessible and need all the help we can get. Send an email to [support@shuffler](mailto:[email protected]) and we'll make sure to give you any training you may need.

These are the main areas to contribute in:

* Frontend (ReactJS)

* Backend (Golang)

* App Creation (Python & GUI w/OpenAPI)

* Documentation (Markdown)

* Workflow creation (GUI & Conceptualizing) 

* Content Creation (Blogs, videos etc) 

Contributing guidelines are outlined [here](https://github.com/shuffle/Shuffle/blob/master/.github/CONTRIBUTING.md).

## Contributors 

![ICPL logo](https://github.com/Shuffle/Shuffle/blob/main/frontend/src/assets/img/icpl_logo.png)

**Shuffle**



  



[**App magicians**](https://github.com/shuffle/shuffle-apps)



  



## License

All modular information related to Shuffle will be under MIT (anyone can use it for whatever purpose), with Shuffle itself using AGPLv3. 

Workflows: MIT

Documentation: MIT

Shuffle backend: AGPLv3 

Apps, specification and App SDK: MIT

## Architecture

![Shuffle Architecture](https://github.com/shuffle/Shuffle/blob/main/frontend/src/assets/img/shuffle_architecture.png)

## Security Contributors: Hall of Fame

[Pushpraj](https://github.com/PushprajPatil) - Reported several issues between July and August 2024

### Repository overview 

Below is the folder structure with a short explanation

```bash

├── README.md				# What you're reading right now

├── backend					# Contains backend related code.

│   ├── go-app 			# The backend golang webserver

│   └── app_sdk			# The SDK used for apps

├── frontend				# Contains frontend code. ReactJS, Material UI and cytoscape

├── functions				# Has execution and extension resources, such as the Wazuh integration

│   ├── onprem				# Code for onprem solutions

│   │   ├── Orborus 	# Distributes execution locations

│   │   ├── Worker		# Runs a workflow

└ docker-compose.yml 	# Used for deployments

```

[Get in touch](https://shuffler.io/contact), send a mail to [[email protected]](mailto:[email protected]) or poke me on twitter [@frikkylikeme](https://twitter.com/frikkylikeme)