Files
3x-ui/internal/web/service/xray_wireguard_config_test.go
T
YoungReckless4 8f162994ef feat(clients): let admins set PersistentKeepalive on tunnel clients (#6377)
* feat(clients): let admins set PersistentKeepalive on tunnel clients

model.Client already carries KeepAlive, and every AmneziaWG/WireGuard client
config emitter already writes PersistentKeepalive when it is above zero -- but
nothing in the UI could set it, so it stayed 0 and the line was never emitted.

Without it a peer that goes quiet has nothing to trigger a handshake: WireGuard
only initiates when it has data to send. An idle client stays disconnected
after any interruption -- a NAT mapping timing out, a device sleeping, the
panel restarting -- until the user generates traffic themselves.

New clients default to 25, the conventional value, which also keeps the NAT
mapping open. Existing clients keep whatever they have, and 0 remains valid and
means "do not send keepalives".

* fix(clients): let an explicit 0 actually disable PersistentKeepalive

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.

* fix(clients): repair the keepalive pointer conversion after the main merge

Merging main brought buildAmneziaWGProxy (#6326) in beside the
Client.KeepAlive int -> *int change without reconciling the new call site,
so internal/sub stopped compiling and took every package importing it with
it. The two sides touched different lines, so git merged them without a
conflict -- the green `make verify` on 112b19a8 predates the break.

ToClient also wrapped a stored 0 in a pointer, so omitempty stopped
omitting: a VLESS client's settings JSON gained "keepAlive": 0 on the
attach and bulk-attach paths, and that JSON reaches xray-core verbatim
through GenXrayInboundConfig. wg_keep_alive cannot tell "off" from "never
set", so a stored 0 now stays nil.

Also copies the regenerated openapi.json over the docs mirror, which
nothing in CI checks, and trims two comment blocks to the two-line cap.

---------

Co-authored-by: Sanaei <ho3ein.sanaei@gmail.com>
2026-09-10 22:32:42 +02:00

241 lines
7.2 KiB
Go

package service
import (
"encoding/base64"
"encoding/json"
"testing"
"github.com/mhsanaei/3x-ui/v3/internal/database"
"github.com/mhsanaei/3x-ui/v3/internal/database/model"
)
func wgTestSecretKey() string {
return base64.StdEncoding.EncodeToString(make([]byte, 32))
}
func wgInboundEmittedSettings(t *testing.T, tag string) map[string]any {
t.Helper()
svc := &XrayService{}
cfg, err := svc.GetXrayConfig()
if err != nil {
t.Fatalf("GetXrayConfig: %v", err)
}
for i := range cfg.InboundConfigs {
ic := cfg.InboundConfigs[i]
if ic.Tag != tag {
continue
}
var s map[string]any
if err := json.Unmarshal([]byte(ic.Settings), &s); err != nil {
t.Fatalf("unmarshal emitted settings: %v", err)
}
return s
}
t.Fatalf("inbound %q not found in generated config", tag)
return nil
}
func seedWGInbound(t *testing.T, tag string, port int, clients []model.Client) {
t.Helper()
setupSettingTestDB(t)
db := database.GetDB()
in := &model.Inbound{
Tag: tag,
Enable: true,
Port: port,
Protocol: model.WireGuard,
Settings: `{"secretKey":"` + wgTestSecretKey() + `","mtu":1420}`,
}
if err := db.Create(in).Error; err != nil {
t.Fatalf("create wg inbound: %v", err)
}
svc := ClientService{}
if err := svc.SyncInbound(nil, in.Id, clients); err != nil {
t.Fatalf("SyncInbound: %v", err)
}
}
func seedDualTunnelClient(t *testing.T, enabled bool) string {
t.Helper()
setupSettingTestDB(t)
db := database.GetDB()
const email = "dual@wg.test"
wgClient := model.Client{
Email: email,
Enable: true,
PublicKey: "pub-dual",
AllowedIPs: []string{"10.0.0.5/32"},
PreSharedKey: "wg-psk",
}
awgClient := wgClient
awgClient.AllowedIPs = []string{"10.8.1.5/32"}
awgClient.PreSharedKey = "awg-psk"
wgSettings, err := json.Marshal(map[string]any{
"secretKey": wgTestSecretKey(),
"mtu": 1420,
"clients": []model.Client{wgClient},
})
if err != nil {
t.Fatalf("marshal wg settings: %v", err)
}
awgSettings, err := json.Marshal(map[string]any{
"server": map[string]any{"subnetIp": "10.8.1.0", "subnetCidr": 24},
"clients": []model.Client{awgClient},
})
if err != nil {
t.Fatalf("marshal awg settings: %v", err)
}
wgInbound := &model.Inbound{Tag: "wg-dual", Enable: true, Port: 51823, Protocol: model.WireGuard, Settings: string(wgSettings)}
awgInbound := &model.Inbound{Tag: "awg-dual", Enable: true, Port: 51824, Protocol: model.AmneziaWG, Settings: string(awgSettings)}
if err := db.Create(wgInbound).Error; err != nil {
t.Fatalf("create wg inbound: %v", err)
}
if err := db.Create(awgInbound).Error; err != nil {
t.Fatalf("create awg inbound: %v", err)
}
svc := ClientService{}
if err := svc.SyncInbound(nil, wgInbound.Id, []model.Client{wgClient}); err != nil {
t.Fatalf("SyncInbound(wg): %v", err)
}
awgClient.Enable = enabled
if err := svc.SyncInbound(nil, awgInbound.Id, []model.Client{awgClient}); err != nil {
t.Fatalf("SyncInbound(awg): %v", err)
}
return email
}
func wgPeerList(t *testing.T, settings map[string]any) []map[string]any {
t.Helper()
if _, ok := settings["clients"]; ok {
t.Fatalf("wireguard inbound must not emit a clients[] key: %v", settings["clients"])
}
rawPeers, ok := settings["peers"].([]any)
if !ok {
t.Fatalf("settings.peers is not an array: %T", settings["peers"])
}
out := make([]map[string]any, 0, len(rawPeers))
for _, p := range rawPeers {
m, ok := p.(map[string]any)
if !ok {
t.Fatalf("peer is not an object: %T", p)
}
out = append(out, m)
}
return out
}
func TestGetXrayConfigWireGuardPeers(t *testing.T) {
clients := []model.Client{
{Email: "alice@wg.test", Enable: true, PublicKey: "pub-alice", AllowedIPs: []string{"10.0.0.2/32"}, KeepAlive: model.KeepAlivePtr(25)},
{Email: "bob@wg.test", Enable: true, PublicKey: "pub-bob", AllowedIPs: []string{"10.0.0.3/32"}},
}
seedWGInbound(t, "wg-multi", 51820, clients)
settings := wgInboundEmittedSettings(t, "wg-multi")
if settings["secretKey"] != wgTestSecretKey() {
t.Errorf("secretKey not preserved: %v", settings["secretKey"])
}
if settings["mtu"] != float64(1420) {
t.Errorf("mtu not preserved: %v", settings["mtu"])
}
peers := wgPeerList(t, settings)
if len(peers) != 2 {
t.Fatalf("expected 2 peers, got %d: %v", len(peers), peers)
}
ips := map[string]bool{}
for _, p := range peers {
if p["email"] == nil || p["email"] == "" {
t.Errorf("peer missing email: %v", p)
}
if p["publicKey"] == nil || p["publicKey"] == "" {
t.Errorf("peer missing publicKey: %v", p)
}
if p["level"] != float64(0) {
t.Errorf("peer level = %v, want 0 (needed for per-user stats)", p["level"])
}
allowed, ok := p["allowedIPs"].([]any)
if !ok || len(allowed) == 0 {
t.Fatalf("peer missing allowedIPs: %v", p)
}
ips[allowed[0].(string)] = true
}
if len(ips) != 2 {
t.Errorf("peers must have distinct allowedIPs, got %v", ips)
}
}
func TestGetXrayConfigWireGuardDisabledClientExcluded(t *testing.T) {
clients := []model.Client{
{Email: "on@wg.test", Enable: true, PublicKey: "pub-on", AllowedIPs: []string{"10.0.0.2/32"}},
{Email: "off@wg.test", Enable: true, PublicKey: "pub-off", AllowedIPs: []string{"10.0.0.3/32"}},
}
seedWGInbound(t, "wg-disabled", 51821, clients)
if err := database.GetDB().Model(&model.ClientRecord{}).
Where("email = ?", "off@wg.test").Update("enable", false).Error; err != nil {
t.Fatalf("disable client: %v", err)
}
peers := wgPeerList(t, wgInboundEmittedSettings(t, "wg-disabled"))
if len(peers) != 1 {
t.Fatalf("expected 1 enabled peer, got %d: %v", len(peers), peers)
}
if peers[0]["email"] != "on@wg.test" {
t.Errorf("wrong peer kept: %v", peers[0])
}
}
func TestGetXrayConfigWireGuardUsesInboundLocalTunnelFields(t *testing.T) {
email := seedDualTunnelClient(t, true)
var shared model.ClientRecord
if err := database.GetDB().Where("email = ?", email).First(&shared).Error; err != nil {
t.Fatalf("read shared client: %v", err)
}
if shared.AllowedIPs != "10.8.1.5/32" || shared.PreSharedKey != "awg-psk" {
t.Fatalf("test setup did not persist AmneziaWG last: allowedIPs=%q preSharedKey=%q", shared.AllowedIPs, shared.PreSharedKey)
}
peers := wgPeerList(t, wgInboundEmittedSettings(t, "wg-dual"))
if len(peers) != 1 {
t.Fatalf("expected 1 peer, got %d: %v", len(peers), peers)
}
allowed, ok := peers[0]["allowedIPs"].([]any)
if !ok || len(allowed) != 1 || allowed[0] != "10.0.0.5/32" {
t.Fatalf("WireGuard peer allowedIPs = %v, want [10.0.0.5/32]", peers[0]["allowedIPs"])
}
if peers[0]["preSharedKey"] != "wg-psk" {
t.Fatalf("WireGuard peer preSharedKey = %v, want wg-psk", peers[0]["preSharedKey"])
}
}
func TestGetXrayConfigWireGuardDisabledDualProtocolClientExcluded(t *testing.T) {
seedDualTunnelClient(t, false)
peers := wgPeerList(t, wgInboundEmittedSettings(t, "wg-dual"))
if len(peers) != 0 {
t.Fatalf("expected disabled dual-protocol client to be excluded, got %v", peers)
}
}
func TestGetXrayConfigWireGuardNoClientsEmitsEmptyPeers(t *testing.T) {
seedWGInbound(t, "wg-empty", 51822, nil)
settings := wgInboundEmittedSettings(t, "wg-empty")
if _, ok := settings["clients"]; ok {
t.Fatalf("clients key must be absent")
}
peers, ok := settings["peers"].([]any)
if !ok {
t.Fatalf("peers must be an (empty) array, got %T", settings["peers"])
}
if len(peers) != 0 {
t.Fatalf("expected empty peers, got %v", peers)
}
}