mirror of
https://github.com/honmashironeko/ProxyCat.git
synced 2025-11-05 10:51:06 +00:00
19 KiB
19 KiB
<p align="center">
<a href="/ProxyCat-EN/README-EN.md">English</a>
·
<a href="/README.md">简体中文</a>
</p>
## Project Overview
During penetration testing, one often encounters situations where hiding or changing the IP address is necessary to bypass security devices. However, commercial tunnel proxies are generally very expensive, ranging from 20 to 40 yuan per day, which can be quite prohibitive. The author has observed that short-lived IPs are much more cost-effective, averaging only 0.2 to 3 yuan per day.
Thus, this tool was developed to transform short-lived IPs (lasting from 1 to 60 minutes) into a stable IP, enabling other tools to utilize them effectively and forming a proxy pool server that can be deployed once for permanent use.
## Supported Features
```
Local Listening Service: Customizable listening ports, custom authentication for listening ports.
Proxy Address Support: Four protocol types, timed proxy address changes, automatic address change after each request, API for automatic proxy retrieval, supports authenticated proxies.
Service Runtime: Changes proxy addresses only upon receiving requests, supports ultra-high concurrency, supports HTTP and HTTPS protocols, checks for version updates at startup.
System Compatibility: Compatible with Windows, Linux, and MacOS; supports VPS remote deployment and local installation.
```
## Project Usage
### Install Dependencies
This tool is implemented in Python (recommended version 3.8 or higher). Please configure the dependencies using the following commands:
```bash
pip install -r requirements.txt
# or use a domestic source:
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple/
```
Run the command `python3 ProxyCat.py -h` in the project directory, and if the following output appears, the configuration is successful:
```
# python3 ProxyCat.py -h
|\ _,,,---,,_ by Honma Shironeko
ZZZzz /,`.-'`' -. ;-;;,_
|,4- ) )-,_. ,\ ( `'-'
'---''(_/--' `-'\_) ProxyCat
Usage: ProxyCat.py [-h] [-c]
Arguments:
-h, --help Display this help message and exit
-c C Specify configuration file name (default: config.ini)
```
### Manually Enter Proxy Addresses in ip.txt
Enter proxy addresses in the following format, one per line, into the `ip.txt` file:
```ip.txt
socks5://127.0.0.1:7890
socks4://127.0.0.1:7890
https://127.0.0.1:7890
http://127.0.0.1:7890
...
```
> If you lack suitable domestic proxy addresses and have a few yuan to spare, you can contact the author (WeChat: 樱花庄的本间白猫) to obtain low-cost proxy purchase addresses, which will provide the author with a small commission.
Configure parameters in `config.ini` (or a custom configuration file):
```
[SETTINGS]
# Local server listening port (default: 1080)
port = 1080
# Proxy address switching mode: 'cycle' for continuous use, 'once' for one-time use (default: 'cycle')
mode = cycle
# Proxy address change interval (seconds); set to 0 to change IP on every request (default: 300)
interval = 300
# Local server authentication username (default: 'neko'); leave blank for no authentication
username = neko
# Local server authentication password (default: '123456'); leave blank for no authentication
password = 123456
# Whether to use getip module to retrieve proxy addresses (True or False, default: False)
use_getip = False
# Proxy address list file (default: ip.txt)
proxy_file = ip.txt
```
Once the corresponding parameters are configured, you may use the following command:
```bash
# python3 ProxyCat.py
```
**Demonstration Result**
Fixed proxy address (default): http://neko:123456@127.0.0.1:1080 or http://127.0.0.1:1080.
If deployed publicly, replace `127.0.0.1` with your public IP address.
### Use API to Automatically Retrieve Proxy Addresses
The tool supports directly calling the API for proxy address retrieval. When you set `use_getip = True`, the tool will no longer read from the local `ip.txt` and will instead execute **getip.py** to fetch new proxy addresses.
In this case, you need to modify the contents of **getip.py** to use your own API, formatted as `IP:PORT`. The default is `socks5` protocol; change it manually if using `http`.
**Demonstration Result**
> The operator can be obtained from the advertisement area below.
## Performance
Current testing shows that under adequate server performance for proxy addresses, the tool can support 500 concurrent requests without packet loss, effectively covering most scanning and penetration testing needs.
## Disclaimer
- By downloading, installing, using, or modifying this tool and its related code, you indicate your trust in this tool.
- We take no responsibility for any loss or damage caused to you or others while using this tool.
- If you engage in any illegal activities while using this tool, you assume all corresponding consequences, and we will not bear any legal or associated liabilities.
- Please read and thoroughly understand each clause, especially those that exempt or limit liability, and choose to accept or decline.
- Unless you have read and accepted all terms of this agreement, you are not entitled to download, install, or use this tool.
- Your actions, including downloading, installing, or using, indicate that you have read and agree to these terms.
## Changelog
**2024/08/31**
- Major structure adjustments for the project.
- UI enhancements to indicate the time remaining until the next proxy address change.
- Support for `ctrl+c` to stop operation.
- Significant adjustments to asynchronous requests; tested at 1000 concurrent requests with 5000 packets sent, resulting in about 50 lost packets, achieving ~99% stability; 500 concurrent requests resulted in no packet loss.
- Changed parameter specification from runtime to reading from local ini configuration file for improved usability.
- Support for local no-authentication, adapting to more software proxy modes.
- Added version detection functionality to automatically prompt version information.
- Introduced authentication for proxy server addresses, but this only applies to local reads due to the need for whitelisting in most APIs, hence not provided repeatedly.
- Implemented a feature that updates via `getip` only upon receiving new requests to reduce IP consumption.
- Enhanced automatic recognition of proxy server address protocols to accommodate more proxy providers.
- Added support for HTTPS and SOCKS4 proxy protocols; now covers HTTP, HTTPS, SOCKS5, and SOCKS4 protocols.
**2024/08/25**
- Automatically skips empty lines when reading from `ip.txt`.
- Replaced `httpx` with a concurrency pool for performance improvement.
- Added a buffering dictionary to reduce latency for the same site.
- Modified the logic for changing IPs on each request to randomly select a proxy.
- Implemented more efficient structures and algorithms to optimize request handling.
**2024/08/24**
- Adopted asynchronous solutions to improve concurrency and reduce timeouts.
- Encapsulated redundant code for increased reusability.
**2024/08/23**
- Adjusted concurrency logic.
- Added authentication features.
- Added IP retrieval interface for permanent IP changes.
- Introduced functionality to change IP on every request.
## Development Plans
- [x] Add local server authentication to prevent malicious use in public.
- [x] Introduce functionality to change IP on every request.
- [x] Create a static proxy automatic retrieval module for permanent operation.
- [ ] Introduce load balancing mode to use multiple proxy addresses simultaneously, effectively increasing concurrency and reducing load on a single server.
- [x] Add version detection functionality.
- [x] Include support for proxy address authentication.
- [x] Implement functionality for updating via `getip` only upon new requests to minimize IP usage.
- [ ] Perform validity checks on all proxy servers in `ip.txt` upon the first startup.
If you have suggestions or encounter bugs during use, please reach out to the author using the contact information provided!
WeChat: 樱花庄的本间白猫
## Acknowledgments
The following individuals are thanked in no particular order for their contributions to this project.
[AabyssZG (Zeng Ge)](https://github.com/AabyssZG)
[ProbiusOfficial (Tan Ji)](https://github.com/ProbiusOfficial)
[](https://star-history.com/#honmashironeko/ProxyCat&Date)
## Support Open Source
Open source development is challenging. If you find this tool useful, consider sponsoring the author's development!
## Proxy Recommendations
- [First cheap proxy purchase, register with an invitation code to get 5000 free IPs + a 10 yuan coupon](https://h.shanchendaili.com/invite_reg.html?invite=fM6fVG)
- [Various carriers' data cards](https://172.lot-ml.com/ProductEn/Index/0b7c9adef5e9648f)
<p align="center">
<a href="/ProxyCat-EN/README-EN.md">English</a>
·
<a href="/README.md">简体中文</a>
</p>
## Project Overview
During penetration testing, one often encounters situations where hiding or changing the IP address is necessary to bypass security devices. However, commercial tunnel proxies are generally very expensive, ranging from 20 to 40 yuan per day, which can be quite prohibitive. The author has observed that short-lived IPs are much more cost-effective, averaging only 0.2 to 3 yuan per day.
Thus, this tool was developed to transform short-lived IPs (lasting from 1 to 60 minutes) into a stable IP, enabling other tools to utilize them effectively and forming a proxy pool server that can be deployed once for permanent use.
## Supported Features
Local Listening Service: Customizable listening ports, custom authentication for listening ports. Proxy Address Support: Four protocol types, timed proxy address changes, automatic address change after each request, API for automatic proxy retrieval, supports authenticated proxies. Service Runtime: Changes proxy addresses only upon receiving requests, supports ultra-high concurrency, supports HTTP and HTTPS protocols, checks for version updates at startup. System Compatibility: Compatible with Windows, Linux, and MacOS; supports VPS remote deployment and local installation.
## Project Usage
### Install Dependencies
This tool is implemented in Python (recommended version 3.8 or higher). Please configure the dependencies using the following commands:
```bash
pip install -r requirements.txt
# or use a domestic source:
pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple/
Run the command python3 ProxyCat.py -h in the project directory, and if the following output appears, the configuration is successful:
# python3 ProxyCat.py -h
|\ _,,,---,,_ by Honma Shironeko
ZZZzz /,`.-'`' -. ;-;;,_
|,4- ) )-,_. ,\ ( `'-'
'---''(_/--' `-'\_) ProxyCat
Usage: ProxyCat.py [-h] [-c]
Arguments:
-h, --help Display this help message and exit
-c C Specify configuration file name (default: config.ini)
Manually Enter Proxy Addresses in ip.txt
Enter proxy addresses in the following format, one per line, into the ip.txt file:
socks5://127.0.0.1:7890
socks4://127.0.0.1:7890
https://127.0.0.1:7890
http://127.0.0.1:7890
...
If you lack suitable domestic proxy addresses and have a few yuan to spare, you can contact the author (WeChat: 樱花庄的本间白猫) to obtain low-cost proxy purchase addresses, which will provide the author with a small commission.
Configure parameters in config.ini (or a custom configuration file):
[SETTINGS]
# Local server listening port (default: 1080)
port = 1080
# Proxy address switching mode: 'cycle' for continuous use, 'once' for one-time use (default: 'cycle')
mode = cycle
# Proxy address change interval (seconds); set to 0 to change IP on every request (default: 300)
interval = 300
# Local server authentication username (default: 'neko'); leave blank for no authentication
username = neko
# Local server authentication password (default: '123456'); leave blank for no authentication
password = 123456
# Whether to use getip module to retrieve proxy addresses (True or False, default: False)
use_getip = False
# Proxy address list file (default: ip.txt)
proxy_file = ip.txt
Once the corresponding parameters are configured, you may use the following command:
# python3 ProxyCat.py
Demonstration Result
Fixed proxy address (default): http://neko:123456@127.0.0.1:1080 or http://127.0.0.1:1080.
If deployed publicly, replace 127.0.0.1 with your public IP address.
Use API to Automatically Retrieve Proxy Addresses
The tool supports directly calling the API for proxy address retrieval. When you set use_getip = True, the tool will no longer read from the local ip.txt and will instead execute getip.py to fetch new proxy addresses.
In this case, you need to modify the contents of getip.py to use your own API, formatted as IP:PORT. The default is socks5 protocol; change it manually if using http.
Demonstration Result
The operator can be obtained from the advertisement area below.
Performance
Current testing shows that under adequate server performance for proxy addresses, the tool can support 500 concurrent requests without packet loss, effectively covering most scanning and penetration testing needs.
Disclaimer
- By downloading, installing, using, or modifying this tool and its related code, you indicate your trust in this tool.
- We take no responsibility for any loss or damage caused to you or others while using this tool.
- If you engage in any illegal activities while using this tool, you assume all corresponding consequences, and we will not bear any legal or associated liabilities.
- Please read and thoroughly understand each clause, especially those that exempt or limit liability, and choose to accept or decline.
- Unless you have read and accepted all terms of this agreement, you are not entitled to download, install, or use this tool.
- Your actions, including downloading, installing, or using, indicate that you have read and agree to these terms.
Changelog
2024/08/31
- Major structure adjustments for the project.
- UI enhancements to indicate the time remaining until the next proxy address change.
- Support for
ctrl+cto stop operation. - Significant adjustments to asynchronous requests; tested at 1000 concurrent requests with 5000 packets sent, resulting in about 50 lost packets, achieving ~99% stability; 500 concurrent requests resulted in no packet loss.
- Changed parameter specification from runtime to reading from local ini configuration file for improved usability.
- Support for local no-authentication, adapting to more software proxy modes.
- Added version detection functionality to automatically prompt version information.
- Introduced authentication for proxy server addresses, but this only applies to local reads due to the need for whitelisting in most APIs, hence not provided repeatedly.
- Implemented a feature that updates via
getiponly upon receiving new requests to reduce IP consumption. - Enhanced automatic recognition of proxy server address protocols to accommodate more proxy providers.
- Added support for HTTPS and SOCKS4 proxy protocols; now covers HTTP, HTTPS, SOCKS5, and SOCKS4 protocols.
2024/08/25
- Automatically skips empty lines when reading from
ip.txt. - Replaced
httpxwith a concurrency pool for performance improvement. - Added a buffering dictionary to reduce latency for the same site.
- Modified the logic for changing IPs on each request to randomly select a proxy.
- Implemented more efficient structures and algorithms to optimize request handling.
2024/08/24
- Adopted asynchronous solutions to improve concurrency and reduce timeouts.
- Encapsulated redundant code for increased reusability.
2024/08/23
- Adjusted concurrency logic.
- Added authentication features.
- Added IP retrieval interface for permanent IP changes.
- Introduced functionality to change IP on every request.
Development Plans
- Add local server authentication to prevent malicious use in public.
- Introduce functionality to change IP on every request.
- Create a static proxy automatic retrieval module for permanent operation.
- Introduce load balancing mode to use multiple proxy addresses simultaneously, effectively increasing concurrency and reducing load on a single server.
- Add version detection functionality.
- Include support for proxy address authentication.
- Implement functionality for updating via
getiponly upon new requests to minimize IP usage. - Perform validity checks on all proxy servers in
ip.txtupon the first startup.
If you have suggestions or encounter bugs during use, please reach out to the author using the contact information provided!
WeChat: 樱花庄的本间白猫
Acknowledgments
The following individuals are thanked in no particular order for their contributions to this project.
Support Open Source
Open source development is challenging. If you find this tool useful, consider sponsoring the author's development!
Proxy Recommendations
- First cheap proxy purchase, register with an invitation code to get 5000 free IPs + a 10 yuan coupon
- Various carriers' data cards
Feel free to adjust any section further to better suit your needs!