diff --git a/docs/content/development/_index.md b/docs/content/development/_index.md index 85b15adcb..b679beaac 100644 --- a/docs/content/development/_index.md +++ b/docs/content/development/_index.md @@ -38,6 +38,6 @@ We always want to improve the core Infection Monkey code to make it smaller, fas ### Documentation 📚 -Every project requires excellent documentation. The Infection Monkey is no different. Please feel free to open pull requests with suggestions, improvements or issues and asking us to document various parts of the Monkey. +Every project requires excellent documentation. The Infection Monkey is no different. Please feel free to open pull requests with suggestions, improvements or issues and ask us to document various parts of the Monkey. The Infection Monkey's documentation is stored in the `/docs/content` directory. diff --git a/docs/content/development/swimm.md b/docs/content/development/swimm.md index 9dd1be6c1..dc8d66ee7 100644 --- a/docs/content/development/swimm.md +++ b/docs/content/development/swimm.md @@ -14,11 +14,11 @@ The Infection Monkey has development tutorials that use [`swimm.io`](https://swi First, [sign up for swimm's beta](https://swimm.io/sign-beta). `swimm` is free for open-source projects, but as they're still in beta you'll need to sign up in order to download it. -After you've downloaded and installed `swimm`, open a shell in the Infeciton Monkey repo folder and run: +After you've downloaded and installed `swimm`, open a shell in the Infection Monkey repo folder and run: ```shell script swimm start -``` +``` A local web server with the currently available tutorials should show up, and will look something like this: diff --git a/docs/content/reference/_index.md b/docs/content/reference/_index.md index 356d85312..5fd95eac9 100644 --- a/docs/content/reference/_index.md +++ b/docs/content/reference/_index.md @@ -4,11 +4,11 @@ date = 2020-05-26T20:55:04+03:00 weight = 30 chapter = true pre = ' ' -tags = ["reference"] +tags = ["reference"] +++ # Reference -Find detailed information about the Infection Monkey. +Find detailed information about the Infection Monkey: {{% children %}} diff --git a/docs/content/reference/data_directory.md b/docs/content/reference/data_directory.md index 2fc6605cd..df384a5c9 100644 --- a/docs/content/reference/data_directory.md +++ b/docs/content/reference/data_directory.md @@ -23,7 +23,7 @@ The location of the data directory is set in the `data_dir` field in the `server_config.json` file. 1. [Create a custom server_config.json file](../server_configuration) and set the `data_dir` field. Its - contents will look like: + contents will look like this: ```json { diff --git a/docs/content/reference/exploiters/MsSQL.md b/docs/content/reference/exploiters/MsSQL.md index 58926addd..6e9cd4a6b 100644 --- a/docs/content/reference/exploiters/MsSQL.md +++ b/docs/content/reference/exploiters/MsSQL.md @@ -7,4 +7,4 @@ tags: ["exploit", "windows"] ### Description -For this exploit, the Infection Monkey will try to brute force into a MsSQL server and use an insecure configuration to execute commands on the server. +For this exploit, the Infection Monkey will try to brute force into an MsSQL server and use an insecure configuration to execute commands on the server. diff --git a/docs/content/reference/exploiters/PowerShell.md b/docs/content/reference/exploiters/PowerShell.md index c80943154..8924fe44e 100644 --- a/docs/content/reference/exploiters/PowerShell.md +++ b/docs/content/reference/exploiters/PowerShell.md @@ -22,8 +22,7 @@ The PowerShell exploiter can be run from both Linux and Windows attackers. On Windows attackers, the exploiter has the ability to use the cached username and/or password from the current user. On both Linux and Windows attackers, the exploiter uses all combinations of the [user-configured usernames and -passwords]({{< ref "/usage/configuration/basic-credentials" >}}), as well as -and LM or NT hashes that have been collected. Different combinations of +passwords]({{< ref "/usage/configuration/basic-credentials" >}}), as well as LM or NT hashes that have been collected. Different combinations of credentials are attempted in the following order: 1. **Cached username and password (Windows attacker only)** - The exploiter will diff --git a/docs/content/reference/exploiters/Zerologon.md b/docs/content/reference/exploiters/Zerologon.md index 90ece682b..78a88fdb5 100644 --- a/docs/content/reference/exploiters/Zerologon.md +++ b/docs/content/reference/exploiters/Zerologon.md @@ -21,10 +21,10 @@ is, therefore, **not** enabled by default. During successful exploitation, the Zerologon exploiter: -* will temporarily change the target domain controller's password. -* may break the target domain controller's communication with other systems in the network, affecting functionality. -* may change the administrator's password. -* will *attempt* to revert all changes. +* Will temporarily change the target domain controller's password. +* May break the target domain controller's communication with other systems in the network, affecting functionality. +* May change the administrator's password. +* Will *attempt* to revert all changes. While the Zerologon exploiter is usually successful in reverting its changes and restoring the original passwords, it sometimes fails. Restoring passwords @@ -58,17 +58,17 @@ to regain access to the system. #### Use Reset-ComputerMachinePassword -If you are able to login as the administrator, you can use the +If you are able to log in as the administrator, you can use the [Reset-ComputerMachinePassword](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.management/reset-computermachinepassword?view=powershell-5.1) powershell command to restore the domain controller's password. -#### Try a zerologon password restoration tool +#### Try a Zerologon password restoration tool If all other approaches fail, you can try the tools and steps found [here](https://github.com/risksense/zerologon). -### Notes +### Note * The Infection Monkey exploiter implementation is based on implementations by [@dirkjanm](https://github.com/dirkjanm/CVE-2020-1472/) and [@risksense](https://github.com/risksense/zerologon). diff --git a/docs/content/reference/exploiters/_index.md b/docs/content/reference/exploiters/_index.md index 618fea0d0..087673b34 100644 --- a/docs/content/reference/exploiters/_index.md +++ b/docs/content/reference/exploiters/_index.md @@ -9,7 +9,7 @@ tags = ["reference", "exploit"] # Exploiters -The Infection Monkey uses various remote code execution (RCE) exploiters. To our best knowledge, most of these pose no risk to performance or services on victim machines. This documentation serves as a quick introduction to the exploiters currently implemented and the vulnerabilities they use. +The Infection Monkey uses various remote code execution (RCE) exploiters. To our best knowledge, most of these pose no risk to performance or services on victim machines. This documentation serves as a quick introduction to the exploiters currently implemented and the vulnerabilities they use: {{% children %}} diff --git a/docs/content/reports/_index.md b/docs/content/reports/_index.md index 50af928b9..eae9b7de6 100644 --- a/docs/content/reports/_index.md +++ b/docs/content/reports/_index.md @@ -8,6 +8,6 @@ pre = " " # Infection Monkey's Reports -The Infection Monkey offers three reports: +The Infection Monkey offers four reports: {{% children description=true style="p"%}} diff --git a/docs/content/reports/mitre.md b/docs/content/reports/mitre.md index ac03f1284..28ec7fa4e 100644 --- a/docs/content/reports/mitre.md +++ b/docs/content/reports/mitre.md @@ -18,7 +18,7 @@ Watch the overview video: ## How to use the report -The MITRE ATT&CK report is centred around the ATT&CK matrix: +The MITRE ATT&CK report is centered around the ATT&CK matrix: ![MITRE Report](/images/usage/reports/mitre-report-0.png "MITRE Report") diff --git a/docs/content/reports/zero-trust.md b/docs/content/reports/zero-trust.md index 921025b5b..a1ad77f71 100644 --- a/docs/content/reports/zero-trust.md +++ b/docs/content/reports/zero-trust.md @@ -27,7 +27,7 @@ This diagram provides you with a quick glance at how your organization scores on ![Zero Trust Report summary](/images/usage/reports/ztreport1.png "Zero Trust Report summary") -## Test Results +## Test results This section shows how your network fared against each of the tests the Infection Monkey ran. The tests are ordered by Zero Trust pillar, so you can quickly navigate to the category you want to prioritize. diff --git a/docs/content/usage/integrations/aws-run-on-ec2-machine.md b/docs/content/usage/integrations/aws-run-on-ec2-machine.md index 690a3a6c7..a3ee13fe0 100644 --- a/docs/content/usage/integrations/aws-run-on-ec2-machine.md +++ b/docs/content/usage/integrations/aws-run-on-ec2-machine.md @@ -28,7 +28,7 @@ In order for the Infection Monkey to successfully view your instances, you'll ne #### Creating a custom IAM role -Go to the [AWS IAM roles dashboard](https://console.aws.amazon.com/iam/home?#/roles) and create a new IAM role for EC2. The role will need to have some specific permissions (see Appendix A), but you can just create a role with the `AmazonEC2RoleforSSM`, `AWSSecurityHubFullAccess` and `AmazonSSMFullAccess` pre-made permissions. In the end it should like something like this: +Go to the [AWS IAM roles dashboard](https://console.aws.amazon.com/iam/home?#/roles) and create a new IAM role for EC2. The role will need to have some specific permissions (see Appendix A), but you can just create a role with the `AmazonEC2RoleforSSM`, `AWSSecurityHubFullAccess` and `AmazonSSMFullAccess` pre-made permissions. In the end it should look something like this: ![Creating a custom IAM role](/images/usage/integrations/monkey-island-aws-screenshot-3.png "Creating a custom IAM role") @@ -72,7 +72,7 @@ After you click on **Run on AWS machine of your choice** you can choose one of t ## Notes -- The machines which can use IAM roles and be listed MUST be internet connected (or you can set up a proxy for IAM). This is standard AWS practice and you can read about it (and about how to set up the required proxy machines) in the AWS IAM documentation. +- The machines that can use IAM roles and be listed MUST be internet connected (or you can set up a proxy for IAM). This is standard AWS practice and you can read about it (and about how to set up the required proxy machines) in the AWS IAM documentation. - You can view the Infection Monkey in [the AWS marketplace](https://aws.amazon.com/marketplace/pp/B07B3J7K6D). ### Appendix A: Specific policy permissions required diff --git a/docs/content/usage/scenarios/custom-scenario/network-segmentation.md b/docs/content/usage/scenarios/custom-scenario/network-segmentation.md index 86db82d06..2f9522d50 100644 --- a/docs/content/usage/scenarios/custom-scenario/network-segmentation.md +++ b/docs/content/usage/scenarios/custom-scenario/network-segmentation.md @@ -28,7 +28,7 @@ You can use the Infection Monkey's cross-segment traffic feature to verify that Execute The Infection Monkey on machines in different subnetworks using the “Manual” run option. Note that if the Infection Monkey can't communicate to the Monkey Island, it will - not be able to send scan results, so make sure all machines can reach the the Monkey Island. + not be able to send scan results, so make sure all machines can reach the Monkey Island. ![How to configure network segmentation testing](/images/usage/scenarios/segmentation-config.png "How to configure network segmentation testing") diff --git a/docs/content/usage/scenarios/custom-scenario/other.md b/docs/content/usage/scenarios/custom-scenario/other.md index 456b0486c..dc35cf5c8 100644 --- a/docs/content/usage/scenarios/custom-scenario/other.md +++ b/docs/content/usage/scenarios/custom-scenario/other.md @@ -9,7 +9,7 @@ weight: 100 ## Overview This page provides additional information about configuring the Infection Monkey, tips and tricks and creative usage scenarios. -## Custom behaviour +## Custom behavior If you want the Infection Monkey to run a specific script or tool after it breaches a machine, you can configure it in **Configuration -> Monkey -> Post-breach**. Input commands you want to execute in the corresponding fields.