diff --git a/README.md b/README.md index 2c15bf1..db8716d 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,7 @@ This attack is also known as Predictable Resource Location, File Enumeration, Di - [Proxy traffic through a SOCKS proxy](#proxy-traffic-through-a-socks-proxy) - [Pass auth token via query parameter](#pass-auth-token-via-query-parameter) - [Limit Total Number of Concurrent Scans (new in `v1.2.0`)](#limit-total-number-of-concurrent-scans-new-in-v120) + - [Filter Response by Status Code (new in `v1.3.0`)](#filter-response-by-status-code--new-in-v130) - [Comparison w/ Similar Tools](#-comparison-w-similar-tools) - [Common Problems/Issues (FAQ)](#-common-problemsissues-faq) - [No file descriptors available](#no-file-descriptors-available) @@ -273,6 +274,7 @@ A pre-made configuration file with examples of all available settings can be fou # # wordlist = "/wordlists/jhaddix/all.txt" # status_codes = [200, 500] +# filter_status = [301] # threads = 1 # timeout = 5 # proxy = "http://127.0.0.1:8080" @@ -315,13 +317,13 @@ USAGE: feroxbuster [FLAGS] [OPTIONS] --url ... FLAGS: - -f, --add-slash Append / to each request - -D, --dont-filter Don't auto-filter wildcard responses + -f, --add-slash Append / to each request + -D, --dont-filter Don't auto-filter wildcard responses -e, --extract-links Extract links from response body (html, javascript, etc...); make new requests based on findings (default: false) -h, --help Prints help information -k, --insecure Disables TLS certificate validation - -n, --no-recursion Do not scan recursively + -n, --no-recursion Do not scan recursively -q, --quiet Only print URLs; Don't print status codes, response size, running config, etc... -r, --redirects Follow redirects --stdin Read url(s) from STDIN @@ -331,17 +333,19 @@ FLAGS: OPTIONS: -d, --depth Maximum recursion depth, a depth of 0 is infinite recursion (default: 4) -x, --extensions ... File extension(s) to search for (ex: -x php -x pdf js) + -S, --filter-size ... Filter out messages of a particular size (ex: -S 5120 -S 4927,1970) + -C, --filter-status ... Filter out status codes (deny list) (ex: -C 200 -S 401) -H, --headers
... Specify HTTP headers (ex: -H Header:val 'stuff: things') -o, --output Output file to write results to (default: stdout) -p, --proxy Proxy to use for requests (ex: http(s)://host:port, socks5://host:port) -Q, --query ... Specify URL query parameters (ex: -Q token=stuff -Q secret=key) - -L, --scan-limit Limit total number of concurrent scans (default: 7) - -S, --filter-size ... Filter out messages of a particular size (ex: -S 5120 -S 4927,1970) - -s, --status-codes ... Status Codes of interest (default: 200 204 301 302 307 308 401 403 405) + -L, --scan-limit Limit total number of concurrent scans (default: 0, i.e. no limit) + -s, --status-codes ... Status Codes to include (allow list) (default: 200 204 301 302 307 308 401 + 403 405) -t, --threads Number of concurrent threads (default: 50) -T, --timeout Number of seconds before a request times out (default: 7) -u, --url ... The target URL(s) (required, unless --stdin used) - -a, --user-agent Sets the User-Agent (default: feroxbuster/VERSION) + -a, --user-agent Sets the User-Agent (default: feroxbuster/VERSION) -w, --wordlist Path to the wordlist ``` @@ -436,6 +440,16 @@ discovered directories can only begin scanning when the total number of active s ./feroxbuster -u http://127.1 --scan-limit 2 ``` +### Filter Response by Status Code (new in `v1.3.0`) + +Version 1.3.0 included an overhaul to the filtering system which will allow for a wide array of filters to be added +with minimal effort. The first such filter is a Status Code Filter. As responses come back from the scanned server, +each one is checked against a list of known filters and either displayed or not according to which filters are set. + +``` +./feroxbuster -u http://127.1 --filter-status 301 +``` + ![limit-demo](img/limit-demo.gif) ## 🧐 Comparison w/ Similar Tools @@ -460,7 +474,7 @@ a few of the use-cases in which feroxbuster may be a better fit: |------------------------------------------------------------------|---|---|---| | fast | ✔ | ✔ | ✔ | | easy to use | ✔ | ✔ | | -| blacklist status codes (in addition to whitelist) | | ✔ | ✔ | +| filter out responses by status code (new in `v1.3.0`) | ✔ | ✔ | ✔ | | allows recursion | ✔ | | ✔ | | can specify query parameters | ✔ | | ✔ | | SOCKS proxy support | ✔ | | |