fix(inbounds): refuse a Shadowsocks-2022 server key xray-core cannot parse

xray-core parses the inbound-level Shadowsocks-2022 key with ParseKey and
refuses one of the wrong size while building the inbound, which keeps the
whole core from starting, not only that inbound. Only client keys were
checked, so an API caller posting a 32-byte key on aes-128 (or keeping a
16-byte key after switching to aes-256/chacha20) saved fine and took
Xray down.

AddInbound and UpdateInbound now reject such a key with a message that
names the method and the size it needs. The check uses the core's own
GetCipherMethod/ParseKey, so a raw non-base64 key the core accepts stays
valid. Startup also replaces a stored wrong-size server key: that inbound
never worked, so no client holds a working copy of it.
This commit is contained in:
MHSanaei
2026-10-11 20:42:23 +02:00
parent b124af2a1b
commit b9e1d3afee
6 changed files with 229 additions and 0 deletions
+23
View File
@@ -509,6 +509,29 @@ func shadowsocksKeyBytes(method string) int {
return 0
}
// validateShadowsocks2022ServerKey refuses a server key xray-core cannot parse:
// the core then fails to build the inbound and does not start at all.
func validateShadowsocks2022ServerKey(protocol model.Protocol, settings string) error {
if protocol != model.Shadowsocks {
return nil
}
var parsed struct {
Method string `json:"method"`
Password string `json:"password"`
}
if json.Unmarshal([]byte(settings), &parsed) != nil {
return nil
}
n := xray.Shadowsocks2022KeyBytes(parsed.Method)
if n == 0 {
return nil
}
if !xray.ValidShadowsocks2022Key(parsed.Method, parsed.Password) {
return common.NewErrorf("shadowsocks inbound password: %s needs a %d-byte key, base64 encoded", parsed.Method, n)
}
return nil
}
// normalizeShadowsocksClientKeys rewrites any Shadowsocks-2022 client password
// whose decoded length no longer matches settings.method, which happens after the
// inbound method is switched between ciphers of different key sizes (e.g.
+6
View File
@@ -1178,6 +1178,9 @@ func (s *InboundService) AddInbound(inbound *model.Inbound) (*model.Inbound, boo
if err := validateFinalMaskSalamander(inbound.StreamSettings); err != nil {
return inbound, false, err
}
if err := validateShadowsocks2022ServerKey(inbound.Protocol, inbound.Settings); err != nil {
return inbound, false, err
}
s.normalizeMtprotoSecret(inbound)
if err := s.normalizeMtprotoXrayPort(inbound, ""); err != nil {
return inbound, false, err
@@ -1823,6 +1826,9 @@ func (s *InboundService) UpdateInbound(inbound *model.Inbound) (*model.Inbound,
if err := validateFinalMaskSalamander(inbound.StreamSettings); err != nil {
return inbound, false, err
}
if err := validateShadowsocks2022ServerKey(inbound.Protocol, inbound.Settings); err != nil {
return inbound, false, err
}
s.normalizeMtprotoSecret(inbound)
oldInbound, err := s.GetInbound(inbound.Id)
@@ -0,0 +1,77 @@
package service
import (
"encoding/base64"
"fmt"
"strings"
"testing"
"github.com/mhsanaei/3x-ui/v3/internal/database/model"
)
func ss2022Settings(method, serverKey string) string {
clientKey := base64.StdEncoding.EncodeToString(make([]byte, 16))
if method != "2022-blake3-aes-128-gcm" {
clientKey = base64.StdEncoding.EncodeToString(make([]byte, 32))
}
return fmt.Sprintf(`{"method":%q,"password":%q,"network":"tcp,udp","clients":[{"email":"ss-key","password":%q,"enable":true}]}`,
method, serverKey, clientKey)
}
// xray-core refuses a wrong-size Shadowsocks-2022 server key while building the
// inbound, which keeps the whole core from starting, not just this inbound.
func TestShadowsocks2022ServerKeyRejected(t *testing.T) {
key32 := base64.StdEncoding.EncodeToString(make([]byte, 32))
key16 := base64.StdEncoding.EncodeToString(make([]byte, 16))
t.Run("add", func(t *testing.T) {
setupConflictDB(t)
nodeID, fake := setupNodeRuntime(t)
ib := &model.Inbound{
UserId: 1, NodeID: &nodeID, Tag: "ss-add", Enable: true, Port: 41801, Protocol: model.Shadowsocks,
Settings: ss2022Settings("2022-blake3-aes-128-gcm", key32),
}
_, _, err := (&InboundService{}).AddInbound(ib)
if err == nil || !strings.Contains(err.Error(), "2022-blake3-aes-128-gcm needs a 16-byte key") {
t.Fatalf("AddInbound with a 32-byte aes-128 key: err = %v", err)
}
if fake.addInbound.Load() != 0 {
t.Fatal("rejected inbound dispatched to the runtime")
}
})
t.Run("update", func(t *testing.T) {
setupConflictDB(t)
nodeID, fake := setupNodeRuntime(t)
svc := &InboundService{}
ib := &model.Inbound{
UserId: 1, NodeID: &nodeID, Tag: "ss-update", Enable: true, Port: 41802, Protocol: model.Shadowsocks,
Settings: ss2022Settings("2022-blake3-aes-128-gcm", key16),
}
if _, _, err := svc.AddInbound(ib); err != nil {
t.Fatalf("AddInbound with a valid key: %v", err)
}
update := *ib
update.Settings = ss2022Settings("2022-blake3-aes-256-gcm", key16)
_, _, err := svc.UpdateInbound(&update)
if err == nil || !strings.Contains(err.Error(), "2022-blake3-aes-256-gcm needs a 32-byte key") {
t.Fatalf("UpdateInbound keeping a 16-byte key on aes-256: err = %v", err)
}
if fake.updateInbound.Load() != 0 {
t.Fatal("rejected update dispatched to the runtime")
}
})
// The core reads a non-base64 key as its raw bytes, so this one is valid.
t.Run("raw key the core accepts", func(t *testing.T) {
setupConflictDB(t)
nodeID, _ := setupNodeRuntime(t)
ib := &model.Inbound{
UserId: 1, NodeID: &nodeID, Tag: "ss-raw", Enable: true, Port: 41803, Protocol: model.Shadowsocks,
Settings: ss2022Settings("2022-blake3-aes-128-gcm", "0123456789abcd-!"),
}
if _, _, err := (&InboundService{}).AddInbound(ib); err != nil {
t.Fatalf("AddInbound with a raw 16-byte key: %v", err)
}
})
}