├── .gitignore ├── .gitmodules ├── CITATION.cff ├── LICENSE ├── NOTICE.md ├── README.md └── ot-one-pagers ├── 1pg BACnet Overview PR_23-1270.pdf ├── 1pg DNP3 Overview PR_23-1270.pdf └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | # VSCode 2 | .vscode/* 3 | !.vscode/settings.json 4 | !.vscode/tasks.json 5 | !.vscode/launch.json 6 | !.vscode/extensions.json 7 | *.code-workspace 8 | # Local History for Visual Studio Code 9 | .history/ 10 | 11 | # Private Node Modules 12 | node_modules/ 13 | creds.js 14 | 15 | # Mac/OSX 16 | .DS_Store 17 | 18 | # Byte-compiled / optimized / DLL files 19 | *__pycache__* 20 | **/__pycache__/ 21 | *.py[cod] 22 | *$py.class 23 | *.pyc 24 | 25 | # Distribution / packaging 26 | .Python 27 | build/ 28 | develop-eggs/ 29 | dist/ 30 | downloads/ 31 | eggs/ 32 | .eggs/ 33 | lib/ 34 | lib64/ 35 | parts/ 36 | sdist/ 37 | var/ 38 | wheels/ 39 | share/python-wheels/ 40 | *.egg-info/ 41 | .installed.cfg 42 | *.egg 43 | MANIFEST 44 | 45 | # PyInstaller 46 | # Usually these files are written by a python script from a template 47 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 48 | *.manifest 49 | *.spec -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "bacnet"] 2 | path = bacnet 3 | url = https://github.com/mitre/bacnet.git 4 | branch = main 5 | [submodule "modbus"] 6 | path = modbus 7 | url = https://github.com/mitre/modbus.git 8 | branch = main 9 | [submodule "dnp3"] 10 | path = dnp3 11 | url = https://github.com/mitre/dnp3.git 12 | branch = main 13 | [submodule "profinet"] 14 | path = profinet 15 | url = https://github.com/mitre/profinet.git 16 | branch = main 17 | [submodule "iec61850"] 18 | path = iec61850 19 | url = https://github.com/mitre/iec61850.git 20 | branch = main -------------------------------------------------------------------------------- /CITATION.cff: -------------------------------------------------------------------------------- 1 | cff-version: 1.2.0 2 | message: "If you use this software, please cite it as below." 3 | authors: 4 | - name: "MITRE Corporation" 5 | title: "MITRE Caldera for OT: Caldera plugins for the OT Environment" 6 | version: 1.0.0 7 | date-released: 2023-09-05 8 | url: "https://github.com/mitre/caldera-ot" 9 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS -------------------------------------------------------------------------------- /NOTICE.md: -------------------------------------------------------------------------------- 1 | © 2023 The MITRE Corporation. 2 | 3 | Approved for Public Release; Distribution Unlimited. Case Number 23-1270. 4 | Approved for Public Release; Distribution Unlimited. Case Number 23-4177. 5 | 6 | NOTICE 7 | 8 | MITRE hereby grants express written permission to use, reproduce, distribute, modify, and otherwise leverage this software to the extent permitted by the licensed terms provided in the LICENSE.md file included with this project. 9 | 10 | NOTICE 11 | 12 | This software was produced for the U. S. Government under Contract Number 70RSAT20D00000001, and is subject to Federal Acquisition Regulation Clause 52.227-14, Rights in Data—General – Alternate II (Dec 2007) and Alternate III (Dec 2007) (DEVIATION). 13 | 14 | No other use other than that granted to the U. S. Government, or to those acting on behalf of the U. S. Government under that Clause is authorized without the express written permission of The MITRE Corporation. 15 | 16 | For further information, please contact The MITRE Corporation, Contracts Management Office, 7515 Colshire Drive, McLean, VA 22102-7539, (703) 983-6000.15 Colshire Drive, McLean, VA 22102-7539, (703) 983-6000. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MITRE Caldera™ for OT Plugins 2 | 3 | A collection of plugins that extend [MITRE Caldera™](https://github.com/mitre/caldera) to the Operational Technology (OT) environment. 4 | 5 | It is built on the [MITRE ATT&CK® for ICS framework](https://attack.mitre.org/matrices/ics/). 6 | 7 | This repository contains all the Caldera for OT plugins as git submodules. As described in each individual plugin README, it is also possible to `git clone` a specific protocol plugin directly into the Caldera `plugins` directory, following the "Installation" guidance. 8 | 9 | ## Install Caldera for OT Plugins 10 | 11 | To install all the Caldera for OT plugins, use the recursive flag while cloning this repository: 12 | 13 | ``` 14 | git clone https://github.com/mitre/caldera-ot.git --recursive 15 | ``` 16 | 17 | Note, that after performing the `git clone`, you will still need to: 18 | 19 | 1. Ensure the plugin(s) of interest are moved into the `caldera/plugins` directory of your caldera instance 20 | 2. Enable the plugin(s) by adding their names to the `conf/local.yml` or `conf/default.yml` (if running Caldera in insecure mode) 21 | 22 | For example, 23 | ``` 24 | - bacnet 25 | - dnp3 26 | - modbus 27 | - profinet 28 | - iec61850 29 | ``` 30 | 31 | The OT plugins can also be setup individually: 32 | * [bacnet](https://github.com/mitre/bacnet#readme) 33 | * [dnp3](https://github.com/mitre/dnp3#readme) 34 | * [modbus](https://github.com/mitre/modbus#readme) 35 | * [profinet](https://github.com/mitre/profinet#readme) 36 | * [iec61850](https://github.com/mitre/iec61850#readme) 37 | 38 | ### Installing the IEC 61850 Payloads 39 | 40 | Using the IEC 61850 plugin requires the additional step of installing the plugin's payloads by following these steps: 41 | 1. Download the appropriate compiled payload from the **Releases** section of the [iec61850-payloads](https://github.com/mitre/iec61850-payloads/releases) repository. 42 | 2. Save the downloaded payload file(s) in the `caldera/plugins/iec61850/payloads` directory of your Caldera installation. 43 | 44 | ## What are the Caldera for OT plugins? 45 | 46 | The Caldera for OT plugins unify and expose open-source OT protocol libraries in the form of protocol specific plugins: 47 | * `bacnet` - for the Building Automation and Control Networks (BACnet) protocol 48 | * `dnp3` - for the Distributed Network Protocol 3 (DNP3) 49 | * `modbus` - for the Modbus protocol 50 | * `profinet` - for the Profinet protocol - *Basic Discovery and Configuration Protocol (DCP) only* 51 | * `iec61850` - for the IEC 61850 series of communication protocols - *Manufacturing Message Specification (MMS) only* 52 | 53 | Each plugin contains the following documentation: 54 | * High-level README.md 55 | * Source code specific README.md (located under `/src`) 56 | * Caldera Field Manual documentation (located under `/docs`) 57 | 58 | ### What is the motivation for the plugins? 59 | 60 | The Caldera for OT plugins enable adversary emulation in the OT environment, which supports traditional Caldera [use cases](https://caldera.mitre.org/). For example, training and testing of operators and defenses. 61 | 62 | Also see our presentation on [Emulating Adversary Actions in the Operational Environment with Caldera (TM) for OT](https://speakerdeck.com/bjeffries/emulating-adversary-actions-in-the-operational-environment-with-caldera-for-ot). 63 | 64 | ## Contact 65 | 66 | Please reach out to OT@mitre.org with comments, questions, and to discuss collaboration opportunities. 67 | 68 | The Caldera for OT team can also be reached on the official [Caldera slack](https://join.slack.com/t/mitre-caldera/shared_invite/zt-rvngjjpw-OQHAqpUT87DcyClTosF8dQ). 69 | -------------------------------------------------------------------------------- /ot-one-pagers/1pg BACnet Overview PR_23-1270.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitre/caldera-ot/4e8079f9d1764becc9f80edd900fb761d446168f/ot-one-pagers/1pg BACnet Overview PR_23-1270.pdf -------------------------------------------------------------------------------- /ot-one-pagers/1pg DNP3 Overview PR_23-1270.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mitre/caldera-ot/4e8079f9d1764becc9f80edd900fb761d446168f/ot-one-pagers/1pg DNP3 Overview PR_23-1270.pdf -------------------------------------------------------------------------------- /ot-one-pagers/README.md: -------------------------------------------------------------------------------- 1 | # OT One-Pagers 2 | 3 | In addition to the Caldera for OT plugins, this repository provides "OT Protocol Primers", or OT one-pagers for short. 4 | 5 | These documents provide an overview of a given protocol, including background information, fundamental details, and additional visuals and guidance on protocol communications and messages. 6 | 7 | At this time, the following OT One-Pagers are available: 8 | * BACnet Overview 9 | * DNP3 Overview 10 | --------------------------------------------------------------------------------