ServerKit is a lightweight, modern server control panel for managing web applications, databases, and services on your VPS or dedicated server. Built with Python/Flask backend and React frontend.
Python astracloudflarecontrol-panelcyberpaneldnsfablehosting-control-panelhosting-panelkimi-k3server-managementserverkitubuntu-web-panelwebserver
Migrate agent to Socket.IO; update endpoints
Juan Denis5ed03e67493f
diff --git a/.claude/skills/create-pr/SKILL.md b/.claude/skills/create-pr/SKILL.mdindex bec9f747..2a6a5aeb 100644--- a/.claude/skills/create-pr/SKILL.md+++ b/.claude/skills/create-pr/SKILL.md@@ -103,6 +103,13 @@ Omit the Highlights section entirely for internal-only PRs — don't force it.- Bullets should describe the mechanism, not just the intent. "Race condition in `get_or_create_chat` fixed by moving creation inside the lookup session" is good. "Fix database issues" is not.- Group related changes together (all typing fixes, all security hardening, all API changes, etc.)+#### Contributors+- If the PR includes commits from multiple authors (not just the repo owner), add a **Contributors** section after the summary and before Highlights.+- Use `git log main..HEAD --format='%aN <%aE>' | sort -u` to find unique commit authors.+- Exclude bot accounts (e.g., `github-actions[bot]`).+- Format: `@username` if their GitHub handle is available (check the ARGUMENTS or commit metadata), otherwise use their name. Add a brief note about what they contributed if it's clear from the commits.+- Keep it short — one line per contributor, no need for a full changelog.+#### General- **No test plan section.** Do not include "Test plan" or "Testing".- **No mention of tests.** Do not reference test files, test results, or testing.diff --git a/agent/cmd/agent/main.go b/agent/cmd/agent/main.goindex 2129e0e5..bca3c36a 100644--- a/agent/cmd/agent/main.go+++ b/agent/cmd/agent/main.go@@ -5,6 +5,7 @@ import ("fmt""os""os/signal"+ "path/filepath""syscall""github.com/serverkit/agent/internal/agent"@@ -309,8 +310,19 @@ func runRegister(token, serverURL, name string) error {cfg.Auth.APIKey = result.APIKeycfg.Auth.APISecret = result.APISecret- // Save config- if err := cfg.Save(config.DefaultConfigPath()); err != nil {+ // Determine config path (use --config flag if set, otherwise default)+ configPath := cfgFile+ if configPath == "" {+ configPath = config.DefaultConfigPath()+ }++ // Update key file path to be relative to config directory if using custom path+ if cfgFile != "" {+ cfg.Auth.KeyFile = filepath.Join(filepath.Dir(configPath), "agent.key")+ }++ // Save config (key_file path must be set before saving)+ if err := cfg.Save(configPath); err != nil {return fmt.Errorf("failed to save config: %w", err)}diff --git a/agent/internal/agent/registration.go b/agent/internal/agent/registration.goindex 36358d40..e1874765 100644--- a/agent/internal/agent/registration.go+++ b/agent/internal/agent/registration.go@@ -103,7 +103,7 @@ func (r *Registration) Register(serverURL, token, name string) (*RegistrationRes}// Make registration request- registrationURL := serverURL + "/api/v1/agents/register"+ registrationURL := serverURL + "/api/v1/servers/register"r.log.Info("Sending registration request", "url", registrationURL)req, err := http.NewRequestWithContext(ctx, "POST", registrationURL, bytes.NewReader(bodyBytes))diff --git a/agent/internal/ws/client.go b/agent/internal/ws/client.goindex 9bc7981d..621da67b 100644--- a/agent/internal/ws/client.go+++ b/agent/internal/ws/client.go@@ -6,6 +6,8 @@ import ("encoding/json""fmt""net/http"+ "net/url"+ "strings""sync""time"@@ -19,7 +21,7 @@ import (// MessageHandler is called when a message is receivedtype MessageHandler func(msgType protocol.MessageType, data []byte)-// Client is a WebSocket client with auto-reconnect+// Client is a Socket.IO client with auto-reconnecttype Client struct {cfg config.ServerConfigauth *auth.Authenticator@@ -36,16 +38,23 @@ type Client struct {doneCh chan struct{}reconnectCount int++ // Socket.IO namespace+ namespace string+ // Engine.IO ping interval from server+ pingInterval time.Duration+ pingTimeout time.Duration}// NewClient creates a new WebSocket clientfunc NewClient(cfg config.ServerConfig, authenticator *auth.Authenticator, log *logger.Logger) *Client {return &Client{- cfg: cfg,- auth: authenticator,- log: log.WithComponent("websocket"),- sendCh: make(chan []byte, 100),- doneCh: make(chan struct{}),+ cfg: cfg,+ auth: authenticator,+ log: log.WithComponent("websocket"),+ sendCh: make(chan []byte, 100),+ doneCh: make(chan struct{}),+ namespace: "/agent",}}@@ -54,7 +63,34 @@ func (c *Client) SetHandler(handler MessageHandler) {c.handler = handler}-// Connect establishes a WebSocket connection+// buildSocketIOURL converts the configured server URL to a Socket.IO WebSocket URL.+// Input examples:+// - "wss://server.example.com/agent"+// - "ws://localhost:5000/agent"+//+// Output: "wss://server.example.com/socket.io/?EIO=4&transport=websocket"+func (c *Client) buildSocketIOURL() (string, error) {+ rawURL := c.cfg.URL+ if rawURL == "" {+ return "", fmt.Errorf("server URL is empty")+ }++ parsed, err := url.Parse(rawURL)+ if err != nil {+ return "", fmt.Errorf("invalid server URL: %w", err)+ }++ // Keep the scheme (ws/wss), strip the path (e.g. /agent)+ parsed.Path = "/socket.io/"+ q := url.Values{}+ q.Set("EIO", "4")+ q.Set("transport", "websocket")+ parsed.RawQuery = q.Encode()++ return parsed.String(), nil+}++// Connect establishes a Socket.IO connection over WebSocketfunc (c *Client) Connect(ctx context.Context) error {c.mu.Lock()if c.connected {@@ -63,6 +99,11 @@ func (c *Client) Connect(ctx context.Context) error {}c.mu.Unlock()+ sioURL, err := c.buildSocketIOURL()+ if err != nil {+ return err+ }+dialer := websocket.Dialer{HandshakeTimeout: 10 * time.Second,}@@ -76,10 +117,11 @@ func (c *Client) Connect(ctx context.Context) error {headers := http.Header{}headers.Set("X-Agent-ID", c.auth.AgentID())headers.Set("X-API-Key-Prefix", c.auth.GetAPIKeyPrefix())+ headers.Set("User-Agent", fmt.Sprintf("ServerKit-Agent/%s", "dev"))- c.log.Debug("Connecting to server", "url", c.cfg.URL)+ c.log.Debug("Connecting to Socket.IO", "url", sioURL)- conn, resp, err := dialer.DialContext(ctx, c.cfg.URL, headers)+ conn, resp, err := dialer.DialContext(ctx, sioURL, headers)if err != nil {if resp != nil {c.log.Error("Connection failed",@@ -92,14 +134,29 @@ func (c *Client) Connect(ctx context.Context) error {c.mu.Lock()c.conn = conn+ c.mu.Unlock()++ // Step 1: Read Engine.IO OPEN packet+ if err := c.handleEngineIOOpen(); err != nil {+ conn.Close()+ return fmt.Errorf("engine.io handshake failed: %w", err)+ }++ // Step 2: Connect to Socket.IO namespace+ if err := c.connectNamespace(); err != nil {+ conn.Close()+ return fmt.Errorf("namespace connect failed: %w", err)+ }++ c.mu.Lock()c.connected = truec.reconnecting = falsec.reconnectCount = 0c.mu.Unlock()- c.log.Info("Connected to server")+ c.log.Info("Connected to server via Socket.IO")- // Authenticate+ // Step 3: Authenticate via Socket.IO eventif err := c.authenticate(); err != nil {c.Close()return fmt.Errorf("authentication failed: %w", err)@@ -108,65 +165,213 @@ func (c *Client) Connect(ctx context.Context) error {return nil}-// authenticate sends authentication message and waits for response+// handleEngineIOOpen reads and processes the Engine.IO OPEN packet (type 0)+func (c *Client) handleEngineIOOpen() error {+ c.conn.SetReadDeadline(time.Now().Add(10 * time.Second))+ _, msg, err := c.conn.ReadMessage()+ if err != nil {+ return fmt.Errorf("failed to read OPEN packet: %w", err)+ }+ c.conn.SetReadDeadline(time.Time{})++ msgStr := string(msg)+ c.log.Debug("Received Engine.IO packet", "raw", msgStr)++ // Engine.IO OPEN packet starts with '0'+ if len(msgStr) < 2 || msgStr[0] != '0' {+ return fmt.Errorf("expected OPEN packet (0), got: %s", msgStr)+ }++ // Parse the JSON payload+ var openData struct {+ SID string `json:"sid"`+ Upgrades []string `json:"upgrades"`+ PingInterval int `json:"pingInterval"`+ PingTimeout int `json:"pingTimeout"`+ }+ if err := json.Unmarshal([]byte(msgStr[1:]), &openData); err != nil {+ return fmt.Errorf("failed to parse OPEN data: %w", err)+ }++ c.pingInterval = time.Duration(openData.PingInterval) * time.Millisecond+ c.pingTimeout = time.Duration(openData.PingTimeout) * time.Millisecond++ c.log.Debug("Engine.IO handshake complete",+ "sid", openData.SID,+ "pingInterval", c.pingInterval,+ "pingTimeout", c.pingTimeout,+ )++ return nil+}++// connectNamespace sends a Socket.IO CONNECT packet to the /agent namespace+func (c *Client) connectNamespace() error {+ // Socket.IO CONNECT: packet type 4 (MESSAGE) + message type 0 (CONNECT) + namespace+ // Wire format: "40/agent,"+ connectMsg := fmt.Sprintf("40%s,", c.namespace)+ c.log.Debug("Connecting to namespace", "namespace", c.namespace, "packet", connectMsg)++ if err := c.conn.WriteMessage(websocket.TextMessage, []byte(connectMsg)); err != nil {+ return fmt.Errorf("failed to send CONNECT: %w", err)+ }++ // Read namespace CONNECT ack+ c.conn.SetReadDeadline(time.Now().Add(10 * time.Second))+ _, msg, err := c.conn.ReadMessage()+ if err != nil {+ return fmt.Errorf("failed to read CONNECT ack: %w", err)+ }+ c.conn.SetReadDeadline(time.Time{})++ msgStr := string(msg)+ c.log.Debug("Received namespace response", "raw", msgStr)++ // Expected: "40/agent,{\"sid\":\"...\"}"+ // Or error: "44/agent,{\"message\":\"...\"}"+ prefix := fmt.Sprintf("40%s,", c.namespace)+ errorPrefix := fmt.Sprintf("44%s,", c.namespace)++ if strings.HasPrefix(msgStr, errorPrefix) {+ return fmt.Errorf("namespace connection rejected: %s", msgStr)+ }++ if !strings.HasPrefix(msgStr, prefix) {+ return fmt.Errorf("unexpected namespace response: %s", msgStr)+ }++ c.log.Info("Connected to namespace", "namespace", c.namespace)+ return nil+}++// authenticate sends an "auth" Socket.IO event and waits for responsefunc (c *Client) authenticate() error {timestamp := time.Now().UnixMilli()nonce := auth.GenerateNonce()- // Sign with nonce for replay protectionsignature := c.auth.SignMessageWithNonce(timestamp, nonce)- authMsg := protocol.AuthMessage{- Message: protocol.NewMessage(protocol.TypeAuth, nonce),- AgentID: c.auth.AgentID(),- APIKeyPrefix: c.auth.GetAPIKeyPrefix(),- Nonce: nonce,+ authData := map[string]interface{}{+ "type": "auth",+ "agent_id": c.auth.AgentID(),+ "api_key_prefix": c.auth.GetAPIKeyPrefix(),+ "nonce": nonce,+ "timestamp": timestamp,+ "signature": signature,}- authMsg.Timestamp = timestamp- authMsg.Signature = signature- data, err := json.Marshal(authMsg)- if err != nil {- return fmt.Errorf("failed to marshal auth message: %w", err)+ c.log.Debug("Sending authentication event")++ if err := c.emitEvent("auth", authData); err != nil {+ return fmt.Errorf("failed to send auth event: %w", err)}- c.log.Debug("Sending authentication message")+ // Wait for auth response event+ c.conn.SetReadDeadline(time.Now().Add(10 * time.Second))+ defer c.conn.SetReadDeadline(time.Time{})++ for {+ _, msg, err := c.conn.ReadMessage()+ if err != nil {+ return fmt.Errorf("failed to read auth response: %w", err)+ }++ msgStr := string(msg)++ // Handle Engine.IO ping during auth+ if msgStr == "2" {+ c.conn.WriteMessage(websocket.TextMessage, []byte("3"))+ continue+ }++ eventName, eventData, err := c.parseEvent(msgStr)+ if err != nil {+ c.log.Debug("Ignoring non-event message during auth", "raw", msgStr)+ continue+ }- if err := c.conn.WriteMessage(websocket.TextMessage, data); err != nil {- return fmt.Errorf("failed to send auth message: %w", err)+ switch eventName {+ case "auth_ok":+ var response struct {+ Type string `json:"type"`+ SessionToken string `json:"session_token"`+ Expires int64 `json:"expires"`+ ServerID string `json:"server_id"`+ }+ if err := json.Unmarshal(eventData, &response); err != nil {+ return fmt.Errorf("failed to parse auth_ok: %w", err)+ }++ c.session = &auth.SessionToken{+ Token: response.SessionToken,+ ExpiresAt: time.UnixMilli(response.Expires),+ }++ c.log.Info("Authentication successful",+ "expires_in", time.Until(c.session.ExpiresAt).Round(time.Second),+ )+ return nil++ case "auth_fail":+ var response struct {+ Type string `json:"type"`+ Error string `json:"error"`+ }+ json.Unmarshal(eventData, &response)+ return fmt.Errorf("authentication rejected: %s", response.Error)++ default:+ c.log.Debug("Ignoring event during auth", "event", eventName)+ }}+}- // Wait for auth response- c.conn.SetReadDeadline(time.Now().Add(10 * time.Second))- _, msg, err := c.conn.ReadMessage()+// emitEvent sends a Socket.IO EVENT packet+// Wire format: 42/agent,["event_name",{data}]+func (c *Client) emitEvent(event string, data interface{}) error {+ dataBytes, err := json.Marshal(data)if err != nil {- return fmt.Errorf("failed to read auth response: %w", err)+ return fmt.Errorf("failed to marshal event data: %w", err)}- c.conn.SetReadDeadline(time.Time{})- var response protocol.AuthResponse- if err := json.Unmarshal(msg, &response); err != nil {- return fmt.Errorf("failed to parse auth response: %w", err)+ // Build Socket.IO EVENT: 42/namespace,["event",data]+ eventJSON := fmt.Sprintf(`42%s,["%s",%s]`, c.namespace, event, string(dataBytes))++ return c.conn.WriteMessage(websocket.TextMessage, []byte(eventJSON))+}++// parseEvent parses a Socket.IO EVENT packet and returns event name + data+// Expected format: 42/agent,["event_name",{data}]+func (c *Client) parseEvent(msg string) (string, json.RawMessage, error) {+ prefix := fmt.Sprintf("42%s,", c.namespace)+ if !strings.HasPrefix(msg, prefix) {+ return "", nil, fmt.Errorf("not a Socket.IO EVENT for namespace %s", c.namespace)}- if response.Type == protocol.TypeAuthFail {- return fmt.Errorf("authentication rejected: %s", response.Error)+ payload := msg[len(prefix):]++ // Parse as JSON array: ["event_name", data]+ var arr []json.RawMessage+ if err := json.Unmarshal([]byte(payload), &arr); err != nil {+ return "", nil, fmt.Errorf("failed to parse event array: %w", err)}- if response.Type != protocol.TypeAuthOK {- return fmt.Errorf("unexpected response type: %s", response.Type)+ if len(arr) < 1 {+ return "", nil, fmt.Errorf("empty event array")}- // Store session token- c.session = &auth.SessionToken{- Token: response.SessionToken,- ExpiresAt: time.UnixMilli(response.Expires),+ // Extract event name (first element is a string)+ var eventName string+ if err := json.Unmarshal(arr[0], &eventName); err != nil {+ return "", nil, fmt.Errorf("failed to parse event name: %w", err)}- c.log.Info("Authentication successful",- "expires_in", time.Until(c.session.ExpiresAt).Round(time.Second),- )+ // Data is the second element (may be absent)+ var eventData json.RawMessage+ if len(arr) > 1 {+ eventData = arr[1]+ }- return nil+ return eventName, eventData, nil}// Run starts the read/write loops and handles reconnection@@ -186,13 +391,14 @@ func (c *Client) Run(ctx context.Context) error {if !connected {if err := c.Connect(ctx); err != nil {+ c.log.Warn("Connection failed", "error", err)c.handleReconnect(ctx)continue}}- // Start read/write loops- errCh := make(chan error, 2)+ // Start read/write/ping loops+ errCh := make(chan error, 3)go func() {errCh <- c.readLoop(ctx)@@ -202,6 +408,10 @@ func (c *Client) Run(ctx context.Context) error {errCh <- c.writeLoop(ctx)}()+ go func() {+ errCh <- c.pingLoop(ctx)+ }()+// Wait for errorerr := <-errChc.log.Warn("Connection loop ended", "error", err)@@ -226,7 +436,7 @@ func (c *Client) Run(ctx context.Context) error {}}-// readLoop reads messages from the WebSocket+// readLoop reads Socket.IO messages from the WebSocketfunc (c *Client) readLoop(ctx context.Context) error {for {select {@@ -240,40 +450,121 @@ func (c *Client) readLoop(ctx context.Context) error {return fmt.Errorf("read error: %w", err)}- // Parse message type- var base protocol.Message- if err := json.Unmarshal(msg, &base); err != nil {- c.log.Warn("Failed to parse message", "error", err)+ msgStr := string(msg)++ // Handle Engine.IO PING (server sends "2", we respond "3")+ if msgStr == "2" {+ if err := c.conn.WriteMessage(websocket.TextMessage, []byte("3")); err != nil {+ return fmt.Errorf("failed to send pong: %w", err)+ }+ c.log.Debug("Responded to Engine.IO ping")continue}- // Handle heartbeat ack internally- if base.Type == protocol.TypeHeartbeatAck {- c.log.Debug("Received heartbeat ack")- continue+ // Handle Engine.IO CLOSE+ if msgStr == "1" {+ return fmt.Errorf("server sent Engine.IO CLOSE")+ }++ // Handle Socket.IO DISCONNECT for our namespace+ disconnectPrefix := fmt.Sprintf("41%s,", c.namespace)+ if strings.HasPrefix(msgStr, disconnectPrefix) || msgStr == "41" {+ return fmt.Errorf("server disconnected namespace %s", c.namespace)}- // Pass to handler- if c.handler != nil {- c.handler(base.Type, msg)+ // Parse Socket.IO EVENT+ eventName, eventData, err := c.parseEvent(msgStr)+ if err != nil {+ c.log.Debug("Ignoring unrecognized message", "raw", msgStr)+ continue}++ // Map event name to protocol message type and dispatch+ c.dispatchEvent(eventName, eventData)}}-// writeLoop writes messages from the send channel+// dispatchEvent maps a Socket.IO event to the agent's message handler+func (c *Client) dispatchEvent(eventName string, data json.RawMessage) {+ c.log.Debug("Received event", "event", eventName)++ // Map Socket.IO event names to protocol message types+ msgType := protocol.MessageType(eventName)++ // Handle heartbeat ack internally+ if msgType == protocol.TypeHeartbeatAck {+ c.log.Debug("Received heartbeat ack")+ return+ }++ // For events that carry data, we need to reconstruct the full message+ // so the agent handler can unmarshal it as expected+ if c.handler != nil && len(data) > 0 {+ c.handler(msgType, data)+ }+}++// writeLoop writes queued messages via Socket.IO eventsfunc (c *Client) writeLoop(ctx context.Context) error {for {select {case <-ctx.Done():return ctx.Err()case msg := <-c.sendCh:- if err := c.conn.WriteMessage(websocket.TextMessage, msg); err != nil {+ // Parse the message to extract the type for the event name+ var base protocol.Message+ if err := json.Unmarshal(msg, &base); err != nil {+ c.log.Warn("Failed to parse outgoing message", "error", err)+ continue+ }++ eventName := string(base.Type)+ eventJSON := fmt.Sprintf(`42%s,["%s",%s]`, c.namespace, eventName, string(msg))++ if err := c.conn.WriteMessage(websocket.TextMessage, []byte(eventJSON)); err != nil {return fmt.Errorf("write error: %w", err)}}}}+// pingLoop sends Engine.IO PING packets to keep the connection alive+func (c *Client) pingLoop(ctx context.Context) error {+ if c.pingInterval <= 0 {+ c.pingInterval = 25 * time.Second+ }++ ticker := time.NewTicker(c.pingInterval)+ defer ticker.Stop()++ for {+ select {+ case <-ctx.Done():+ return ctx.Err()+ case <-ticker.C:+ c.mu.RLock()+ connected := c.connected+ c.mu.RUnlock()++ if !connected {+ return fmt.Errorf("not connected")+ }++ // Engine.IO PING from client side (type 3 = PONG in EIO4 client-initiated)+ // Actually in EIO4, server sends PINGs (2) and client responds with PONGs (3)+ // Client doesn't need to send its own pings, just respond to server's+ // But we'll use this loop to detect stale connections via WriteControl+ if err := c.conn.WriteControl(+ websocket.PingMessage,+ nil,+ time.Now().Add(5*time.Second),+ ); err != nil {+ return fmt.Errorf("websocket ping failed: %w", err)+ }+ }+ }+}+// handleReconnect implements exponential backoff reconnectionfunc (c *Client) handleReconnect(ctx context.Context) {c.mu.Lock()diff --git a/agent/scripts/install.ps1 b/agent/scripts/install.ps1index 36c6f55e..9bdba718 100644--- a/agent/scripts/install.ps1+++ b/agent/scripts/install.ps1@@ -59,7 +59,7 @@ function Install-ServerKitAgent {# Construct download URLif ([string]::IsNullOrEmpty($DownloadUrl)) {- $DownloadUrl = "$Server/downloads/agent/serverkit-agent-windows-$Arch.exe"+ $DownloadUrl = "$Server/api/v1/servers/agent/download/windows/$Arch"}# Download agentdiff --git a/agent/scripts/install.sh b/agent/scripts/install.shindex ea1eec80..872b1b1e 100644--- a/agent/scripts/install.sh+++ b/agent/scripts/install.sh@@ -156,7 +156,7 @@ create_user() {download_agent() {if [ -z "$DOWNLOAD_URL" ]; then# Construct download URL from server- DOWNLOAD_URL="${SERVER_URL}/downloads/agent/serverkit-agent-${OS}-${ARCH}"+ DOWNLOAD_URL="${SERVER_URL}/api/v1/servers/agent/download/${OS}/${ARCH}"filog_info "Downloading agent from $DOWNLOAD_URL..."diff --git a/frontend/src/pages/Servers.jsx b/frontend/src/pages/Servers.jsxindex 2c64eefd..31030716 100644--- a/frontend/src/pages/Servers.jsx+++ b/frontend/src/pages/Servers.jsx@@ -503,7 +503,7 @@ Install-ServerKitAgent -Server "${window.location.origin}" -Token "${registratio<li>Once connected, the server will appear as "Online"</li></ol><p className="text-muted">- The registration token expires in 1 hour. After that, you'll need to generate a new one.+ The registration token expires in 24 hours. After that, you'll need to generate a new one.</p></div>