Files
atomic-red-team/README.md
T

60 lines
3.3 KiB
Markdown
Raw Normal View History

2018-05-23 17:34:41 -06:00
<p><img src="https://redcanary.com/wp-content/uploads/Atomic-Red-Team-Logo.png" width="150px" /></p>
2017-10-19 13:27:16 -07:00
# Atomic Red Team
2018-05-10 13:25:40 -06:00
[![CircleCI](https://circleci.com/gh/redcanaryco/atomic-red-team.svg?style=svg)](https://circleci.com/gh/redcanaryco/atomic-red-team)
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
Atomic Red Team allows every security team to test their controls by executing simple
"atomic tests" that exercise the same techniques used by adversaries (all mapped to
[Mitre's ATT&CK](https://attack.mitre.org/wiki/Main_Page)).
2018-02-20 16:31:29 -05:00
2018-06-13 19:33:59 -06:00
## Philosophy
2017-10-19 13:32:26 -07:00
2018-06-13 19:33:59 -06:00
Atomic Red Team is a library of simple tests that every security team can execute to test their controls. Tests are
focused, have few dependencies, and are defined in a structured format that be used by automation frameworks.
2017-10-19 13:32:26 -07:00
2018-06-13 19:33:59 -06:00
Three key beliefs made up the Atomic Red Team charter:
- **Teams need to be able to test everything from specific technical controls to outcomes.**
Our security teams do not want to operate with a “hopes and prayers” attitude toward detection. We need to know
what our controls and program can detect, and what it cannot. We dont have to detect every adversary, but we
do believe in knowing our blind spots.
2017-10-19 13:32:26 -07:00
2018-06-13 19:33:59 -06:00
- **We should be able to run a test in less than five minutes.**
Most security tests and automation tools take a tremendous amount of time to install, configure, and execute.
We coined the term "atomic tests" because we felt there was a simple way to decompose tests so most could be
run in a few minutes.
2017-10-19 13:32:26 -07:00
2018-06-13 19:33:59 -06:00
The best test is the one you actually run.
2017-10-19 13:32:26 -07:00
2018-06-13 19:33:59 -06:00
- **We need to keep learning how adversaries are operating.**
Most security teams dont have the benefit of seeing a wide variety of adversary types and techniques crossing
their desk every day. Even we at Red Canary only come across a fraction of the possible techniques being used,
which makes the community working together essential to making us all better.
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
See: https://atomicredteam.io/philosophy
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
## Having trouble?
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
Join the community on Slack at [https://atomicredteam.slack.com](https://atomicredteam.slack.com)
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
## Getting Started
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
* [Quick Start: Using Atomic Red Team to test your security](#quick-start-using-atomic-red-team-to-test-your-security)
* Peruse the [Complete list of Atomic Tests](atomics/index.md) and the [ATT&CK Matrix](atomics/matrix.md)
- Windows [Tests](atomics/windows-index.md) and [Matrix](atomics/windows-matrix.md)
- macOS [Tests](atomics/macos-index.md) and [Matrix](atomics/macos-matrix.md)
- Linux [Tests](atomics/linux-index.md) and [Matrix](atomics/linux-matrix.md)
* [Fork](https://github.com/redcanaryco/atomic-red-team/fork) and [Contribute](https://atomicredteam.io/contributing/) your own modifications
* [Doing more with Atomic Red Team](#doing-more-with-atomic-red-team)
* [Using the Atomic Red Team Ruby API](#using-the-atomic-red-team-ruby-api)
* [Bonus APIs: Ruby ATT&CK API](#bonus-apis-ruby-attck-api)
* [Execution Frameworks](https://github.com/redcanaryco/atomic-red-team/blob/master/execution-frameworks)
* Have questions? Join the community on Slack at [https://atomicredteam.slack.com](https://atomicredteam.slack.com)
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
## Code of Conduct
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
In order to have a more open and welcoming community, Atomic Red Team adheres to a
[code of conduct](CODE_OF_CONDUCT.md).
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
## License
2017-10-19 13:27:16 -07:00
2018-06-13 19:33:59 -06:00
See the [LICENSE](https://github.com/redcanaryco/atomic-red-team/blob/master/LICENSE.txt) file.