Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8bcb5c63be | ||
|
|
532ee44da3 | ||
|
|
407a023a68 | ||
|
|
bbdd4af66d | ||
|
|
47d627c2e7 | ||
|
|
f2fe4bdbbe | ||
|
|
d777a1e3d3 |
@@ -0,0 +1,170 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/rand"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/auth"
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/config"
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
adminPasswordLen = 20
|
||||||
|
minAdminPasswordLen = 12
|
||||||
|
adminPasswordChars = "ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz23456789"
|
||||||
|
)
|
||||||
|
|
||||||
|
func cmdAdmin(args []string) error {
|
||||||
|
if len(args) < 1 {
|
||||||
|
return errors.New("usage: nixmsg admin <init|set-password>")
|
||||||
|
}
|
||||||
|
switch args[0] {
|
||||||
|
case "init":
|
||||||
|
return cmdAdminInit(args[1:])
|
||||||
|
case "set-password":
|
||||||
|
return cmdAdminSetPassword(args[1:])
|
||||||
|
default:
|
||||||
|
return fmt.Errorf("unknown admin command: %s", args[0])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func cmdAdminInit(_ []string) error {
|
||||||
|
cfg, err := loadAndValidateConfig()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
db, err := store.Open(cfg.DataDir, cfg.SQLiteSynchronous)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer func() { _ = db.Close() }()
|
||||||
|
|
||||||
|
ok, err := store.HasAdminPassword(ctx, db.Write)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if ok {
|
||||||
|
return errors.New("admin already initialized; use admin set-password")
|
||||||
|
}
|
||||||
|
|
||||||
|
password, err := generateAdminPassword(adminPasswordLen)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
phc, err := auth.HashPassword(password)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := store.SetAdminPasswordHash(ctx, db.Write, phc); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
// 密码只打印到终端一次,不进日志。
|
||||||
|
fmt.Printf("admin password: %s\n", password)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func cmdAdminSetPassword(args []string) error {
|
||||||
|
password, err := parseSetPasswordArgs(args, os.Stdin)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if vErr := validateAdminPassword(password); vErr != nil {
|
||||||
|
return vErr
|
||||||
|
}
|
||||||
|
cfg, err := loadAndValidateConfig()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
db, err := store.Open(cfg.DataDir, cfg.SQLiteSynchronous)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer func() { _ = db.Close() }()
|
||||||
|
|
||||||
|
phc, err := auth.HashPassword(password)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := store.SetAdminPasswordHash(ctx, db.Write, phc); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
fmt.Fprintln(os.Stderr, "admin password updated")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseSetPasswordArgs(args []string, stdin io.Reader) (string, error) {
|
||||||
|
var password string
|
||||||
|
for i := 0; i < len(args); i++ {
|
||||||
|
switch args[i] {
|
||||||
|
case "--password":
|
||||||
|
if i+1 >= len(args) {
|
||||||
|
return "", errors.New("usage: nixmsg admin set-password --password <password>")
|
||||||
|
}
|
||||||
|
password = args[i+1]
|
||||||
|
i++
|
||||||
|
default:
|
||||||
|
if strings.HasPrefix(args[i], "-") {
|
||||||
|
return "", fmt.Errorf("unknown flag: %s", args[i])
|
||||||
|
}
|
||||||
|
if password != "" {
|
||||||
|
return "", errors.New("usage: nixmsg admin set-password --password <password>")
|
||||||
|
}
|
||||||
|
password = args[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if password == "" {
|
||||||
|
b, err := io.ReadAll(io.LimitReader(stdin, 4096))
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
password = strings.TrimSpace(string(b))
|
||||||
|
}
|
||||||
|
if password == "" {
|
||||||
|
return "", errors.New("password required (pass --password or stdin)")
|
||||||
|
}
|
||||||
|
return password, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateAdminPassword(password string) error {
|
||||||
|
if len(password) < minAdminPasswordLen {
|
||||||
|
return fmt.Errorf("admin password must be at least %d characters", minAdminPasswordLen)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func generateAdminPassword(n int) (string, error) {
|
||||||
|
buf := make([]byte, n)
|
||||||
|
charset := []byte(adminPasswordChars)
|
||||||
|
for i := 0; i < n; {
|
||||||
|
var b [1]byte
|
||||||
|
if _, err := rand.Read(b[:]); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if int(b[0]) >= 256-(256%len(charset)) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
buf[i] = charset[int(b[0])%len(charset)]
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
return string(buf), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadAndValidateConfig() (config.Config, error) {
|
||||||
|
cfgPath := config.PathFromEnv()
|
||||||
|
cfg, err := config.Load(cfgPath)
|
||||||
|
if err != nil {
|
||||||
|
return config.Config{}, err
|
||||||
|
}
|
||||||
|
if err := cfg.Validate(); err != nil {
|
||||||
|
return config.Config{}, err
|
||||||
|
}
|
||||||
|
return cfg, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
func cmdBackup(args []string) error {
|
||||||
|
outPath, err := parseBackupArgs(args)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
cfg, err := loadAndValidateConfig()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if dir := filepath.Dir(outPath); dir != "" && dir != "." {
|
||||||
|
if mkErr := os.MkdirAll(dir, 0o755); mkErr != nil {
|
||||||
|
return fmt.Errorf("mkdir backup dir: %w", mkErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
absOut, err := filepath.Abs(outPath)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
// 对运行中的库:单独打开写连接执行 VACUUM INTO(可与 serve 并存,WAL 下安全)。
|
||||||
|
write, err := store.OpenWriter(cfg.DataDir, cfg.SQLiteSynchronous)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer func() { _ = write.Close() }()
|
||||||
|
if err := store.VacuumInto(ctx, write, filepath.ToSlash(absOut)); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
fmt.Fprintf(os.Stderr, "backup written to %s\n", absOut)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseBackupArgs(args []string) (string, error) {
|
||||||
|
var out string
|
||||||
|
for i := 0; i < len(args); i++ {
|
||||||
|
switch args[i] {
|
||||||
|
case "--out":
|
||||||
|
if i+1 >= len(args) {
|
||||||
|
return "", errors.New("usage: nixmsg backup --out <file.db>")
|
||||||
|
}
|
||||||
|
out = args[i+1]
|
||||||
|
i++
|
||||||
|
default:
|
||||||
|
return "", fmt.Errorf("unknown argument: %s", args[i])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if out == "" {
|
||||||
|
return "", errors.New("usage: nixmsg backup --out <file.db>")
|
||||||
|
}
|
||||||
|
return out, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func cmdCheckConfig(args []string) error {
|
||||||
|
path := config.PathFromEnv()
|
||||||
|
if len(args) > 0 {
|
||||||
|
path = args[0]
|
||||||
|
}
|
||||||
|
cfg, err := config.Load(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := cfg.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
fmt.Fprintln(os.Stderr, "config ok")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,153 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/store"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestCheckConfigRejectsLargeBody(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "bad.yaml")
|
||||||
|
body := "listen: \":0\"\ndata_dir: \"" + filepath.ToSlash(dir) + "\"\nlimits:\n max_body_bytes: 262145\n"
|
||||||
|
if err := os.WriteFile(path, []byte(body), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
t.Setenv("NIXMSG_CONFIG", path)
|
||||||
|
err := cmdCheckConfig(nil)
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "max_body_bytes") {
|
||||||
|
t.Fatalf("want max_body_bytes error, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCheckConfigOK(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := writeTestConfig(t, dir)
|
||||||
|
t.Setenv("NIXMSG_CONFIG", path)
|
||||||
|
if err := cmdCheckConfig(nil); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAdminInitOnceAndSetPassword(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := writeTestConfig(t, dir)
|
||||||
|
t.Setenv("NIXMSG_CONFIG", path)
|
||||||
|
|
||||||
|
var out bytes.Buffer
|
||||||
|
old := os.Stdout
|
||||||
|
r, w, err := os.Pipe()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
os.Stdout = w
|
||||||
|
errInit := cmdAdminInit(nil)
|
||||||
|
_ = w.Close()
|
||||||
|
os.Stdout = old
|
||||||
|
_, _ = out.ReadFrom(r)
|
||||||
|
_ = r.Close()
|
||||||
|
if errInit != nil {
|
||||||
|
t.Fatal(errInit)
|
||||||
|
}
|
||||||
|
text := out.String()
|
||||||
|
if !strings.Contains(text, "admin password:") {
|
||||||
|
t.Fatalf("password not printed: %q", text)
|
||||||
|
}
|
||||||
|
pass := strings.TrimSpace(strings.TrimPrefix(strings.TrimSpace(text), "admin password:"))
|
||||||
|
if len(pass) != 20 {
|
||||||
|
t.Fatalf("password len=%d value=%q", len(pass), pass)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err2 := cmdAdminInit(nil); err2 == nil || !strings.Contains(err2.Error(), "already initialized") {
|
||||||
|
t.Fatalf("want already initialized, got %v", err2)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err2 := cmdAdminSetPassword([]string{"--password", "short"}); err2 == nil {
|
||||||
|
t.Fatal("expected short password error")
|
||||||
|
}
|
||||||
|
if err2 := cmdAdminSetPassword([]string{"--password", "long-enough-password"}); err2 != nil {
|
||||||
|
t.Fatal(err2)
|
||||||
|
}
|
||||||
|
|
||||||
|
db, openErr := store.Open(dir, "FULL")
|
||||||
|
if openErr != nil {
|
||||||
|
t.Fatal(openErr)
|
||||||
|
}
|
||||||
|
defer func() { _ = db.Close() }()
|
||||||
|
ok, hasErr := store.HasAdminPassword(context.Background(), db.Write)
|
||||||
|
if hasErr != nil || !ok {
|
||||||
|
t.Fatalf("has admin: ok=%v err=%v", ok, hasErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBackupVacuumInto(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := writeTestConfig(t, dir)
|
||||||
|
t.Setenv("NIXMSG_CONFIG", path)
|
||||||
|
initAdminForTest(t, dir)
|
||||||
|
|
||||||
|
out := filepath.Join(dir, "backup", "copy.db")
|
||||||
|
if err := os.MkdirAll(filepath.Dir(out), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := cmdBackup([]string{"--out", out}); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
st, err := os.Stat(out)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if st.Size() == 0 {
|
||||||
|
t.Fatal("backup empty")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestHealthcheck(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
cfgPath := writeTestConfig(t, dir)
|
||||||
|
initAdminForTest(t, dir)
|
||||||
|
t.Setenv("NIXMSG_CONFIG", cfgPath)
|
||||||
|
|
||||||
|
cfg, err := loadAndValidateConfig()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
errCh := make(chan error, 1)
|
||||||
|
go func() { errCh <- runServe(ctx, cfg) }()
|
||||||
|
|
||||||
|
deadline := time.Now().Add(10 * time.Second)
|
||||||
|
for time.Now().Before(deadline) {
|
||||||
|
if b, readErr := os.ReadFile(filepath.Join(dir, "listen.addr")); readErr == nil && strings.TrimSpace(string(b)) != "" {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
time.Sleep(20 * time.Millisecond)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := cmdHealthcheck(nil); err != nil {
|
||||||
|
cancel()
|
||||||
|
<-errCh
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
cancel()
|
||||||
|
<-errCh
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestParseSetPasswordArgs(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
pass, err := parseSetPasswordArgs([]string{"--password", "abcdefghijkl"}, nil)
|
||||||
|
if err != nil || pass != "abcdefghijkl" {
|
||||||
|
t.Fatalf("pass=%q err=%v", pass, err)
|
||||||
|
}
|
||||||
|
pass, err = parseSetPasswordArgs([]string{"twelvechars!!"}, nil)
|
||||||
|
if err != nil || pass != "twelvechars!!" {
|
||||||
|
t.Fatalf("pass=%q err=%v", pass, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func cmdHealthcheck(_ []string) error {
|
||||||
|
cfg, err := loadAndValidateConfig()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
addrBytes, err := os.ReadFile(filepath.Join(cfg.DataDir, "listen.addr"))
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("read listen.addr: %w", err)
|
||||||
|
}
|
||||||
|
addr := strings.TrimSpace(string(addrBytes))
|
||||||
|
if addr == "" {
|
||||||
|
return fmt.Errorf("listen.addr is empty")
|
||||||
|
}
|
||||||
|
url := "http://" + addr + "/healthz"
|
||||||
|
client := &http.Client{Timeout: 5 * time.Second}
|
||||||
|
resp, err := client.Get(url)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer func() { _ = resp.Body.Close() }()
|
||||||
|
body, _ := io.ReadAll(io.LimitReader(resp.Body, 1024))
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
return fmt.Errorf("healthz status %d: %s", resp.StatusCode, strings.TrimSpace(string(body)))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
+16
-4
@@ -10,16 +10,28 @@ func main() {
|
|||||||
fmt.Fprintln(os.Stderr, "usage: nixmsg <command>")
|
fmt.Fprintln(os.Stderr, "usage: nixmsg <command>")
|
||||||
os.Exit(2)
|
os.Exit(2)
|
||||||
}
|
}
|
||||||
|
var err error
|
||||||
switch os.Args[1] {
|
switch os.Args[1] {
|
||||||
case "version":
|
case "version":
|
||||||
cmdVersion(os.Args[2:])
|
cmdVersion(os.Args[2:])
|
||||||
case "serve":
|
case "serve":
|
||||||
if err := cmdServe(os.Args[2:]); err != nil {
|
err = cmdServe(os.Args[2:])
|
||||||
fmt.Fprintln(os.Stderr, err)
|
// P-WIRE-BEGIN
|
||||||
os.Exit(1)
|
case "admin":
|
||||||
}
|
err = cmdAdmin(os.Args[2:])
|
||||||
|
case "backup":
|
||||||
|
err = cmdBackup(os.Args[2:])
|
||||||
|
case "check-config":
|
||||||
|
err = cmdCheckConfig(os.Args[2:])
|
||||||
|
case "healthcheck":
|
||||||
|
err = cmdHealthcheck(os.Args[2:])
|
||||||
|
// P-WIRE-END
|
||||||
default:
|
default:
|
||||||
fmt.Fprintf(os.Stderr, "unknown command: %s\n", os.Args[1])
|
fmt.Fprintf(os.Stderr, "unknown command: %s\n", os.Args[1])
|
||||||
os.Exit(2)
|
os.Exit(2)
|
||||||
}
|
}
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintln(os.Stderr, err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+55
-1
@@ -4,11 +4,13 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
"os/signal"
|
"os/signal"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
"syscall"
|
"syscall"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -23,6 +25,12 @@ func cmdServe(_ []string) error {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
// P-WIRE-BEGIN
|
||||||
|
if err := cfg.Validate(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
setupJSONLogger(cfg.Log)
|
||||||
|
// P-WIRE-END
|
||||||
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
|
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
|
||||||
defer stop()
|
defer stop()
|
||||||
return runServe(ctx, cfg)
|
return runServe(ctx, cfg)
|
||||||
@@ -41,6 +49,16 @@ func runServe(ctx context.Context, cfg config.Config) error {
|
|||||||
}
|
}
|
||||||
defer func() { _ = db.Close() }()
|
defer func() { _ = db.Close() }()
|
||||||
|
|
||||||
|
// P-WIRE-BEGIN
|
||||||
|
ok, err := store.HasAdminPassword(ctx, db.Write)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !ok {
|
||||||
|
return errors.New("admin password not initialized; run: nixmsg admin init")
|
||||||
|
}
|
||||||
|
// P-WIRE-END
|
||||||
|
|
||||||
// 启动恢复入口已挂上(假实现为空操作);M 线替换 message.Service 后生效。
|
// 启动恢复入口已挂上(假实现为空操作);M 线替换 message.Service 后生效。
|
||||||
if recoverErr := deps.Messages.RecoverOnStart(ctx); recoverErr != nil {
|
if recoverErr := deps.Messages.RecoverOnStart(ctx); recoverErr != nil {
|
||||||
return fmt.Errorf("message recover: %w", recoverErr)
|
return fmt.Errorf("message recover: %w", recoverErr)
|
||||||
@@ -62,6 +80,17 @@ func runServe(ctx context.Context, cfg config.Config) error {
|
|||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
_, _ = w.Write([]byte("ok"))
|
_, _ = w.Write([]byte("ok"))
|
||||||
})
|
})
|
||||||
|
// P-WIRE-BEGIN
|
||||||
|
mux.HandleFunc("GET /readyz", func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if readyErr := db.Ready(r.Context()); readyErr != nil {
|
||||||
|
slog.Error("readyz failed", "err", readyErr)
|
||||||
|
http.Error(w, "not ready", http.StatusServiceUnavailable)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
_, _ = w.Write([]byte("ok"))
|
||||||
|
})
|
||||||
|
// P-WIRE-END
|
||||||
// 确保前端资源被链接进二进制;完整静态托管由后续任务完善。
|
// 确保前端资源被链接进二进制;完整静态托管由后续任务完善。
|
||||||
_ = web.Dist()
|
_ = web.Dist()
|
||||||
|
|
||||||
@@ -87,9 +116,17 @@ func runServe(ctx context.Context, cfg config.Config) error {
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
shutdownCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
// P-WIRE-BEGIN
|
||||||
|
// 先停止接受新连接,再等写队列最多 10 秒,然后断开并退出。
|
||||||
|
shutdownCtx, cancel := context.WithTimeout(context.Background(), 15*time.Second)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
_ = srv.Shutdown(shutdownCtx)
|
_ = srv.Shutdown(shutdownCtx)
|
||||||
|
drainCtx, drainCancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer drainCancel()
|
||||||
|
if drainErr := db.Queue.Drain(drainCtx); drainErr != nil && !errors.Is(drainErr, context.DeadlineExceeded) {
|
||||||
|
slog.Error("write queue drain", "err", drainErr)
|
||||||
|
}
|
||||||
|
// P-WIRE-END
|
||||||
serveErr := <-errCh
|
serveErr := <-errCh
|
||||||
if serveErr != nil && !errors.Is(serveErr, http.ErrServerClosed) {
|
if serveErr != nil && !errors.Is(serveErr, http.ErrServerClosed) {
|
||||||
return serveErr
|
return serveErr
|
||||||
@@ -107,3 +144,20 @@ func writeListenAddr(dataDir, addr string) error {
|
|||||||
path := filepath.Join(dataDir, "listen.addr")
|
path := filepath.Join(dataDir, "listen.addr")
|
||||||
return os.WriteFile(path, []byte(addr+"\n"), 0o644)
|
return os.WriteFile(path, []byte(addr+"\n"), 0o644)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// P-WIRE-BEGIN
|
||||||
|
func setupJSONLogger(cfg config.LogConfig) {
|
||||||
|
level := slog.LevelInfo
|
||||||
|
switch strings.ToLower(strings.TrimSpace(cfg.Level)) {
|
||||||
|
case "debug":
|
||||||
|
level = slog.LevelDebug
|
||||||
|
case "warn", "warning":
|
||||||
|
level = slog.LevelWarn
|
||||||
|
case "error":
|
||||||
|
level = slog.LevelError
|
||||||
|
}
|
||||||
|
h := slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{Level: level})
|
||||||
|
slog.SetDefault(slog.New(h))
|
||||||
|
}
|
||||||
|
|
||||||
|
// P-WIRE-END
|
||||||
|
|||||||
@@ -10,23 +10,51 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/auth"
|
||||||
"git.asio.asia/nixevol/NixMsg/internal/config"
|
"git.asio.asia/nixevol/NixMsg/internal/config"
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/store"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
func writeTestConfig(t *testing.T, dataDir string) string {
|
||||||
|
t.Helper()
|
||||||
|
cfgPath := filepath.Join(dataDir, "config.yaml")
|
||||||
|
cfgYAML := []byte("listen: \"127.0.0.1:0\"\ndata_dir: \"" + filepath.ToSlash(dataDir) + "\"\nlog:\n level: error\n")
|
||||||
|
if err := os.WriteFile(cfgPath, cfgYAML, 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return cfgPath
|
||||||
|
}
|
||||||
|
|
||||||
|
func initAdminForTest(t *testing.T, dataDir string) {
|
||||||
|
t.Helper()
|
||||||
|
db, err := store.Open(dataDir, "FULL")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = db.Close() }()
|
||||||
|
phc, err := auth.HashPassword("test-admin-password-xx")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := store.SetAdminPasswordHash(context.Background(), db.Write, phc); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestServeHealthzAndListenAddr(t *testing.T) {
|
func TestServeHealthzAndListenAddr(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
dataDir := t.TempDir()
|
dataDir := t.TempDir()
|
||||||
cfgPath := filepath.Join(dataDir, "config.yaml")
|
cfgPath := writeTestConfig(t, dataDir)
|
||||||
cfgYAML := []byte("listen: \"127.0.0.1:0\"\ndata_dir: \"" + filepath.ToSlash(dataDir) + "\"\n")
|
initAdminForTest(t, dataDir)
|
||||||
if err := os.WriteFile(cfgPath, cfgYAML, 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cfg, err := config.Load(cfgPath)
|
cfg, err := config.Load(cfgPath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal(err)
|
t.Fatal(err)
|
||||||
}
|
}
|
||||||
|
if vErr := cfg.Validate(); vErr != nil {
|
||||||
|
t.Fatal(vErr)
|
||||||
|
}
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
defer cancel()
|
defer cancel()
|
||||||
@@ -37,7 +65,7 @@ func TestServeHealthzAndListenAddr(t *testing.T) {
|
|||||||
}()
|
}()
|
||||||
|
|
||||||
var addr string
|
var addr string
|
||||||
deadline := time.Now().Add(5 * time.Second)
|
deadline := time.Now().Add(10 * time.Second)
|
||||||
for time.Now().Before(deadline) {
|
for time.Now().Before(deadline) {
|
||||||
b, readErr := os.ReadFile(filepath.Join(dataDir, "listen.addr"))
|
b, readErr := os.ReadFile(filepath.Join(dataDir, "listen.addr"))
|
||||||
if readErr == nil {
|
if readErr == nil {
|
||||||
@@ -65,6 +93,15 @@ func TestServeHealthzAndListenAddr(t *testing.T) {
|
|||||||
t.Fatalf("unexpected body: %q", body)
|
t.Fatalf("unexpected body: %q", body)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
ready, err := http.Get("http://" + addr + "/readyz")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("readyz: %v", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = ready.Body.Close() }()
|
||||||
|
if ready.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("readyz status=%d", ready.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
if _, err := os.Stat(filepath.Join(dataDir, "nixmsg.db")); err != nil {
|
if _, err := os.Stat(filepath.Join(dataDir, "nixmsg.db")); err != nil {
|
||||||
t.Fatalf("db missing: %v", err)
|
t.Fatalf("db missing: %v", err)
|
||||||
}
|
}
|
||||||
@@ -75,7 +112,23 @@ func TestServeHealthzAndListenAddr(t *testing.T) {
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("serve exit: %v", err)
|
t.Fatalf("serve exit: %v", err)
|
||||||
}
|
}
|
||||||
case <-time.After(5 * time.Second):
|
case <-time.After(10 * time.Second):
|
||||||
t.Fatal("serve did not stop")
|
t.Fatal("serve did not stop")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestServeRejectsWithoutAdmin(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
dataDir := t.TempDir()
|
||||||
|
cfgPath := writeTestConfig(t, dataDir)
|
||||||
|
cfg, err := config.Load(cfgPath)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
err = runServe(ctx, cfg)
|
||||||
|
if err == nil || !strings.Contains(err.Error(), "admin password") {
|
||||||
|
t.Fatalf("want admin init error, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
+120
-2
@@ -152,11 +152,129 @@
|
|||||||
|
|
||||||
## 平台 P
|
## 平台 P
|
||||||
|
|
||||||
暂无。
|
### P1 2026-09-30
|
||||||
|
|
||||||
|
1. **admin set-password 传参方式**
|
||||||
|
- 原条款:DEVELOPMENT 11.2 仅列命令名,未规定密码如何传入。
|
||||||
|
- 实际做法:支持 `--password <pwd>`、位置参数,或从 stdin 读一行;最短 12 位。
|
||||||
|
- 原因:自动化测试与 Docker 非交互环境需要非交互传参。
|
||||||
|
- 备选方案:仅交互式 prompt。
|
||||||
|
- 影响:运维文档需写明推荐用 `--password` 或管道,勿把密码写进 shell 历史时可改用 stdin。
|
||||||
|
|
||||||
|
2. **admin init 密码字符集**
|
||||||
|
- 原条款:生成 20 位密码,未规定字符集。
|
||||||
|
- 实际做法:从去掉易混字符(0/O/1/I/l)的字母数字中均匀抽样 20 位。
|
||||||
|
- 原因:终端抄写友好。
|
||||||
|
- 备选方案:全 ASCII 可打印字符。
|
||||||
|
- 影响:熵略低于全字符集,对 20 位仍足够。
|
||||||
|
|
||||||
|
3. **PHC 哈希辅助先放在 auth,池在 P3**
|
||||||
|
- 原条款:argon2 并发池属 P3;admin init 需落库哈希属 P1。
|
||||||
|
- 实际做法:P1 在 `internal/auth` 提供 `HashPassword`/`VerifyPassword`(PHC),admin 命令直接调用;P3 再用同参数实现带并发上限的 `HashPool`。
|
||||||
|
- 原因:避免 P1 在 cmd 内复制算法,又不等到 P3 才做 init。
|
||||||
|
- 备选方案:P1 cmd 内联 argon2;或 P1/P3 合并提交。
|
||||||
|
- 影响:P3 合入后 admin 可改为走 HashPool(非必须,单次 init 无并发压力)。
|
||||||
|
|
||||||
|
4. **优雅停机顺序**
|
||||||
|
- 原条款:停接受 → 写队列最多 10 秒 → 断开连接退出。
|
||||||
|
- 实际做法:`http.Server.Shutdown`(先停接受并等待进行中的 HTTP)后,再 `Queue.Drain` 最多 10 秒;本期尚无长连接表,断开连接由 Shutdown 覆盖。
|
||||||
|
- 原因:当前 main 仅有 HTTP 健康检查;N 线接入后应在 Drain 前后显式踢连接。
|
||||||
|
- 备选方案:先关 listener、Drain、再 Shutdown。
|
||||||
|
- 影响:有 MQTT 长连接后需 N/P 联调停机路径。
|
||||||
|
|
||||||
|
### P2 2026-09-30
|
||||||
|
|
||||||
|
1. **合并写入队列替换 T0.3 简单实现**
|
||||||
|
- 原条款:DEVELOPMENT 7.2;TASKS P2。
|
||||||
|
- 实际做法:单写 goroutine;批次上限 256 或等待 2ms;每操作用 `SAVEPOINT`/`ROLLBACK TO`/`RELEASE`;Begin/Commit/SAVEPOINT 基础设施失败返回 `errors.Join(ErrBusy, err)` 并令 `IsReady()=false`;业务操作错误只回滚该 SAVEPOINT,不标 busy。
|
||||||
|
- 原因:满足每秒约 200 条写入的落盘合并需求。
|
||||||
|
- 备选方案:按固定时间窗无条件合并。
|
||||||
|
- 影响:调用方需用 `errors.Is(err, store.ErrBusy)` 映射协议 `busy`;`/readyz` 读 `DB.Ready`。
|
||||||
|
|
||||||
|
2. **调用方 context 取消与已入队任务**
|
||||||
|
- 原条款:未规定入队后取消。
|
||||||
|
- 实际做法:入队前检查 ctx;批次执行前再检查;若调用方在等待结果时取消,最多再等 30 秒取结果以免泄漏。
|
||||||
|
- 原因:写 goroutine 仍可能已执行该操作,不能静默丢结果。
|
||||||
|
- 备选方案:取消即从队列摘除(需可取消数据结构)。
|
||||||
|
- 影响:极端取消场景下调用方可能多等一会儿。
|
||||||
|
|
||||||
|
### P3 2026-09-30
|
||||||
|
|
||||||
|
1. **管理员/注册锁定阈值沿用登录 IP 档**
|
||||||
|
- 原条款:登录/对话密码阈值写清;管理员登录与注册安全码仅写「临时锁定」,未给数字。
|
||||||
|
- 实际做法:`LockAdminIP`、`LockRegisterIP`、`LockTalkPair`/`LockLoginEndpointIP` 均为 5 分钟窗口 10 次、锁 5 分钟;`LockTalkTarget`/`LockLoginEndpoint` 为 1 小时 50 次、锁 1 小时。
|
||||||
|
- 原因:与 PRD D18/F23「默认 5 分钟 10 次」叙述一致。
|
||||||
|
- 备选方案:管理员单独更严阈值。
|
||||||
|
- 影响:A/I/N 线直接用 `LoginLocks` 即可。
|
||||||
|
|
||||||
|
2. **真实 auth 实现未改 wire.go**
|
||||||
|
- 原条款:平台不改 `wire.go`;P3 实现接口。
|
||||||
|
- 实际做法:提供 `NewPool`/`NewSessionTokens`/`NewAPITokens`/`NewLoginLocks`;`wire()` 仍用 Stub,由总控或各线接线时替换。
|
||||||
|
- 原因:分工禁止改 wire.go。
|
||||||
|
- 备选方案:在 serve 旁路替换(会绕过 wire)。
|
||||||
|
- 影响:合入后需有一次接线才能在进程内用上真实哈希池。
|
||||||
|
|
||||||
|
3. **令牌随机部分用 RawURLEncoding**
|
||||||
|
- 原条款:32 字节随机数的 base64url。
|
||||||
|
- 实际做法:`encoding/base64.RawURLEncoding`(无 padding)。
|
||||||
|
- 原因:URL/Header 友好,与常见 token 惯例一致。
|
||||||
|
- 备选方案:StdEncoding 带 padding。
|
||||||
|
- 影响:SDK/文档示例需无 `=` 结尾。
|
||||||
|
|
||||||
|
### P4 2026-09-30
|
||||||
|
|
||||||
|
1. **指标包放在 `internal/metrics`**
|
||||||
|
- 原条款:TASKS 分工表未列 metrics 目录;P4 要求用 prometheus/client_golang 建注册表。
|
||||||
|
- 实际做法:新建 `internal/metrics`,提供 `New`/`Handler`/`Registry` 字段供各线打点;不在 `serve` 挂路由(访问规则属 A 线)。
|
||||||
|
- 原因:不宜塞进 auth/store/config。
|
||||||
|
- 备选方案:放 `internal/httpx`(A 线目录)。
|
||||||
|
- 影响:A/N 接线时 import 本包并挂 `/metrics`。
|
||||||
|
|
||||||
|
2. **指标命名**
|
||||||
|
- 原条款:列了指标含义,未规定 Prometheus 名字。
|
||||||
|
- 实际做法:`nixmsg_connections{transport}`、`nixmsg_endpoints`、`nixmsg_deliveries_pending`、`nixmsg_messages_scheduled`、`nixmsg_dispatch_to_push_duration_seconds`、`nixmsg_ack_duration_seconds`、`nixmsg_write_queue_length`、`nixmsg_write_batch_commit_duration_seconds`、`nixmsg_password_hash_queue_length`、`nixmsg_errors_total{code}`。
|
||||||
|
- 原因:固定可抓取文本便于联调。
|
||||||
|
- 备选方案:更短前缀或 HistogramVec。
|
||||||
|
- 影响:仪表盘按上述名字配置。
|
||||||
|
|
||||||
## 连接 N
|
## 连接 N
|
||||||
|
|
||||||
暂无。
|
### N1 / N2 2026-09-30
|
||||||
|
|
||||||
|
1. **未接线 `cmd/nixmsg`**
|
||||||
|
- 原条款:serve 最终应挂上端口识别、broker、`/mqtt`。
|
||||||
|
- 实际做法:本任务只交付 `internal/listener`、`internal/broker`;按总控要求不改 `cmd/nixmsg`。
|
||||||
|
- 原因:避免与平台/总控并行改 wire 冲突;合并时再接线。
|
||||||
|
- 备选方案:本分支顺带改 `wire.go`(与指令冲突)。
|
||||||
|
- 影响:当前 `serve` 仍是 T0.4 的简单 `/healthz` 监听,不含 MQTT。
|
||||||
|
|
||||||
|
2. **`listen.addr` / `admin.addr` 仅端口为 0 时写入**
|
||||||
|
- 原条款:DEVELOPMENT 4.1「端口写 0 时」写地址文件;T0.1 偏差曾改为 always write。
|
||||||
|
- 实际做法:`listener.Server` 仅当配置地址端口为 `0` 时写 `listen.addr` / `admin.addr`。
|
||||||
|
- 原因:本任务说明与 DEVELOPMENT 4.1 字面一致;T0.1 的 always write 在 `cmd/nixmsg`,本线未改。
|
||||||
|
- 备选方案:接线时统一为 always write 以兼容 harness。
|
||||||
|
- 影响:固定端口场景下 harness 若只读地址文件会读不到;接线时建议沿用 T0.1 超集或改 harness。
|
||||||
|
|
||||||
|
3. **登录校验为可替换接口,默认拒绝**
|
||||||
|
- 原条款:第 5 节完整会话令牌/密码/锁定属 N3。
|
||||||
|
- 实际做法:`broker.Authenticator` 接口 + 默认 `RejectAuthenticator`;内部错误在 `OnConnect` 返回 error;测试提供 `AllowAuthenticator`。
|
||||||
|
- 原因:N3 范围;N2 需可跑通装配与钩子。
|
||||||
|
- 备选方案:N2 内做假登录表(超出范围)。
|
||||||
|
- 影响:真实端连不上直到 N3;总控接线时注入 Authenticator。
|
||||||
|
|
||||||
|
4. **大帧并发名额释放策略**
|
||||||
|
- 原条款:DEVELOPMENT 7.5 大于 64KiB 全局同时不超过 64;PUBACK / 超时 / 断线释放。
|
||||||
|
- 实际做法:发布前申请名额;QoS 0 发布成功立即释放;QoS 1 在 `OnQosComplete` 且 payload>64KiB 时释放,断线 `releaseAllLarge`;未单独做「确认超时」计时释放(确认超时属 M 线推送循环)。
|
||||||
|
- 原因:N2 无投递确认计时器;与 M 线推送超时释放衔接。
|
||||||
|
- 备选方案:broker 内对大帧自建超时(与 M 重复)。
|
||||||
|
- 影响:若客户端永不 PUBACK 且不断线,名额可能占满直到断开;M 线超时踢线或回调 Disconnect 可释放。
|
||||||
|
|
||||||
|
5. **`OnPublishDropped` 仅打日志**
|
||||||
|
- 原条款:清「已推送」标记并 1 秒后重推。
|
||||||
|
- 实际做法:钩子记录 debug 日志;清标记/重推留给消息 M。
|
||||||
|
- 原因:投递状态在 M/store,N2 无投递表。
|
||||||
|
- 备选方案:N2 暴露回调给 M 注册。
|
||||||
|
- 影响:接线后 M 需订阅或包装该钩子;当前接口可后续加 `OnPublishDropped` 回调字段。
|
||||||
|
|
||||||
## 消息 M
|
## 消息 M
|
||||||
|
|
||||||
|
|||||||
@@ -3,17 +3,30 @@ module git.asio.asia/nixevol/NixMsg
|
|||||||
go 1.27
|
go 1.27
|
||||||
|
|
||||||
require (
|
require (
|
||||||
|
github.com/coder/websocket v1.8.14
|
||||||
|
github.com/mochi-mqtt/server/v2 v2.7.9
|
||||||
|
github.com/prometheus/client_golang v1.24.1
|
||||||
go.yaml.in/yaml/v3 v3.0.5
|
go.yaml.in/yaml/v3 v3.0.5
|
||||||
|
golang.org/x/crypto v0.57.0
|
||||||
modernc.org/sqlite v1.60.1
|
modernc.org/sqlite v1.60.1
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
|
github.com/beorn7/perks v1.0.1 // indirect
|
||||||
|
github.com/cespare/xxhash/v2 v2.3.0 // indirect
|
||||||
github.com/dustin/go-humanize v1.0.1 // indirect
|
github.com/dustin/go-humanize v1.0.1 // indirect
|
||||||
github.com/google/uuid v1.6.0 // indirect
|
github.com/google/uuid v1.6.0 // indirect
|
||||||
|
github.com/gorilla/websocket v1.5.0 // indirect
|
||||||
github.com/mattn/go-isatty v0.0.24 // indirect
|
github.com/mattn/go-isatty v0.0.24 // indirect
|
||||||
|
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
|
||||||
github.com/ncruces/go-strftime v1.0.0 // indirect
|
github.com/ncruces/go-strftime v1.0.0 // indirect
|
||||||
|
github.com/prometheus/client_model v0.6.2 // indirect
|
||||||
|
github.com/prometheus/common v0.70.1 // indirect
|
||||||
|
github.com/prometheus/procfs v0.21.1 // indirect
|
||||||
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
|
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
|
||||||
|
github.com/rs/xid v1.4.0 // indirect
|
||||||
golang.org/x/sys v0.48.0 // indirect
|
golang.org/x/sys v0.48.0 // indirect
|
||||||
|
google.golang.org/protobuf v1.36.11 // indirect
|
||||||
modernc.org/libc v1.77.1 // indirect
|
modernc.org/libc v1.77.1 // indirect
|
||||||
modernc.org/mathutil v1.7.1 // indirect
|
modernc.org/mathutil v1.7.1 // indirect
|
||||||
modernc.org/memory v1.12.1 // indirect
|
modernc.org/memory v1.12.1 // indirect
|
||||||
|
|||||||
@@ -1,19 +1,61 @@
|
|||||||
|
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
|
||||||
|
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
|
||||||
|
github.com/cespare/xxhash/v2 v2.3.0 h1:UL815xU9SqsFlibzuggzjXhog7bL6oX9BbNZnL2UFvs=
|
||||||
|
github.com/cespare/xxhash/v2 v2.3.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
|
||||||
|
github.com/coder/websocket v1.8.14 h1:9L0p0iKiNOibykf283eHkKUHHrpG7f65OE3BhhO7v9g=
|
||||||
|
github.com/coder/websocket v1.8.14/go.mod h1:NX3SzP+inril6yawo5CQXx8+fk145lPDC6pumgx0mVg=
|
||||||
|
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||||
|
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||||
github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
|
github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY=
|
||||||
github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
|
github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto=
|
||||||
|
github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
|
||||||
|
github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
|
||||||
github.com/google/pprof v0.0.0-20260802141513-ef3492d7dac3 h1:LMLX+LgTNWpfvCBdFebv6EsYotImrt/Ppc5cXIriCSo=
|
github.com/google/pprof v0.0.0-20260802141513-ef3492d7dac3 h1:LMLX+LgTNWpfvCBdFebv6EsYotImrt/Ppc5cXIriCSo=
|
||||||
github.com/google/pprof v0.0.0-20260802141513-ef3492d7dac3/go.mod h1:jl5iWTm0/hd5PjEYEOuwAJ57L/CibdZfrqZ5XA5GrCk=
|
github.com/google/pprof v0.0.0-20260802141513-ef3492d7dac3/go.mod h1:jl5iWTm0/hd5PjEYEOuwAJ57L/CibdZfrqZ5XA5GrCk=
|
||||||
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||||
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||||
|
github.com/gorilla/websocket v1.5.0 h1:PPwGk2jz7EePpoHN/+ClbZu8SPxiqlu12wZP/3sWmnc=
|
||||||
|
github.com/gorilla/websocket v1.5.0/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE=
|
||||||
github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=
|
github.com/hashicorp/golang-lru/v2 v2.0.7 h1:a+bsQ5rvGLjzHuww6tVxozPZFVghXaHOwFs4luLUK2k=
|
||||||
github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=
|
github.com/hashicorp/golang-lru/v2 v2.0.7/go.mod h1:QeFd9opnmA6QUJc5vARoKUSoFhyfM2/ZepoAG6RGpeM=
|
||||||
|
github.com/jinzhu/copier v0.3.5 h1:GlvfUwHk62RokgqVNvYsku0TATCF7bAHVwEXoBh3iJg=
|
||||||
|
github.com/jinzhu/copier v0.3.5/go.mod h1:DfbEm0FYsaqBcKcFuvmOZb218JkPGtvSHsKg8S8hyyg=
|
||||||
|
github.com/klauspost/compress v1.19.1 h1:VsB4HPswih7mmZ8WleSFQ75c/Ui1M4trX5oAsJnhSlk=
|
||||||
|
github.com/klauspost/compress v1.19.1/go.mod h1:cwPg85FWrGar70rWktvGQj8/hthj3wpl0PGDogxkrSQ=
|
||||||
|
github.com/kylelemons/godebug v1.1.0 h1:RPNrshWIDI6G2gRW9EHilWtl7Z6Sb1BR0xunSBf0SNc=
|
||||||
|
github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw=
|
||||||
github.com/mattn/go-isatty v0.0.24 h1:tGZZoVgT/KiqK1c8ocVLeDS8BSWMRd47J3Lbz7vsReI=
|
github.com/mattn/go-isatty v0.0.24 h1:tGZZoVgT/KiqK1c8ocVLeDS8BSWMRd47J3Lbz7vsReI=
|
||||||
github.com/mattn/go-isatty v0.0.24/go.mod h1:nMCL3Zebbrt45jsMDgnfIwz6ydEQApk5oEI3HqDio6A=
|
github.com/mattn/go-isatty v0.0.24/go.mod h1:nMCL3Zebbrt45jsMDgnfIwz6ydEQApk5oEI3HqDio6A=
|
||||||
|
github.com/mochi-mqtt/server/v2 v2.7.9 h1:y0g4vrSLAag7T07l2oCzOa/+nKVLoazKEWAArwqBNYI=
|
||||||
|
github.com/mochi-mqtt/server/v2 v2.7.9/go.mod h1:lZD3j35AVNqJL5cezlnSkuG05c0FCHSsfAKSPBOSbqc=
|
||||||
|
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
|
||||||
|
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
|
||||||
github.com/ncruces/go-strftime v1.0.0 h1:HMFp8mLCTPp341M/ZnA4qaf7ZlsbTc+miZjCLOFAw7w=
|
github.com/ncruces/go-strftime v1.0.0 h1:HMFp8mLCTPp341M/ZnA4qaf7ZlsbTc+miZjCLOFAw7w=
|
||||||
github.com/ncruces/go-strftime v1.0.0/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
|
github.com/ncruces/go-strftime v1.0.0/go.mod h1:Fwc5htZGVVkseilnfgOVb9mKy6w1naJmn9CehxcKcls=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||||
|
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||||
|
github.com/prometheus/client_golang v1.24.1 h1:JnJkREXzWxUdCuPFpIWZiPispT9xVV59uiuyR2bPlnU=
|
||||||
|
github.com/prometheus/client_golang v1.24.1/go.mod h1:F+oSRECHg4sse5ucfYpYDeIv/hu68Zo0uoHKetWnzcE=
|
||||||
|
github.com/prometheus/client_model v0.6.2 h1:oBsgwpGs7iVziMvrGhE53c/GrLUsZdHnqNwqPLxwZyk=
|
||||||
|
github.com/prometheus/client_model v0.6.2/go.mod h1:y3m2F6Gdpfy6Ut/GBsUqTWZqCUvMVzSfMLjcu6wAwpE=
|
||||||
|
github.com/prometheus/common v0.70.1 h1:1HvjP4D5oL3t8RsPlwxA9onvvStjtIHYE5XuuwOi/PY=
|
||||||
|
github.com/prometheus/common v0.70.1/go.mod h1:VdFUQDMZK3VLkurFUVhia6uys/0suUp86TJz5qbJRhc=
|
||||||
|
github.com/prometheus/procfs v0.21.1 h1:GljZCt+zSTS+NZq88cyQ1LjZ+RCHp3uVuabBWA5+OJI=
|
||||||
|
github.com/prometheus/procfs v0.21.1/go.mod h1:aB55Cww9pdSJVHk0hUf0inxWyyjPogFIjmHKYgMKmtY=
|
||||||
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE=
|
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94icq4NjY3clb7Lk8O1qJ8BdBEF8z0ibU0rE=
|
||||||
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
|
github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
|
||||||
|
github.com/rs/xid v1.4.0 h1:qd7wPTDkN6KQx2VmMBLrpHkiyQwgFXRnkOLacUiaSNY=
|
||||||
|
github.com/rs/xid v1.4.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg=
|
||||||
|
github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U=
|
||||||
|
github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U=
|
||||||
|
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
|
||||||
|
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
|
||||||
|
go.yaml.in/yaml/v2 v2.4.4 h1:tuyd0P+2Ont/d6e2rl3be67goVK4R6deVxCUX5vyPaQ=
|
||||||
|
go.yaml.in/yaml/v2 v2.4.4/go.mod h1:gMZqIpDtDqOfM0uNfy0SkpRhvUryYH0Z6wdMYcacYXQ=
|
||||||
go.yaml.in/yaml/v3 v3.0.5 h1:N6y/pJk8buWs9NY5ERU2HSMfm+IuD/OtfdAnq6kESPw=
|
go.yaml.in/yaml/v3 v3.0.5 h1:N6y/pJk8buWs9NY5ERU2HSMfm+IuD/OtfdAnq6kESPw=
|
||||||
go.yaml.in/yaml/v3 v3.0.5/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg=
|
go.yaml.in/yaml/v3 v3.0.5/go.mod h1:HVTZu1O7/Vkt2N+BFy8Zza+lnLsABggaTM2ZpNIGuKg=
|
||||||
|
golang.org/x/crypto v0.57.0 h1:3ZVCjf8Ggz7zneR/EHRVx68Ctf+2pmIMP2UFhh9cC6M=
|
||||||
|
golang.org/x/crypto v0.57.0/go.mod h1:Fdz0i5U6CoizGwLda9DttjSk6qlZo25zYNtR+ycvuZA=
|
||||||
golang.org/x/mod v0.41.0 h1:qJmnOUb4YB+FsEuM3HcWucdZASCPGhsX6uljO6pog0c=
|
golang.org/x/mod v0.41.0 h1:qJmnOUb4YB+FsEuM3HcWucdZASCPGhsX6uljO6pog0c=
|
||||||
golang.org/x/mod v0.41.0/go.mod h1:Ek9pY8RKWXwsWvd3rQiHYtMqkjSUV+s1Rj7j4H5Ur6o=
|
golang.org/x/mod v0.41.0/go.mod h1:Ek9pY8RKWXwsWvd3rQiHYtMqkjSUV+s1Rj7j4H5Ur6o=
|
||||||
golang.org/x/sync v0.23.0 h1:KameEIfc1IkluZyXWLn39Wd4tURc6GbCiISGiZm2bQk=
|
golang.org/x/sync v0.23.0 h1:KameEIfc1IkluZyXWLn39Wd4tURc6GbCiISGiZm2bQk=
|
||||||
@@ -22,6 +64,10 @@ golang.org/x/sys v0.48.0 h1:bbX/i/6MgT9BVLM9RT1thmxL04yeTAhbEz4SyadbXoo=
|
|||||||
golang.org/x/sys v0.48.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
|
golang.org/x/sys v0.48.0/go.mod h1:hNLxWAXmnKAxqDtdwIYC4bM9oQPEecfsnNMuSxOs3og=
|
||||||
golang.org/x/tools v0.50.0 h1:c2ifzfcuY7L90lZ2aKd8S4K2NpASF08SZx9ZuJkHmSU=
|
golang.org/x/tools v0.50.0 h1:c2ifzfcuY7L90lZ2aKd8S4K2NpASF08SZx9ZuJkHmSU=
|
||||||
golang.org/x/tools v0.50.0/go.mod h1:7ulVMw3831Mwi5EZD6RomGyffr4VFjuNYXf2BbCEAV0=
|
golang.org/x/tools v0.50.0/go.mod h1:7ulVMw3831Mwi5EZD6RomGyffr4VFjuNYXf2BbCEAV0=
|
||||||
|
google.golang.org/protobuf v1.36.11 h1:fV6ZwhNocDyBLK0dj+fg8ektcVegBBuEolpbTQyBNVE=
|
||||||
|
google.golang.org/protobuf v1.36.11/go.mod h1:HTf+CrKn2C3g5S8VImy6tdcUvCska2kB7j23XfzDpco=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
|
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
modernc.org/cc/v4 v4.29.7 h1:q+NXGJ0bK3b4TXFYQQVr9pYETGnmwFWkrUzJnMya/Tg=
|
modernc.org/cc/v4 v4.29.7 h1:q+NXGJ0bK3b4TXFYQQVr9pYETGnmwFWkrUzJnMya/Tg=
|
||||||
modernc.org/cc/v4 v4.29.7/go.mod h1:OnovgIhbbMXMu1aISnJ0wvVD1KnW+cAUJkIrAWh+kVI=
|
modernc.org/cc/v4 v4.29.7/go.mod h1:OnovgIhbbMXMu1aISnJ0wvVD1KnW+cAUJkIrAWh+kVI=
|
||||||
modernc.org/ccgo/v4 v4.36.1 h1:ZNIUZAryN0UgnJwtyxrdEzcFc3yD4Cu4AzjfPXsLsIE=
|
modernc.org/ccgo/v4 v4.36.1 h1:ZNIUZAryN0UgnJwtyxrdEzcFc3yD4Cu4AzjfPXsLsIE=
|
||||||
|
|||||||
@@ -0,0 +1,140 @@
|
|||||||
|
package auth
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestPoolLimitsConcurrency(t *testing.T) {
|
||||||
|
pool := NewPoolSize(1)
|
||||||
|
errCh := make(chan error, 3)
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(3)
|
||||||
|
for i := 0; i < 3; i++ {
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
_, err := pool.Hash(context.Background(), PasswordLogin, "concurrency-test-password")
|
||||||
|
errCh <- err
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
close(errCh)
|
||||||
|
for err := range errCh {
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if pool.MaxActive() > 1 {
|
||||||
|
t.Fatalf("max active=%d want <=1", pool.MaxActive())
|
||||||
|
}
|
||||||
|
if pool.MaxActive() < 1 {
|
||||||
|
t.Fatal("expected at least one active hash")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPoolHashVerifyRoundTrip(t *testing.T) {
|
||||||
|
pool := NewPoolSize(2)
|
||||||
|
ctx := context.Background()
|
||||||
|
phc, err := pool.Hash(ctx, PasswordAdmin, "round-trip-password-1")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(phc, "$argon2id$") {
|
||||||
|
t.Fatalf("phc=%q", phc)
|
||||||
|
}
|
||||||
|
ok, err := pool.Verify(ctx, PasswordAdmin, "round-trip-password-1", phc)
|
||||||
|
if err != nil || !ok {
|
||||||
|
t.Fatalf("ok=%v err=%v", ok, err)
|
||||||
|
}
|
||||||
|
ok, err = pool.Verify(ctx, PasswordAdmin, "wrong-password-xxxxx", phc)
|
||||||
|
if err != nil || ok {
|
||||||
|
t.Fatalf("mismatch ok=%v err=%v", ok, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSessionAndAPITokens(t *testing.T) {
|
||||||
|
s := NewSessionTokens()
|
||||||
|
tok, hash, err := s.Issue(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(tok, "nst_") {
|
||||||
|
t.Fatalf("tok=%q", tok)
|
||||||
|
}
|
||||||
|
if !s.LooksLikeSessionToken(tok) {
|
||||||
|
t.Fatal("LooksLikeSessionToken")
|
||||||
|
}
|
||||||
|
if !EqualHash(hash, s.HashToken(tok)) {
|
||||||
|
t.Fatal("hash mismatch")
|
||||||
|
}
|
||||||
|
|
||||||
|
a := NewAPITokens()
|
||||||
|
atok, ahash, err := a.Issue(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.HasPrefix(atok, "nxm_") {
|
||||||
|
t.Fatalf("atok=%q", atok)
|
||||||
|
}
|
||||||
|
if !a.LooksLikeAPIToken(atok) || !EqualHash(ahash, a.HashToken(atok)) {
|
||||||
|
t.Fatal("api token hash")
|
||||||
|
}
|
||||||
|
if EqualHash(hash, ahash) {
|
||||||
|
t.Fatal("session and api hashes should differ")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoginLocksWindowAndExpiry(t *testing.T) {
|
||||||
|
locks := NewLoginLocks()
|
||||||
|
now := time.Date(2026, 9, 30, 12, 0, 0, 0, time.UTC)
|
||||||
|
locks.SetClock(func() time.Time { return now })
|
||||||
|
|
||||||
|
key := LockKey{Kind: LockLoginEndpointIP, EndpointID: "e1", IP: "1.2.3.4"}
|
||||||
|
for i := 0; i < 9; i++ {
|
||||||
|
locked, _ := locks.Fail(key)
|
||||||
|
if locked {
|
||||||
|
t.Fatalf("locked early at %d", i+1)
|
||||||
|
}
|
||||||
|
now = now.Add(time.Second)
|
||||||
|
}
|
||||||
|
locked, retry := locks.Fail(key)
|
||||||
|
if !locked || retry <= 0 {
|
||||||
|
t.Fatalf("want lock, locked=%v retry=%v", locked, retry)
|
||||||
|
}
|
||||||
|
locked, _ = locks.Check(key)
|
||||||
|
if !locked {
|
||||||
|
t.Fatal("check should be locked")
|
||||||
|
}
|
||||||
|
|
||||||
|
now = now.Add(5*time.Minute + time.Second)
|
||||||
|
locked, _ = locks.Check(key)
|
||||||
|
if locked {
|
||||||
|
t.Fatal("should unlock after window")
|
||||||
|
}
|
||||||
|
locked, _ = locks.Fail(key)
|
||||||
|
if locked {
|
||||||
|
t.Fatal("after expiry should not still be locked on first fail")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoginLocksClearEndpoint(t *testing.T) {
|
||||||
|
locks := NewLoginLocks()
|
||||||
|
k1 := LockKey{Kind: LockLoginEndpointIP, EndpointID: "e1", IP: "1.1.1.1"}
|
||||||
|
k2 := LockKey{Kind: LockLoginEndpoint, EndpointID: "e1"}
|
||||||
|
k3 := LockKey{Kind: LockLoginEndpointIP, EndpointID: "e2", IP: "1.1.1.1"}
|
||||||
|
for i := 0; i < 10; i++ {
|
||||||
|
locks.Fail(k1)
|
||||||
|
locks.Fail(k2)
|
||||||
|
}
|
||||||
|
locks.Fail(k3)
|
||||||
|
locks.ClearEndpoint("e1")
|
||||||
|
if locked, _ := locks.Check(k1); locked {
|
||||||
|
t.Fatal("e1 ip lock should clear")
|
||||||
|
}
|
||||||
|
if locked, _ := locks.Check(k2); locked {
|
||||||
|
t.Fatal("e1 total lock should clear")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,155 @@
|
|||||||
|
package auth
|
||||||
|
|
||||||
|
import (
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type lockPolicy struct {
|
||||||
|
window time.Duration
|
||||||
|
maxFails int
|
||||||
|
lockFor time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
func policyFor(kind LockKind) lockPolicy {
|
||||||
|
switch kind {
|
||||||
|
case LockLoginEndpoint, LockTalkTarget:
|
||||||
|
return lockPolicy{window: time.Hour, maxFails: 50, lockFor: time.Hour}
|
||||||
|
default:
|
||||||
|
// LockLoginEndpointIP、LockTalkPair、LockAdminIP、LockRegisterIP
|
||||||
|
return lockPolicy{window: 5 * time.Minute, maxFails: 10, lockFor: 5 * time.Minute}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type lockEntry struct {
|
||||||
|
fails []time.Time
|
||||||
|
lockedUntil time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// MemoryLocks 是内存锁定计数器(重启清零)。
|
||||||
|
type MemoryLocks struct {
|
||||||
|
mu sync.Mutex
|
||||||
|
entries map[string]*lockEntry
|
||||||
|
now func() time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewLoginLocks 创建默认锁定计数器。
|
||||||
|
func NewLoginLocks() *MemoryLocks {
|
||||||
|
return &MemoryLocks{
|
||||||
|
entries: make(map[string]*lockEntry),
|
||||||
|
now: time.Now,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetClock 注入时钟(测试到期解除)。
|
||||||
|
func (l *MemoryLocks) SetClock(now func() time.Time) {
|
||||||
|
l.mu.Lock()
|
||||||
|
defer l.mu.Unlock()
|
||||||
|
if now == nil {
|
||||||
|
l.now = time.Now
|
||||||
|
return
|
||||||
|
}
|
||||||
|
l.now = now
|
||||||
|
}
|
||||||
|
|
||||||
|
func lockMapKey(key LockKey) string {
|
||||||
|
return string(key.Kind) + "|" + key.EndpointID + "|" + key.PeerID + "|" + key.IP
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check 若当前已锁定返回 locked=true 与剩余时间。
|
||||||
|
func (l *MemoryLocks) Check(key LockKey) (bool, time.Duration) {
|
||||||
|
l.mu.Lock()
|
||||||
|
defer l.mu.Unlock()
|
||||||
|
now := l.now()
|
||||||
|
e := l.entries[lockMapKey(key)]
|
||||||
|
if e == nil {
|
||||||
|
return false, 0
|
||||||
|
}
|
||||||
|
if e.lockedUntil.After(now) {
|
||||||
|
return true, e.lockedUntil.Sub(now)
|
||||||
|
}
|
||||||
|
// 到期自动解除:清空锁定与窗口内失败(保留结构以便后续 Fail)。
|
||||||
|
if !e.lockedUntil.IsZero() && !e.lockedUntil.After(now) {
|
||||||
|
e.lockedUntil = time.Time{}
|
||||||
|
e.fails = nil
|
||||||
|
}
|
||||||
|
return false, 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fail 记录一次失败;若因此触发锁定,返回 locked=true。
|
||||||
|
func (l *MemoryLocks) Fail(key LockKey) (bool, time.Duration) {
|
||||||
|
l.mu.Lock()
|
||||||
|
defer l.mu.Unlock()
|
||||||
|
now := l.now()
|
||||||
|
k := lockMapKey(key)
|
||||||
|
e := l.entries[k]
|
||||||
|
if e == nil {
|
||||||
|
e = &lockEntry{}
|
||||||
|
l.entries[k] = e
|
||||||
|
}
|
||||||
|
if e.lockedUntil.After(now) {
|
||||||
|
return true, e.lockedUntil.Sub(now)
|
||||||
|
}
|
||||||
|
if !e.lockedUntil.IsZero() {
|
||||||
|
e.lockedUntil = time.Time{}
|
||||||
|
e.fails = nil
|
||||||
|
}
|
||||||
|
pol := policyFor(key.Kind)
|
||||||
|
cutoff := now.Add(-pol.window)
|
||||||
|
kept := e.fails[:0]
|
||||||
|
for _, t := range e.fails {
|
||||||
|
if t.After(cutoff) {
|
||||||
|
kept = append(kept, t)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
e.fails = append(kept, now)
|
||||||
|
if len(e.fails) >= pol.maxFails {
|
||||||
|
e.lockedUntil = now.Add(pol.lockFor)
|
||||||
|
e.fails = nil
|
||||||
|
return true, pol.lockFor
|
||||||
|
}
|
||||||
|
return false, 0
|
||||||
|
}
|
||||||
|
|
||||||
|
// ClearEndpoint 清除某端编号相关的登录锁定(两种都清)。
|
||||||
|
func (l *MemoryLocks) ClearEndpoint(endpointID string) {
|
||||||
|
l.mu.Lock()
|
||||||
|
defer l.mu.Unlock()
|
||||||
|
for k, e := range l.entries {
|
||||||
|
// kind|endpoint|peer|ip
|
||||||
|
parts := splitLockKey(k)
|
||||||
|
if len(parts) != 4 {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
kind, ep := LockKind(parts[0]), parts[1]
|
||||||
|
if ep != endpointID {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if kind == LockLoginEndpointIP || kind == LockLoginEndpoint {
|
||||||
|
delete(l.entries, k)
|
||||||
|
_ = e
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Clear 清除精确键。
|
||||||
|
func (l *MemoryLocks) Clear(key LockKey) {
|
||||||
|
l.mu.Lock()
|
||||||
|
defer l.mu.Unlock()
|
||||||
|
delete(l.entries, lockMapKey(key))
|
||||||
|
}
|
||||||
|
|
||||||
|
func splitLockKey(k string) []string {
|
||||||
|
out := make([]string, 0, 4)
|
||||||
|
start := 0
|
||||||
|
for i := 0; i < len(k); i++ {
|
||||||
|
if k[i] == '|' {
|
||||||
|
out = append(out, k[start:i])
|
||||||
|
start = i + 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out = append(out, k[start:])
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ LoginLocks = (*MemoryLocks)(nil)
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
package auth
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/subtle"
|
||||||
|
"encoding/base64"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"golang.org/x/crypto/argon2"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Argon2 参数(DEVELOPMENT 第 12 节 / OWASP 最低配置)。
|
||||||
|
const (
|
||||||
|
ArgonMemoryKiB = 19 * 1024 // 19 MiB
|
||||||
|
ArgonTime = 2
|
||||||
|
ArgonThreads = 1
|
||||||
|
ArgonKeyLen = 32
|
||||||
|
ArgonSaltLen = 16
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrInvalidPHC 表示 PHC 字符串无法解析或参数不支持。
|
||||||
|
var ErrInvalidPHC = errors.New("auth: invalid phc")
|
||||||
|
|
||||||
|
// HashPassword 用 argon2id 生成 PHC 字符串(不含并发池;池见 HashPool)。
|
||||||
|
func HashPassword(password string) (string, error) {
|
||||||
|
salt := make([]byte, ArgonSaltLen)
|
||||||
|
if _, err := rand.Read(salt); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
hash := argon2.IDKey([]byte(password), salt, ArgonTime, ArgonMemoryKiB, ArgonThreads, ArgonKeyLen)
|
||||||
|
return encodePHC(salt, hash), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// VerifyPassword 常量时间比较密码与 PHC;不匹配时 ok=false 且 err=nil。
|
||||||
|
func VerifyPassword(password, phc string) (bool, error) {
|
||||||
|
salt, hash, err := decodePHC(phc)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
got := argon2.IDKey([]byte(password), salt, ArgonTime, ArgonMemoryKiB, ArgonThreads, ArgonKeyLen)
|
||||||
|
if subtle.ConstantTimeCompare(got, hash) == 1 {
|
||||||
|
return true, nil
|
||||||
|
}
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func encodePHC(salt, hash []byte) string {
|
||||||
|
return fmt.Sprintf(
|
||||||
|
"$argon2id$v=%d$m=%d,t=%d,p=%d$%s$%s",
|
||||||
|
argon2.Version,
|
||||||
|
ArgonMemoryKiB,
|
||||||
|
ArgonTime,
|
||||||
|
ArgonThreads,
|
||||||
|
base64.RawStdEncoding.EncodeToString(salt),
|
||||||
|
base64.RawStdEncoding.EncodeToString(hash),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
func decodePHC(phc string) (salt, hash []byte, err error) {
|
||||||
|
// $argon2id$v=19$m=19456,t=2,p=1$salt$hash
|
||||||
|
parts := strings.Split(phc, "$")
|
||||||
|
if len(parts) != 6 || parts[1] != "argon2id" {
|
||||||
|
return nil, nil, ErrInvalidPHC
|
||||||
|
}
|
||||||
|
var version int
|
||||||
|
if _, scanErr := fmt.Sscanf(parts[2], "v=%d", &version); scanErr != nil || version != argon2.Version {
|
||||||
|
return nil, nil, ErrInvalidPHC
|
||||||
|
}
|
||||||
|
var m, t, p int
|
||||||
|
if _, scanErr := fmt.Sscanf(parts[3], "m=%d,t=%d,p=%d", &m, &t, &p); scanErr != nil {
|
||||||
|
return nil, nil, ErrInvalidPHC
|
||||||
|
}
|
||||||
|
if m != ArgonMemoryKiB || t != ArgonTime || p != ArgonThreads {
|
||||||
|
return nil, nil, ErrInvalidPHC
|
||||||
|
}
|
||||||
|
salt, err = base64.RawStdEncoding.DecodeString(parts[4])
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, ErrInvalidPHC
|
||||||
|
}
|
||||||
|
hash, err = base64.RawStdEncoding.DecodeString(parts[5])
|
||||||
|
if err != nil {
|
||||||
|
return nil, nil, ErrInvalidPHC
|
||||||
|
}
|
||||||
|
if len(salt) == 0 || len(hash) == 0 {
|
||||||
|
return nil, nil, ErrInvalidPHC
|
||||||
|
}
|
||||||
|
return salt, hash, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
package auth
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"runtime"
|
||||||
|
"sync/atomic"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Pool 是 argon2id 并发池(DEVELOPMENT 第 12 节)。
|
||||||
|
type Pool struct {
|
||||||
|
sem chan struct{}
|
||||||
|
waiting atomic.Int64
|
||||||
|
active atomic.Int64
|
||||||
|
maxSeen atomic.Int64 // 测试用:观察到的最大并发
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewPool 创建大小为 CPU 核数的哈希池。
|
||||||
|
func NewPool() *Pool {
|
||||||
|
return NewPoolSize(runtime.NumCPU())
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewPoolSize 创建指定并发上限的哈希池(测试可传入 1)。
|
||||||
|
func NewPoolSize(n int) *Pool {
|
||||||
|
if n < 1 {
|
||||||
|
n = 1
|
||||||
|
}
|
||||||
|
return &Pool{sem: make(chan struct{}, n)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Hash 在池内计算 PHC 格式哈希。
|
||||||
|
func (p *Pool) Hash(ctx context.Context, _ PasswordKind, password string) (string, error) {
|
||||||
|
if err := p.acquire(ctx); err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
defer p.release()
|
||||||
|
return HashPassword(password)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify 在池内校验;常量时间比较。
|
||||||
|
func (p *Pool) Verify(ctx context.Context, _ PasswordKind, password, phc string) (bool, error) {
|
||||||
|
if err := p.acquire(ctx); err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
defer p.release()
|
||||||
|
return VerifyPassword(password, phc)
|
||||||
|
}
|
||||||
|
|
||||||
|
// QueueLen 返回等待获取池槽位的任务数。
|
||||||
|
func (p *Pool) QueueLen() int {
|
||||||
|
return int(p.waiting.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
// MaxActive 返回曾达到的最大并发哈希数(测试用)。
|
||||||
|
func (p *Pool) MaxActive() int {
|
||||||
|
return int(p.maxSeen.Load())
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Pool) acquire(ctx context.Context) error {
|
||||||
|
p.waiting.Add(1)
|
||||||
|
select {
|
||||||
|
case p.sem <- struct{}{}:
|
||||||
|
p.waiting.Add(-1)
|
||||||
|
cur := p.active.Add(1)
|
||||||
|
for {
|
||||||
|
old := p.maxSeen.Load()
|
||||||
|
if cur <= old || p.maxSeen.CompareAndSwap(old, cur) {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
case <-ctx.Done():
|
||||||
|
p.waiting.Add(-1)
|
||||||
|
return ctx.Err()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Pool) release() {
|
||||||
|
p.active.Add(-1)
|
||||||
|
<-p.sem
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ HashPool = (*Pool)(nil)
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
package auth
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/sha256"
|
||||||
|
"crypto/subtle"
|
||||||
|
"encoding/base64"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
sessionTokenPrefix = "nst_"
|
||||||
|
apiTokenPrefix = "nxm_"
|
||||||
|
tokenRandomBytes = 32
|
||||||
|
)
|
||||||
|
|
||||||
|
// SessionTokenService 生成与哈希端会话令牌。
|
||||||
|
type SessionTokenService struct{}
|
||||||
|
|
||||||
|
// NewSessionTokens 创建会话令牌服务。
|
||||||
|
func NewSessionTokens() *SessionTokenService {
|
||||||
|
return &SessionTokenService{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Issue 生成 nst_ + 32 字节随机数的 base64url;返回明文与 SHA-256。
|
||||||
|
func (s *SessionTokenService) Issue(_ context.Context) (string, []byte, error) {
|
||||||
|
return issuePrefixedToken(sessionTokenPrefix)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HashToken 对令牌做 SHA-256。
|
||||||
|
func (s *SessionTokenService) HashToken(token string) []byte {
|
||||||
|
sum := sha256.Sum256([]byte(token))
|
||||||
|
return sum[:]
|
||||||
|
}
|
||||||
|
|
||||||
|
// LooksLikeSessionToken 判断是否以 nst_ 开头。
|
||||||
|
func (s *SessionTokenService) LooksLikeSessionToken(credential string) bool {
|
||||||
|
return strings.HasPrefix(credential, sessionTokenPrefix)
|
||||||
|
}
|
||||||
|
|
||||||
|
// APITokenService 生成与哈希 API 令牌。
|
||||||
|
type APITokenService struct{}
|
||||||
|
|
||||||
|
// NewAPITokens 创建 API 令牌服务。
|
||||||
|
func NewAPITokens() *APITokenService {
|
||||||
|
return &APITokenService{}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Issue 生成 nxm_ + 32 字节随机数的 base64url;返回明文与 SHA-256。
|
||||||
|
func (s *APITokenService) Issue(_ context.Context) (string, []byte, error) {
|
||||||
|
return issuePrefixedToken(apiTokenPrefix)
|
||||||
|
}
|
||||||
|
|
||||||
|
// HashToken 对令牌做 SHA-256。
|
||||||
|
func (s *APITokenService) HashToken(token string) []byte {
|
||||||
|
sum := sha256.Sum256([]byte(token))
|
||||||
|
return sum[:]
|
||||||
|
}
|
||||||
|
|
||||||
|
// LooksLikeAPIToken 判断是否以 nxm_ 开头。
|
||||||
|
func (s *APITokenService) LooksLikeAPIToken(credential string) bool {
|
||||||
|
return strings.HasPrefix(credential, apiTokenPrefix)
|
||||||
|
}
|
||||||
|
|
||||||
|
// EqualHash 常量时间比较两个哈希。
|
||||||
|
func EqualHash(a, b []byte) bool {
|
||||||
|
if len(a) != len(b) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return subtle.ConstantTimeCompare(a, b) == 1
|
||||||
|
}
|
||||||
|
|
||||||
|
func issuePrefixedToken(prefix string) (string, []byte, error) {
|
||||||
|
raw := make([]byte, tokenRandomBytes)
|
||||||
|
if _, err := rand.Read(raw); err != nil {
|
||||||
|
return "", nil, err
|
||||||
|
}
|
||||||
|
tok := prefix + base64.RawURLEncoding.EncodeToString(raw)
|
||||||
|
sum := sha256.Sum256([]byte(tok))
|
||||||
|
return tok, sum[:], nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
_ SessionTokens = (*SessionTokenService)(nil)
|
||||||
|
_ APITokens = (*APITokenService)(nil)
|
||||||
|
)
|
||||||
@@ -0,0 +1,379 @@
|
|||||||
|
package broker
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/rand"
|
||||||
|
"encoding/hex"
|
||||||
|
"errors"
|
||||||
|
"log/slog"
|
||||||
|
"net"
|
||||||
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/app/port"
|
||||||
|
mqtt "github.com/mochi-mqtt/server/v2"
|
||||||
|
"github.com/mochi-mqtt/server/v2/packets"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
maxClients = 2000
|
||||||
|
maxPacketSize = 786432
|
||||||
|
uplinkQueueSize = 256
|
||||||
|
largeFrameBytes = 64 * 1024
|
||||||
|
largeFrameSlots = 64
|
||||||
|
packetOverheadBudget = 128 // 主题与 MQTT 包头预留
|
||||||
|
keepaliveMin = 10
|
||||||
|
keepaliveMax = 600
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrPayloadTooLarge 下行超过客户端 Maximum Packet Size(减包头预留)或 max_receive_bytes。
|
||||||
|
var ErrPayloadTooLarge = errors.New("broker: payload exceeds client limit")
|
||||||
|
|
||||||
|
// ErrNoConnection 目标端没有当前连接。
|
||||||
|
var ErrNoConnection = errors.New("broker: no active connection")
|
||||||
|
|
||||||
|
// AuthResult 是登录校验结论(N3 实现真实逻辑;N2 默认拒绝)。
|
||||||
|
type AuthResult struct {
|
||||||
|
OK bool
|
||||||
|
SessionToken string // 密码登录成功时由 N3 填写
|
||||||
|
}
|
||||||
|
|
||||||
|
// Authenticator 由 N3 实现;内部故障必须返回 error,不得当成密码错误。
|
||||||
|
type Authenticator interface {
|
||||||
|
Authenticate(ctx context.Context, endpointID string, password []byte, remoteIP string) (AuthResult, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// RejectAuthenticator 默认拒绝所有客户端(CONNACK 用户名密码错误)。
|
||||||
|
type RejectAuthenticator struct{}
|
||||||
|
|
||||||
|
func (RejectAuthenticator) Authenticate(context.Context, string, []byte, string) (AuthResult, error) {
|
||||||
|
return AuthResult{OK: false}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// AllowAuthenticator 测试用:允许任意编号。
|
||||||
|
type AllowAuthenticator struct{}
|
||||||
|
|
||||||
|
func (AllowAuthenticator) Authenticate(context.Context, string, []byte, string) (AuthResult, error) {
|
||||||
|
return AuthResult{OK: true}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Options 装配 broker。
|
||||||
|
type Options struct {
|
||||||
|
Authenticator Authenticator
|
||||||
|
Uplink port.UplinkHandler
|
||||||
|
Logger *slog.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
// Broker 内置 mochi,不自带监听端口。
|
||||||
|
type Broker struct {
|
||||||
|
server *mqtt.Server
|
||||||
|
auth Authenticator
|
||||||
|
uplink port.UplinkHandler
|
||||||
|
log *slog.Logger
|
||||||
|
|
||||||
|
hook *nixHook
|
||||||
|
|
||||||
|
connsMu sync.RWMutex
|
||||||
|
current map[string]*connState
|
||||||
|
byClient map[*mqtt.Client]*connState
|
||||||
|
|
||||||
|
queuesMu sync.Mutex
|
||||||
|
queues map[string]*uplinkQueue
|
||||||
|
|
||||||
|
largeSem chan struct{}
|
||||||
|
closed atomic.Bool
|
||||||
|
}
|
||||||
|
|
||||||
|
type connState struct {
|
||||||
|
connID port.ConnID
|
||||||
|
endpointID string
|
||||||
|
transport port.Transport
|
||||||
|
remoteIP string
|
||||||
|
client *mqtt.Client
|
||||||
|
maxPacketSize uint32
|
||||||
|
maxRecvBytes int
|
||||||
|
authOK bool
|
||||||
|
authErr error
|
||||||
|
sessionToken string
|
||||||
|
largeHeld int
|
||||||
|
mu sync.Mutex
|
||||||
|
}
|
||||||
|
|
||||||
|
// New 创建并 Serve mochi(无监听器)。
|
||||||
|
func New(opts Options) (*Broker, error) {
|
||||||
|
auth := opts.Authenticator
|
||||||
|
if auth == nil {
|
||||||
|
auth = RejectAuthenticator{}
|
||||||
|
}
|
||||||
|
uplink := opts.Uplink
|
||||||
|
if uplink == nil {
|
||||||
|
uplink = port.StubUplinkHandler{}
|
||||||
|
}
|
||||||
|
log := opts.Logger
|
||||||
|
if log == nil {
|
||||||
|
log = slog.Default()
|
||||||
|
}
|
||||||
|
|
||||||
|
caps := mqtt.NewDefaultServerCapabilities()
|
||||||
|
caps.MaximumClients = maxClients
|
||||||
|
caps.MaximumQos = 1
|
||||||
|
caps.MaximumPacketSize = maxPacketSize
|
||||||
|
caps.MaximumSessionExpiryInterval = 0
|
||||||
|
caps.ReceiveMaximum = 1024
|
||||||
|
caps.MaximumInflight = 1024
|
||||||
|
caps.MaximumClientWritesPending = 1024
|
||||||
|
caps.RetainAvailable = 0
|
||||||
|
caps.WildcardSubAvailable = 0
|
||||||
|
caps.SharedSubAvailable = 0
|
||||||
|
caps.TopicAliasMaximum = 0
|
||||||
|
caps.Compatibilities.ObscureNotAuthorized = true
|
||||||
|
|
||||||
|
srv := mqtt.New(&mqtt.Options{
|
||||||
|
InlineClient: true,
|
||||||
|
Capabilities: caps,
|
||||||
|
Logger: log,
|
||||||
|
})
|
||||||
|
|
||||||
|
b := &Broker{
|
||||||
|
server: srv,
|
||||||
|
auth: auth,
|
||||||
|
uplink: uplink,
|
||||||
|
log: log,
|
||||||
|
current: make(map[string]*connState),
|
||||||
|
byClient: make(map[*mqtt.Client]*connState),
|
||||||
|
queues: make(map[string]*uplinkQueue),
|
||||||
|
largeSem: make(chan struct{}, largeFrameSlots),
|
||||||
|
}
|
||||||
|
b.hook = &nixHook{b: b}
|
||||||
|
if err := srv.AddHook(b.hook, nil); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := srv.Serve(); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return b, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Server 返回底层 mochi(测试用)。
|
||||||
|
func (b *Broker) Server() *mqtt.Server { return b.server }
|
||||||
|
|
||||||
|
// Close 关闭 broker。
|
||||||
|
func (b *Broker) Close() error {
|
||||||
|
if b.closed.Swap(true) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
b.queuesMu.Lock()
|
||||||
|
for _, q := range b.queues {
|
||||||
|
q.close()
|
||||||
|
}
|
||||||
|
b.queuesMu.Unlock()
|
||||||
|
return b.server.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// AttachTCP 把裸 TCP/TLS 连接交给 mochi;阻塞到连接结束。
|
||||||
|
func (b *Broker) AttachTCP(conn net.Conn) error {
|
||||||
|
return b.server.EstablishConnection("tcp", conn)
|
||||||
|
}
|
||||||
|
|
||||||
|
// AttachWS 把 WebSocket NetConn 交给 mochi;阻塞到连接结束。
|
||||||
|
func (b *Broker) AttachWS(conn net.Conn) error {
|
||||||
|
return b.server.EstablishConnection("ws", conn)
|
||||||
|
}
|
||||||
|
|
||||||
|
// PublishDown 实现 port.Downlink。
|
||||||
|
func (b *Broker) PublishDown(ctx context.Context, endpointID string, connID port.ConnID, payload []byte, opts port.PublishOpts) error {
|
||||||
|
if b.closed.Load() {
|
||||||
|
return errors.New("broker: closed")
|
||||||
|
}
|
||||||
|
st := b.lookupConn(endpointID, connID)
|
||||||
|
if st == nil {
|
||||||
|
return ErrNoConnection
|
||||||
|
}
|
||||||
|
|
||||||
|
limit := effectivePayloadLimit(st.maxPacketSize, st.maxRecvBytes)
|
||||||
|
if limit > 0 && len(payload) > limit {
|
||||||
|
return ErrPayloadTooLarge
|
||||||
|
}
|
||||||
|
|
||||||
|
qos := opts.QoS
|
||||||
|
if qos > 1 {
|
||||||
|
qos = 1
|
||||||
|
}
|
||||||
|
topic := downTopic(endpointID)
|
||||||
|
large := len(payload) > largeFrameBytes
|
||||||
|
|
||||||
|
if large {
|
||||||
|
select {
|
||||||
|
case b.largeSem <- struct{}{}:
|
||||||
|
case <-ctx.Done():
|
||||||
|
return ctx.Err()
|
||||||
|
}
|
||||||
|
st.mu.Lock()
|
||||||
|
st.largeHeld++
|
||||||
|
st.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := b.server.Publish(topic, payload, false, qos); err != nil {
|
||||||
|
if large {
|
||||||
|
b.releaseOneLarge(st)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if large && qos == 0 {
|
||||||
|
b.releaseOneLarge(st)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *Broker) releaseOneLarge(st *connState) {
|
||||||
|
st.mu.Lock()
|
||||||
|
if st.largeHeld > 0 {
|
||||||
|
st.largeHeld--
|
||||||
|
st.mu.Unlock()
|
||||||
|
select {
|
||||||
|
case <-b.largeSem:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
st.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *Broker) releaseAllLarge(st *connState) {
|
||||||
|
st.mu.Lock()
|
||||||
|
n := st.largeHeld
|
||||||
|
st.largeHeld = 0
|
||||||
|
st.mu.Unlock()
|
||||||
|
for i := 0; i < n; i++ {
|
||||||
|
select {
|
||||||
|
case <-b.largeSem:
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Disconnect 实现 port.ConnControl。
|
||||||
|
func (b *Broker) Disconnect(_ context.Context, endpointID string, connID port.ConnID, reason port.DisconnectReason) error {
|
||||||
|
st := b.lookupConn(endpointID, connID)
|
||||||
|
if st == nil {
|
||||||
|
return ErrNoConnection
|
||||||
|
}
|
||||||
|
code := packets.CodeDisconnect
|
||||||
|
switch reason {
|
||||||
|
case port.DisconnectTakenOver:
|
||||||
|
code = packets.ErrSessionTakenOver
|
||||||
|
case port.DisconnectKicked, port.DisconnectFatal:
|
||||||
|
code = packets.ErrAdministrativeAction
|
||||||
|
}
|
||||||
|
return b.server.DisconnectClient(st.client, code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *Broker) lookupConn(endpointID string, connID port.ConnID) *connState {
|
||||||
|
b.connsMu.RLock()
|
||||||
|
defer b.connsMu.RUnlock()
|
||||||
|
if connID != "" {
|
||||||
|
for _, st := range b.byClient {
|
||||||
|
if st.endpointID == endpointID && st.connID == connID {
|
||||||
|
return st
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return b.current[endpointID]
|
||||||
|
}
|
||||||
|
|
||||||
|
func downTopic(endpointID string) string {
|
||||||
|
return "nix/c/" + endpointID + "/down"
|
||||||
|
}
|
||||||
|
|
||||||
|
func upTopic(endpointID string) string {
|
||||||
|
return "nix/c/" + endpointID + "/up"
|
||||||
|
}
|
||||||
|
|
||||||
|
func effectivePayloadLimit(maxPacketSize uint32, maxRecvBytes int) int {
|
||||||
|
limit := 0
|
||||||
|
if maxPacketSize > 0 {
|
||||||
|
if maxPacketSize > packetOverheadBudget {
|
||||||
|
limit = int(maxPacketSize) - packetOverheadBudget
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if maxRecvBytes > 0 {
|
||||||
|
if limit == 0 || maxRecvBytes < limit {
|
||||||
|
limit = maxRecvBytes
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return limit
|
||||||
|
}
|
||||||
|
|
||||||
|
func randomConnID() port.ConnID {
|
||||||
|
var b [16]byte
|
||||||
|
_, _ = rand.Read(b[:])
|
||||||
|
return port.ConnID(hex.EncodeToString(b[:]))
|
||||||
|
}
|
||||||
|
|
||||||
|
func transportOf(cl *mqtt.Client) port.Transport {
|
||||||
|
if cl != nil && cl.Net.Listener == "ws" {
|
||||||
|
return port.TransportWS
|
||||||
|
}
|
||||||
|
return port.TransportTCP
|
||||||
|
}
|
||||||
|
|
||||||
|
func remoteIPOf(cl *mqtt.Client) string {
|
||||||
|
if cl == nil {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
addr := cl.Net.Remote
|
||||||
|
if addr == "" && cl.Net.Conn != nil && cl.Net.Conn.RemoteAddr() != nil {
|
||||||
|
addr = cl.Net.Conn.RemoteAddr().String()
|
||||||
|
}
|
||||||
|
host, _, err := net.SplitHostPort(addr)
|
||||||
|
if err != nil {
|
||||||
|
return addr
|
||||||
|
}
|
||||||
|
return host
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetMaxReceiveBytes 供 N3 握手后设置;0 表示不限。
|
||||||
|
func (b *Broker) SetMaxReceiveBytes(endpointID string, connID port.ConnID, n int) {
|
||||||
|
st := b.lookupConn(endpointID, connID)
|
||||||
|
if st == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
st.mu.Lock()
|
||||||
|
st.maxRecvBytes = n
|
||||||
|
st.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
// ConnInfoOf 返回连接信息(测试/N3)。
|
||||||
|
func (b *Broker) ConnInfoOf(endpointID string) (port.ConnInfo, bool) {
|
||||||
|
b.connsMu.RLock()
|
||||||
|
st := b.current[endpointID]
|
||||||
|
b.connsMu.RUnlock()
|
||||||
|
if st == nil {
|
||||||
|
return port.ConnInfo{}, false
|
||||||
|
}
|
||||||
|
return port.ConnInfo{
|
||||||
|
ConnID: st.connID,
|
||||||
|
EndpointID: st.endpointID,
|
||||||
|
Transport: st.transport,
|
||||||
|
RemoteIP: st.remoteIP,
|
||||||
|
SessionToken: st.sessionToken,
|
||||||
|
MaxPacketSize: st.maxPacketSize,
|
||||||
|
}, true
|
||||||
|
}
|
||||||
|
|
||||||
|
func (b *Broker) enqueueUplink(endpointID string, conn port.ConnInfo, payload []byte) {
|
||||||
|
b.queuesMu.Lock()
|
||||||
|
q, ok := b.queues[endpointID]
|
||||||
|
if !ok {
|
||||||
|
q = newUplinkQueue(b, endpointID)
|
||||||
|
b.queues[endpointID] = q
|
||||||
|
}
|
||||||
|
b.queuesMu.Unlock()
|
||||||
|
q.push(uplinkItem{conn: conn, payload: payload})
|
||||||
|
}
|
||||||
|
|
||||||
|
var (
|
||||||
|
_ port.Downlink = (*Broker)(nil)
|
||||||
|
_ port.ConnControl = (*Broker)(nil)
|
||||||
|
)
|
||||||
@@ -0,0 +1,259 @@
|
|||||||
|
package broker
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/app/port"
|
||||||
|
"github.com/coder/websocket"
|
||||||
|
"github.com/mochi-mqtt/server/v2/packets"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestWSCrossOriginAllowed(t *testing.T) {
|
||||||
|
b, err := New(Options{Authenticator: AllowAuthenticator{}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.Handle("/mqtt", b.WSHandler(nil))
|
||||||
|
srv := httptest.NewServer(mux)
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
c, _, err := websocket.Dial(ctx, "ws"+srv.URL[len("http"):]+"/mqtt", &websocket.DialOptions{
|
||||||
|
HTTPHeader: http.Header{"Origin": []string{"https://other.example"}},
|
||||||
|
Subprotocols: []string{"mqtt"},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("cross-origin dial: %v", err)
|
||||||
|
}
|
||||||
|
defer func() { _ = c.Close(websocket.StatusNormalClosure, "") }()
|
||||||
|
if c.Subprotocol() != "mqtt" {
|
||||||
|
t.Fatalf("subprotocol=%q", c.Subprotocol())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWSWrongSubprotocolClosed(t *testing.T) {
|
||||||
|
b, err := New(Options{Authenticator: AllowAuthenticator{}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.Handle("/mqtt", b.WSHandler(nil))
|
||||||
|
srv := httptest.NewServer(mux)
|
||||||
|
defer srv.Close()
|
||||||
|
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
c, _, err := websocket.Dial(ctx, "ws"+srv.URL[len("http"):]+"/mqtt", &websocket.DialOptions{
|
||||||
|
HTTPHeader: http.Header{"Origin": []string{"https://other.example"}},
|
||||||
|
Subprotocols: []string{"not-mqtt"},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
// 有的实现在握手阶段就失败;也算关闭
|
||||||
|
return
|
||||||
|
}
|
||||||
|
defer func() { _ = c.Close(websocket.StatusNormalClosure, "") }()
|
||||||
|
|
||||||
|
// 服务端应立刻关掉;后续读写会失败
|
||||||
|
c.SetReadLimit(16)
|
||||||
|
_, _, readErr := c.Read(ctx)
|
||||||
|
if readErr == nil {
|
||||||
|
t.Fatal("expected connection closed for wrong subprotocol")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPublishDownExceedsClientMax(t *testing.T) {
|
||||||
|
b, err := New(Options{Authenticator: AllowAuthenticator{}})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
clientDone := make(chan struct{})
|
||||||
|
r, w := net.Pipe()
|
||||||
|
go func() {
|
||||||
|
defer close(clientDone)
|
||||||
|
_ = b.AttachTCP(r)
|
||||||
|
}()
|
||||||
|
|
||||||
|
endpoint := "ep-limit"
|
||||||
|
connectAndSubscribe(t, w, endpoint, 200) // MaximumPacketSize=200 → payload limit 72
|
||||||
|
|
||||||
|
// 等会话建立
|
||||||
|
deadline := time.Now().Add(3 * time.Second)
|
||||||
|
for {
|
||||||
|
if _, ok := b.ConnInfoOf(endpoint); ok {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if time.Now().After(deadline) {
|
||||||
|
t.Fatal("session not established")
|
||||||
|
}
|
||||||
|
time.Sleep(10 * time.Millisecond)
|
||||||
|
}
|
||||||
|
|
||||||
|
big := bytes.Repeat([]byte("x"), 100) // > 200-128
|
||||||
|
pubErr := b.PublishDown(context.Background(), endpoint, "", big, port.PublishOpts{QoS: 1})
|
||||||
|
if !errors.Is(pubErr, ErrPayloadTooLarge) {
|
||||||
|
t.Fatalf("PublishDown err=%v want ErrPayloadTooLarge", pubErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
// 合法大小应成功
|
||||||
|
small := []byte(`{"v":1,"type":"resp"}`)
|
||||||
|
if err := b.PublishDown(context.Background(), endpoint, "", small, port.PublishOpts{QoS: 0}); err != nil {
|
||||||
|
t.Fatalf("small publish: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_ = w.Close()
|
||||||
|
select {
|
||||||
|
case <-clientDone:
|
||||||
|
case <-time.After(3 * time.Second):
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestInternalAuthErrorDoesNotReturnBadPassword(t *testing.T) {
|
||||||
|
auth := &errAuthenticator{err: context.DeadlineExceeded}
|
||||||
|
b, err := New(Options{Authenticator: auth})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
r, w := net.Pipe()
|
||||||
|
errCh := make(chan error, 1)
|
||||||
|
go func() { errCh <- b.AttachTCP(r) }()
|
||||||
|
|
||||||
|
writeConnect(t, w, "ep-err", 30, 0)
|
||||||
|
// 不应收到 CONNACK(内部错误直接断开)
|
||||||
|
_ = w.SetReadDeadline(time.Now().Add(500 * time.Millisecond))
|
||||||
|
buf := make([]byte, 64)
|
||||||
|
n, readErr := w.Read(buf)
|
||||||
|
if readErr == nil && n > 0 {
|
||||||
|
// 若收到包,不能是 bad username/password CONNACK (reason 0x86)
|
||||||
|
if n >= 2 && buf[0]>>4 == packets.Connack {
|
||||||
|
t.Fatalf("unexpected connack on internal error: %x", buf[:n])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_ = w.Close()
|
||||||
|
select {
|
||||||
|
case <-errCh:
|
||||||
|
case <-time.After(2 * time.Second):
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRejectUnknownByDefault(t *testing.T) {
|
||||||
|
b, err := New(Options{}) // RejectAuthenticator
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = b.Close() }()
|
||||||
|
|
||||||
|
r, w := net.Pipe()
|
||||||
|
go func() { _ = b.AttachTCP(r) }()
|
||||||
|
writeConnect(t, w, "ep-unknown", 30, 0)
|
||||||
|
_ = w.SetReadDeadline(time.Now().Add(2 * time.Second))
|
||||||
|
buf := make([]byte, 128)
|
||||||
|
n, err := io.ReadAtLeast(w, buf, 2)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if buf[0]>>4 != packets.Connack {
|
||||||
|
t.Fatalf("want connack, got %x", buf[:n])
|
||||||
|
}
|
||||||
|
_ = w.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
type errAuthenticator struct {
|
||||||
|
err error
|
||||||
|
mu sync.Mutex
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *errAuthenticator) Authenticate(context.Context, string, []byte, string) (AuthResult, error) {
|
||||||
|
a.mu.Lock()
|
||||||
|
defer a.mu.Unlock()
|
||||||
|
return AuthResult{}, a.err
|
||||||
|
}
|
||||||
|
|
||||||
|
func connectAndSubscribe(t *testing.T, w net.Conn, endpoint string, maxPacket uint32) {
|
||||||
|
t.Helper()
|
||||||
|
writeConnect(t, w, endpoint, 30, maxPacket)
|
||||||
|
// read CONNACK
|
||||||
|
_ = w.SetReadDeadline(time.Now().Add(3 * time.Second))
|
||||||
|
buf := make([]byte, 256)
|
||||||
|
n, err := io.ReadAtLeast(w, buf, 2)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if buf[0]>>4 != packets.Connack {
|
||||||
|
t.Fatalf("want connack got %x", buf[:n])
|
||||||
|
}
|
||||||
|
writeSubscribe(t, w, downTopic(endpoint))
|
||||||
|
// read SUBACK
|
||||||
|
n, err = io.ReadAtLeast(w, buf, 2)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if buf[0]>>4 != packets.Suback {
|
||||||
|
t.Fatalf("want suback got %x", buf[:n])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeConnect(t *testing.T, w net.Conn, endpoint string, keepalive uint16, maxPacket uint32) {
|
||||||
|
t.Helper()
|
||||||
|
pk := packets.Packet{
|
||||||
|
FixedHeader: packets.FixedHeader{Type: packets.Connect},
|
||||||
|
ProtocolVersion: 5,
|
||||||
|
Connect: packets.ConnectParams{
|
||||||
|
ProtocolName: []byte("MQTT"),
|
||||||
|
Clean: true,
|
||||||
|
ClientIdentifier: endpoint,
|
||||||
|
Keepalive: keepalive,
|
||||||
|
UsernameFlag: true,
|
||||||
|
Username: []byte(endpoint),
|
||||||
|
PasswordFlag: true,
|
||||||
|
Password: []byte("test"),
|
||||||
|
},
|
||||||
|
Properties: packets.Properties{
|
||||||
|
MaximumPacketSize: maxPacket,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
var buf bytes.Buffer
|
||||||
|
if err := pk.ConnectEncode(&buf); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := w.Write(buf.Bytes()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeSubscribe(t *testing.T, w net.Conn, topic string) {
|
||||||
|
t.Helper()
|
||||||
|
pk := packets.Packet{
|
||||||
|
FixedHeader: packets.FixedHeader{Type: packets.Subscribe, Qos: 1},
|
||||||
|
ProtocolVersion: 5,
|
||||||
|
PacketID: 1,
|
||||||
|
Filters: packets.Subscriptions{
|
||||||
|
{Filter: topic, Qos: 1},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
var buf bytes.Buffer
|
||||||
|
if err := pk.SubscribeEncode(&buf); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := w.Write(buf.Bytes()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,196 @@
|
|||||||
|
package broker
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/app/port"
|
||||||
|
mqtt "github.com/mochi-mqtt/server/v2"
|
||||||
|
"github.com/mochi-mqtt/server/v2/packets"
|
||||||
|
)
|
||||||
|
|
||||||
|
type nixHook struct {
|
||||||
|
mqtt.HookBase
|
||||||
|
b *Broker
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) ID() string { return "nixmsg" }
|
||||||
|
|
||||||
|
func (h *nixHook) Provides(b byte) bool {
|
||||||
|
return bytes.Contains([]byte{
|
||||||
|
mqtt.OnConnect,
|
||||||
|
mqtt.OnConnectAuthenticate,
|
||||||
|
mqtt.OnACLCheck,
|
||||||
|
mqtt.OnPublish,
|
||||||
|
mqtt.OnPublishDropped,
|
||||||
|
mqtt.OnSessionEstablished,
|
||||||
|
mqtt.OnDisconnect,
|
||||||
|
mqtt.OnQosComplete,
|
||||||
|
}, []byte{b})
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) OnConnect(cl *mqtt.Client, pk packets.Packet) error {
|
||||||
|
endpointID := string(pk.Connect.Username)
|
||||||
|
if endpointID == "" {
|
||||||
|
endpointID = pk.Connect.ClientIdentifier
|
||||||
|
}
|
||||||
|
remoteIP := remoteIPOf(cl)
|
||||||
|
|
||||||
|
st := &connState{
|
||||||
|
connID: randomConnID(),
|
||||||
|
endpointID: endpointID,
|
||||||
|
transport: transportOf(cl),
|
||||||
|
remoteIP: remoteIP,
|
||||||
|
client: cl,
|
||||||
|
maxPacketSize: pk.Properties.MaximumPacketSize,
|
||||||
|
}
|
||||||
|
|
||||||
|
// 心跳校正:超出 10–600 秒就改写 Keepalive 并设 ServerKeepalive
|
||||||
|
ka := pk.Connect.Keepalive
|
||||||
|
if ka < keepaliveMin || ka > keepaliveMax {
|
||||||
|
if ka < keepaliveMin {
|
||||||
|
ka = keepaliveMin
|
||||||
|
}
|
||||||
|
if ka > keepaliveMax {
|
||||||
|
ka = keepaliveMax
|
||||||
|
}
|
||||||
|
cl.State.Keepalive = ka
|
||||||
|
cl.State.ServerKeepalive = true
|
||||||
|
}
|
||||||
|
|
||||||
|
res, err := h.b.auth.Authenticate(context.Background(), endpointID, pk.Connect.Password, remoteIP)
|
||||||
|
if err != nil {
|
||||||
|
st.authErr = err
|
||||||
|
h.rememberPending(cl, st)
|
||||||
|
return err // mochi 不回 CONNACK,直接断开
|
||||||
|
}
|
||||||
|
st.authOK = res.OK
|
||||||
|
st.sessionToken = res.SessionToken
|
||||||
|
h.rememberPending(cl, st)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) rememberPending(cl *mqtt.Client, st *connState) {
|
||||||
|
h.b.connsMu.Lock()
|
||||||
|
h.b.byClient[cl] = st
|
||||||
|
h.b.connsMu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) OnConnectAuthenticate(cl *mqtt.Client, _ packets.Packet) bool {
|
||||||
|
h.b.connsMu.RLock()
|
||||||
|
st := h.b.byClient[cl]
|
||||||
|
h.b.connsMu.RUnlock()
|
||||||
|
if st == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
// 内部故障已在 OnConnect 返回 error;此处只反映业务上的拒绝
|
||||||
|
return st.authOK
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) OnACLCheck(cl *mqtt.Client, topic string, write bool) bool {
|
||||||
|
h.b.connsMu.RLock()
|
||||||
|
st := h.b.byClient[cl]
|
||||||
|
h.b.connsMu.RUnlock()
|
||||||
|
if st == nil || st.endpointID == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
up := upTopic(st.endpointID)
|
||||||
|
down := downTopic(st.endpointID)
|
||||||
|
if write {
|
||||||
|
return topic == up
|
||||||
|
}
|
||||||
|
return topic == down
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) OnPublish(cl *mqtt.Client, pk packets.Packet) (packets.Packet, error) {
|
||||||
|
h.b.connsMu.RLock()
|
||||||
|
st := h.b.byClient[cl]
|
||||||
|
h.b.connsMu.RUnlock()
|
||||||
|
if st == nil {
|
||||||
|
return pk, packets.CodeSuccessIgnore
|
||||||
|
}
|
||||||
|
payload := append([]byte(nil), pk.Payload...)
|
||||||
|
info := port.ConnInfo{
|
||||||
|
ConnID: st.connID,
|
||||||
|
EndpointID: st.endpointID,
|
||||||
|
Transport: st.transport,
|
||||||
|
RemoteIP: st.remoteIP,
|
||||||
|
SessionToken: st.sessionToken,
|
||||||
|
MaxPacketSize: st.maxPacketSize,
|
||||||
|
}
|
||||||
|
h.b.enqueueUplink(st.endpointID, info, payload)
|
||||||
|
return pk, packets.CodeSuccessIgnore
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) OnPublishDropped(cl *mqtt.Client, pk packets.Packet) {
|
||||||
|
h.b.log.Debug("publish dropped", "client", cl.ID, "topic", pk.TopicName, "size", len(pk.Payload))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) OnSessionEstablished(cl *mqtt.Client, _ packets.Packet) {
|
||||||
|
h.b.connsMu.Lock()
|
||||||
|
st := h.b.byClient[cl]
|
||||||
|
if st != nil {
|
||||||
|
h.b.current[st.endpointID] = st
|
||||||
|
}
|
||||||
|
h.b.connsMu.Unlock()
|
||||||
|
if st == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
info := port.ConnInfo{
|
||||||
|
ConnID: st.connID,
|
||||||
|
EndpointID: st.endpointID,
|
||||||
|
Transport: st.transport,
|
||||||
|
RemoteIP: st.remoteIP,
|
||||||
|
SessionToken: st.sessionToken,
|
||||||
|
MaxPacketSize: st.maxPacketSize,
|
||||||
|
}
|
||||||
|
_ = h.b.uplink.OnSessionEstablished(context.Background(), info)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) OnDisconnect(cl *mqtt.Client, err error, _ bool) {
|
||||||
|
h.b.connsMu.Lock()
|
||||||
|
st := h.b.byClient[cl]
|
||||||
|
delete(h.b.byClient, cl)
|
||||||
|
if st != nil && h.b.current[st.endpointID] == st {
|
||||||
|
delete(h.b.current, st.endpointID)
|
||||||
|
}
|
||||||
|
h.b.connsMu.Unlock()
|
||||||
|
if st == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.b.releaseAllLarge(st)
|
||||||
|
|
||||||
|
reason := port.DisconnectNormal
|
||||||
|
if err != nil {
|
||||||
|
if code, ok := err.(packets.Code); ok {
|
||||||
|
switch code.Code {
|
||||||
|
case packets.ErrSessionTakenOver.Code:
|
||||||
|
reason = port.DisconnectTakenOver
|
||||||
|
case packets.ErrAdministrativeAction.Code:
|
||||||
|
reason = port.DisconnectKicked
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
info := port.ConnInfo{
|
||||||
|
ConnID: st.connID,
|
||||||
|
EndpointID: st.endpointID,
|
||||||
|
Transport: st.transport,
|
||||||
|
RemoteIP: st.remoteIP,
|
||||||
|
SessionToken: st.sessionToken,
|
||||||
|
MaxPacketSize: st.maxPacketSize,
|
||||||
|
}
|
||||||
|
h.b.uplink.OnDisconnect(context.Background(), info, reason)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *nixHook) OnQosComplete(cl *mqtt.Client, pk packets.Packet) {
|
||||||
|
if len(pk.Payload) <= largeFrameBytes {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.b.connsMu.RLock()
|
||||||
|
st := h.b.byClient[cl]
|
||||||
|
h.b.connsMu.RUnlock()
|
||||||
|
if st == nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
h.b.releaseOneLarge(st)
|
||||||
|
}
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
package broker
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"sync"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/app/port"
|
||||||
|
)
|
||||||
|
|
||||||
|
type uplinkItem struct {
|
||||||
|
conn port.ConnInfo
|
||||||
|
payload []byte
|
||||||
|
}
|
||||||
|
|
||||||
|
// uplinkQueue 每端串行队列,长度 256,满了堵住 OnPublish(背压)。
|
||||||
|
type uplinkQueue struct {
|
||||||
|
b *Broker
|
||||||
|
endpointID string
|
||||||
|
ch chan uplinkItem
|
||||||
|
once sync.Once
|
||||||
|
}
|
||||||
|
|
||||||
|
func newUplinkQueue(b *Broker, endpointID string) *uplinkQueue {
|
||||||
|
q := &uplinkQueue{
|
||||||
|
b: b,
|
||||||
|
endpointID: endpointID,
|
||||||
|
ch: make(chan uplinkItem, uplinkQueueSize),
|
||||||
|
}
|
||||||
|
go q.loop()
|
||||||
|
return q
|
||||||
|
}
|
||||||
|
|
||||||
|
func (q *uplinkQueue) push(item uplinkItem) {
|
||||||
|
q.ch <- item // 满则阻塞读循环,形成背压
|
||||||
|
}
|
||||||
|
|
||||||
|
func (q *uplinkQueue) close() {
|
||||||
|
q.once.Do(func() { close(q.ch) })
|
||||||
|
}
|
||||||
|
|
||||||
|
func (q *uplinkQueue) loop() {
|
||||||
|
for item := range q.ch {
|
||||||
|
_ = q.b.uplink.HandleUplink(context.Background(), item.conn, item.payload)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
package broker
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"git.asio.asia/nixevol/NixMsg/internal/listener"
|
||||||
|
"github.com/coder/websocket"
|
||||||
|
)
|
||||||
|
|
||||||
|
// WSHandler 返回 /mqtt 的 WebSocket 升级处理。
|
||||||
|
// Accept 时 InsecureSkipVerify=true;之后检查 Subprotocol==mqtt。
|
||||||
|
// NetConn 使用 Background 派生的 context,不用请求 Context。
|
||||||
|
func (b *Broker) WSHandler(proxies *listener.ProxySet) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
c, err := websocket.Accept(w, r, &websocket.AcceptOptions{
|
||||||
|
Subprotocols: []string{"mqtt"},
|
||||||
|
InsecureSkipVerify: true,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if c.Subprotocol() != "mqtt" {
|
||||||
|
_ = c.Close(websocket.StatusPolicyViolation, "subprotocol must be mqtt")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
|
||||||
|
nc := websocket.NetConn(ctx, c, websocket.MessageBinary)
|
||||||
|
if proxies != nil {
|
||||||
|
ip := proxies.ClientIP(r)
|
||||||
|
if ip != "" {
|
||||||
|
nc = listener.WithRemoteAddr(nc, &net.TCPAddr{IP: net.ParseIP(ip)})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_ = b.AttachWS(nc)
|
||||||
|
})
|
||||||
|
}
|
||||||
+142
-5
@@ -2,11 +2,16 @@ package config
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"net"
|
||||||
"os"
|
"os"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"go.yaml.in/yaml/v3"
|
"go.yaml.in/yaml/v3"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// MaxBodyBytesCap 是 max_body_bytes 的硬上限(DEVELOPMENT 11.1)。
|
||||||
|
const MaxBodyBytesCap = 262144
|
||||||
|
|
||||||
// Config 对应 DEVELOPMENT 第 11.1 节的配置文件。
|
// Config 对应 DEVELOPMENT 第 11.1 节的配置文件。
|
||||||
type Config struct {
|
type Config struct {
|
||||||
Listen string `yaml:"listen"`
|
Listen string `yaml:"listen"`
|
||||||
@@ -65,7 +70,7 @@ func Default() Config {
|
|||||||
TrustedProxies: nil,
|
TrustedProxies: nil,
|
||||||
DataDir: "./data",
|
DataDir: "./data",
|
||||||
Limits: LimitsConfig{
|
Limits: LimitsConfig{
|
||||||
MaxBodyBytes: 262144,
|
MaxBodyBytes: MaxBodyBytesCap,
|
||||||
MaxMetaBytes: 4096,
|
MaxMetaBytes: 4096,
|
||||||
MaxFrameBytes: 786432,
|
MaxFrameBytes: 786432,
|
||||||
MaxTTLSeconds: 2592000,
|
MaxTTLSeconds: 2592000,
|
||||||
@@ -101,16 +106,148 @@ func Load(path string) (Config, error) {
|
|||||||
if err := yaml.Unmarshal(data, &cfg); err != nil {
|
if err := yaml.Unmarshal(data, &cfg); err != nil {
|
||||||
return Config{}, fmt.Errorf("parse config: %w", err)
|
return Config{}, fmt.Errorf("parse config: %w", err)
|
||||||
}
|
}
|
||||||
|
applyEmptyDefaults(&cfg)
|
||||||
|
return cfg, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func applyEmptyDefaults(cfg *Config) {
|
||||||
|
def := Default()
|
||||||
if cfg.Listen == "" {
|
if cfg.Listen == "" {
|
||||||
cfg.Listen = Default().Listen
|
cfg.Listen = def.Listen
|
||||||
}
|
}
|
||||||
if cfg.DataDir == "" {
|
if cfg.DataDir == "" {
|
||||||
cfg.DataDir = Default().DataDir
|
cfg.DataDir = def.DataDir
|
||||||
}
|
}
|
||||||
if cfg.SQLiteSynchronous == "" {
|
if cfg.SQLiteSynchronous == "" {
|
||||||
cfg.SQLiteSynchronous = Default().SQLiteSynchronous
|
cfg.SQLiteSynchronous = def.SQLiteSynchronous
|
||||||
}
|
}
|
||||||
return cfg, nil
|
if cfg.Log.Level == "" {
|
||||||
|
cfg.Log.Level = def.Log.Level
|
||||||
|
}
|
||||||
|
if cfg.Limits.MaxBodyBytes == 0 {
|
||||||
|
cfg.Limits.MaxBodyBytes = def.Limits.MaxBodyBytes
|
||||||
|
}
|
||||||
|
if cfg.Limits.MaxMetaBytes == 0 {
|
||||||
|
cfg.Limits.MaxMetaBytes = def.Limits.MaxMetaBytes
|
||||||
|
}
|
||||||
|
if cfg.Limits.MaxFrameBytes == 0 {
|
||||||
|
cfg.Limits.MaxFrameBytes = def.Limits.MaxFrameBytes
|
||||||
|
}
|
||||||
|
if cfg.Limits.MaxTTLSeconds == 0 {
|
||||||
|
cfg.Limits.MaxTTLSeconds = def.Limits.MaxTTLSeconds
|
||||||
|
}
|
||||||
|
if cfg.Limits.MaxScheduleSeconds == 0 {
|
||||||
|
cfg.Limits.MaxScheduleSeconds = def.Limits.MaxScheduleSeconds
|
||||||
|
}
|
||||||
|
if cfg.Limits.MaxGroupMembers == 0 {
|
||||||
|
cfg.Limits.MaxGroupMembers = def.Limits.MaxGroupMembers
|
||||||
|
}
|
||||||
|
if cfg.Limits.GraceSeconds == 0 {
|
||||||
|
cfg.Limits.GraceSeconds = def.Limits.GraceSeconds
|
||||||
|
}
|
||||||
|
if cfg.Limits.AckTimeoutSeconds == 0 {
|
||||||
|
cfg.Limits.AckTimeoutSeconds = def.Limits.AckTimeoutSeconds
|
||||||
|
}
|
||||||
|
if cfg.Limits.DeliveryWindow == 0 {
|
||||||
|
cfg.Limits.DeliveryWindow = def.Limits.DeliveryWindow
|
||||||
|
}
|
||||||
|
if cfg.Limits.ReceiptWindow == 0 {
|
||||||
|
cfg.Limits.ReceiptWindow = def.Limits.ReceiptWindow
|
||||||
|
}
|
||||||
|
if cfg.Limits.RequestsPerSecond == 0 {
|
||||||
|
cfg.Limits.RequestsPerSecond = def.Limits.RequestsPerSecond
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate 校验 DEVELOPMENT 11.1 全部字段;拒绝 max_body_bytes > 262144。
|
||||||
|
func (c Config) Validate() error {
|
||||||
|
var errs []string
|
||||||
|
if strings.TrimSpace(c.Listen) == "" {
|
||||||
|
errs = append(errs, "listen is required")
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(c.DataDir) == "" {
|
||||||
|
errs = append(errs, "data_dir is required")
|
||||||
|
}
|
||||||
|
sync := strings.ToUpper(strings.TrimSpace(c.SQLiteSynchronous))
|
||||||
|
if sync != "FULL" && sync != "NORMAL" {
|
||||||
|
errs = append(errs, "sqlite_synchronous must be FULL or NORMAL")
|
||||||
|
}
|
||||||
|
switch strings.ToLower(strings.TrimSpace(c.Log.Level)) {
|
||||||
|
case "debug", "info", "warn", "warning", "error":
|
||||||
|
default:
|
||||||
|
errs = append(errs, "log.level must be debug, info, warn, or error")
|
||||||
|
}
|
||||||
|
if c.Limits.MaxBodyBytes <= 0 {
|
||||||
|
errs = append(errs, "limits.max_body_bytes must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.MaxBodyBytes > MaxBodyBytesCap {
|
||||||
|
errs = append(errs, fmt.Sprintf("limits.max_body_bytes must be <= %d", MaxBodyBytesCap))
|
||||||
|
}
|
||||||
|
if c.Limits.MaxMetaBytes <= 0 {
|
||||||
|
errs = append(errs, "limits.max_meta_bytes must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.MaxFrameBytes <= 0 {
|
||||||
|
errs = append(errs, "limits.max_frame_bytes must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.MaxFrameBytes < c.Limits.MaxBodyBytes {
|
||||||
|
errs = append(errs, "limits.max_frame_bytes must be >= limits.max_body_bytes")
|
||||||
|
}
|
||||||
|
if c.Limits.MaxTTLSeconds <= 0 {
|
||||||
|
errs = append(errs, "limits.max_ttl_seconds must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.MaxScheduleSeconds <= 0 {
|
||||||
|
errs = append(errs, "limits.max_schedule_seconds must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.MaxGroupMembers <= 0 {
|
||||||
|
errs = append(errs, "limits.max_group_members must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.GraceSeconds < 0 {
|
||||||
|
errs = append(errs, "limits.grace_seconds must be >= 0")
|
||||||
|
}
|
||||||
|
if c.Limits.AckTimeoutSeconds <= 0 {
|
||||||
|
errs = append(errs, "limits.ack_timeout_seconds must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.DeliveryWindow <= 0 {
|
||||||
|
errs = append(errs, "limits.delivery_window must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.ReceiptWindow <= 0 {
|
||||||
|
errs = append(errs, "limits.receipt_window must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.RequestsPerSecond <= 0 {
|
||||||
|
errs = append(errs, "limits.requests_per_second must be > 0")
|
||||||
|
}
|
||||||
|
if c.Limits.MaxPendingPerSender < 0 {
|
||||||
|
errs = append(errs, "limits.max_pending_per_sender must be >= 0")
|
||||||
|
}
|
||||||
|
if c.Limits.MaxPendingPerReceiver < 0 {
|
||||||
|
errs = append(errs, "limits.max_pending_per_receiver must be >= 0")
|
||||||
|
}
|
||||||
|
if c.SessionIdleDays < 0 {
|
||||||
|
errs = append(errs, "session_idle_days must be >= 0")
|
||||||
|
}
|
||||||
|
if c.RecordRetentionDays < 0 {
|
||||||
|
errs = append(errs, "record_retention_days must be >= 0")
|
||||||
|
}
|
||||||
|
if c.IdempotencyHours < 0 {
|
||||||
|
errs = append(errs, "idempotency_hours must be >= 0")
|
||||||
|
}
|
||||||
|
if c.ReceiptRetentionDays < 0 {
|
||||||
|
errs = append(errs, "receipt_retention_days must be >= 0")
|
||||||
|
}
|
||||||
|
cert := strings.TrimSpace(c.TLS.CertFile)
|
||||||
|
key := strings.TrimSpace(c.TLS.KeyFile)
|
||||||
|
if (cert == "") != (key == "") {
|
||||||
|
errs = append(errs, "tls.cert_file and tls.key_file must both be set or both empty")
|
||||||
|
}
|
||||||
|
for _, cidr := range c.TrustedProxies {
|
||||||
|
if _, _, err := net.ParseCIDR(strings.TrimSpace(cidr)); err != nil {
|
||||||
|
errs = append(errs, fmt.Sprintf("trusted_proxies entry %q is not a valid CIDR", cidr))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(errs) > 0 {
|
||||||
|
return fmt.Errorf("invalid config: %s", strings.Join(errs, "; "))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// PathFromEnv 返回 NIXMSG_CONFIG 或默认 ./config.yaml。
|
// PathFromEnv 返回 NIXMSG_CONFIG 或默认 ./config.yaml。
|
||||||
|
|||||||
@@ -0,0 +1,62 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestValidateDefaultOK(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
cfg := Default()
|
||||||
|
if err := cfg.Validate(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateRejectsMaxBodyBytesTooLarge(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
cfg := Default()
|
||||||
|
cfg.Limits.MaxBodyBytes = MaxBodyBytesCap + 1
|
||||||
|
err := cfg.Validate()
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected error")
|
||||||
|
}
|
||||||
|
if !strings.Contains(err.Error(), "max_body_bytes") {
|
||||||
|
t.Fatalf("unexpected error: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadAndValidate(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
dir := t.TempDir()
|
||||||
|
path := filepath.Join(dir, "config.yaml")
|
||||||
|
body := "listen: \"127.0.0.1:0\"\ndata_dir: \"" + filepath.ToSlash(dir) + "\"\n"
|
||||||
|
if err := os.WriteFile(path, []byte(body), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
cfg, err := Load(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := cfg.Validate(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if cfg.Listen != "127.0.0.1:0" {
|
||||||
|
t.Fatalf("listen=%q", cfg.Listen)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestValidateTrustedProxies(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
cfg := Default()
|
||||||
|
cfg.TrustedProxies = []string{"not-a-cidr"}
|
||||||
|
if err := cfg.Validate(); err == nil {
|
||||||
|
t.Fatal("expected error")
|
||||||
|
}
|
||||||
|
cfg.TrustedProxies = []string{"127.0.0.1/32"}
|
||||||
|
if err := cfg.Validate(); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
package listener
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net"
|
||||||
|
"sync"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ChanListener 是从通道取连接的 net.Listener,交给同一个 http.Server。
|
||||||
|
type ChanListener struct {
|
||||||
|
addr net.Addr
|
||||||
|
ch chan net.Conn
|
||||||
|
closed chan struct{}
|
||||||
|
once sync.Once
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewChanListener 创建缓冲通道监听器;addr 仅用于 Addr()。
|
||||||
|
func NewChanListener(addr net.Addr, buf int) *ChanListener {
|
||||||
|
if buf < 1 {
|
||||||
|
buf = 64
|
||||||
|
}
|
||||||
|
if addr == nil {
|
||||||
|
addr = &net.TCPAddr{IP: net.IPv4zero, Port: 0}
|
||||||
|
}
|
||||||
|
return &ChanListener{
|
||||||
|
addr: addr,
|
||||||
|
ch: make(chan net.Conn, buf),
|
||||||
|
closed: make(chan struct{}),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Addr 返回构造时给出的地址。
|
||||||
|
func (l *ChanListener) Addr() net.Addr { return l.addr }
|
||||||
|
|
||||||
|
// Accept 阻塞直到有连接或关闭。
|
||||||
|
func (l *ChanListener) Accept() (net.Conn, error) {
|
||||||
|
select {
|
||||||
|
case <-l.closed:
|
||||||
|
return nil, net.ErrClosed
|
||||||
|
case c, ok := <-l.ch:
|
||||||
|
if !ok {
|
||||||
|
return nil, net.ErrClosed
|
||||||
|
}
|
||||||
|
return c, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close 关闭监听器并唤醒 Accept。
|
||||||
|
func (l *ChanListener) Close() error {
|
||||||
|
l.once.Do(func() {
|
||||||
|
close(l.closed)
|
||||||
|
})
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enqueue 把识别为 HTTP 的连接交给 http.Server;已关闭时丢弃并关闭连接。
|
||||||
|
func (l *ChanListener) Enqueue(c net.Conn) {
|
||||||
|
select {
|
||||||
|
case <-l.closed:
|
||||||
|
_ = c.Close()
|
||||||
|
case l.ch <- c:
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,76 @@
|
|||||||
|
package listener
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bufio"
|
||||||
|
"net"
|
||||||
|
"strconv"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
const firstByteTimeout = 10 * time.Second
|
||||||
|
|
||||||
|
// bufferedConn 把已读字节放回连接,供后续 TLS/HTTP/MQTT 继续读。
|
||||||
|
type bufferedConn struct {
|
||||||
|
net.Conn
|
||||||
|
r *bufio.Reader
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *bufferedConn) Read(p []byte) (int, error) {
|
||||||
|
return c.r.Read(p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func wrapBuffered(c net.Conn) *bufferedConn {
|
||||||
|
if bc, ok := c.(*bufferedConn); ok {
|
||||||
|
return bc
|
||||||
|
}
|
||||||
|
return &bufferedConn{Conn: c, r: bufio.NewReader(c)}
|
||||||
|
}
|
||||||
|
|
||||||
|
// peekFirstByte 在超时内读首字节并 Unread,返回仍可读完整流的连接。
|
||||||
|
func peekFirstByte(c net.Conn) (net.Conn, byte, error) {
|
||||||
|
bc := wrapBuffered(c)
|
||||||
|
_ = bc.SetReadDeadline(time.Now().Add(firstByteTimeout))
|
||||||
|
b, err := bc.r.ReadByte()
|
||||||
|
_ = bc.SetReadDeadline(time.Time{})
|
||||||
|
if err != nil {
|
||||||
|
return nil, 0, err
|
||||||
|
}
|
||||||
|
if err := bc.r.UnreadByte(); err != nil {
|
||||||
|
return nil, 0, err
|
||||||
|
}
|
||||||
|
return bc, b, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// addrConn 只改 RemoteAddr,用于受信任代理后的真实 IP。
|
||||||
|
type addrConn struct {
|
||||||
|
net.Conn
|
||||||
|
remote net.Addr
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *addrConn) RemoteAddr() net.Addr {
|
||||||
|
if c.remote != nil {
|
||||||
|
return c.remote
|
||||||
|
}
|
||||||
|
return c.Conn.RemoteAddr()
|
||||||
|
}
|
||||||
|
|
||||||
|
// WithRemoteAddr 包装连接,使 RemoteAddr 返回指定地址(通常是解析出的客户端 IP)。
|
||||||
|
func WithRemoteAddr(c net.Conn, remote net.Addr) net.Conn {
|
||||||
|
if remote == nil {
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
return &addrConn{Conn: c, remote: remote}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TCPAddrFromIPPort 把 "ip:port" 或纯 IP 转成 *net.TCPAddr。
|
||||||
|
func TCPAddrFromIPPort(ipPort string) *net.TCPAddr {
|
||||||
|
if ipPort == "" {
|
||||||
|
return &net.TCPAddr{}
|
||||||
|
}
|
||||||
|
host, portStr, err := net.SplitHostPort(ipPort)
|
||||||
|
if err != nil {
|
||||||
|
return &net.TCPAddr{IP: net.ParseIP(ipPort)}
|
||||||
|
}
|
||||||
|
port, _ := strconv.Atoi(portStr)
|
||||||
|
return &net.TCPAddr{IP: net.ParseIP(host), Port: port}
|
||||||
|
}
|
||||||
@@ -0,0 +1,398 @@
|
|||||||
|
package listener
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/ecdsa"
|
||||||
|
"crypto/elliptic"
|
||||||
|
"crypto/rand"
|
||||||
|
"crypto/tls"
|
||||||
|
"crypto/x509"
|
||||||
|
"crypto/x509/pkix"
|
||||||
|
"encoding/pem"
|
||||||
|
"io"
|
||||||
|
"math/big"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestIdentifyPlainHTTPAndMQTT(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
gotMQTT := make(chan net.Conn, 1)
|
||||||
|
mux := NewMux(RoleShared, Handlers{
|
||||||
|
Healthz: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
_, _ = w.Write([]byte("ok"))
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
s, err := New(Options{
|
||||||
|
Listen: "127.0.0.1:0",
|
||||||
|
DataDir: dir,
|
||||||
|
ClientHandler: mux,
|
||||||
|
AllowPlaintext: true,
|
||||||
|
OnMQTT: func(c net.Conn) {
|
||||||
|
gotMQTT <- c
|
||||||
|
buf := make([]byte, 1)
|
||||||
|
_, _ = c.Read(buf)
|
||||||
|
_ = c.Close()
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
if startErr := s.Start(ctx); startErr != nil {
|
||||||
|
t.Fatal(startErr)
|
||||||
|
}
|
||||||
|
defer func() { _ = s.Close() }()
|
||||||
|
|
||||||
|
addr := s.ListenAddr()
|
||||||
|
if addr == "" {
|
||||||
|
t.Fatal("empty listen addr")
|
||||||
|
}
|
||||||
|
b, err := os.ReadFile(filepath.Join(dir, "listen.addr"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if string(b) != addr+"\n" {
|
||||||
|
t.Fatalf("listen.addr=%q want %q", b, addr+"\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := http.Get("http://" + addr + "/healthz")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
body, _ := io.ReadAll(resp.Body)
|
||||||
|
_ = resp.Body.Close()
|
||||||
|
if resp.StatusCode != 200 || string(body) != "ok" {
|
||||||
|
t.Fatalf("healthz: %d %q", resp.StatusCode, body)
|
||||||
|
}
|
||||||
|
|
||||||
|
c, err := net.DialTimeout("tcp", addr, 2*time.Second)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_, _ = c.Write([]byte{0x10, 0x00})
|
||||||
|
select {
|
||||||
|
case mc := <-gotMQTT:
|
||||||
|
_ = mc.Close()
|
||||||
|
case <-time.After(3 * time.Second):
|
||||||
|
t.Fatal("mqtt not delivered")
|
||||||
|
}
|
||||||
|
_ = c.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIdentifyTLSHTTPAndMQTT(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
certPath, keyPath := writeTestCert(t, dir, "old")
|
||||||
|
gotMQTT := make(chan net.Conn, 1)
|
||||||
|
mux := NewMux(RoleShared, Handlers{
|
||||||
|
Healthz: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
_, _ = w.Write([]byte("tls-ok"))
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
s, err := New(Options{
|
||||||
|
Listen: "127.0.0.1:0",
|
||||||
|
DataDir: dir,
|
||||||
|
CertFile: certPath,
|
||||||
|
KeyFile: keyPath,
|
||||||
|
AllowPlaintext: false,
|
||||||
|
ClientHandler: mux,
|
||||||
|
OnMQTT: func(c net.Conn) {
|
||||||
|
gotMQTT <- c
|
||||||
|
_ = c.Close()
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
if startErr := s.Start(ctx); startErr != nil {
|
||||||
|
t.Fatal(startErr)
|
||||||
|
}
|
||||||
|
defer func() { _ = s.Close() }()
|
||||||
|
|
||||||
|
addr := s.ListenAddr()
|
||||||
|
tlsCfg := &tls.Config{InsecureSkipVerify: true}
|
||||||
|
|
||||||
|
// TLS + HTTP
|
||||||
|
tr := &http.Transport{TLSClientConfig: tlsCfg}
|
||||||
|
client := &http.Client{Transport: tr, Timeout: 5 * time.Second}
|
||||||
|
resp, err := client.Get("https://" + addr + "/healthz")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
body, _ := io.ReadAll(resp.Body)
|
||||||
|
_ = resp.Body.Close()
|
||||||
|
if string(body) != "tls-ok" {
|
||||||
|
t.Fatalf("body=%q", body)
|
||||||
|
}
|
||||||
|
|
||||||
|
// TLS + MQTT (0x10 after handshake)
|
||||||
|
raw, err := tls.Dial("tcp", addr, tlsCfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_, _ = raw.Write([]byte{0x10})
|
||||||
|
select {
|
||||||
|
case mc := <-gotMQTT:
|
||||||
|
_ = mc.Close()
|
||||||
|
case <-time.After(3 * time.Second):
|
||||||
|
t.Fatal("tls mqtt not delivered")
|
||||||
|
}
|
||||||
|
_ = raw.Close()
|
||||||
|
|
||||||
|
// ALPN mqtt 客户端仍能握手(服务端不设 NextProtos)
|
||||||
|
alpn, err := tls.Dial("tcp", addr, &tls.Config{
|
||||||
|
InsecureSkipVerify: true,
|
||||||
|
NextProtos: []string{"mqtt"},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("alpn mqtt handshake: %v", err)
|
||||||
|
}
|
||||||
|
_ = alpn.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCertReloadUsesNewCert(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
certPath, keyPath := writeTestCert(t, dir, "v1")
|
||||||
|
cr, err := NewCertReloader(certPath, keyPath, nil)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer cr.Close()
|
||||||
|
old := cr.Certificate()
|
||||||
|
if old == nil {
|
||||||
|
t.Fatal("nil cert")
|
||||||
|
}
|
||||||
|
|
||||||
|
time.Sleep(20 * time.Millisecond) // 保证 mtime 变化
|
||||||
|
certPath2, keyPath2 := writeTestCert(t, dir, "v2")
|
||||||
|
// 覆盖原路径
|
||||||
|
data, _ := os.ReadFile(certPath2)
|
||||||
|
_ = os.WriteFile(certPath, data, 0o644)
|
||||||
|
data, _ = os.ReadFile(keyPath2)
|
||||||
|
_ = os.WriteFile(keyPath, data, 0o644)
|
||||||
|
|
||||||
|
if reloadErr := cr.ReloadNow(); reloadErr != nil {
|
||||||
|
t.Fatal(reloadErr)
|
||||||
|
}
|
||||||
|
neu := cr.Certificate()
|
||||||
|
if neu == nil || neu == old {
|
||||||
|
t.Fatal("certificate not reloaded")
|
||||||
|
}
|
||||||
|
|
||||||
|
// 完整服务:重载后新连接用新证书(用 Leaf CN 区分)
|
||||||
|
mux := NewMux(RoleShared, Handlers{})
|
||||||
|
s, err := New(Options{
|
||||||
|
Listen: "127.0.0.1:0",
|
||||||
|
DataDir: dir,
|
||||||
|
CertFile: certPath,
|
||||||
|
KeyFile: keyPath,
|
||||||
|
ClientHandler: mux,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
if startErr := s.Start(ctx); startErr != nil {
|
||||||
|
t.Fatal(startErr)
|
||||||
|
}
|
||||||
|
defer func() { _ = s.Close() }()
|
||||||
|
|
||||||
|
// 再换一版证书
|
||||||
|
time.Sleep(20 * time.Millisecond)
|
||||||
|
c3, k3 := writeTestCert(t, dir, "v3")
|
||||||
|
data, _ = os.ReadFile(c3)
|
||||||
|
_ = os.WriteFile(certPath, data, 0o644)
|
||||||
|
data, _ = os.ReadFile(k3)
|
||||||
|
_ = os.WriteFile(keyPath, data, 0o644)
|
||||||
|
if reloadErr := s.certs.ReloadNow(); reloadErr != nil {
|
||||||
|
t.Fatal(reloadErr)
|
||||||
|
}
|
||||||
|
|
||||||
|
conn, err := tls.Dial("tcp", s.ListenAddr(), &tls.Config{InsecureSkipVerify: true})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = conn.Close() }()
|
||||||
|
state := conn.ConnectionState()
|
||||||
|
if len(state.PeerCertificates) == 0 {
|
||||||
|
t.Fatal("no peer cert")
|
||||||
|
}
|
||||||
|
if cn := state.PeerCertificates[0].Subject.CommonName; cn != "v3" {
|
||||||
|
t.Fatalf("cn=%q want v3", cn)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestAdminSeparateMQTTClosedAndAdmin404OnListen(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
clientMux := NewMux(RoleClient, Handlers{
|
||||||
|
Healthz: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
_, _ = w.Write([]byte("client"))
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
adminMux := NewMux(RoleAdmin, Handlers{
|
||||||
|
AdminAPI: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
_, _ = w.Write([]byte("admin"))
|
||||||
|
}),
|
||||||
|
Healthz: http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
_, _ = w.Write([]byte("admin-health"))
|
||||||
|
}),
|
||||||
|
})
|
||||||
|
mqttSeen := make(chan struct{}, 1)
|
||||||
|
s, err := New(Options{
|
||||||
|
Listen: "127.0.0.1:0",
|
||||||
|
AdminListen: "127.0.0.1:0",
|
||||||
|
DataDir: dir,
|
||||||
|
AllowPlaintext: true,
|
||||||
|
ClientHandler: clientMux,
|
||||||
|
AdminHandler: adminMux,
|
||||||
|
OnMQTT: func(c net.Conn) {
|
||||||
|
mqttSeen <- struct{}{}
|
||||||
|
_ = c.Close()
|
||||||
|
},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
if startErr := s.Start(ctx); startErr != nil {
|
||||||
|
t.Fatal(startErr)
|
||||||
|
}
|
||||||
|
defer func() { _ = s.Close() }()
|
||||||
|
|
||||||
|
// listen 上 /api/admin/ 404
|
||||||
|
resp, err := http.Get("http://" + s.ListenAddr() + "/api/admin/x")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_ = resp.Body.Close()
|
||||||
|
if resp.StatusCode != 404 {
|
||||||
|
t.Fatalf("listen admin status=%d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
|
||||||
|
// admin 上 API 可用
|
||||||
|
resp, err = http.Get("http://" + s.AdminAddr() + "/api/admin/x")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
body, _ := io.ReadAll(resp.Body)
|
||||||
|
_ = resp.Body.Close()
|
||||||
|
if string(body) != "admin" {
|
||||||
|
t.Fatalf("admin body=%q", body)
|
||||||
|
}
|
||||||
|
|
||||||
|
// admin_listen 上裸 MQTT 关闭,不回调
|
||||||
|
ac, err := net.DialTimeout("tcp", s.AdminAddr(), 2*time.Second)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_, _ = ac.Write([]byte{0x10})
|
||||||
|
time.Sleep(200 * time.Millisecond)
|
||||||
|
buf := make([]byte, 1)
|
||||||
|
_ = ac.SetReadDeadline(time.Now().Add(500 * time.Millisecond))
|
||||||
|
_, readErr := ac.Read(buf)
|
||||||
|
_ = ac.Close()
|
||||||
|
if readErr == nil {
|
||||||
|
t.Fatal("expected admin mqtt connection closed")
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-mqttSeen:
|
||||||
|
t.Fatal("mqtt should not be accepted on admin")
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := os.ReadFile(filepath.Join(dir, "admin.addr")); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTrustedProxyClientIP(t *testing.T) {
|
||||||
|
ps, err := ParseTrustedProxies([]string{"10.0.0.0/8", "192.168.1.1"})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
r := &http.Request{
|
||||||
|
RemoteAddr: "10.1.2.3:1234",
|
||||||
|
Header: http.Header{"X-Forwarded-For": []string{"1.1.1.1, 10.9.9.9"}},
|
||||||
|
}
|
||||||
|
if got := ps.ClientIP(r); got != "1.1.1.1" {
|
||||||
|
t.Fatalf("got %q", got)
|
||||||
|
}
|
||||||
|
// 非代理来源忽略头
|
||||||
|
r2 := &http.Request{
|
||||||
|
RemoteAddr: "8.8.8.8:9",
|
||||||
|
Header: http.Header{"X-Forwarded-For": []string{"1.1.1.1"}},
|
||||||
|
}
|
||||||
|
if got := ps.ClientIP(r2); got != "8.8.8.8" {
|
||||||
|
t.Fatalf("got %q", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFirstByteTimeout(t *testing.T) {
|
||||||
|
c1, c2 := net.Pipe()
|
||||||
|
defer func() { _ = c1.Close() }()
|
||||||
|
defer func() { _ = c2.Close() }()
|
||||||
|
done := make(chan error, 1)
|
||||||
|
go func() {
|
||||||
|
_, _, err := peekFirstByte(c2)
|
||||||
|
done <- err
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case err := <-done:
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("expected timeout error")
|
||||||
|
}
|
||||||
|
case <-time.After(12 * time.Second):
|
||||||
|
t.Fatal("peek did not time out")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeTestCert(t *testing.T, dir, cn string) (certPath, keyPath string) {
|
||||||
|
t.Helper()
|
||||||
|
key, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
tmpl := &x509.Certificate{
|
||||||
|
SerialNumber: big.NewInt(time.Now().UnixNano()),
|
||||||
|
Subject: pkix.Name{CommonName: cn},
|
||||||
|
NotBefore: time.Now().Add(-time.Hour),
|
||||||
|
NotAfter: time.Now().Add(24 * time.Hour),
|
||||||
|
KeyUsage: x509.KeyUsageDigitalSignature | x509.KeyUsageKeyEncipherment,
|
||||||
|
ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth},
|
||||||
|
DNSNames: []string{"localhost"},
|
||||||
|
IPAddresses: []net.IP{net.ParseIP("127.0.0.1")},
|
||||||
|
}
|
||||||
|
der, err := x509.CreateCertificate(rand.Reader, tmpl, tmpl, &key.PublicKey, key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
certPath = filepath.Join(dir, cn+".crt")
|
||||||
|
keyPath = filepath.Join(dir, cn+".key")
|
||||||
|
certOut, err := os.Create(certPath)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_ = pem.Encode(certOut, &pem.Block{Type: "CERTIFICATE", Bytes: der})
|
||||||
|
_ = certOut.Close()
|
||||||
|
keyOut, err := os.Create(keyPath)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
b, err := x509.MarshalECPrivateKey(key)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
_ = pem.Encode(keyOut, &pem.Block{Type: "EC PRIVATE KEY", Bytes: b})
|
||||||
|
_ = keyOut.Close()
|
||||||
|
return certPath, keyPath
|
||||||
|
}
|
||||||
@@ -0,0 +1,101 @@
|
|||||||
|
package listener
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ProxySet 保存受信任代理地址段。
|
||||||
|
type ProxySet struct {
|
||||||
|
nets []*net.IPNet
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseTrustedProxies 解析 CIDR 或单 IP 列表。
|
||||||
|
func ParseTrustedProxies(cidrs []string) (*ProxySet, error) {
|
||||||
|
ps := &ProxySet{}
|
||||||
|
for _, s := range cidrs {
|
||||||
|
s = strings.TrimSpace(s)
|
||||||
|
if s == "" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !strings.Contains(s, "/") {
|
||||||
|
ip := net.ParseIP(s)
|
||||||
|
if ip == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if ip.To4() != nil {
|
||||||
|
s += "/32"
|
||||||
|
} else {
|
||||||
|
s += "/128"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_, n, err := net.ParseCIDR(s)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
ps.nets = append(ps.nets, n)
|
||||||
|
}
|
||||||
|
return ps, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Contains 判断 IP 是否在受信任段内。
|
||||||
|
func (ps *ProxySet) Contains(ip net.IP) bool {
|
||||||
|
if ps == nil || ip == nil {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, n := range ps.nets {
|
||||||
|
if n.Contains(ip) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// ClientIP 按 DEVELOPMENT 4.5:来自受信任代理时,取 X-Forwarded-For 从右往左第一个不在段内的 IP。
|
||||||
|
// 非代理来源忽略转发头,返回 RemoteAddr 的 IP。
|
||||||
|
func (ps *ProxySet) ClientIP(r *http.Request) string {
|
||||||
|
remoteIP := ipFromAddr(r.RemoteAddr)
|
||||||
|
if ps == nil || remoteIP == nil || !ps.Contains(remoteIP) {
|
||||||
|
if remoteIP != nil {
|
||||||
|
return remoteIP.String()
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
xff := r.Header.Get("X-Forwarded-For")
|
||||||
|
if xff == "" {
|
||||||
|
return remoteIP.String()
|
||||||
|
}
|
||||||
|
parts := strings.Split(xff, ",")
|
||||||
|
for i := len(parts) - 1; i >= 0; i-- {
|
||||||
|
ipStr := strings.TrimSpace(parts[i])
|
||||||
|
ip := net.ParseIP(ipStr)
|
||||||
|
if ip == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if !ps.Contains(ip) {
|
||||||
|
return ip.String()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return remoteIP.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsHTTPS 来自受信任代理时按 X-Forwarded-Proto 判断。
|
||||||
|
func (ps *ProxySet) IsHTTPS(r *http.Request) bool {
|
||||||
|
if r.TLS != nil {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
remoteIP := ipFromAddr(r.RemoteAddr)
|
||||||
|
if ps == nil || remoteIP == nil || !ps.Contains(remoteIP) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return strings.EqualFold(r.Header.Get("X-Forwarded-Proto"), "https")
|
||||||
|
}
|
||||||
|
|
||||||
|
func ipFromAddr(remoteAddr string) net.IP {
|
||||||
|
host, _, err := net.SplitHostPort(remoteAddr)
|
||||||
|
if err != nil {
|
||||||
|
return net.ParseIP(remoteAddr)
|
||||||
|
}
|
||||||
|
return net.ParseIP(host)
|
||||||
|
}
|
||||||
@@ -0,0 +1,124 @@
|
|||||||
|
package listener
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// RouteRole 区分监听用途,决定哪些路径可用。
|
||||||
|
type RouteRole int
|
||||||
|
|
||||||
|
const (
|
||||||
|
// RoleShared listen 与 admin 共用同一端口。
|
||||||
|
RoleShared RouteRole = iota
|
||||||
|
// RoleClient 仅端接入(admin_listen 已分离)。
|
||||||
|
RoleClient
|
||||||
|
// RoleAdmin 仅后台。
|
||||||
|
RoleAdmin
|
||||||
|
)
|
||||||
|
|
||||||
|
// Handlers 由上层注入各路径处理函数;未设置的路径返回 404。
|
||||||
|
type Handlers struct {
|
||||||
|
MQTT http.Handler // /mqtt
|
||||||
|
ClientAPI http.Handler // /api/client/
|
||||||
|
AdminAPI http.Handler // /api/admin/
|
||||||
|
Metrics http.Handler // /metrics
|
||||||
|
Static http.Handler // 后台静态页
|
||||||
|
Healthz http.Handler // /healthz
|
||||||
|
Readyz http.Handler // /readyz
|
||||||
|
// MetricsToken 共用端口时校验 Authorization: Bearer;空则 /metrics 404。
|
||||||
|
MetricsToken string
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewMux 按角色装配 HTTP 路由骨架。
|
||||||
|
func NewMux(role RouteRole, h Handlers) http.Handler {
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
|
||||||
|
healthz := h.Healthz
|
||||||
|
if healthz == nil {
|
||||||
|
healthz = http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
_, _ = w.Write([]byte("ok"))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
readyz := h.Readyz
|
||||||
|
if readyz == nil {
|
||||||
|
readyz = http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
_, _ = w.Write([]byte("ok"))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
mux.Handle("GET /healthz", healthz)
|
||||||
|
mux.Handle("GET /readyz", readyz)
|
||||||
|
|
||||||
|
switch role {
|
||||||
|
case RoleClient:
|
||||||
|
if h.MQTT != nil {
|
||||||
|
mux.Handle("/mqtt", h.MQTT)
|
||||||
|
}
|
||||||
|
if h.ClientAPI != nil {
|
||||||
|
mux.Handle("/api/client/", h.ClientAPI)
|
||||||
|
}
|
||||||
|
// 后台路径在端端口一律 404
|
||||||
|
mux.Handle("/api/admin/", http.NotFoundHandler())
|
||||||
|
mux.Handle("/metrics", http.NotFoundHandler())
|
||||||
|
mux.Handle("/", http.NotFoundHandler())
|
||||||
|
|
||||||
|
case RoleAdmin:
|
||||||
|
if h.AdminAPI != nil {
|
||||||
|
mux.Handle("/api/admin/", h.AdminAPI)
|
||||||
|
}
|
||||||
|
if h.Metrics != nil {
|
||||||
|
mux.Handle("GET /metrics", h.Metrics)
|
||||||
|
} else {
|
||||||
|
mux.Handle("GET /metrics", http.NotFoundHandler())
|
||||||
|
}
|
||||||
|
mux.Handle("/mqtt", http.NotFoundHandler())
|
||||||
|
mux.Handle("/api/client/", http.NotFoundHandler())
|
||||||
|
if h.Static != nil {
|
||||||
|
mux.Handle("/", h.Static)
|
||||||
|
} else {
|
||||||
|
mux.Handle("/", http.NotFoundHandler())
|
||||||
|
}
|
||||||
|
|
||||||
|
default: // RoleShared
|
||||||
|
if h.MQTT != nil {
|
||||||
|
mux.Handle("/mqtt", h.MQTT)
|
||||||
|
}
|
||||||
|
if h.ClientAPI != nil {
|
||||||
|
mux.Handle("/api/client/", h.ClientAPI)
|
||||||
|
}
|
||||||
|
if h.AdminAPI != nil {
|
||||||
|
mux.Handle("/api/admin/", h.AdminAPI)
|
||||||
|
}
|
||||||
|
mux.Handle("GET /metrics", metricsGate(h.MetricsToken, h.Metrics))
|
||||||
|
if h.Static != nil {
|
||||||
|
mux.Handle("/", h.Static)
|
||||||
|
} else {
|
||||||
|
mux.Handle("/", http.NotFoundHandler())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return mux
|
||||||
|
}
|
||||||
|
|
||||||
|
func metricsGate(token string, next http.Handler) http.Handler {
|
||||||
|
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if token == "" {
|
||||||
|
http.NotFound(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
auth := r.Header.Get("Authorization")
|
||||||
|
const prefix = "Bearer "
|
||||||
|
if !strings.HasPrefix(auth, prefix) || auth[len(prefix):] != token {
|
||||||
|
w.WriteHeader(http.StatusUnauthorized)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if next == nil {
|
||||||
|
http.NotFound(w, r)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
next.ServeHTTP(w, r)
|
||||||
|
})
|
||||||
|
}
|
||||||
@@ -0,0 +1,338 @@
|
|||||||
|
package listener
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/tls"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"log/slog"
|
||||||
|
"net"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Kind 识别结果。
|
||||||
|
type Kind int
|
||||||
|
|
||||||
|
const (
|
||||||
|
KindHTTP Kind = iota
|
||||||
|
KindMQTT
|
||||||
|
KindClosed
|
||||||
|
)
|
||||||
|
|
||||||
|
// Options 控制双端口识别与分流。
|
||||||
|
type Options struct {
|
||||||
|
Listen string
|
||||||
|
AdminListen string
|
||||||
|
DataDir string
|
||||||
|
CertFile string
|
||||||
|
KeyFile string
|
||||||
|
AllowPlaintext bool
|
||||||
|
TrustedProxies []string
|
||||||
|
// ClientHandler / AdminHandler 分别为端端口与后台端口的 HTTP 处理;AdminListen 为空时只用 ClientHandler。
|
||||||
|
ClientHandler http.Handler
|
||||||
|
AdminHandler http.Handler
|
||||||
|
// OnMQTT 在 listen 上识别到裸 MQTT(含 TLS 后)时调用;应阻塞到连接结束。
|
||||||
|
OnMQTT func(conn net.Conn)
|
||||||
|
Logger *slog.Logger
|
||||||
|
}
|
||||||
|
|
||||||
|
// Server 一个或两个 TCP 监听上的协议识别与分流。
|
||||||
|
type Server struct {
|
||||||
|
opts Options
|
||||||
|
log *slog.Logger
|
||||||
|
proxies *ProxySet
|
||||||
|
certs *CertReloader
|
||||||
|
|
||||||
|
clientHTTP *ChanListener
|
||||||
|
adminHTTP *ChanListener
|
||||||
|
clientSrv *http.Server
|
||||||
|
adminSrv *http.Server
|
||||||
|
|
||||||
|
clientLn net.Listener
|
||||||
|
adminLn net.Listener
|
||||||
|
|
||||||
|
listenAddr string
|
||||||
|
adminAddr string
|
||||||
|
writeListenAddr bool
|
||||||
|
writeAdminAddr bool
|
||||||
|
|
||||||
|
wg sync.WaitGroup
|
||||||
|
closed chan struct{}
|
||||||
|
closeOnce sync.Once
|
||||||
|
}
|
||||||
|
|
||||||
|
// New 校验选项并准备证书;不开始监听。
|
||||||
|
func New(opts Options) (*Server, error) {
|
||||||
|
if opts.Listen == "" {
|
||||||
|
return nil, errors.New("listener: listen is required")
|
||||||
|
}
|
||||||
|
if opts.ClientHandler == nil {
|
||||||
|
return nil, errors.New("listener: ClientHandler is required")
|
||||||
|
}
|
||||||
|
log := opts.Logger
|
||||||
|
if log == nil {
|
||||||
|
log = slog.Default()
|
||||||
|
}
|
||||||
|
ps, err := ParseTrustedProxies(opts.TrustedProxies)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("trusted_proxies: %w", err)
|
||||||
|
}
|
||||||
|
s := &Server{
|
||||||
|
opts: opts,
|
||||||
|
log: log,
|
||||||
|
proxies: ps,
|
||||||
|
closed: make(chan struct{}),
|
||||||
|
}
|
||||||
|
hasCert := opts.CertFile != "" && opts.KeyFile != ""
|
||||||
|
if hasCert {
|
||||||
|
cr, err := NewCertReloader(opts.CertFile, opts.KeyFile, log)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("tls: %w", err)
|
||||||
|
}
|
||||||
|
s.certs = cr
|
||||||
|
} else {
|
||||||
|
log.Warn("tls not configured; plaintext only")
|
||||||
|
}
|
||||||
|
s.writeListenAddr = isPortZero(opts.Listen)
|
||||||
|
s.writeAdminAddr = opts.AdminListen != "" && isPortZero(opts.AdminListen)
|
||||||
|
return s, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start 开始监听并分流;非阻塞,关闭用 Close。
|
||||||
|
func (s *Server) Start(ctx context.Context) error {
|
||||||
|
ln, err := net.Listen("tcp", s.opts.Listen)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("listen %s: %w", s.opts.Listen, err)
|
||||||
|
}
|
||||||
|
s.clientLn = ln
|
||||||
|
s.listenAddr = ln.Addr().String()
|
||||||
|
if s.writeListenAddr {
|
||||||
|
if err := writeAddrFile(s.opts.DataDir, "listen.addr", s.listenAddr); err != nil {
|
||||||
|
_ = ln.Close()
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
s.clientHTTP = NewChanListener(ln.Addr(), 128)
|
||||||
|
s.clientSrv = &http.Server{
|
||||||
|
Handler: s.opts.ClientHandler,
|
||||||
|
ReadHeaderTimeout: 10 * time.Second,
|
||||||
|
}
|
||||||
|
s.wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer s.wg.Done()
|
||||||
|
err := s.clientSrv.Serve(s.clientHTTP)
|
||||||
|
if err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||||
|
s.log.Error("client http serve", "err", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
s.wg.Add(1)
|
||||||
|
go s.acceptLoop(ln, false)
|
||||||
|
|
||||||
|
if s.opts.AdminListen != "" {
|
||||||
|
aln, err := net.Listen("tcp", s.opts.AdminListen)
|
||||||
|
if err != nil {
|
||||||
|
_ = s.Close()
|
||||||
|
return fmt.Errorf("admin_listen %s: %w", s.opts.AdminListen, err)
|
||||||
|
}
|
||||||
|
s.adminLn = aln
|
||||||
|
s.adminAddr = aln.Addr().String()
|
||||||
|
if s.writeAdminAddr {
|
||||||
|
if err := writeAddrFile(s.opts.DataDir, "admin.addr", s.adminAddr); err != nil {
|
||||||
|
_ = s.Close()
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
adminHandler := s.opts.AdminHandler
|
||||||
|
if adminHandler == nil {
|
||||||
|
adminHandler = http.NotFoundHandler()
|
||||||
|
}
|
||||||
|
s.adminHTTP = NewChanListener(aln.Addr(), 64)
|
||||||
|
s.adminSrv = &http.Server{
|
||||||
|
Handler: adminHandler,
|
||||||
|
ReadHeaderTimeout: 10 * time.Second,
|
||||||
|
}
|
||||||
|
s.wg.Add(1)
|
||||||
|
go func() {
|
||||||
|
defer s.wg.Done()
|
||||||
|
err := s.adminSrv.Serve(s.adminHTTP)
|
||||||
|
if err != nil && !errors.Is(err, http.ErrServerClosed) {
|
||||||
|
s.log.Error("admin http serve", "err", err)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
s.wg.Add(1)
|
||||||
|
go s.acceptLoop(aln, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
<-ctx.Done()
|
||||||
|
_ = s.Close()
|
||||||
|
}()
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ListenAddr 返回端监听实际地址。
|
||||||
|
func (s *Server) ListenAddr() string { return s.listenAddr }
|
||||||
|
|
||||||
|
// AdminAddr 返回后台监听实际地址(未分离时为空)。
|
||||||
|
func (s *Server) AdminAddr() string { return s.adminAddr }
|
||||||
|
|
||||||
|
// Proxies 返回受信任代理集合。
|
||||||
|
func (s *Server) Proxies() *ProxySet { return s.proxies }
|
||||||
|
|
||||||
|
// TLSConfig 返回当前 TLS 配置(未配置证书时为 nil)。
|
||||||
|
func (s *Server) TLSConfig() *tls.Config {
|
||||||
|
if s.certs == nil {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return s.certs.TLSConfig()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close 停止接受并关闭 HTTP。
|
||||||
|
func (s *Server) Close() error {
|
||||||
|
var first error
|
||||||
|
s.closeOnce.Do(func() {
|
||||||
|
close(s.closed)
|
||||||
|
if s.clientLn != nil {
|
||||||
|
_ = s.clientLn.Close()
|
||||||
|
}
|
||||||
|
if s.adminLn != nil {
|
||||||
|
_ = s.adminLn.Close()
|
||||||
|
}
|
||||||
|
shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
if s.clientSrv != nil {
|
||||||
|
if err := s.clientSrv.Shutdown(shutdownCtx); err != nil && first == nil {
|
||||||
|
first = err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if s.adminSrv != nil {
|
||||||
|
if err := s.adminSrv.Shutdown(shutdownCtx); err != nil && first == nil {
|
||||||
|
first = err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if s.clientHTTP != nil {
|
||||||
|
_ = s.clientHTTP.Close()
|
||||||
|
}
|
||||||
|
if s.adminHTTP != nil {
|
||||||
|
_ = s.adminHTTP.Close()
|
||||||
|
}
|
||||||
|
if s.certs != nil {
|
||||||
|
s.certs.Close()
|
||||||
|
}
|
||||||
|
})
|
||||||
|
s.wg.Wait()
|
||||||
|
return first
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) acceptLoop(ln net.Listener, isAdmin bool) {
|
||||||
|
defer s.wg.Done()
|
||||||
|
for {
|
||||||
|
c, err := ln.Accept()
|
||||||
|
if err != nil {
|
||||||
|
select {
|
||||||
|
case <-s.closed:
|
||||||
|
return
|
||||||
|
default:
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
s.wg.Add(1)
|
||||||
|
go func(conn net.Conn) {
|
||||||
|
defer s.wg.Done()
|
||||||
|
s.handleConn(conn, isAdmin)
|
||||||
|
}(c)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) handleConn(conn net.Conn, isAdmin bool) {
|
||||||
|
kind, out, err := s.classify(conn, isAdmin, false)
|
||||||
|
if err != nil || kind == KindClosed {
|
||||||
|
_ = conn.Close()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
switch kind {
|
||||||
|
case KindHTTP:
|
||||||
|
httpLn := s.clientHTTP
|
||||||
|
if isAdmin {
|
||||||
|
httpLn = s.adminHTTP
|
||||||
|
}
|
||||||
|
if httpLn == nil {
|
||||||
|
_ = out.Close()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
httpLn.Enqueue(out)
|
||||||
|
case KindMQTT:
|
||||||
|
if s.opts.OnMQTT != nil {
|
||||||
|
s.opts.OnMQTT(out)
|
||||||
|
} else {
|
||||||
|
_ = out.Close()
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
_ = out.Close()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// classify 读首字节分流;afterTLS 表示已在 TLS 内层再识别。
|
||||||
|
func (s *Server) classify(conn net.Conn, isAdmin, afterTLS bool) (Kind, net.Conn, error) {
|
||||||
|
c, b, err := peekFirstByte(conn)
|
||||||
|
if err != nil {
|
||||||
|
return KindClosed, nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
hasCert := s.certs != nil
|
||||||
|
allowPlain := s.opts.AllowPlaintext || !hasCert
|
||||||
|
|
||||||
|
if b == 0x16 {
|
||||||
|
if !hasCert {
|
||||||
|
return KindClosed, nil, errors.New("tls client hello but no certificate")
|
||||||
|
}
|
||||||
|
if afterTLS {
|
||||||
|
return KindClosed, nil, errors.New("nested tls")
|
||||||
|
}
|
||||||
|
tlsConn := tls.Server(c, s.certs.TLSConfig())
|
||||||
|
if err := tlsConn.Handshake(); err != nil {
|
||||||
|
return KindClosed, nil, err
|
||||||
|
}
|
||||||
|
return s.classify(tlsConn, isAdmin, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !allowPlain && !afterTLS {
|
||||||
|
// 配了证书且未允许明文:非 TLS 首字节直接关
|
||||||
|
return KindClosed, nil, errors.New("plaintext not allowed")
|
||||||
|
}
|
||||||
|
|
||||||
|
if b >= 'A' && b <= 'Z' {
|
||||||
|
return KindHTTP, c, nil
|
||||||
|
}
|
||||||
|
if b == 0x10 {
|
||||||
|
if isAdmin {
|
||||||
|
return KindClosed, nil, errors.New("mqtt not allowed on admin_listen")
|
||||||
|
}
|
||||||
|
return KindMQTT, c, nil
|
||||||
|
}
|
||||||
|
return KindClosed, nil, errors.New("unknown first byte")
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeAddrFile(dataDir, name, addr string) error {
|
||||||
|
if dataDir == "" {
|
||||||
|
return errors.New("data_dir required to write addr file")
|
||||||
|
}
|
||||||
|
if err := os.MkdirAll(dataDir, 0o755); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return os.WriteFile(filepath.Join(dataDir, name), []byte(addr+"\n"), 0o644)
|
||||||
|
}
|
||||||
|
|
||||||
|
func isPortZero(addr string) bool {
|
||||||
|
_, port, err := net.SplitHostPort(addr)
|
||||||
|
if err != nil {
|
||||||
|
return strings.HasSuffix(addr, ":0") || addr == ":0"
|
||||||
|
}
|
||||||
|
return port == "0"
|
||||||
|
}
|
||||||
@@ -0,0 +1,117 @@
|
|||||||
|
package listener
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/tls"
|
||||||
|
"log/slog"
|
||||||
|
"os"
|
||||||
|
"sync"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// CertReloader 按文件修改时间每小时重载证书;失败继续用旧证书。
|
||||||
|
type CertReloader struct {
|
||||||
|
certFile string
|
||||||
|
keyFile string
|
||||||
|
log *slog.Logger
|
||||||
|
|
||||||
|
mu sync.RWMutex
|
||||||
|
cert *tls.Certificate
|
||||||
|
certMod time.Time
|
||||||
|
keyMod time.Time
|
||||||
|
stop chan struct{}
|
||||||
|
stopOnce sync.Once
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewCertReloader 立即加载一次证书。
|
||||||
|
func NewCertReloader(certFile, keyFile string, log *slog.Logger) (*CertReloader, error) {
|
||||||
|
if log == nil {
|
||||||
|
log = slog.Default()
|
||||||
|
}
|
||||||
|
r := &CertReloader{
|
||||||
|
certFile: certFile,
|
||||||
|
keyFile: keyFile,
|
||||||
|
log: log,
|
||||||
|
stop: make(chan struct{}),
|
||||||
|
}
|
||||||
|
if err := r.reload(true); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
go r.loop()
|
||||||
|
return r, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// GetCertificate 供 tls.Config.GetCertificate 使用。
|
||||||
|
func (r *CertReloader) GetCertificate(*tls.ClientHelloInfo) (*tls.Certificate, error) {
|
||||||
|
r.mu.RLock()
|
||||||
|
defer r.mu.RUnlock()
|
||||||
|
return r.cert, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Certificate 返回当前证书(测试用)。
|
||||||
|
func (r *CertReloader) Certificate() *tls.Certificate {
|
||||||
|
r.mu.RLock()
|
||||||
|
defer r.mu.RUnlock()
|
||||||
|
return r.cert
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close 停止重载循环。
|
||||||
|
func (r *CertReloader) Close() {
|
||||||
|
r.stopOnce.Do(func() { close(r.stop) })
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *CertReloader) loop() {
|
||||||
|
t := time.NewTicker(time.Hour)
|
||||||
|
defer t.Stop()
|
||||||
|
for {
|
||||||
|
select {
|
||||||
|
case <-r.stop:
|
||||||
|
return
|
||||||
|
case <-t.C:
|
||||||
|
if err := r.reload(false); err != nil {
|
||||||
|
r.log.Error("tls cert reload failed, keeping old cert", "err", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReloadNow 立即按 mtime 检查并重载(测试用)。
|
||||||
|
func (r *CertReloader) ReloadNow() error {
|
||||||
|
return r.reload(false)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *CertReloader) reload(force bool) error {
|
||||||
|
certInfo, err := os.Stat(r.certFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
keyInfo, err := os.Stat(r.keyFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
r.mu.RLock()
|
||||||
|
same := !force && certInfo.ModTime().Equal(r.certMod) && keyInfo.ModTime().Equal(r.keyMod) && r.cert != nil
|
||||||
|
r.mu.RUnlock()
|
||||||
|
if same {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
cert, err := tls.LoadX509KeyPair(r.certFile, r.keyFile)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
r.mu.Lock()
|
||||||
|
r.cert = &cert
|
||||||
|
r.certMod = certInfo.ModTime()
|
||||||
|
r.keyMod = keyInfo.ModTime()
|
||||||
|
r.mu.Unlock()
|
||||||
|
r.log.Info("tls certificate loaded", "cert", r.certFile)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TLSConfig 构造不设 NextProtos 的服务端 TLS 配置。
|
||||||
|
func (r *CertReloader) TLSConfig() *tls.Config {
|
||||||
|
return &tls.Config{
|
||||||
|
GetCertificate: r.GetCertificate,
|
||||||
|
MinVersion: tls.VersionTLS12,
|
||||||
|
// 故意不设 NextProtos,以便声明 ALPN mqtt 的客户端仍能握手。
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,115 @@
|
|||||||
|
package metrics
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"github.com/prometheus/client_golang/prometheus"
|
||||||
|
"github.com/prometheus/client_golang/prometheus/promhttp"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Registry 持有 NixMsg 指标与独立注册表(避免污染默认全局注册表)。
|
||||||
|
type Registry struct {
|
||||||
|
reg *prometheus.Registry
|
||||||
|
|
||||||
|
Connections *prometheus.GaugeVec
|
||||||
|
EndpointsTotal prometheus.Gauge
|
||||||
|
DeliveriesPending prometheus.Gauge
|
||||||
|
MessagesScheduled prometheus.Gauge
|
||||||
|
DispatchToPushSeconds prometheus.Observer
|
||||||
|
AckSeconds prometheus.Observer
|
||||||
|
WriteQueueLength prometheus.Gauge
|
||||||
|
WriteCommitSeconds prometheus.Observer
|
||||||
|
PasswordHashQueue prometheus.Gauge
|
||||||
|
ErrorsTotal *prometheus.CounterVec
|
||||||
|
}
|
||||||
|
|
||||||
|
// New 按 DEVELOPMENT 4.3 注册指标。
|
||||||
|
func New() *Registry {
|
||||||
|
reg := prometheus.NewRegistry()
|
||||||
|
r := &Registry{reg: reg}
|
||||||
|
|
||||||
|
r.Connections = prometheus.NewGaugeVec(prometheus.GaugeOpts{
|
||||||
|
Name: "nixmsg_connections",
|
||||||
|
Help: "Current online connections by transport (ws or tcp).",
|
||||||
|
}, []string{"transport"})
|
||||||
|
|
||||||
|
r.EndpointsTotal = prometheus.NewGauge(prometheus.GaugeOpts{
|
||||||
|
Name: "nixmsg_endpoints",
|
||||||
|
Help: "Total number of endpoints.",
|
||||||
|
})
|
||||||
|
|
||||||
|
r.DeliveriesPending = prometheus.NewGauge(prometheus.GaugeOpts{
|
||||||
|
Name: "nixmsg_deliveries_pending",
|
||||||
|
Help: "Number of pending deliveries.",
|
||||||
|
})
|
||||||
|
|
||||||
|
r.MessagesScheduled = prometheus.NewGauge(prometheus.GaugeOpts{
|
||||||
|
Name: "nixmsg_messages_scheduled",
|
||||||
|
Help: "Number of scheduled messages not yet dispatched.",
|
||||||
|
})
|
||||||
|
|
||||||
|
dispatchHist := prometheus.NewHistogram(prometheus.HistogramOpts{
|
||||||
|
Name: "nixmsg_dispatch_to_push_duration_seconds",
|
||||||
|
Help: "Latency from message due time to push.",
|
||||||
|
Buckets: prometheus.DefBuckets,
|
||||||
|
})
|
||||||
|
r.DispatchToPushSeconds = dispatchHist
|
||||||
|
|
||||||
|
ackHist := prometheus.NewHistogram(prometheus.HistogramOpts{
|
||||||
|
Name: "nixmsg_ack_duration_seconds",
|
||||||
|
Help: "Latency from push to ack.",
|
||||||
|
Buckets: prometheus.DefBuckets,
|
||||||
|
})
|
||||||
|
r.AckSeconds = ackHist
|
||||||
|
|
||||||
|
r.WriteQueueLength = prometheus.NewGauge(prometheus.GaugeOpts{
|
||||||
|
Name: "nixmsg_write_queue_length",
|
||||||
|
Help: "Number of write operations waiting or in the current batch.",
|
||||||
|
})
|
||||||
|
|
||||||
|
commitHist := prometheus.NewHistogram(prometheus.HistogramOpts{
|
||||||
|
Name: "nixmsg_write_batch_commit_duration_seconds",
|
||||||
|
Help: "Duration of each merged write-queue commit.",
|
||||||
|
Buckets: prometheus.DefBuckets,
|
||||||
|
})
|
||||||
|
r.WriteCommitSeconds = commitHist
|
||||||
|
|
||||||
|
r.PasswordHashQueue = prometheus.NewGauge(prometheus.GaugeOpts{
|
||||||
|
Name: "nixmsg_password_hash_queue_length",
|
||||||
|
Help: "Number of password hash jobs waiting for a pool slot.",
|
||||||
|
})
|
||||||
|
|
||||||
|
r.ErrorsTotal = prometheus.NewCounterVec(prometheus.CounterOpts{
|
||||||
|
Name: "nixmsg_errors_total",
|
||||||
|
Help: "Count of application error codes.",
|
||||||
|
}, []string{"code"})
|
||||||
|
|
||||||
|
reg.MustRegister(
|
||||||
|
r.Connections,
|
||||||
|
r.EndpointsTotal,
|
||||||
|
r.DeliveriesPending,
|
||||||
|
r.MessagesScheduled,
|
||||||
|
dispatchHist,
|
||||||
|
ackHist,
|
||||||
|
r.WriteQueueLength,
|
||||||
|
commitHist,
|
||||||
|
r.PasswordHashQueue,
|
||||||
|
r.ErrorsTotal,
|
||||||
|
)
|
||||||
|
|
||||||
|
// 初始化 transport 标签,便于空载抓取也能看到序列。
|
||||||
|
r.Connections.WithLabelValues("ws").Set(0)
|
||||||
|
r.Connections.WithLabelValues("tcp").Set(0)
|
||||||
|
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handler 返回 Prometheus 文本格式的 /metrics 处理函数(访问规则由 A 线加)。
|
||||||
|
func (r *Registry) Handler() http.Handler {
|
||||||
|
return promhttp.HandlerFor(r.reg, promhttp.HandlerOpts{})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gatherer 暴露底层 Gatherer(测试用)。
|
||||||
|
func (r *Registry) Gatherer() prometheus.Gatherer {
|
||||||
|
return r.reg
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
package metrics
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestMetricsHandlerExposesText(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
m := New()
|
||||||
|
m.Connections.WithLabelValues("ws").Set(3)
|
||||||
|
m.Connections.WithLabelValues("tcp").Set(2)
|
||||||
|
m.EndpointsTotal.Set(10)
|
||||||
|
m.DeliveriesPending.Set(4)
|
||||||
|
m.MessagesScheduled.Set(1)
|
||||||
|
m.DispatchToPushSeconds.Observe(0.05)
|
||||||
|
m.AckSeconds.Observe(0.02)
|
||||||
|
m.WriteQueueLength.Set(7)
|
||||||
|
m.WriteCommitSeconds.Observe(0.001)
|
||||||
|
m.PasswordHashQueue.Set(2)
|
||||||
|
m.ErrorsTotal.WithLabelValues("busy").Inc()
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/metrics", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
m.Handler().ServeHTTP(rec, req)
|
||||||
|
resp := rec.Result()
|
||||||
|
defer func() { _ = resp.Body.Close() }()
|
||||||
|
if resp.StatusCode != http.StatusOK {
|
||||||
|
t.Fatalf("status=%d", resp.StatusCode)
|
||||||
|
}
|
||||||
|
body, err := io.ReadAll(resp.Body)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
text := string(body)
|
||||||
|
for _, want := range []string{
|
||||||
|
"nixmsg_connections",
|
||||||
|
`transport="ws"`,
|
||||||
|
`transport="tcp"`,
|
||||||
|
"nixmsg_endpoints",
|
||||||
|
"nixmsg_deliveries_pending",
|
||||||
|
"nixmsg_messages_scheduled",
|
||||||
|
"nixmsg_dispatch_to_push_duration_seconds",
|
||||||
|
"nixmsg_ack_duration_seconds",
|
||||||
|
"nixmsg_write_queue_length",
|
||||||
|
"nixmsg_write_batch_commit_duration_seconds",
|
||||||
|
"nixmsg_password_hash_queue_length",
|
||||||
|
"nixmsg_errors_total",
|
||||||
|
`code="busy"`,
|
||||||
|
} {
|
||||||
|
if !strings.Contains(text, want) {
|
||||||
|
t.Fatalf("metrics text missing %q\n%s", want, text)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
const settingAdminPasswordHash = "admin_password_hash"
|
||||||
|
|
||||||
|
// HasAdminPassword 检查 settings 中是否已有管理员密码哈希。
|
||||||
|
func HasAdminPassword(ctx context.Context, db *sql.DB) (bool, error) {
|
||||||
|
var value string
|
||||||
|
err := db.QueryRowContext(ctx, `SELECT value FROM settings WHERE key = ?`, settingAdminPasswordHash).Scan(&value)
|
||||||
|
if err == sql.ErrNoRows {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
return value != "", nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetAdminPasswordHash 写入或覆盖管理员密码哈希。
|
||||||
|
func SetAdminPasswordHash(ctx context.Context, db *sql.DB, phc string) error {
|
||||||
|
now := time.Now().UnixMilli()
|
||||||
|
_, err := db.ExecContext(ctx, `
|
||||||
|
INSERT INTO settings(key, value, updated_at) VALUES(?, ?, ?)
|
||||||
|
ON CONFLICT(key) DO UPDATE SET value = excluded.value, updated_at = excluded.updated_at
|
||||||
|
`, settingAdminPasswordHash, phc, now)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
// VacuumInto 对打开的写连接执行 VACUUM INTO(可用于运行中备份)。
|
||||||
|
func VacuumInto(ctx context.Context, db *sql.DB, outPath string) error {
|
||||||
|
if outPath == "" {
|
||||||
|
return fmt.Errorf("store: vacuum into path empty")
|
||||||
|
}
|
||||||
|
escaped := strings.ReplaceAll(outPath, "'", "''")
|
||||||
|
_, err := db.ExecContext(ctx, "VACUUM INTO '"+escaped+"'")
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("vacuum into: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
+252
-18
@@ -4,29 +4,57 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"database/sql"
|
"database/sql"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
"sync"
|
"sync"
|
||||||
|
"sync/atomic"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ErrQueueClosed 表示写入队列已关闭。
|
// ErrQueueClosed 表示写入队列已关闭。
|
||||||
var ErrQueueClosed = errors.New("store: write queue closed")
|
var ErrQueueClosed = errors.New("store: write queue closed")
|
||||||
|
|
||||||
|
// ErrBusy 表示写库基础设施失败(可映射为协议 busy;/readyz 应失败)。
|
||||||
|
var ErrBusy = errors.New("store: busy")
|
||||||
|
|
||||||
|
const (
|
||||||
|
maxBatchOps = 256
|
||||||
|
batchWait = 2 * time.Millisecond
|
||||||
|
queueBuffSize = 1024
|
||||||
|
)
|
||||||
|
|
||||||
// WriteFunc 在单个写事务中执行的操作。
|
// WriteFunc 在单个写事务中执行的操作。
|
||||||
type WriteFunc func(tx *sql.Tx) error
|
type WriteFunc func(tx *sql.Tx) error
|
||||||
|
|
||||||
// Queue 写入队列:提交一个写操作并拿到结果。
|
type writeJob struct {
|
||||||
//
|
ctx context.Context
|
||||||
// 本任务(T0.3)实现为互斥串行的一操作一事务,不做合并;DEVELOPMENT 7.2
|
fn WriteFunc
|
||||||
// 要求的写 goroutine 合并提交(最多 256 个或凑满 2ms、SAVEPOINT 隔离失败)留给 P2。
|
res chan error
|
||||||
|
}
|
||||||
|
|
||||||
|
// Queue 写入队列:写 goroutine 合并提交(最多 256 个或凑满 2ms),每操作用 SAVEPOINT 隔离。
|
||||||
type Queue struct {
|
type Queue struct {
|
||||||
db *sql.DB
|
db *sql.DB
|
||||||
|
|
||||||
|
ch chan writeJob
|
||||||
|
done chan struct{}
|
||||||
|
closed atomic.Bool
|
||||||
|
|
||||||
mu sync.Mutex
|
mu sync.Mutex
|
||||||
closed bool
|
ready bool
|
||||||
|
lastWriteErr error
|
||||||
|
pending int
|
||||||
}
|
}
|
||||||
|
|
||||||
// NewQueue 创建简单写入队列(一操作一事务)。
|
// NewQueue 创建合并写入队列并启动写 goroutine。
|
||||||
func NewQueue(db *sql.DB) *Queue {
|
func NewQueue(db *sql.DB) *Queue {
|
||||||
return &Queue{db: db}
|
q := &Queue{
|
||||||
|
db: db,
|
||||||
|
ch: make(chan writeJob, queueBuffSize),
|
||||||
|
done: make(chan struct{}),
|
||||||
|
ready: true,
|
||||||
|
}
|
||||||
|
go q.loop()
|
||||||
|
return q
|
||||||
}
|
}
|
||||||
|
|
||||||
// Do 提交写操作并等待提交结果。
|
// Do 提交写操作并等待提交结果。
|
||||||
@@ -34,29 +62,235 @@ func (q *Queue) Do(ctx context.Context, fn WriteFunc) error {
|
|||||||
if fn == nil {
|
if fn == nil {
|
||||||
return errors.New("store: nil write func")
|
return errors.New("store: nil write func")
|
||||||
}
|
}
|
||||||
q.mu.Lock()
|
if q.closed.Load() {
|
||||||
defer q.mu.Unlock()
|
|
||||||
if q.closed {
|
|
||||||
return ErrQueueClosed
|
return ErrQueueClosed
|
||||||
}
|
}
|
||||||
if err := ctx.Err(); err != nil {
|
if err := ctx.Err(); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
tx, err := q.db.BeginTx(ctx, nil)
|
job := writeJob{ctx: ctx, fn: fn, res: make(chan error, 1)}
|
||||||
|
q.mu.Lock()
|
||||||
|
q.pending++
|
||||||
|
q.mu.Unlock()
|
||||||
|
select {
|
||||||
|
case q.ch <- job:
|
||||||
|
case <-ctx.Done():
|
||||||
|
q.mu.Lock()
|
||||||
|
q.pending--
|
||||||
|
q.mu.Unlock()
|
||||||
|
return ctx.Err()
|
||||||
|
case <-q.done:
|
||||||
|
q.mu.Lock()
|
||||||
|
q.pending--
|
||||||
|
q.mu.Unlock()
|
||||||
|
return ErrQueueClosed
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case err := <-job.res:
|
||||||
|
return err
|
||||||
|
case <-ctx.Done():
|
||||||
|
// 操作可能仍在队列中执行;结果通道仍会被写端关闭式填入。
|
||||||
|
select {
|
||||||
|
case err := <-job.res:
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if err := fn(tx); err != nil {
|
return ctx.Err()
|
||||||
_ = tx.Rollback()
|
case <-time.After(30 * time.Second):
|
||||||
return err
|
return ctx.Err()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return tx.Commit()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Close 关闭队列,之后 Do 返回 ErrQueueClosed。
|
func (q *Queue) loop() {
|
||||||
func (q *Queue) Close() error {
|
defer close(q.done)
|
||||||
|
for {
|
||||||
|
job, ok := <-q.ch
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
batch := []writeJob{job}
|
||||||
|
timer := time.NewTimer(batchWait)
|
||||||
|
collect:
|
||||||
|
for len(batch) < maxBatchOps {
|
||||||
|
select {
|
||||||
|
case j, ok := <-q.ch:
|
||||||
|
if !ok {
|
||||||
|
break collect
|
||||||
|
}
|
||||||
|
batch = append(batch, j)
|
||||||
|
case <-timer.C:
|
||||||
|
break collect
|
||||||
|
}
|
||||||
|
}
|
||||||
|
timer.Stop()
|
||||||
|
q.runBatch(batch)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (q *Queue) runBatch(batch []writeJob) {
|
||||||
|
defer func() {
|
||||||
|
q.mu.Lock()
|
||||||
|
q.pending -= len(batch)
|
||||||
|
if q.pending < 0 {
|
||||||
|
q.pending = 0
|
||||||
|
}
|
||||||
|
q.mu.Unlock()
|
||||||
|
}()
|
||||||
|
|
||||||
|
// 过滤已取消的任务。
|
||||||
|
active := make([]writeJob, 0, len(batch))
|
||||||
|
for _, j := range batch {
|
||||||
|
if err := j.ctx.Err(); err != nil {
|
||||||
|
j.res <- err
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
active = append(active, j)
|
||||||
|
}
|
||||||
|
if len(active) == 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
tx, err := q.db.BeginTx(context.Background(), nil)
|
||||||
|
if err != nil {
|
||||||
|
q.markBusy(err)
|
||||||
|
for _, j := range active {
|
||||||
|
j.res <- errors.Join(ErrBusy, err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
type outcome struct {
|
||||||
|
job writeJob
|
||||||
|
opErr error
|
||||||
|
success bool
|
||||||
|
}
|
||||||
|
outcomes := make([]outcome, 0, len(active))
|
||||||
|
for i, j := range active {
|
||||||
|
sp := fmt.Sprintf("sp_%d", i)
|
||||||
|
if _, err := tx.Exec("SAVEPOINT " + sp); err != nil {
|
||||||
|
_ = tx.Rollback()
|
||||||
|
q.markBusy(err)
|
||||||
|
for _, o := range outcomes {
|
||||||
|
if o.success {
|
||||||
|
o.job.res <- errors.Join(ErrBusy, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, rest := range active[i:] {
|
||||||
|
rest.res <- errors.Join(ErrBusy, err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
opErr := j.fn(tx)
|
||||||
|
if opErr != nil {
|
||||||
|
if _, rbErr := tx.Exec("ROLLBACK TO " + sp); rbErr != nil {
|
||||||
|
_ = tx.Rollback()
|
||||||
|
q.markBusy(rbErr)
|
||||||
|
for _, o := range outcomes {
|
||||||
|
if o.success {
|
||||||
|
o.job.res <- errors.Join(ErrBusy, rbErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
j.res <- opErr
|
||||||
|
for _, rest := range active[i+1:] {
|
||||||
|
rest.res <- errors.Join(ErrBusy, rbErr)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
_, _ = tx.Exec("RELEASE " + sp)
|
||||||
|
outcomes = append(outcomes, outcome{job: j, opErr: opErr, success: false})
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if _, err := tx.Exec("RELEASE " + sp); err != nil {
|
||||||
|
_ = tx.Rollback()
|
||||||
|
q.markBusy(err)
|
||||||
|
for _, o := range outcomes {
|
||||||
|
if o.success {
|
||||||
|
o.job.res <- errors.Join(ErrBusy, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
j.res <- errors.Join(ErrBusy, err)
|
||||||
|
for _, rest := range active[i+1:] {
|
||||||
|
rest.res <- errors.Join(ErrBusy, err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
outcomes = append(outcomes, outcome{job: j, success: true})
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := tx.Commit(); err != nil {
|
||||||
|
q.markBusy(err)
|
||||||
|
for _, o := range outcomes {
|
||||||
|
if o.success {
|
||||||
|
o.job.res <- errors.Join(ErrBusy, err)
|
||||||
|
} else {
|
||||||
|
o.job.res <- o.opErr
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
for _, o := range outcomes {
|
||||||
|
if o.success {
|
||||||
|
o.job.res <- nil
|
||||||
|
} else {
|
||||||
|
o.job.res <- o.opErr
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (q *Queue) markBusy(err error) {
|
||||||
q.mu.Lock()
|
q.mu.Lock()
|
||||||
defer q.mu.Unlock()
|
defer q.mu.Unlock()
|
||||||
q.closed = true
|
q.ready = false
|
||||||
|
q.lastWriteErr = err
|
||||||
|
}
|
||||||
|
|
||||||
|
// IsReady 写库是否仍可用(写失败后为 false)。
|
||||||
|
func (q *Queue) IsReady() bool {
|
||||||
|
q.mu.Lock()
|
||||||
|
defer q.mu.Unlock()
|
||||||
|
return q.ready
|
||||||
|
}
|
||||||
|
|
||||||
|
// LastWriteError 返回最近一次基础设施写失败。
|
||||||
|
func (q *Queue) LastWriteError() error {
|
||||||
|
q.mu.Lock()
|
||||||
|
defer q.mu.Unlock()
|
||||||
|
return q.lastWriteErr
|
||||||
|
}
|
||||||
|
|
||||||
|
// Len 返回排队与批次中的写操作数。
|
||||||
|
func (q *Queue) Len() int {
|
||||||
|
q.mu.Lock()
|
||||||
|
defer q.mu.Unlock()
|
||||||
|
return q.pending
|
||||||
|
}
|
||||||
|
|
||||||
|
// Drain 等待已入队操作完成,或 ctx 取消。关闭后也会等到 loop 退出。
|
||||||
|
func (q *Queue) Drain(ctx context.Context) error {
|
||||||
|
ticker := time.NewTicker(5 * time.Millisecond)
|
||||||
|
defer ticker.Stop()
|
||||||
|
for {
|
||||||
|
q.mu.Lock()
|
||||||
|
n := q.pending
|
||||||
|
q.mu.Unlock()
|
||||||
|
if n == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return ctx.Err()
|
||||||
|
case <-ticker.C:
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Close 关闭队列:不再接受新任务,并等待写 goroutine 处理完已入队任务后退出。
|
||||||
|
func (q *Queue) Close() error {
|
||||||
|
if q.closed.Swap(true) {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
close(q.ch)
|
||||||
|
<-q.done
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,175 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"sync"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestWriteQueueSavepointIsolatesFailure(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
dir := t.TempDir()
|
||||||
|
db, err := Open(dir, "FULL")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = db.Close() }()
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(2)
|
||||||
|
errOK := make(chan error, 1)
|
||||||
|
errBad := make(chan error, 1)
|
||||||
|
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
errOK <- db.Queue.Do(ctx, func(tx *sql.Tx) error {
|
||||||
|
_, e := tx.Exec(
|
||||||
|
`INSERT INTO settings(key, value, updated_at) VALUES(?, ?, ?)`,
|
||||||
|
"k_ok", "1", time.Now().UnixMilli(),
|
||||||
|
)
|
||||||
|
return e
|
||||||
|
})
|
||||||
|
}()
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
// 稍等,尽量与成功操作进同一批。
|
||||||
|
time.Sleep(500 * time.Microsecond)
|
||||||
|
errBad <- db.Queue.Do(ctx, func(tx *sql.Tx) error {
|
||||||
|
return errors.New("forced op failure")
|
||||||
|
})
|
||||||
|
}()
|
||||||
|
wg.Wait()
|
||||||
|
|
||||||
|
if e := <-errOK; e != nil {
|
||||||
|
t.Fatalf("ok op: %v", e)
|
||||||
|
}
|
||||||
|
if e := <-errBad; e == nil || e.Error() != "forced op failure" {
|
||||||
|
t.Fatalf("bad op: %v", e)
|
||||||
|
}
|
||||||
|
|
||||||
|
var value string
|
||||||
|
if scanErr := db.Read.QueryRow(`SELECT value FROM settings WHERE key = ?`, "k_ok").Scan(&value); scanErr != nil {
|
||||||
|
t.Fatalf("ok row missing: %v", scanErr)
|
||||||
|
}
|
||||||
|
if value != "1" {
|
||||||
|
t.Fatalf("value=%q", value)
|
||||||
|
}
|
||||||
|
if !db.Queue.IsReady() {
|
||||||
|
t.Fatal("op failure should not mark queue busy")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWriteQueueBatchCommit(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
dir := t.TempDir()
|
||||||
|
db, err := Open(dir, "FULL")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = db.Close() }()
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
const n = 32
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(n)
|
||||||
|
errs := make([]error, n)
|
||||||
|
for i := 0; i < n; i++ {
|
||||||
|
i := i
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
key := fmt.Sprintf("batch_%d", i)
|
||||||
|
errs[i] = db.Queue.Do(ctx, func(tx *sql.Tx) error {
|
||||||
|
_, e := tx.Exec(
|
||||||
|
`INSERT INTO settings(key, value, updated_at) VALUES(?, ?, ?)`,
|
||||||
|
key, "1", time.Now().UnixMilli(),
|
||||||
|
)
|
||||||
|
return e
|
||||||
|
})
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
for i, e := range errs {
|
||||||
|
if e != nil {
|
||||||
|
t.Fatalf("op %d: %v", i, e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var count int
|
||||||
|
if err := db.Read.QueryRow(`SELECT COUNT(*) FROM settings WHERE key LIKE 'batch_%'`).Scan(&count); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if count != n {
|
||||||
|
t.Fatalf("count=%d want %d", count, n)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWriteQueueNoBacklogAt200PerSec(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
dir := t.TempDir()
|
||||||
|
db, err := Open(dir, "FULL")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = db.Close() }()
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
const total = 200
|
||||||
|
start := time.Now()
|
||||||
|
var wg sync.WaitGroup
|
||||||
|
wg.Add(total)
|
||||||
|
for i := 0; i < total; i++ {
|
||||||
|
i := i
|
||||||
|
go func() {
|
||||||
|
defer wg.Done()
|
||||||
|
key := fmt.Sprintf("load_%d", i)
|
||||||
|
if e := db.Queue.Do(ctx, func(tx *sql.Tx) error {
|
||||||
|
_, e := tx.Exec(
|
||||||
|
`INSERT INTO settings(key, value, updated_at) VALUES(?, ?, ?)`,
|
||||||
|
key, "1", time.Now().UnixMilli(),
|
||||||
|
)
|
||||||
|
return e
|
||||||
|
}); e != nil {
|
||||||
|
t.Errorf("op %d: %v", i, e)
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
wg.Wait()
|
||||||
|
elapsed := time.Since(start)
|
||||||
|
if db.Queue.Len() != 0 {
|
||||||
|
t.Fatalf("queue backlog len=%d", db.Queue.Len())
|
||||||
|
}
|
||||||
|
// 200 条并发写入应在数秒内完成(合并提交);过长则合并未生效。
|
||||||
|
if elapsed > 5*time.Second {
|
||||||
|
t.Fatalf("200 writes took %s, queue likely not merging well", elapsed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func BenchmarkWriteQueue200PerSec(b *testing.B) {
|
||||||
|
dir := b.TempDir()
|
||||||
|
db, err := Open(dir, "FULL")
|
||||||
|
if err != nil {
|
||||||
|
b.Fatal(err)
|
||||||
|
}
|
||||||
|
defer func() { _ = db.Close() }()
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
b.ReportAllocs()
|
||||||
|
b.ResetTimer()
|
||||||
|
for i := 0; i < b.N; i++ {
|
||||||
|
key := fmt.Sprintf("bench_%d", i)
|
||||||
|
if err := db.Queue.Do(ctx, func(tx *sql.Tx) error {
|
||||||
|
_, e := tx.Exec(
|
||||||
|
`INSERT INTO settings(key, value, updated_at) VALUES(?, ?, ?)
|
||||||
|
ON CONFLICT(key) DO UPDATE SET value = excluded.value, updated_at = excluded.updated_at`,
|
||||||
|
key, "1", time.Now().UnixMilli(),
|
||||||
|
)
|
||||||
|
return e
|
||||||
|
}); err != nil {
|
||||||
|
b.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
package store
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Ready 检查读写库可用且写入队列未因磁盘类失败进入 busy。
|
||||||
|
func (d *DB) Ready(ctx context.Context) error {
|
||||||
|
if d == nil || d.Write == nil || d.Read == nil {
|
||||||
|
return errors.New("store: not open")
|
||||||
|
}
|
||||||
|
if err := d.Write.PingContext(ctx); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := d.Read.PingContext(ctx); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if d.Queue != nil && !d.Queue.IsReady() {
|
||||||
|
if err := d.Queue.LastWriteError(); err != nil {
|
||||||
|
return errors.Join(ErrBusy, err)
|
||||||
|
}
|
||||||
|
return ErrBusy
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user