{"id":13809822,"url":"https://github.com/atc-project/atc-react","last_synced_at":"2025-05-14T10:31:06.480Z","repository":{"id":39584928,"uuid":"252314963","full_name":"atc-project/atc-react","owner":"atc-project","description":"A knowledge base of actionable Incident Response techniques","archived":false,"fork":false,"pushed_at":"2022-05-31T15:18:24.000Z","size":19741,"stargazers_count":636,"open_issues_count":183,"forks_count":115,"subscribers_count":33,"default_branch":"master","last_synced_at":"2025-04-13T11:41:21.957Z","etag":null,"topics":["amitt","dfir","incident-response","mitre-attack","response-playbooks","thehive"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atc-project.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"patreon":"yugoslavskiy"}},"created_at":"2020-04-02T00:11:17.000Z","updated_at":"2025-04-08T13:29:03.000Z","dependencies_parsed_at":"2022-07-11T02:31:24.782Z","dependency_job_id":null,"html_url":"https://github.com/atc-project/atc-react","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atc-project%2Fatc-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atc-project%2Fatc-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atc-project%2Fatc-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atc-project%2Fatc-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atc-project","download_url":"https://codeload.github.com/atc-project/atc-react/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254120624,"owners_count":22018024,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amitt","dfir","incident-response","mitre-attack","response-playbooks","thehive"],"created_at":"2024-08-04T02:00:36.837Z","updated_at":"2025-05-14T10:31:05.098Z","avatar_url":"https://github.com/atc-project.png","language":"Python","readme":"[Русская версия](README_RU.md)\n\n# RE\u0026CT\n\n![](docs/images/logo_v2.png)\n\nThe project represents the following:\n\n1. A [framework](https://atc-project.github.io/atc-react/) — knowledge base of actionable Incident Response techniques\n2. A community-driven [collection](docs/Response_Playbooks) of Security Incident Response Playbooks\n3. A data source of the [Atomic Threat Coverage](https://github.com/atc-project/atomic-threat-coverage) framework\n\n## The RE\u0026CT Framework\n\nThe RE\u0026CT Framework is designed for accumulating, describing and classification actionable Incident Response techniques. \n\nRE\u0026CT's philosophy is based on the [MITRE's ATT\u0026CK](https://attack.mitre.org/) framework.  \nThe columns represent [Response Stages](https://atc-project.github.io/atc-react/responsestages/).  \nThe cells repsresent [Response Actions](#response-action).  \n\n![](docs/images/react_navigator_export_v5.svg)\n\u003cp align=\"center\"\u003e(Image generated by \u003ca href=\"https://atc-project.github.io/react-navigator/\"\u003eRE\u0026CT Navigator)\u003c/a\u003e\u003c/p\u003e\n\nThe main use cases:\n\n- Prioritization of Incident Response capabilities development, including skills development, technical measures acquisition/deployment, internal procedures development, etc\n- Gap analysis — determine \"coverage\" of existing Incident Response capabilities\n\nThe main resources:\n\n- [RE\u0026CT Navigator](https://atc-project.github.io/react-navigator/) (modified [ATT\u0026CK Navigator](https://github.com/mitre-attack/attack-navigator)) for visualization and observing the big picture  \n- Automatically generated RE\u0026CT [website](https://atc-project.github.io/atc-react/) is the best place for getting details about existing analytics  \n- Automatically generated [Atlassian Confluence knowledge base](https://atomicthreatcoverage.atlassian.net/wiki/spaces/REACT/pages/755469668/Response+Stages) - exporting functionality demonstration  \n\n## Actionable Analytics\n\nThe ATC RE\u0026CT project inherits the \"Actionable Analytics\" paradigm from the [ATC](https://github.com/atc-project/atomic-threat-coverage) project, which means that the analytics are:\n\n- **human-readable** (`.md`) for sharing/using in operations\n- **machine-readable** (`.yml`) for automatic processing/integrations\n- **executable** by Incident Response Platform ([TheHive Case Templates](docs/thehive_templates/) only, at the moment)\n\nSimply saying, the analytics are stored in `.yml` files, that are automatically converted to `.md` documents (with [jinja](https://palletsprojects.com/p/jinja/)) and `.json` TheHive Case Templates.\n\n### Response Action\n\nResponse Action is a description of a specific atomic procedure/task that has to be executed during the Incident Response. It is an initial entity that is used to construct Response Playbooks.  \n\nHere is an example of Response Action:\n\n\u003cdetails\u003e\n  \u003csummary\u003eInitial YAML file (click to expand)\u003c/summary\u003e\n  \u003cimg src=\"docs/images/ra_yaml_v6.png\" /\u003e\n\u003c/details\u003e\n\n- Automatically created [Markdown file](docs/Response_Actions/RA_2202_collect_email_message.md)\n- Automatically created [mkdocs web page](https://atc-project.github.io/atc-react/Response_Actions/RA_2202_collect_email_message/)\n- Automatically created [Confluence page](https://atomicthreatcoverage.atlassian.net/wiki/spaces/REACT/pages/755435640/RA2202+Collect+email+message)\n\nEach Response Action mapped to a specific [Response Stage](https://atc-project.github.io/atc-react/responsestages/).  \n\nThe first digit of the Response Action ID reflects a Stage it belongs to:\n\n- **1**: Preparation\n- **2**: Identification\n- **3**: Containment\n- **4**: Eradication\n- **5**: Recovery\n- **6**: Lessons Learned\n\nThe second digit of the Response Action ID reflects a Category it belongs to:\n\n- **0**: General\n- **1**: Network\n- **2**: Email\n- **3**: File\n- **4**: Process\n- **5**: Configuration\n- **6**: Identity\n\nThis way, using Response Action ID, you can see the Stage and Category it belongs to.  \nFor example, [RA**22**02: Collect an email message](docs/Response_Actions/RA_2202_collect_email_message.md) is related to Stage **2** (Identification) and Category **2** (Email).  \n\nThe categorization aims to improve Incident Response process maturity assessment and roadmap development.  \n\n### Response Playbook\n\nResponse Playbook is an Incident Response plan, that represents a complete list of procedures/tasks (Response Actions) that has to be executed to respond to a specific threat with optional mapping to the [MITRE's ATT\u0026CK](https://attack.mitre.org/) or [Misinfosec's  AMITT](https://github.com/misinfosecproject/amitt_framework) frameworks.\n\nHere is an example of Response Playbook:\n\n\u003cdetails\u003e\n  \u003csummary\u003eInitial YAML file (click to expand)\u003c/summary\u003e\n  \u003cimg src=\"docs/images/rp_yaml_v6.png\" /\u003e\n\u003c/details\u003e\n\n- Automatically created [Markdown file](docs/Response_Playbooks/RP_0001_phishing_email.md)\n- Automatically created [mkdocs web page](https://atc-project.github.io/atc-react/Response_Playbooks/RP_0001_phishing_email/)\n- Automatically created [Confluence page](https://atomicthreatcoverage.atlassian.net/wiki/spaces/REACT/pages/755469546/RP0001+Phishing+email)\n\nResponse Playbook could include a description of the workflow, specific conditions/requirements, details on the order of Response Actions execution, or any other relevant information.\n\n### TheHive Case Templates\n\nTheHive Case Templates are built on top of the Response Playbooks. Each task in a Case Template is a Response Action (with full description). \n\nHere is the example of an imported TheHive Case Template:\n\n\u003cdetails\u003e\n  \u003csummary\u003eImported TheHive Case Template, made on top of a Response Playbook (click to expand)\u003c/summary\u003e\n  \u003cimg src=\"docs/images/thehive_case_template_v1.png\" /\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eOne of the Tasks in TheHive Case, made on top of a Response Action (click to expand)\u003c/summary\u003e\n  \u003cimg src=\"docs/images/thehive_case_task_v1.png\" /\u003e\n\u003c/details\u003e\n\nTheHive Case Templates could be found in `docs/thehive_templates` directory and could be imported to TheHive via its web interface.\n\n## Data source of the ATC framework\n\nATC RE\u0026CT project plays a role of data source for the [Atomic Threat Coverage](https://github.com/atc-project/atomic-threat-coverage) framework, that uses it to generate Markdown and Confluence knowledge bases, ATT\u0026CK Navigator layers, Elasticsearch indexes and [other](https://github.com/atc-project/atomic-threat-coverage#how-it-works) analytics. \n\nOriginally analytics related to Incident Response were part of the ATC, but we decided to move it into a separate project to make it easier to maintain and provide an option for integration with other projects in this area. \n\n## Usage\n\n1. Make sure you are compliant with the [requirements](#requirements)\n\n2. Create configuration file by copying configuration file template `scripts/config.default.yml` to `config.yml` (root of the project). Modify it, following the guideline in the configuration file template.\n\n3. Modify existing `.yml` files, or develop your own analytics using the templates of [Response Actions](response_actions/respose_action.yml.template) or [Response Playbooks](response_playbooks/respose_playbook.yml.template). They should be stored in the directories according to their type.\n\n4. When `.yml` files are ready, convert them to `.md` documents, import them into Confluence, generate TheHive templates and [RE\u0026CT Navigator](https://github.com/atc-project/react-navigator) layer using the following commands:\n    ```\n    python3 main.py --markdown --auto --init\n    python3 main.py --confluence --auto --init\n    python3 main.py --thehive\n    python3 main.py -NAV\n    ```\n    You will find the outcome in the `docs` directory and Confluence pages (according to the configuration). Also, the RE\u0026CT Navigator layer could be opened only in the [customized application](https://github.com/atc-project/react-navigator).\n\n5. Generate your own (private) website with your analytics, using [mkdocs](https://www.mkdocs.org/):\n    ```\n    python3 main.py -MK         # automatic mkdocs config (navigation) generation\n    python3 -m mkdocs build\n    ```\n    The website will be stored in the `site` directory.  You can preview it with the following command:\n    ```\n    python3 -m mkdocs serve\n    ```\n\n### Requirements\n\n- Python 3.7\n- [PyYAML](https://pypi.org/project/PyYAML/), [mkdocs](https://pypi.org/project/mkdocs/), [jinja2](https://pypi.org/project/Jinja2/) and [stix2](https://pypi.org/project/stix2/) (optionally)  Python libraries. They could be installed with the following command:\n    ```\n    python3 -m pip install -r requirements.txt\n    ```\n\n## Contacts\n\n- Folow us on [Twitter](https://twitter.com/atc_project) for updates\n- Join discussions in [Slack](https://join.slack.com/t/atomicthreatcoverage/shared_invite/zt-6ropl01z-wIdiq3M0AEZPj_HiKfbiBg) or [Telegram](https://t.me/atomic_threat_coverage) \n\n## Contributors\n\n- Timur Zinniatullin, [@zinint](https://twitter.com/zinint)  \n- Daniil Svetlov, [@Mr_4nders0n](https://twitter.com/Mr_4nders0n)  \n- Andreas Hunkeler, [@Karneades](https://github.com/Karneades)\n- Patrick Abraham, [@pjabes](https://github.com/pjabes)\n- Lucas Berezy, [@lberezy](https://github.com/lberezy)\n- Efe Erdur, [@efeerdur](https://github.com/efeerdur)\n- Alejandro Ortuno, [@aomanzanera](https://twitter.com/aomanzanera)  \n- [@d3anp](https://github.com/d3anp)  \n- Christoph Bott, [@xofolowski](https://github.com/xofolowski)  \n\nWould you like to become one? You are very welcome! Our [CONTRIBUTING](CONTRIBUTING.md) guideline is a good starting point.\n\n## Roadmap\n\nThe roadmap and related discussions could be found in the project [issues](https://github.com/atc-project/atc-react/issues) by labes:\n\n- [Discussions](https://github.com/atc-project/atc-react/issues?q=is%3Aissue+is%3Aopen+label%3Adiscussion)\n- [Questions](https://github.com/atc-project/atc-react/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion)\n- [Enhancements](https://github.com/atc-project/atc-react/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)\n- [Response Actions development](https://github.com/atc-project/atc-react/issues?q=is%3Aissue+is%3Aopen+label%3ARA-dev)\n\n## License\n\nSee the [LICENSE](LICENSE) file.\n","funding_links":["https://patreon.com/yugoslavskiy"],"categories":["Links","Global-Standards"],"sub_categories":["Incident Response"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatc-project%2Fatc-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatc-project%2Fatc-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatc-project%2Fatc-react/lists"}