Update descriptions of config values

Now can use whitespace
This commit is contained in:
Shay Nehmad 2020-07-23 18:18:53 +03:00
parent db6552a136
commit 336c3cbb47
4 changed files with 34 additions and 19 deletions

View File

@ -6,6 +6,7 @@ BASIC = {
"exploiters": { "exploiters": {
"title": "Exploiters", "title": "Exploiters",
"type": "object", "type": "object",
"description": "Choose which exploiters the Monkey will attempt.",
"properties": { "properties": {
"exploiter_classes": { "exploiter_classes": {
"title": "Exploiters", "title": "Exploiters",
@ -46,7 +47,8 @@ BASIC = {
"root", "root",
"user" "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": { "exploit_password_list": {
"title": "Exploit password list", "title": "Exploit password list",
@ -61,7 +63,8 @@ BASIC = {
"password", "password",
"12345678" "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."
} }
} }
} }

View File

@ -17,25 +17,26 @@ BASIC_NETWORK = {
}, },
"default": [ "default": [
], ],
"description": "List of IPs to not scan" "description": "List of IPs that the Monkey will not scan."
}, },
"local_network_scan": { "local_network_scan": {
"title": "Local network scan", "title": "Local network scan",
"type": "boolean", "type": "boolean",
"default": True, "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": { "depth": {
"title": "Distance from island", "title": "Distance from island",
"type": "integer", "type": "integer",
"default": 2, "default": 2,
"description": "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 + 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": { "subnet_scan_list": {
"title": "Scan IP/subnet list", "title": "Scan target list",
"type": "array", "type": "array",
"uniqueItems": True, "uniqueItems": True,
"items": { "items": {
@ -44,9 +45,12 @@ BASIC_NETWORK = {
"default": [ "default": [
], ],
"description": "description":
"List of IPs/subnets/hosts the monkey should scan." "List of targets the Monkey will try to scan. The targets can be IPs, subnets or hosts."
" Examples: \"192.168.0.1\", \"192.168.0.5-192.168.0.20\", \"192.168.0.5/24\"," " Examples:\n"
" \"printer.example\"" "\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": [ "default": [
], ],
"description": "description":
"Test for network segmentation by providing a list of" "Test for network segmentation by providing a list of network segments that should NOT be accessible "
" subnets that should NOT be accessible to each other." "to each other.\n\n"
" For example, given the following configuration:" "For example, if you configured the following three segments: \"10.0.0.0/24\", \"11.0.0.2/32\", "
" '10.0.0.0/24, 11.0.0.2/32, 12.2.3.0/24'" "and \"12.2.3.0/24\", a Monkey running on 10.0.0.5 will try to access machines in the following "
" 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 "
" subnets: 11.0.0.2/32, 12.2.3.0/24." "reports. \n\n"
" An alert on successful connections will be shown in the report" "Network segments can be IPs, subnets or hosts. Examples:\n"
" Additional subnet formats include: 13.0.0.1, 13.0.0.1-13.0.0.5" "\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\""
} }
} }
} }

View File

@ -76,6 +76,6 @@ export default function UiSchema(props) {
} }
} }
} }
} };
return UiSchema[props.selectedSection] return UiSchema[props.selectedSection]
} }

View File

@ -48,3 +48,8 @@
.config-field-hidden { .config-field-hidden {
display: none; display: none;
} }
.field-description {
white-space: pre-wrap;
}