mica-framework.github.io/index.html at master · mica-framework/mica-framework.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297

    <html>
      <head>
        <title>MiCA-Framework</title>
        <meta name="viewport" content="width=device-width, initial-scale=1">
      </head>
      <body>
        <div id='content'>
    <h1 id="the-mica-framework">The MiCA-Framework</h1>
<p>A Framework for the Microservice-based Simulation of Cyber Attacks. Created as <a href="https://github.com/zinklandi">my</a> Master-Thesis at the <a href="https://seclab.othr.de">Laboratory for Information Security</a> at the <a href="https://www.oth-regensburg.de">OTH Regensburg</a>.</p>
<div stlye="width:100%;float:left;">
<img src="./images/MiCA_Logo.png" style="float: left; height: 100px; margin-right: 20px; z-index: 1;" />
<img src="./images/OTH_Logo_SEC.png" style="margin: 5px 10px; height: 90px;" />
</div>
<p><a href="https://github.com/mica-framework">Go to GitHub to see the project..</a></p>
<h2 id="introduction">Introduction</h2>
<p>The goal of the MiCA-Framework is to provide a simple framework and an easy way to integrate the framework into an existing infrastructure, which allows a simple and fast way of simulating cyber attacks. Therefore custom cyber attacks can be developed and simulated and scaled through the MiCA-Framework on as much victim-clients as needed.</p>
<p><strong>Important!</strong><br />
This frameworks purpose is to support IT-Security researchers on simulating and analyzing cyber attacks. Therefore we do not provide any cyber attacks!</p>
<p>Using Docker enables the possibility to run and distribute attacks on multiple devices, which have Docker installed. This also enables a detailed analysis of the implemented cyber attacks, by providing the same environment on each victim, thanks to the used docker containers.</p>
<p>If you like to use this framework feel free to use it within your researches. If you'd like to reference this project, please use the following BibTex-Reference:</p>
<pre><code>@misc{
  author = {Zinkl, Andreas},
  title = {The MiCA-Framework},
  year = {2019},
  publisher = {GitHub},
  journal = {GitHub Repository},
  howpublished = {\url{https://github.com/mica-framework}}
}
</code></pre>
<h2 id="requirements">Requirements</h2>
<p>To be able to run this framework on your local environment, the following requirements need to be fulfilled:</p>
<ul>
<li>Docker Client or Docker Toolbox (Installers can be found <a href="https://docs.docker.com/install/">here</a>)</li>
<li>Python 3.5 (or newer)</li>
</ul>
<h2 id="integration">Integration</h2>
<p>Integrating the framework into your research environment requires two steps:</p>
<ol>
<li>Installation &amp; Configuration of the MiCA-Server</li>
<li>Installation of the MiCA-Agents</li>
</ol>
<h3 id="mica-server"><strong><em>MiCA-Server</em></strong>:</h3>
<p>The installation of the <strong>MiCA-Server</strong> can be processed by going through the following steps:</p>
<ol>
<li>Clone the repo: <code>git clone git@github.com/mica-framework/server.git</code></li>
<li>Go to the folder <code>server</code> and edit the following files as need for your system:<ol>
<li>docker-compose.yml</li>
<li>config.yml</li></ol></li>
<li>Finally start the services by running the command <code>docker-compose up --build</code></li>
</ol>
<p><strong>Hints:</strong> </p>
<ul>
<li><code>--build</code> should be run on the first startup. I'd recommend to use it every time, if you changed something on the server</li>
<li>Currently, only an Influx database is supported for storing the logs. If you do not have an Influx instance, use the following command to run a local instance as a docker container:<br />
<code>docker-compose up -f docker-compose.yml -f ./docker/influxdb.yml --build</code></li>
</ul>
<h3 id="mica-cli"><strong><em>MiCA-CLI</em></strong>:</h3>
<p>You can run the MiCA-CLI by just downloading or cloning the repo and finally running the <code>mica-cli.py</code> file. An executable is not available till now (but is in progress!).</p>
<p><strong>WARNING</strong>: The CLI is currently only working properly under unix-terminals. Windows consoles like powershell and cmd do not decode a the text properly. Fixing this, is also in progress!</p>
<p>Here's a short hint, how the CLI can be executed on your system:</p>
<pre><code class="bash language-bash"># 1 - Start by creating a virutal environment within the CLI project
python3 -m venv .env

# 2 - Activate the virutal environment
. .env/bin/activate     # on unix devices
. .env/scripts/activate # on windows

# 3 - Now install the dependencies
pip install -r requirements.txt

# 4 - Run the cli
python3 mica-cli.py
</code></pre>
<h3 id="mica-agent"><strong><em>MiCA-Agent</em></strong>:</h3>
<p>Running the MiCA-Agent is simple, but currently there's only a working Windows Installer-Version of the Installer-Script. That means, you need to download the binary for linux and execute it manually on your system. If you're running windows, then the following command will install the MiCA-Agent on your system and registers the agent-startup within your autostart:</p>
<pre><code class="bash language-bash">curl https://raw.githubusercontent.com/mica-framework/tools/master/agent-installation/install_mica_agent.sh --output install.sh &amp;&amp; ./install.sh &amp;&amp; rm ./install.sh
</code></pre>
<h2 id="contribution--development">Contribution / Development</h2>
<p>This project was published as Open Source to share the framework with all IT-Security researchers and to create a framework which may be improved through different areas of use. I hope that you like what you get with this framework, but also feel free to create issues about errors, problems or things you like to see. If you want to be a part or contribute to this project, just feel free to do it!</p>
<p>The Project was published through the popular MIT-License, to create the best conditions for all of you to contribute to this project as well as use it within your researches!</p>
<h2 id="references">References</h2>
<p>Thanks to all Open Source Developers for sharing their tools and software! I've mentioned the used Tools for the creation of this landing page and framework below:</p>
<ul>
<li><a href="https://github.com/rapid7/metasploit-framework">Metasploit Framework by <a href="https://github.com/rapid7">@rapid7</a></a></li>
<li><a href="https://github.com/KrauseFx/markdown-to-html-github-style">Markdown to HTML Tool by <a href="https://github.com/krausefx">@krausefx</a></a></li>
<li><a href="https://github.com/pwaller/pyfiglet">PyFiglet for the Intro-Page of the CLI by <a href="https://github.com/pwaller">@pwaller</a></a></li>
<li><a href="https://github.com/CITGuru/PyInquirer">PyInquirer for the CLI-Interaction by <a href="https://github.com/CITguru">@CITguru</a></a></li>
</ul>
<h2 id="license">License</h2>
<p>MIT License</p>
<p>Copyright (c) 2019 MiCA-Framework</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy<br />
of this software and associated documentation files (the "Software"), to deal<br />
in the Software without restriction, including without limitation the rights<br />
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br />
copies of the Software, and to permit persons to whom the Software is<br />
furnished to do so, subject to the following conditions:</p>
<p>The above copyright notice and this permission notice shall be included in all<br />
copies or substantial portions of the Software.</p>
<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br />
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br />
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br />
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br />
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br />
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE<br />
SOFTWARE.</p>

        </div>
        <style type='text/css'>body {
  font: 400 16px/1.5 "Helvetica Neue", Helvetica, Arial, sans-serif;
  color: #111;
  background-color: #fdfdfd;
  -webkit-text-size-adjust: 100%;
  -webkit-font-feature-settings: "kern" 1;
  -moz-font-feature-settings: "kern" 1;
  -o-font-feature-settings: "kern" 1;
  font-feature-settings: "kern" 1;
  font-kerning: normal;
  padding: 30px;
}

@media only screen and (max-width: 600px) {
  body {
    padding: 5px;
  }

  body > #content {
    padding: 0px 20px 20px 20px !important;
  }
}

body > #content {
  margin: 0px;
  max-width: 900px;
  border: 1px solid #e1e4e8;
  padding: 10px 40px;
  padding-bottom: 20px;
  border-radius: 2px;
  margin-left: auto;
  margin-right: auto;
}

hr {
  color: #bbb;
  background-color: #bbb;
  height: 1px;
  flex: 0 1 auto;
  margin: 1em 0;
  padding: 0;
  border: none;
}

/**
 * Links
 */
a {
  color: #0366d6;
  text-decoration: none; }
  a:visited {
    color: #0366d6; }
  a:hover {
    color: #0366d6;
    text-decoration: underline; }

pre {
  background-color: #f6f8fa;
  border-radius: 3px;
  font-size: 85%;
  line-height: 1.45;
  overflow: auto;
  padding: 16px;
}

/**
  * Code blocks
  */

code {
  background-color: rgba(27,31,35,.05);
  border-radius: 3px;
  font-size: 85%;
  margin: 0;
  word-wrap: break-word;
  padding: .2em .4em;
  font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,Courier,monospace;
}

pre > code {
  background-color: transparent;
  border: 0;
  display: inline;
  line-height: inherit;
  margin: 0;
  overflow: visible;
  padding: 0;
  word-wrap: normal;
  font-size: 100%;
}


/**
 * Blockquotes
 */
blockquote {
  margin-left: 30px;
  margin-top: 0px;
  margin-bottom: 16px;
  border-left-width: 3px;
  padding: 0 1em;
  color: #828282;
  border-left: 4px solid #e8e8e8;
  padding-left: 15px;
  font-size: 18px;
  letter-spacing: -1px;
  font-style: italic;
}
blockquote * {
  font-style: normal !important;
  letter-spacing: 0;
  color: #6a737d !important;
}

/**
 * Tables
 */
table {
  border-spacing: 2px;
  display: block;
  font-size: 14px;
  overflow: auto;
  width: 100%;
  margin-bottom: 16px;
  border-spacing: 0;
  border-collapse: collapse;
}

td {
  padding: 6px 13px;
  border: 1px solid #dfe2e5;
}

th {
  font-weight: 600;
  padding: 6px 13px;
  border: 1px solid #dfe2e5;
}

tr {
  background-color: #fff;
  border-top: 1px solid #c6cbd1;
}

table tr:nth-child(2n) {
  background-color: #f6f8fa;
}

/**
 * Others
 */

img {
  max-width: 100%;
}

p {
  line-height: 24px;
  font-weight: 400;
  font-size: 16px;
  color: #24292e; }

ul {
  margin-top: 0; }

li {
  color: #24292e;
  font-size: 16px;
  font-weight: 400;
  line-height: 1.5; }

li + li {
  margin-top: 0.25em; }

* {
  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
  color: #24292e; }

a:visited {
  color: #0366d6; }

h1, h2, h3 {
  border-bottom: 1px solid #eaecef;
  color: #111;
  /* Darker */ }
</style>
      </body>
    </html>