The script is designed to scan Cloudflare's edge IPs and locate ones that are viable for use with v2ray/xray. It aims to identify edge IPs that are accessible and not blocked.

CFSCanner runs on different operating systems including and not limited to:

• Linux
• MacOS
• Windows
• Android (termux, UserLAnd, etc.)

• Python (>=3.6)
• Libraries
  • requests
  • pysocks
  • rich

sudo apt update && sudo apt install python3-pip git -y

git clone https://github.com/MortezaBashsiz/CFScanner.git

cd CFScanner/python/

pip install -r ./requirements.txt

• If you want to use the default sudoer config, you can skip this step

• create a config json file (e.g., myconfig.json) with the following content. replace the values with your own!

{
	"id": "248ecb72-89cf-5be7-923f-b790fca681c5",
	"host": "scherehtzhel01.sudoer.net",
	"port": "443",
	"path": "api01",
	"serverName": "248ecb72-89cf-5be7-923f-b790fca681c5.sudoer.net"
}

In the following, you can find examples of running the script with and without custom config and subnets file. For more details on the arguments, please see Arguments

• To run with sudoer default config and only one thread on the default subnets list:

  python3 cfscanner.py 

• To run with sudoer default config and 8 threads:

  python3 cfscanner.py -t 8

• To run on a list of subnets:

  python3 cfscanner.py -t 8 -c ./myconfig.json -s ./mysubnets.selection

  Each line of the file can be either a subnet (in CIDR notation) or a single IP (v4 or v6):

  1.0.0.0/24
  108.162.218.0/24
  108.162.236.0/22
  162.158.8.0/21
  162.158.60.0/24
  162.158.82.12
  2606:4700::/120
  2606:4700:3032::6815:3819
  ...
  

• To run with a minimum acceptable download speed of 100 kilobytes per second

  python3 cfscanner.py -t 8 -c ./myconfig.json -s ./mysubnets.selection -DS 100

• To run with a minimum acceptable download and upload speed (in KBps)

  python3 cfscanner.py -t 8 -c ./myconfig.json -s ./mysubnets.selection -DS 100 -US 25

• To run and try each IP multiple (in this case 3) times. An IP is marked ok if it passes all the tests.

  python3 cfscanner.py --threads 8 --config ./myconfig.json --subnets ./mysubnets.selection --download-speed 100 --upload-speed 25 --tries 3

• To run on a random sample of size 20 of the subnets and minimum acceptable download and upload speed of 10 KBps with the default config

  python3 cfscanner.py -t 8 -DS 10 -US 10 -r 20

To use this tool, you can specify various options as follows:

To see the help message, use the --help or -h option.

• --threads, -t: Number of threads to use for parallel scanning. Default value is 1.
• --tries, -n: Number of times to try each IP. An IP is marked as OK if all tries are successful. Default value is 1.
• --subnets, -s: The path to the custom subnets file. Each line should be either a single ip (v4 or v6) or a subnet in cidr notation (v4 or v6). If not provided, the program will read the list of cidrs from https://github.com/MortezaBashsiz/CFScanner/blob/main/bash/cf.local.iplist.
• --sample, -r: Size of the random sample to take from each subnet. The sample size can either be a float between 0 and 1 ($0 < s < 1$) or an integer ($ s \ge 1$). If it is a float, it will be interpreted as a percentage of the subnet size. If it is an integer, it will be interpreted as the number of ips to take from each subnet. If not provided, the program will take all ips from each subnet

• --config, -c: The path to the config file. For config file example, see sudoer default config. If not provided, the program will read the default sudoer config file.
• --template: Path to the proxy (v2ray/xray) client file template. By default vmess_ws_tls is used.
• --binpath, -b: Path to the v2ray/xray binary file. If not provided, will use the latest compatible version of xray.
• --novpn: If passed, xray/v2ray service will not be started and the program will not use vpn.
• --startprocess-timeout: Maximum time (in seconds) to wait for xray/v2ray process to start. Default value is 5.

• --fronting-timeout, -FT: Maximum time to wait for fronting response. Default value is 1.

• --download-speed, -DS: Minimum acceptable download speed in kilobytes per second. Default value is 50.
• --download-latency, -DL: Maximum allowed latency (seconds) for download. Default value is 2.
• --download-time, -DT: Maximum (effective, excluding http time) time to spend for each download. Default value is 2.

• --upload-test, -U: If passed, upload test will be conducted. If not passed, only download and fronting test will be conducted.
• --upload-speed, -US: Minimum acceptable upload speed in kilobytes per second. Default value is 50.
• --upload-latency, -UL: Maximum allowed latency (seconds) for upload. Default value is 2.
• --upload-time, -UT: Maximum (effective, excluding http time) time (in seconds) to spend for each upload. Default value is 2.

• In the current version, an IP is marked "OK", only if it passes all tries of the experiment
• The size of the file for download is determined based on the arguments download-speed and download-time (similar for upload as well). Therefore, it is recommended to choose these parameters carefully based on your expectations, internet speed and the number of threads being used

The results will be stored in the results directory. Each line of the generated csv file includes a Cloudflare edge ip together with the following values:

• avg_download_speed : Average download speed in mbps
• avg_upload_speed: Average upload speed in mbps
• avg_download_latency: Average download latency in ms
• avg_upload_latency: Average upload latency in ms
• avg_download_jitter: Average jitter during downloads in ms
• avg_upload_jitter: Average jitter during uploads in ms
• download_speed_1,...,n_tries: Values of download speeds in mbps for each download
• upload_speed_1,...,n_ties: Values of download speeds in mbps for each upload
• download_latency_1,...,n_tries: Values of download latencies in ms
• download_latency_1,..._n_tries: Values of upload latencies in ms

For each time running the code, a result file is generated in the result folder with the datetime string to avoid overwriting (e.g, 20230226_180502_result.csv)

Contributors names and contact info

• Tempookian
• Morteza Bashsiz

• 0.1
  • Initial Releas
• 1.0.0
  • Automatic download of xray binary
  • Use xray by default
  • Arguments reorginazed
  • Changed default behavior when a subnet list is not provided. The list is read from the repo and not asnlookup anymore
• 1.0.1
  • Fixed a bug in detect system (issue #385)
• 1.0.2
  • Fixed a bug in the min UL speed, especially for min_upload_speed = 0
• 1.0.3
  • Fixed a bug in custom config template
• 1.1.0
  • Added random sampling
• 1.2.0
  • Added progress bar
  • Improved logging