diff --git a/docs/config/_default/config.toml b/docs/config/_default/config.toml index e86950c04..5b00da3c1 100644 --- a/docs/config/_default/config.toml +++ b/docs/config/_default/config.toml @@ -34,6 +34,8 @@ theme = "learn" disableNextPrev = true # Order sections in menu by "weight" or "title". Default to "weight" ordersectionsby = "weight" + # Provide a list of custom css files to load relative from the `static/` folder in the site root. + custom_css = ["css/labels.css"] [outputs] home = ["HTML", "RSS", "JSON"] diff --git a/docs/content/_index.md b/docs/content/_index.md index 92d21afff..491c9f098 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -12,8 +12,8 @@ The Infection Monkey is an open source security tool for testing a data center's The Infection Monkey is comprised of two parts: -* Monkey - A tool which infects other machines and propagates to them -* Monkey Island - A dedicated UI to visualize the Infection Monkey's progress inside the data center +* Monkey - A tool which infects other machines and propagates to them. +* Monkey Island - A dedicated UI to visualize the Infection Monkey's progress inside the data center. To read more about the Monkey and download it, visit [our homepage](https://infectionmonkey.com/). diff --git a/docs/content/usage/reports/zero-trust.md b/docs/content/usage/reports/zero-trust.md index 52b3edb58..328eccbe2 100644 --- a/docs/content/usage/reports/zero-trust.md +++ b/docs/content/usage/reports/zero-trust.md @@ -10,7 +10,33 @@ The Guardicore Infection Monkey runs different tests to evaluate your network ad This diagram provides a quick glance at how your organization scores on each component of the Forrester’s Zero Trust model with **Failed**, **Verify**, **Passed** and **Unexecuted** verdicts. -- **Failed**: At least one of the tests related to this component failed. This means that the Infection Monkey detected an unmet Zero Trust requirement. -- **Verify**: At least one of the tests’ results related to this component requires further manual verification. -- **Passed**: All Tests related to this pillar passed. No violation of a Zero Trust guiding principle was detected. -- **Unexecuted**: This status means no tests were executed for this pillar. +- {{< label danger Failed >}} At least one of the tests related to this component failed. This means that the Infection Monkey detected an unmet Zero Trust requirement. +- {{< label warning Verify >}} At least one of the tests’ results related to this component requires further manual verification. +- {{< label success Passed >}} All Tests related to this pillar passed. No violation of a Zero Trust guiding principle was detected. +- {{< label other Unexecuted >}} This status means no tests were executed for this pillar. + +![Zero Trust Report summary](/images/usage/reports/ztreport1.png "Zero Trust Report summary") + +## Test Results + +See how your network fared against each of the tests the Infection Monkey ran. The tests are ordered by Zero Trust components so you can so you quickly navigate to the components you care about first. + +![Zero Trust Report test results](/images/usage/reports/ztreport2.png "Zero Trust Report test results") + +## Findings + +Deep-dive into the details of each test, and see the explicit events and exact timestamps in which things happened in your network. This will enable you to match up with your SOC logs and alerts and to gain deeper insight as to what exactly happened during each of the tests. + +![Zero Trust Report Findings](/images/usage/reports/ztreport3.png "Zero Trust Report Findings") + +## Events + +The results are exportable. Click Export after clicking on Events to view them in a machine-readable format. + +![Zero Trust Report events](/images/usage/reports/ztreport4.png "Zero Trust Report events") + +## Overview Video + +You can check out an overview video here: + +{{% youtube z4FNu3WCd9o %}} diff --git a/docs/layouts/shortcodes/label.html b/docs/layouts/shortcodes/label.html new file mode 100644 index 000000000..b9c99ac26 --- /dev/null +++ b/docs/layouts/shortcodes/label.html @@ -0,0 +1 @@ +{{ .Get 1 }} diff --git a/docs/static/css/labels.css b/docs/static/css/labels.css new file mode 100644 index 000000000..06565138d --- /dev/null +++ b/docs/static/css/labels.css @@ -0,0 +1,12 @@ +.label { + color: white; + padding: 3px; + border-radius: 5px; + -moz-border-radius: 5px; + } + + .success {background-color: #4CAF50;} /* Green */ + .info {background-color: #2196F3;} /* Blue */ + .warning {background-color: #ff9800;} /* Orange */ + .danger {background-color: #f44336;} /* Red */ + .other {background-color: #e7e7e7; color: black;} /* Gray */ diff --git a/docs/static/images/usage/reports/ztreport1.png b/docs/static/images/usage/reports/ztreport1.png new file mode 100644 index 000000000..d90116e82 Binary files /dev/null and b/docs/static/images/usage/reports/ztreport1.png differ diff --git a/docs/static/images/usage/reports/ztreport2.png b/docs/static/images/usage/reports/ztreport2.png new file mode 100644 index 000000000..c6c4c707c Binary files /dev/null and b/docs/static/images/usage/reports/ztreport2.png differ diff --git a/docs/static/images/usage/reports/ztreport3.png b/docs/static/images/usage/reports/ztreport3.png new file mode 100644 index 000000000..affb069b3 Binary files /dev/null and b/docs/static/images/usage/reports/ztreport3.png differ diff --git a/docs/static/images/usage/reports/ztreport4.png b/docs/static/images/usage/reports/ztreport4.png new file mode 100644 index 000000000..f76da9167 Binary files /dev/null and b/docs/static/images/usage/reports/ztreport4.png differ