README
¶
見える / mieru
mieru is a secure, hard to classify, hard to probe, TCP or UDP protocol-based socks5 / HTTP / HTTPS network proxy software.
The mieru proxy software suite consists of two parts, a client software called mieru, and a proxy server software called mita.
Protocol
The principle of mieru is similar to shadowsocks / v2ray etc. It creates an encrypted channel between the client and the proxy server outside the firewall. GFW cannot decrypt the encrypted transmission and cannot determine the destination you end up visiting, so it has no choice but to let you go.
For an explanation of the mieru protocol, see mieru Proxy Protocol.
Features
- Provides socks5, HTTP, and HTTPS proxy interfaces.
- Does not use TLS protocol. No need to register a domain name or set up a fake website.
- Uses the high-strength XChaCha20-Poly1305 encryption algorithm that generates encryption keys based on username, password and system time.
- Utilizes random padding and replay attack detection to prevent GFW from detecting the mieru service.
- Supports multiple users sharing a single proxy server.
- Supports both IPv4 and IPv6.
- The server software supports socks5 outbound (proxy chain).
- The client software supports Windows, Mac OS, Linux and Android. Android clients include
- NekoBox with mieru plugin.
- Exclave with mieru plugin.
- husi with mieru plugin.
- If you need advanced features like global proxy or customized routing rules, you can use mieru as the backend of a proxy platform such as Xray and sing-box.
User Guide
- Server Installation & Configuration
- Client Installation & Configuration
- Client Installation & Configuration - OpenWrt
- Maintenance & Troubleshooting
- Security Guide
- Compilation
Share
If you think this software is helpful, please share to your friends. Thanks!
Contact Us
Use GitHub issue.
License
Use of this software is subject to the GPL-3 license.
Directories
¶
| Path | Synopsis |
|---|---|
|
apis
|
|
|
client
Package client provides mieru client APIs for third party applications to integrate mieru protocol.
|
Package client provides mieru client APIs for third party applications to integrate mieru protocol. |
|
cmd
|
|
|
mieru
Binary mieru is the client of mieru proxy.
|
Binary mieru is the client of mieru proxy. |
|
mita
Binary mita is the server of mieru proxy.
|
Binary mita is the server of mieru proxy. |
|
pkg
|
|
|
deque
Package deque provides a fast ring-buffer deque (double-ended queue) implementation.
|
Package deque provides a fast ring-buffer deque (double-ended queue) implementation. |
|
log
Package log is is imported from https://github.com/sirupsen/logrus
|
Package log is is imported from https://github.com/sirupsen/logrus |
|
socks5
Package socks5 is imported from https://github.com/armon/go-socks5 and https://github.com/h12w/socks
|
Package socks5 is imported from https://github.com/armon/go-socks5 and https://github.com/h12w/socks |
|
test
|
|
|
cmd/httpserver
httpserver is a simple HTTP server.
|
httpserver is a simple HTTP server. |
|
cmd/sockshttpclient
sockshttpclient is a HTTP client that connects to HTTP server via a socks proxy.
|
sockshttpclient is a HTTP client that connects to HTTP server via a socks proxy. |
|
cmd/socksudpclient
socksudpclient is a client that connects to a server via a socks UDP association.
|
socksudpclient is a client that connects to a server via a socks UDP association. |
|
cmd/udpserver
For each incoming UDP packet, if the data satisfy [A-Za-z]+, a rot13 of the input is send back.
|
For each incoming UDP packet, if the data satisfy [A-Za-z]+, a rot13 of the input is send back. |