v4.1 - See CHANGELOG.md

xnl-h4ck3r · Apr 22, 2024 · 7273bf0 · 7273bf0
1 parent 872134a
commit 7273bf0
Show file tree

Hide file tree

Showing 5 changed files with 162 additions and 74 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,24 @@
 ## Changelog
 
+- v4.1
+
+  - New
+
+    - Add arg `-r`/`--retries` for the number of times to retry when having issues connecting to the KNOXSS API (default: 3)
+    - Add arg `ri`/`--retry-interval` for how many seconds to wait before retrying when having issues connecting to the KNOXSS API (default: 30 seconds)
+    - Add arg `rb`/`--rety-backoff` for the backoff factor used when retrying when having issues connecting to the KNOXSS API (default: 1.5). For example, with defaults, first time will wait for 30 seconds, 2nd time will be 45 (30 x 1.5) seconds, etc.
+    - Check for the runtime error `Response ended prematurely` when sending to the API. This can happen if the user is using a VPN, which the KNOXSS servers don't seem to like.
+    - If a scheme and domain have been flagged as blocked already, skip other URLs with the same. Include `from urllib.parse import urlparse` and add `urlparse3` to `setup.py` to achieve this.
+    - URL encode any `+` characters in the target URL so they don't get changed to spaces.
+
+  - Changed
+
+    - Change the error `The target website timed out` to `The KNOXSS API timed out getting the response (consider changing -t value)`
+    - Change the error `The target dropped the connection.` to `The KNOXSS API dropped the connection.`
+    - Set the default timeout limit for requests to the KNOXSS API to 600 seconds. The previous default was 180, but this has been resulting in many timeouts as the server response can take a lot longer for some URLs.
+    - If you set `-t`/`--timeout` to 0, it will not request a timeout at all when calling the KNOXSS API.
+    - When adding a blocked domain to the set, include the scheme too because there have been examples where a target blocks KNOXSS for `https://target.com`, but not `http://target.com`.
+
 - v4.0
 
   - New

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <center><img src="https://github.com/xnl-h4ck3r/knoxnl/blob/main/knoxnl/images/title.png"></center>
 
-## About - v4.0
+## About - v4.1
 
 This is a python wrapper around the amazing [KNOXSS API](https://knoxss.me/?page_id=2729) by Brute Logic.
 To use this tool (and the underlying API), you must have a valid KNOXSS API key. Don't have one? Go visit https://knoxss.me and subscribe!
@@ -53,8 +53,11 @@ pipx install git+https://github.com/xnl-h4ck3r/knoxnl.git
 | -afb | --advanced-filter-bypass | If the advanced filter bypass should be used on the KNOXSS API.                                                                                                                                                                                            |
 | -s   | --success-only           | Only show successful XSS payloads in the CLI output.                                                                                                                                                                                                       |
 | -p   | --processes              | Basic multithreading is done when getting requests for a file of URLs. This argument determines the number of processes (one per URL to check) are run per minute (default: 3). This is due to the rate limit of the KNOXSS API.                           |
-| -t   | --timeout                | How many seconds to wait for the KNOXSS API to respond before giving up (default: 180)                                                                                                                                                                     |
+| -t   | --timeout                | How many seconds to wait for the KNOXSS API to respond before giving up (default: 600). If set to 0, then timeout will be used.                                                                                                                            |
 | -bp  | --burp-piper             | Use if **knoxnl** is called from the Burp Piper extension, so that a request in **Burp Suite** proxy can be tested. See the [Using in Burp Suite Proxy](#using-in-burp-suite-proxy) section below.                                                         |
+| -r   | --retries                | The number of times to retry when having issues connecting to the KNOXSS API (default: 3)                                                                                                                                                                  |
+| -ri  | --retry-interval         | How many seconds to wait before retrying when having issues connecting to the KNOXSS API (default: 30)                                                                                                                                                     |
+| -rb  | --retry-backoff          | The backoff factor used when retrying when having issues connecting to the KNOXSS API (default: 1.5). For example, with defaults, first time will wait for 30 seconds, 2nd time will be 45 (30 x 1.5) seconds, etc.                                        |
 | -v   | --verbose                | Verbose output                                                                                                                                                                                                                                             |
 |      | --version                | Show current version number.                                                                                                                                                                                                                               |
 | -h   | --help                   | show the help message and exit                                                                                                                                                                                                                             |

diff --git a/knoxnl/__init__.py b/knoxnl/__init__.py
@@ -1 +1 @@
-__version__="4.0"
+__version__="4.1"