Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/enfein/mieru

mieru is a socks5 / HTTP / HTTPS proxy to bypass censorship. 見える是一款 socks5 / HTTP / HTTPS 网络代理翻墙工具。
https://github.com/enfein/mieru

anti-censorship gfw network proxy socks5 tunnel

Last synced: 10 days ago
JSON representation

mieru is a socks5 / HTTP / HTTPS proxy to bypass censorship. 見える是一款 socks5 / HTTP / HTTPS 网络代理翻墙工具。

Host: GitHub
URL: https://github.com/enfein/mieru
Owner: enfein
License: gpl-3.0
Created: 2021-09-25T04:54:02.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-05-23T04:30:38.000Z (about 1 month ago)
Last Synced: 2024-05-23T05:32:38.910Z (about 1 month ago)
Topics: anti-censorship, gfw, network, proxy, socks5, tunnel
Language: Go
Homepage:
Size: 1.03 MB
Stars: 931
Watchers: 13
Forks: 122
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/security.md

Lists

awesome-stars - enfein/mieru - `★962` mieru is a socks5 / HTTP / HTTPS proxy to bypass censorship. 見える是一款 socks5 / HTTP / HTTPS 网络代理翻墙工具。 (Go)

README

# 見える / mieru

[![Build Status](https://github.com/enfein/mieru/actions/workflows/ci.yaml/badge.svg)](https://github.com/enfein/mieru/actions/workflows/ci.yaml)
[![Releases](https://img.shields.io/github/release/enfein/mieru/all.svg?style=flat)](https://github.com/enfein/mieru/releases)
[![Downloads](https://img.shields.io/github/downloads/enfein/mieru/total.svg?style=flat)](https://github.com/enfein/mieru/releases)
[![LICENSE](https://img.shields.io/github/license/enfein/mieru.svg?style=flat)](./LICENSE)

[中文文档](./README.zh_CN.md)

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](./docs/protocol.md).

## Features

1. mieru uses a high-strength XChaCha20-Poly1305 encryption algorithm that generates encryption keys based on username, password and system time.
2. mieru implements complete encryption of all transmitted content between the client and the proxy server, without transmitting any plaintext information.
3. When mieru sends a packet, it is padded with random bytes at the end. Even when the same content is transmitted, the packet size varies.
4. When using the UDP transport protocol, mieru does not require a handshake between client and server.
5. When the server can not decrypt the data sent by the client, no content is returned. it is difficult for GFW to discover the mieru service through active probing.
6. mieru supports multiple users sharing a single proxy server.
7. mieru supports IPv4 and IPv6.
8. mieru provides socks5, HTTP and HTTPS proxy.
9. The client software supports Windows, Mac OS, Linux and Android. For Android users, please use [NekoBox](https://github.com/MatsuriDayo/NekoBoxForAndroid) version 1.3.1 or above, and install [mieru plugin](https://github.com/enfein/NekoBoxPlugins).
10. The server software supports socks5 outbound (proxy chain).
11. 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 clash.

## User Guide

1. [Server Installation & Configuration](./docs/server-install.md)
2. [Client Installation & Configuration](./docs/client-install.md)
3. [Client Installation & Configuration - OpenWrt](./docs/client-install-openwrt.md)
4. [Maintenance & Troubleshooting](./docs/operation.md)
5. [Security Guide](./docs/security.md)

## Compile

Compiling should be done in Linux. The compilation process requires downloading dependent packages, which may be blocked by the firewall.

The following softwares are required for compilation.

- curl
- env
- git
- go (version >= 1.20)
- make
- sha256sum
- tar
- zip

To build Android executable files:

- gcc

To build debian packages:

- dpkg-deb
- fakeroot

To build RPM packages:

- rpmbuild

To compile, go to the root directory of the project and invoke `make`. The compilation result will be stored in the `release` directory.

## 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.