Skip to content

Commit 613becd

Browse files
enfeinenfein
authored
feat: support mieru protocol (#1702)
1 parent d6b496d commit 613becd

File tree

7 files changed

+391
-3
lines changed

7 files changed

+391
-3
lines changed

‎adapter/outbound/mieru.go

+268
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,268 @@
1+
package outbound
2+
3+
import (
4+
"context"
5+
"fmt"
6+
"net"
7+
"runtime"
8+
"strconv"
9+
"sync"
10+
11+
mieruclient "github.com/enfein/mieru/v3/apis/client"
12+
mierumodel "github.com/enfein/mieru/v3/apis/model"
13+
mierupb "github.com/enfein/mieru/v3/pkg/appctl/appctlpb"
14+
"github.com/metacubex/mihomo/component/dialer"
15+
"github.com/metacubex/mihomo/component/proxydialer"
16+
C "github.com/metacubex/mihomo/constant"
17+
"google.golang.org/protobuf/proto"
18+
)
19+
20+
type Mieru struct {
21+
*Base
22+
option *MieruOption
23+
client mieruclient.Client
24+
mu sync.Mutex
25+
}
26+
27+
type MieruOption struct {
28+
BasicOption
29+
Name string `proxy:"name"`
30+
Server string `proxy:"server"`
31+
Port int `proxy:"port,omitempty"`
32+
PortRange string `proxy:"port-range,omitempty"`
33+
Transport string `proxy:"transport"`
34+
UserName string `proxy:"username"`
35+
Password string `proxy:"password"`
36+
}
37+
38+
// DialContext implements C.ProxyAdapter
39+
func (m *Mieru) DialContext(ctx context.Context, metadata *C.Metadata, opts ...dialer.Option) (C.Conn, error) {
40+
if err := m.ensureClientIsRunning(opts...); err != nil {
41+
return nil, err
42+
}
43+
addr := metadataToMieruNetAddrSpec(metadata)
44+
c, err := m.client.DialContext(ctx, addr)
45+
if err != nil {
46+
return nil, fmt.Errorf("dial to %s failed: %w", addr, err)
47+
}
48+
return NewConn(c, m), nil
49+
}
50+
51+
// ProxyInfo implements C.ProxyAdapter
52+
func (m *Mieru) ProxyInfo() C.ProxyInfo {
53+
info := m.Base.ProxyInfo()
54+
info.DialerProxy = m.option.DialerProxy
55+
return info
56+
}
57+
58+
func (m *Mieru) ensureClientIsRunning(opts ...dialer.Option) error {
59+
m.mu.Lock()
60+
defer m.mu.Unlock()
61+
62+
if m.client.IsRunning() {
63+
return nil
64+
}
65+
66+
// Create a dialer and add it to the client config, before starting the client.
67+
var dialer C.Dialer = dialer.NewDialer(m.Base.DialOptions(opts...)...)
68+
var err error
69+
if len(m.option.DialerProxy) > 0 {
70+
dialer, err = proxydialer.NewByName(m.option.DialerProxy, dialer)
71+
if err != nil {
72+
return err
73+
}
74+
}
75+
config, err := m.client.Load()
76+
if err != nil {
77+
return err
78+
}
79+
config.Dialer = dialer
80+
if err := m.client.Store(config); err != nil {
81+
return err
82+
}
83+
84+
if err := m.client.Start(); err != nil {
85+
return fmt.Errorf("failed to start mieru client: %w", err)
86+
}
87+
return nil
88+
}
89+
90+
func NewMieru(option MieruOption) (*Mieru, error) {
91+
config, err := buildMieruClientConfig(option)
92+
if err != nil {
93+
return nil, fmt.Errorf("failed to build mieru client config: %w", err)
94+
}
95+
c := mieruclient.NewClient()
96+
if err := c.Store(config); err != nil {
97+
return nil, fmt.Errorf("failed to store mieru client config: %w", err)
98+
}
99+
// Client is started lazily on the first use.
100+
101+
var addr string
102+
if option.Port != 0 {
103+
addr = net.JoinHostPort(option.Server, strconv.Itoa(option.Port))
104+
} else {
105+
beginPort, _, _ := beginAndEndPortFromPortRange(option.PortRange)
106+
addr = net.JoinHostPort(option.Server, strconv.Itoa(beginPort))
107+
}
108+
outbound := &Mieru{
109+
Base: &Base{
110+
name: option.Name,
111+
addr: addr,
112+
iface: option.Interface,
113+
tp: C.Mieru,
114+
udp: false,
115+
xudp: false,
116+
rmark: option.RoutingMark,
117+
prefer: C.NewDNSPrefer(option.IPVersion),
118+
},
119+
option: &option,
120+
client: c,
121+
}
122+
runtime.SetFinalizer(outbound, closeMieru)
123+
return outbound, nil
124+
}
125+
126+
func closeMieru(m *Mieru) {
127+
m.mu.Lock()
128+
defer m.mu.Unlock()
129+
if m.client != nil && m.client.IsRunning() {
130+
m.client.Stop()
131+
}
132+
}
133+
134+
func metadataToMieruNetAddrSpec(metadata *C.Metadata) mierumodel.NetAddrSpec {
135+
if metadata.Host != "" {
136+
return mierumodel.NetAddrSpec{
137+
AddrSpec: mierumodel.AddrSpec{
138+
FQDN: metadata.Host,
139+
Port: int(metadata.DstPort),
140+
},
141+
Net: "tcp",
142+
}
143+
} else {
144+
return mierumodel.NetAddrSpec{
145+
AddrSpec: mierumodel.AddrSpec{
146+
IP: metadata.DstIP.AsSlice(),
147+
Port: int(metadata.DstPort),
148+
},
149+
Net: "tcp",
150+
}
151+
}
152+
}
153+
154+
func buildMieruClientConfig(option MieruOption) (*mieruclient.ClientConfig, error) {
155+
if err := validateMieruOption(option); err != nil {
156+
return nil, fmt.Errorf("failed to validate mieru option: %w", err)
157+
}
158+
159+
transportProtocol := mierupb.TransportProtocol_TCP.Enum()
160+
var server *mierupb.ServerEndpoint
161+
if net.ParseIP(option.Server) != nil {
162+
// server is an IP address
163+
if option.PortRange != "" {
164+
server = &mierupb.ServerEndpoint{
165+
IpAddress: proto.String(option.Server),
166+
PortBindings: []*mierupb.PortBinding{
167+
{
168+
PortRange: proto.String(option.PortRange),
169+
Protocol: transportProtocol,
170+
},
171+
},
172+
}
173+
} else {
174+
server = &mierupb.ServerEndpoint{
175+
IpAddress: proto.String(option.Server),
176+
PortBindings: []*mierupb.PortBinding{
177+
{
178+
Port: proto.Int32(int32(option.Port)),
179+
Protocol: transportProtocol,
180+
},
181+
},
182+
}
183+
}
184+
} else {
185+
// server is a domain name
186+
if option.PortRange != "" {
187+
server = &mierupb.ServerEndpoint{
188+
DomainName: proto.String(option.Server),
189+
PortBindings: []*mierupb.PortBinding{
190+
{
191+
PortRange: proto.String(option.PortRange),
192+
Protocol: transportProtocol,
193+
},
194+
},
195+
}
196+
} else {
197+
server = &mierupb.ServerEndpoint{
198+
DomainName: proto.String(option.Server),
199+
PortBindings: []*mierupb.PortBinding{
200+
{
201+
Port: proto.Int32(int32(option.Port)),
202+
Protocol: transportProtocol,
203+
},
204+
},
205+
}
206+
}
207+
}
208+
return &mieruclient.ClientConfig{
209+
Profile: &mierupb.ClientProfile{
210+
ProfileName: proto.String(option.Name),
211+
User: &mierupb.User{
212+
Name: proto.String(option.UserName),
213+
Password: proto.String(option.Password),
214+
},
215+
Servers: []*mierupb.ServerEndpoint{server},
216+
},
217+
}, nil
218+
}
219+
220+
func validateMieruOption(option MieruOption) error {
221+
if option.Name == "" {
222+
return fmt.Errorf("name is empty")
223+
}
224+
if option.Server == "" {
225+
return fmt.Errorf("server is empty")
226+
}
227+
if option.Port == 0 && option.PortRange == "" {
228+
return fmt.Errorf("either port or port-range must be set")
229+
}
230+
if option.Port != 0 && option.PortRange != "" {
231+
return fmt.Errorf("port and port-range cannot be set at the same time")
232+
}
233+
if option.Port != 0 && (option.Port < 1 || option.Port > 65535) {
234+
return fmt.Errorf("port must be between 1 and 65535")
235+
}
236+
if option.PortRange != "" {
237+
begin, end, err := beginAndEndPortFromPortRange(option.PortRange)
238+
if err != nil {
239+
return fmt.Errorf("invalid port-range format")
240+
}
241+
if begin < 1 || begin > 65535 {
242+
return fmt.Errorf("begin port must be between 1 and 65535")
243+
}
244+
if end < 1 || end > 65535 {
245+
return fmt.Errorf("end port must be between 1 and 65535")
246+
}
247+
if begin > end {
248+
return fmt.Errorf("begin port must be less than or equal to end port")
249+
}
250+
}
251+
252+
if option.Transport != "TCP" {
253+
return fmt.Errorf("transport must be TCP")
254+
}
255+
if option.UserName == "" {
256+
return fmt.Errorf("username is empty")
257+
}
258+
if option.Password == "" {
259+
return fmt.Errorf("password is empty")
260+
}
261+
return nil
262+
}
263+
264+
func beginAndEndPortFromPortRange(portRange string) (int, int, error) {
265+
var begin, end int
266+
_, err := fmt.Sscanf(portRange, "%d-%d", &begin, &end)
267+
return begin, end, err
268+
}

‎adapter/outbound/mieru_test.go

+92
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
package outbound
2+
3+
import "testing"
4+
5+
func TestNewMieru(t *testing.T) {
6+
testCases := []struct {
7+
option MieruOption
8+
wantBaseAddr string
9+
}{
10+
{
11+
option: MieruOption{
12+
Name: "test",
13+
Server: "1.2.3.4",
14+
Port: 10000,
15+
Transport: "TCP",
16+
UserName: "test",
17+
Password: "test",
18+
},
19+
wantBaseAddr: "1.2.3.4:10000",
20+
},
21+
{
22+
option: MieruOption{
23+
Name: "test",
24+
Server: "2001:db8::1",
25+
PortRange: "10001-10002",
26+
Transport: "TCP",
27+
UserName: "test",
28+
Password: "test",
29+
},
30+
wantBaseAddr: "[2001:db8::1]:10001",
31+
},
32+
{
33+
option: MieruOption{
34+
Name: "test",
35+
Server: "example.com",
36+
Port: 10003,
37+
Transport: "TCP",
38+
UserName: "test",
39+
Password: "test",
40+
},
41+
wantBaseAddr: "example.com:10003",
42+
},
43+
}
44+
45+
for _, testCase := range testCases {
46+
mieru, err := NewMieru(testCase.option)
47+
if err != nil {
48+
t.Error(err)
49+
}
50+
if mieru.addr != testCase.wantBaseAddr {
51+
t.Errorf("got addr %q, want %q", mieru.addr, testCase.wantBaseAddr)
52+
}
53+
}
54+
}
55+
56+
func TestBeginAndEndPortFromPortRange(t *testing.T) {
57+
testCases := []struct {
58+
input string
59+
begin int
60+
end int
61+
hasErr bool
62+
}{
63+
{"1-10", 1, 10, false},
64+
{"1000-2000", 1000, 2000, false},
65+
{"65535-65535", 65535, 65535, false},
66+
{"1", 0, 0, true},
67+
{"1-", 0, 0, true},
68+
{"-10", 0, 0, true},
69+
{"a-b", 0, 0, true},
70+
{"1-b", 0, 0, true},
71+
{"a-10", 0, 0, true},
72+
}
73+
74+
for _, testCase := range testCases {
75+
begin, end, err := beginAndEndPortFromPortRange(testCase.input)
76+
if testCase.hasErr {
77+
if err == nil {
78+
t.Errorf("beginAndEndPortFromPortRange(%s) should return an error", testCase.input)
79+
}
80+
} else {
81+
if err != nil {
82+
t.Errorf("beginAndEndPortFromPortRange(%s) should not return an error, but got %v", testCase.input, err)
83+
}
84+
if begin != testCase.begin {
85+
t.Errorf("beginAndEndPortFromPortRange(%s) begin port mismatch, got %d, want %d", testCase.input, begin, testCase.begin)
86+
}
87+
if end != testCase.end {
88+
t.Errorf("beginAndEndPortFromPortRange(%s) end port mismatch, got %d, want %d", testCase.input, end, testCase.end)
89+
}
90+
}
91+
}
92+
}

‎adapter/parser.go

+7
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,13 @@ func ParseProxy(mapping map[string]any) (C.Proxy, error) {
141141
break
142142
}
143143
proxy, err = outbound.NewSsh(*sshOption)
144+
case "mieru":
145+
mieruOption := &outbound.MieruOption{}
146+
err = decoder.Decode(mapping, mieruOption)
147+
if err != nil {
148+
break
149+
}
150+
proxy, err = outbound.NewMieru(*mieruOption)
144151
default:
145152
return nil, fmt.Errorf("unsupport proxy type: %s", proxyType)
146153
}

‎constant/adapters.go

+3-1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ const (
4242
WireGuard
4343
Tuic
4444
Ssh
45+
Mieru
4546
)
4647

4748
const (
@@ -226,7 +227,8 @@ func (at AdapterType) String() string {
226227
return "Tuic"
227228
case Ssh:
228229
return "Ssh"
229-
230+
case Mieru:
231+
return "Mieru"
230232
case Relay:
231233
return "Relay"
232234
case Selector:

0 commit comments

Comments
 (0)