# midori

**Repository Path**: zoujiaqing/midori

## Basic Information

- **Project Name**: midori
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-13
- **Last Updated**: 2025-05-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Midori

[![CI][ci-badge]][ci-url]
[![Codacy][codacy-badge]][codacy-url]
[![License][mit-badge]][mit-url]
![Activity][activity-img]

[ci-badge]: https://github.com/zephyrchien/midori/workflows/ci/badge.svg
[ci-url]: https://github.com/zephyrchien/midori/actions

[codacy-badge]: https://app.codacy.com/project/badge/Grade/908ed7e0dd5f4bec8984856931021165
[codacy-url]: https://www.codacy.com/gh/zephyrchien/midori/dashboard?utm_source=github.com&utm_medium=referral&utm_content=zephyrchien/midori&utm_campaign=Badge_Grade

[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/zephyrchien/midori/blob/master/LICENSE

[activity-img]: https://img.shields.io/github/commit-activity/m/zephyrchien/midori?color=green&label=commit

## Protocols
- [x] [TCP][tcp-doc-url]
- [x] [UDS][uds-doc-url]
- [x] [UDP][udp-doc-url]
- [x] [TLS][tls-doc-url]
- [x] [WebSocket][ws-doc-url]
- [x] [HTTP2][h2-doc-url]
- [ ] KCP
- [ ] gRPC
- [x] [QUIC][quic-doc-url]

[doc-url]: https://github.com/zephyrchien/midori/tree/master/docs

[tcp-doc-url]: https://github.com/zephyrchien/midori/blob/master/docs/tcp.md

[uds-doc-url]: https://github.com/zephyrchien/midori/blob/master/docs/uds.md

[udp-doc-url]: https://github.com/zephyrchien/midori/blob/master/docs/udp.md

[tls-doc-url]: https://github.com/zephyrchien/midori/blob/master/docs/tls.md

[ws-doc-url]: https://github.com/zephyrchien/midori/blob/master/docs/ws.md

[h2-doc-url]: https://github.com/zephyrchien/midori/blob/master/docs/h2.md

[quic-doc-url]: https://github.com/zephyrchien/midori/blob/master/docs/quic.md

## Build
```shell
git clone https://github.com/zephyrchien/midori
cd midori
cargo build --release
```
### Optional Features
- `uds` -- enable unix domain socket
- `udp` -- enable udp
- `tls` -- enable tls(rustls)
- `ws` -- enable websocket
- `h2c` -- enable http2
- `quic` -- enable quic
- `full` -- enable all above (*default*)
```shell
# tcp only
cargo build --release --no-default-features

# with tls support
cargo build --release --no-default-features --features tls

# with other protocols
cargo build --release --no-default-features --features tls,ws,h2c
```
## Usage
```shell
midori [OPTIONS] [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -c, --config <file>    specify a config file
```

## Quick Start
Let's start with a simple TCP relay(supports zero-copy on linux). Just create a config file and then specify the listen and remote address:

```json
{
    "endpoints":[
        {
            "listen": "0.0.0.0:5000",
            "remote": "1.2.3.4:8080"
        },
        {
            "listen": "0.0.0.0:10000",
            "remote": "www.example.com:443"
        },
    ]
}
```

Launch these 2 endpoints:
```shell
midori -c config.json
```

Almost all kinds of address are supported, including `ipv4`, `ipv6`, `domain name` and `unix socket path`.

## Log
This program is equipped with a light-weight logger, which is disabled by default. You can provide env variables to enable it.

Supported log levels:
- Off
- Error
- Warn
- Info
- Debug
- Trace

Example:
```shell
RUST_LOG=debug midori
```

## Full Configuration
<details>
<summary>show example</summary>
<pre><code>
{
  "dns_mode": "ipv4_then_ipv6",
  "endpoints": [
    {
      "listen": {
        "addr": "0.0.0.0:5000",
        "net": "tcp",
        "trans": {
          "proto": "ws",
          "path": "/"
        },
        "tls": {
          "cert": "x.crt",
          "key": "x.pem",
          "versions": "tlsv1.3, tlsv1.2",
          "aplns": "http/1.1",
          "ocsp": "x.ocsp"
        }
      },
      "remote": {
        "addr": "www.example.com:443",
        "net": "tcp",
        "trans": {
          "proto": "h2",
          "path": "/",
          "server_push": false
        },
        "tls": {
          "roots": "firefox",
          "versions": "tlsv1.3, tlsv1.2",
          "sni": "www.example.com",
          "aplns": "h2",
          "skip_verify": false,
          "enable_sni": true
        }
      }
    }
  ]
}
</code></pre>
</details>

### Global
Currently, the configuration file only consists of 2 fields:
```shell
{
    "dns_mode": "", // and other global params
    "endpoints": []
}
```

### DNS Mode
The `trust-dns` crate supports these strategies:
- ipv4_only
- ipv6_only
- ipv4_then_ipv6 (*default*)
- ipv6_then_ipv4
- ipv4_and_ipv6

### Endpoint(s)
Each endpoint contains an associated pair of `listen` and `remote`:
```bash
{
    "listen": "",
    "remote": ""
}
```

Options of `listen` & `remote`:

```bash
{
    "addr": "",  // must
    "net": "",  // tcp(deafult), uds, udp
    "trans": "",  // plain(default), ws, h2..
    "tls": ""  // none(default)
}
```
Not all fields above are required. If not specified, the default value will be applied. `trans` and `tls` have more complicated params. [See protocol docs for more details][doc-url].

You can freely combine `net`, `trans` and `tls`. For example, tcp + ws + tls = wss; uds + h2 + tls = h2(over uds).

All possible combinations:
| net | tls| trans | result |
| :---: | :---: | :---: | :---: |
| tcp/uds | none   | plain | plain tcp/uds      |
| tcp/uds | rustls | plain | tls over tcp/uds   |
| tcp/uds | none   | ws    | ws over tcp/uds    |
| tcp/uds | rustls | ws    | wss over tcp/uds   |
| tcp/uds | none   | h2    | h2c over tcp/uds   |
| tcp/uds | rustls | h2    | http2  over tcp/uds|
| tcp/uds | none   | grpc  | grpc over tcp/uds  |
| tcp/uds | rustls | grpc  | grpc over tcp/uds  |
| udp     | none   | plain | plain udp          |
| udp     | none   | kcp   | kcp                |
| udp     | rustls | quic  | quic               |


## License
[The MIT License (MIT)](https://github.com/zephyrchien/midori/blob/master/LICENSE)