______ __ ______ __ __ __ __ _____ __ __ __ | __ \.-----.--| |______| __ \.---.-.| |--.| |--.|__| |_ ______| \.-----.----.--.--.--------.-----.-----.| |_.---.-.| |_|__|.-----.-----. | <| -__| _ |______| <| _ || _ || _ || | _|______| -- | _ | __| | | | -__| || _| _ || _| || _ | | |___|__||_____|_____| |___|__||___._||_____||_____||__|____| |_____/|_____|____|_____|__|__|__|_____|__|__||____|___._||____|__||_____|__|__| The next few sections will be dedicated to the red rabbit documentation, the sections will be disected by module, eg: (0x0001 is module search) it goes from there from the list above. Another example of how modules will be seperated is by the cloumn number in the chart above where Brute is the second module name, its section will be labeled 0x0002 - BRUTE -, please take your time going through the documentation ALOT of people often forget about documentation then come to the devs confused as to why some dont work, or how the script works and how to use it, so please, when i mean read it i mean READ IT CAREFULLY!






0x0005 Interacting with file parsing such as NMAP XML files
Alot of this mainly contains parsing NMAP XML files, JSON files, or even parsing through files via regex to find all sensative information in the file that you are parsing.
> parse xmln host This command is quite simple, it takes a nmap XML output file then parses through the file to look for all hostnames that have been scanned. (USER NOTE: You could always use the example files and lists and even images to test out utiltiies in red rabbit if you do not have your own) example output
Addresses scanned ~> 45.33.32.156

> parse xmln service this command like others are simple to use and understand it will parse through the NMAP XML file, and try to find the ports scanned, their service, service info etc... example output
< Port > | 49 | < State > | closed | < Service information of port > Service | ssh | OS_type | Linux | Product | OpenSSH | Version | 6.6.1p1 Ubuntu 2ubuntu2.13 | CPE | [cpe:/a:openbsd:openssh:6.6.1p1 cpe:/o:linux:linux_kernel] | Method | probed | < Port > | 45 | < State > | closed | < Service information of port > Service | smtp | OS_type | | Product | | Version | | CPE | [] | Method | table | < Port > | 50 | < State > | closed | < Service information of port > Service | http | OS_type | | Product | Apache httpd | Version | 2.4.7 | CPE | [cpe:/a:apache:http_server:2.4.7] | Method | probed | < Port > | 49 | < State > | closed | < Service information of port > Service | msrpc | OS_type | | Product | | Version | | CPE | [] | Method | table | < Port > | 44 | < State > | closed | < Service information of port > Service | profile | OS_type | | Product | | Version | | CPE | [] | Method | table |

> parse xmln ports Find all of the ports scanned and saved in the output of a nmap XML file, this will also try to find information on the found port example output
< Port > | 49 | < State > | closed | < Service > | ssh | < Port > | 45 | < State > | closed | < Service > | smtp | < Port > | 50 | < State > | closed | < Service > | http | < Port > | 49 | < State > | closed | < Service > | msrpc | < Port > | 44 | < State > | closed | < Service > | profile | < Port > | 50 | < State > | closed | < Service > | netbios-ns | < Port > | 51 | < State > | closed | < Service > | netbios-dgm | < Port > | 45 | < State > | closed | < Service > | netbios-ssn | < Port > | 50 | < State > | closed | < Service > | microsoft-ds | < Port > | 52 | < State > | closed | < Service > | ssh | < Port > | 44 | < State > | closed | < Service > | smtp | < Port > | 50 | < State > | closed | < Service > | http | < Port > | 54 | < State > | closed | < Service > | msrpc | < Port > | 45 | < State > | closed | < Service > | profile | < Port > | 55 | < State > | closed | < Service > | netbios-ns | < Port > | 57 | < State > | closed | < Service > | netbios-dgm | < Port > | 44 | < State > | closed | < Service > | netbios-ssn | < Port > | 56 | < State > | closed | < Service > | microsoft-ds |

> parse xmln hostn parse through the nmap XML file that you saved to find all scanned hostnames within the file, based on a predefined structure. example output
< Host > | scanme.nmap.org | | |----Host Type>: | user | | | |----Host Text>: | | ---------------------------------------------------------------------- < Host > | scanme.nmap.org | | |----Host Type>: | PTR | | | |----Host Text>: | | ---------------------------------------------------------------------- < Host > | scanme.nmap.org | | |----Host Type>: | user | | | |----Host Text>: | | ---------------------------------------------------------------------- < Host > | scanme.nmap.org | | |----Host Type>: | PTR | | | |----Host Text>: | | ---------------------------------------------------------------------- < Host > | scanme.nmap.org | | |----Host Type>: | user | | | |----Host Text>: | | ---------------------------------------------------------------------- < Host > | scanme.nmap.org | | |----Host Type>: | PTR | | | |----Host Text>: | | ----------------------------------------------------------------------

> parse xmln porti parse through a NMAP XML file to find all ports that were scanned and for every port get information on the port such as service, protocal name, loc, and port description example output
< Port > | 49 | < Stat > | closed | < Service information of port > Service | ssh | OS_type | Linux | Product | OpenSSH | Version | 6.6.1p1 Ubuntu 2ubuntu2.13 | CPE | [cpe:/a:openbsd:openssh:6.6.1p1 cpe:/o:linux:linux_kernel] | Method | probed | < Reason > Reason | conn-refused | Protocal | tcp | Count | 991 | Text | | Ports | 1-21,23-24,26-79,81-134,140-444,446-1000 | < Port > | 45 | < Stat > | closed | < Service information of port > Service | smtp | OS_type | | Product | | Version | | CPE | [] | Method | table | < Reason > Reason | conn-refused | Protocal | tcp | Count | 991 | Text | | Ports | 1-21,23-24,26-79,81-134,140-444,446-1000 |

> parse xmln runs Command will parse through a NMAP XML file to find all given runtime data and script information about the command and the session that was started example output
Script Finished Area > | | |>> Time | 1652112645 | |>> Time String | Mon May 9 12:10:45 2022 | |>> Summary | Nmap done at Mon May 9 12:10:45 2022; 1 IP address (1 host up) scanned in 26.87 seconds | |>> Elapsed Time| 26.87 | |>> Exit | success |

> parse xmln hosts Find all scanned number of hosts in the NMAP XML output file, quite simple output example output
Run Statistics Hosts > | | |>> Text | | |>> Down | 0 | |>> Up | 1 | |>> Total | 1 |

> parse xmln hosth Parse through a NMAP output based XML file to find and output all host information found in the prdefined hosth / host hint tag and structure example output
Host Hint Information > | | |>> Status Text | | |>> Status State | up | |>> Status Reason | unknown-response | |>> Status ReasonTTL | 0 | |>> Address Text | | |>> Address Addr | 45.33.32.156 | |>> Address Type | ipv4 |

> parse xmln verbose parse through a nmap XML file to locate and output all information on the verbose tag and script side used. example output
Verbosity Information > | | |>> Level | 2 | |>> Text | |

> parse xmln debug parse through a nmap XML based output file to find all debug information and debug settings that were logged during output example output
Debug Information > | | |>> Level | 0 | |>> Text | |

> parse xmln times parse through a nmap xml based output file to find the time of execution of the scan and other time based information example output
Scanning Information > | | | |>> time Start | 1652112619 | |>> Time end | 1652112645 | |>> Time Finish | 1652112645 | |>> Time string | Mon May 9 12:10:45 2022 |

> parse xmln scaninf Parse through a nmap XML output file to find all scan information example output
Scanning Information > | | |>> Protocal | tcp | |>> Type | connect | |>> Number Of Services | 1000 | |>> Services | 1-1000 | |>> Text | |

> parse xmln * like all commands any command that ends in * will mean run all functions, this command will simply parse through an XML output file from a nmap scan, and run all parsing functions and will output all given information example output
Port > | 49 | State > | closed | Service > | ssh | Port > | 57 | State > | closed | Service > | netbios-dgm | Port > | 44 State > | closed | Service > | netbios-ssn | Port > | 56 | State > | closed | Service > | microsoft-ds | Port > | 49 | State > | closed | Service > | ssh | Port > | 45 | State > | closed | Service > | smtp | Port > | 49 | State > | closed | Service > | http | Port > | 51 | State > | closed | Service > | msrpc | Port > | 52 | State > | closed | Service > | profile | Port > | 44 | State > | closed | Service > | netbios-ns | Port > | 49 | State > | closed | Service > | netbios-dgm | Port > | 52 | State > | closed | Service > | netbios-ssn | Port > | 48 | State > | closed | Service > | microsoft-ds | Run Statistics Hosts > | | |>> Text | | |>> Down | 0 | |>> Up | 1 | |>> Total | 1 | Port > | 49 | State > | closed | Service information of port > Service | ssh | OS_type | Linux | Product | OpenSSH | Version | 6.6.1p1 Ubuntu 2ubuntu2.13 | CPE | [cpe:/a:openbsd:openssh:6.6.1p1 cpe:/o:linux:linux_kernel] | Method | probed | Port > | 45 | State > | closed | Service information of port > Service | smtp | OS_type | | Product | | Version | | CPE | [] | Method | table | Script Finished Area > | | | Time | 1652112645 | | Time String | Mon May 9 12:10:45 2022 | | Summary | Nmap done at Mon May 9 12:10:45 2022; 1 IP address (1 host up) scanned in 26.87 seconds | |>> Elapsed Time| 26.87 | |>> Exit | success | Host Hint Information > | | |>> Status Text | | |>> Status State | up | |>> Status Reason | unknown-response | |>> Status ReasonTTL | 0 | |>> Address Text | | |>> Address Addr | 45.33.32.156 | |>> Address Type | ipv4 | Debug Information > | | |>> Level | 0 | |>> Text | | Verbosity Information > | | |>> Level | 0 | |>> Text | | Scanning Information > | | |>> Protocal | tcp | |>> Type | connect | |>> Number Of Services | 1000 | |>> Services | 1-1000 | |>> Text | |

> parse config Simple command will check all API keys you have inserted into the API settings YAML file --NO OUTPUT
> parse burp targets Open and parse for a list of URLS and targets to produce a burp configuration file example file output
{ "target": { "scope": { "advanced_mode": true, "exclude": [], "include": [ { "enabled": true, "file": "^/.*", "host": "^http://www\\.google\\.com$", "port": "^443$", "protocol": "https" },

> parse data IP4 Open a file and pillage that file for all IP4 addresses that were found in that file
> parse data IP6 Open a file and pillage that file for all IP6 addresses that were found in that file
> parse data email Open a file and pillage that file for all email addresses that were found in that file
> parse data mac Open a file and pillage that file for all mac addresses that were found in that file
> parse data custom use your own customized regex string to pillage a file for information such as addresses names, numbers, etc..