From 336c3cbb47e4431f91085d730514d4fdb8628e0c Mon Sep 17 00:00:00 2001 From: Shay Nehmad Date: Thu, 23 Jul 2020 18:18:53 +0300 Subject: [PATCH] Update descriptions of config values Now can use whitespace --- .../cc/services/config_schema/basic.py | 7 +++- .../services/config_schema/basic_network.py | 39 +++++++++++-------- .../configuration-components/UiSchema.js | 2 +- .../src/styles/pages/ConfigurationPage.scss | 5 +++ 4 files changed, 34 insertions(+), 19 deletions(-) diff --git a/monkey/monkey_island/cc/services/config_schema/basic.py b/monkey/monkey_island/cc/services/config_schema/basic.py index 6a255fc95..b141db010 100644 --- a/monkey/monkey_island/cc/services/config_schema/basic.py +++ b/monkey/monkey_island/cc/services/config_schema/basic.py @@ -6,6 +6,7 @@ BASIC = { "exploiters": { "title": "Exploiters", "type": "object", + "description": "Choose which exploiters the Monkey will attempt.", "properties": { "exploiter_classes": { "title": "Exploiters", @@ -46,7 +47,8 @@ BASIC = { "root", "user" ], - "description": "List of usernames to use on exploits using credentials" + "description": "List of user names that will be used by exploiters that need credentials, like " + "SSH brute-forcing." }, "exploit_password_list": { "title": "Exploit password list", @@ -61,7 +63,8 @@ BASIC = { "password", "12345678" ], - "description": "List of password to use on exploits using credentials" + "description": "List of passwords that will be used by exploiters that need credentials, like " + "SSH brute-forcing." } } } diff --git a/monkey/monkey_island/cc/services/config_schema/basic_network.py b/monkey/monkey_island/cc/services/config_schema/basic_network.py index 3674c0f71..fb9d0af24 100644 --- a/monkey/monkey_island/cc/services/config_schema/basic_network.py +++ b/monkey/monkey_island/cc/services/config_schema/basic_network.py @@ -17,25 +17,26 @@ BASIC_NETWORK = { }, "default": [ ], - "description": "List of IPs to not scan" + "description": "List of IPs that the Monkey will not scan." }, "local_network_scan": { "title": "Local network scan", "type": "boolean", "default": True, - "description": "Determines whether the monkey should scan its subnets additionally" + "description": "Determines whether the monkey will scan the local subnets of machines it runs on, in " + "addition to the IPs that are configured manually in the 'scan target list'." }, "depth": { "title": "Distance from island", "type": "integer", "default": 2, "description": - "Amount of hops allowed for the monkey to spread from the island. " + "Amount of hops allowed for the monkey to spread from the island. \n" + WARNING_SIGN - + " Note that setting this value too high may result in the monkey propagating too far" + + " Note that setting this value too high may result in the monkey propagating too far." }, "subnet_scan_list": { - "title": "Scan IP/subnet list", + "title": "Scan target list", "type": "array", "uniqueItems": True, "items": { @@ -44,9 +45,12 @@ BASIC_NETWORK = { "default": [ ], "description": - "List of IPs/subnets/hosts the monkey should scan." - " Examples: \"192.168.0.1\", \"192.168.0.5-192.168.0.20\", \"192.168.0.5/24\"," - " \"printer.example\"" + "List of targets the Monkey will try to scan. The targets can be IPs, subnets or hosts." + " Examples:\n" + "\tTarget a specific IP: \"192.168.0.1\"\n" + "\tTarget a subnet using a network range: \"192.168.0.5-192.168.0.20\"\n" + "\tTarget a subnet using an IP mask: \"192.168.0.5/24\"\n" + "\tTarget a specific host: \"printer.example\"" } } }, @@ -64,14 +68,17 @@ BASIC_NETWORK = { "default": [ ], "description": - "Test for network segmentation by providing a list of" - " subnets that should NOT be accessible to each other." - " For example, given the following configuration:" - " '10.0.0.0/24, 11.0.0.2/32, 12.2.3.0/24'" - " a Monkey running on 10.0.0.5 will try to access machines in the following" - " subnets: 11.0.0.2/32, 12.2.3.0/24." - " An alert on successful connections will be shown in the report" - " Additional subnet formats include: 13.0.0.1, 13.0.0.1-13.0.0.5" + "Test for network segmentation by providing a list of network segments that should NOT be accessible " + "to each other.\n\n" + "For example, if you configured the following three segments: \"10.0.0.0/24\", \"11.0.0.2/32\", " + "and \"12.2.3.0/24\", a Monkey running on 10.0.0.5 will try to access machines in the following " + "subnets: 11.0.0.2/32, 12.2.3.0/24. An alert on successful cross-segment connections will be shown in the " + "reports. \n\n" + "Network segments can be IPs, subnets or hosts. Examples:\n" + "\tDefine a single-IP segment: \"192.168.0.1\"\n" + "\tDefine a segment using a network range: \"192.168.0.5-192.168.0.20\"\n" + "\tDefine a segment using an subnet IP mask: \"192.168.0.5/24\"\n" + "\tDefine a single-host segment: \"printer.example\"" } } } diff --git a/monkey/monkey_island/cc/ui/src/components/configuration-components/UiSchema.js b/monkey/monkey_island/cc/ui/src/components/configuration-components/UiSchema.js index 745b6c49e..a8425b5ae 100644 --- a/monkey/monkey_island/cc/ui/src/components/configuration-components/UiSchema.js +++ b/monkey/monkey_island/cc/ui/src/components/configuration-components/UiSchema.js @@ -76,6 +76,6 @@ export default function UiSchema(props) { } } } - } + }; return UiSchema[props.selectedSection] } diff --git a/monkey/monkey_island/cc/ui/src/styles/pages/ConfigurationPage.scss b/monkey/monkey_island/cc/ui/src/styles/pages/ConfigurationPage.scss index 48b168476..de19a5d9e 100644 --- a/monkey/monkey_island/cc/ui/src/styles/pages/ConfigurationPage.scss +++ b/monkey/monkey_island/cc/ui/src/styles/pages/ConfigurationPage.scss @@ -48,3 +48,8 @@ .config-field-hidden { display: none; } + +.field-description { + white-space: pre-wrap; +} +