Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiddify/hiddify-reality-scanner
An efficient Reality scanner that swiftly identifies optimal SNIs through minimal commands.
https://github.com/hiddify/hiddify-reality-scanner
hiddify python reality scanner tls
Last synced: 4 days ago
JSON representation
An efficient Reality scanner that swiftly identifies optimal SNIs through minimal commands.
- Host: GitHub
- URL: https://github.com/hiddify/hiddify-reality-scanner
- Owner: hiddify
- License: unlicense
- Created: 2023-11-22T13:33:29.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-04-02T18:12:03.000Z (8 months ago)
- Last Synced: 2024-11-06T13:57:37.610Z (8 days ago)
- Topics: hiddify, python, reality, scanner, tls
- Language: Python
- Homepage: https://hiddify.com
- Size: 619 KB
- Stars: 179
- Watchers: 3
- Forks: 35
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[** فارسی**](README_fa.md)
# Hiddify Reality Scanner
This is a TLS scanner that helps you scan across different networks and find the best Reality SNI for you based on a list of SNIs. For more information about development, you can read through our [Contribution Guidelines](CONTRIBUTING.md) .
## ⚙️ Installation
The installation of this scanner has 2 parts. The first part is a server-side application and the 2nd part is client-side.
#### 🛠️ Server-side Installation
* First you need to install our custom Xray core on the server using the following command:
```
# remove old xray
bash -c "$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)" @ remove
#only if you have hiddify manager and hiddify panel
systemctl stop hiddify-xray
# install hiddify custom xray
bash -c "$(curl -L https://github.com/hiddify/Xray-core-custom/raw/main/install-release.sh)" @ install
#only if you have hiddify manager and hiddify panel
systemctl start hiddify-xray
```
* Now you should create a config with empty nameserver in your panel or add the following config:
```
curl -o server_config.json https://raw.githubusercontent.com/hiddify/Hiddify_Reality_Scanner/main/server_config.json
echo "---------------IPV6---------"
echo "vless://hiddify@$(curl -6 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify"
echo "---------------IPV4---------"
echo "vless://hiddify@$(curl -4 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify"
```
* Then you need to run the config via Xray like the command below. This will create a temporary Xray server for you :
```
xray run -c server_config.json
```
* You can use your Reality config like the the following link:
```
vless://hiddify@SERVER_IP:11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.yahoo.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify
```
#### 🛠️ Client-side Installation
For client-side, you just need to use Pypi and run the following command:
```bash
pip install -U hiddify_reality_scanner
```
## 🚀 Basic Usage
In order to run the scanner you need to [insall python](https://www.python.org/downloads/) first, then use one of the following commands on your client:
```bash
python -m hiddify_reality_scanner "vless_link"
#or
hiddify_reality_scanner "vless_link"
```
> Be careful that instead of `vless_link' you have to replace it with your Reality config.
## 🚀 Advanced Usage
* If you want to consider more items when scanning, use the following command on your client:
```bash
hiddify_reality_scanner --jobs 10 --limit 100 --sni yahoo.com,google.com "vless_link"
```
* Here:
* `--jobs 10` defines the number of concurrent scans. The(default 10 if you dont use this parameter in the command.
* `--sni` defines the desired SNIs for scanning.
* `--limit 100` defines the 100 limit for the working SNIs in the result list. The default 10 if you dont use this parameter in the command
* If you want to add a list of SNIs, use the following command
```bash
hiddify_reality_scanner --jobs 10 --limit 100 --sni path_to_the_list vless_link
```
* Here:
* `--jobs 10` defines the number of concurrent scans. The(default 10 if you dont use this parameter in the command.
* `--sni path_to_the_list` desines the path for the list of SNIs.
* `--limit 100` defines the 100 limit for the working SNIs in the result list. The(default 10 if you dont use this parameter in the command.
> Note: during the scan, if you want to intrupt it, you can simply use `ctrl+c` .
## 📊 Results
The results will be stored in `results.txt` and `results.json` on your client. You can use these SNIs as a Reality domain in your server. [How to add Reality domain on Hiddify Manager](https://hiddify.com/manager/configuration-and-advanced-settings/How-to-use-Reality-on-Hiddify/)
> Note: If you have installed server-side scanner on your Hiddify Manager; You need to run the following command after finishing the scan:
```
systemctl start hiddify-xray
```