Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:bug: Reject malformed WebSocket command messages https://github.com/siyuan-note/siyuan/issues/20193

Daniel1687e8ec10c8
diff --git a/kernel/server/serve.go b/kernel/server/serve.go
index 1cc84f510b..fefc3f4551 100644
--- a/kernel/server/serve.go
+++ b/kernel/server/serve.go
@@ -1899,75 +1899,86 @@ func serveWebSocket(ginServer *gin.Engine) {
return nil
})
- util.WebSocketServer.HandleMessage(func(s *melody.Session, msg []byte) {
- start := time.Now()
- logging.LogTracef("request [%s]", shortReqMsg(msg))
+ util.WebSocketServer.HandleMessage(handleWebSocketMessage)
+}
- if util.IsAuthSession(s) {
- return
- }
- if value, ok := s.Get("oidcSessionVersion"); ok {
- version, valid := value.(string)
- if !valid || !model.IsOIDCSessionVersionCurrent(version) {
- s.CloseWithMsg([]byte(" OIDC session expired"))
- return
- }
+func handleWebSocketMessage(s *melody.Session, msg []byte) {
+ badRequest := func() {
+ result := util.NewResult()
+ result.Code = -1
+ result.Msg = "Bad Request"
+ s.Write(result.Bytes())
+ }
+ defer func() {
+ if recovered := recover(); recovered != nil {
+ logging.LogErrorf("handle websocket message failed: %v", recovered)
+ badRequest()
}
+ }()
+ start := time.Now()
+ logging.LogTracef("request [%s]", shortReqMsg(msg))
- request := map[string]any{}
- if err := gulu.JSON.UnmarshalJSON(msg, &request); err != nil {
- result := util.NewResult()
- result.Code = -1
- result.Msg = "Bad Request"
- responseData, _ := gulu.JSON.MarshalJSON(result)
- s.Write(responseData)
+ if util.IsAuthSession(s) {
+ return
+ }
+ if value, ok := s.Get("oidcSessionVersion"); ok {
+ version, valid := value.(string)
+ if !valid || !model.IsOIDCSessionVersionCurrent(version) {
+ s.CloseWithMsg([]byte(" OIDC session expired"))
return
}
+ }
- if _, ok := s.Get("app"); !ok {
- result := util.NewResult()
- result.Code = -1
- result.Msg = "Bad Request"
- s.Write(result.Bytes())
- return
+ request := map[string]any{}
+ if err := gulu.JSON.UnmarshalJSON(msg, &request); err != nil {
+ badRequest()
+ return
+ }
+
+ if _, ok := s.Get("app"); !ok {
+ badRequest()
+ return
+ }
+
+ cmdStr, cmdOK := request["cmd"].(string)
+ cmdId, idOK := request["reqId"].(float64)
+ param, paramOK := request["param"].(map[string]any)
+ if !cmdOK || !idOK || !paramOK {
+ badRequest()
+ return
+ }
+ command := cmd.NewCommand(cmdStr, cmdId, param, s)
+ if nil == command {
+ result := util.NewResult()
+ result.Code = -1
+ result.Msg = "can not find command [" + cmdStr + "]"
+ s.Write(result.Bytes())
+ return
+ }
+ if !command.IsRead() {
+ readonly := util.ReadOnly
+ if !readonly {
+ if token := model.ParseXAuthToken(s.Request); token != nil {
+ readonly = token.Valid && model.IsValidRole(model.GetClaimRole(model.GetTokenClaims(token)), []model.Role{
+ model.RoleReader,
+ model.RoleVisitor,
+ })
+ }
}
- cmdStr := request["cmd"].(string)
- cmdId := request["reqId"].(float64)
- param := request["param"].(map[string]any)
- command := cmd.NewCommand(cmdStr, cmdId, param, s)
- if nil == command {
+ if readonly {
result := util.NewResult()
result.Code = -1
- result.Msg = "can not find command [" + cmdStr + "]"
+ result.Msg = model.Conf.Language(34)
s.Write(result.Bytes())
return
}
- if !command.IsRead() {
- readonly := util.ReadOnly
- if !readonly {
- if token := model.ParseXAuthToken(s.Request); token != nil {
- readonly = token.Valid && model.IsValidRole(model.GetClaimRole(model.GetTokenClaims(token)), []model.Role{
- model.RoleReader,
- model.RoleVisitor,
- })
- }
- }
-
- if readonly {
- result := util.NewResult()
- result.Code = -1
- result.Msg = model.Conf.Language(34)
- s.Write(result.Bytes())
- return
- }
- }
+ }
- end := time.Now()
- logging.LogTracef("parse cmd [%s] consumed [%d]ms", command.Name(), end.Sub(start).Milliseconds())
+ end := time.Now()
+ logging.LogTracef("parse cmd [%s] consumed [%d]ms", command.Name(), end.Sub(start).Milliseconds())
- cmd.Exec(command)
- })
+ cmd.Exec(command)
}
// encryptedBoxAwareWebdavFS 包装 webdav.Dir,拦截所有指向加密笔记本的访问。
diff --git a/kernel/server/serve_websocket_test.go b/kernel/server/serve_websocket_test.go
new file mode 100644
index 0000000000..445a5a2979
--- /dev/null
+++ b/kernel/server/serve_websocket_test.go
@@ -0,0 +1,63 @@
+package server
+
+import (
+ "net/http"
+ "net/http/httptest"
+ "strings"
+ "testing"
+ "time"
+
+ "github.com/gorilla/websocket"
+ "github.com/olahol/melody"
+ "github.com/siyuan-note/siyuan/kernel/util"
+)
+
+func TestWebSocketRejectsMalformedMessages(t *testing.T) {
+ server := melody.New()
+ defer server.Close()
+ server.HandleConnect(func(s *melody.Session) {
+ s.Set("app", "test")
+ s.Set("id", "test")
+ })
+ server.HandleMessage(handleWebSocketMessage)
+ httpServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ if err := server.HandleRequest(w, r); err != nil {
+ t.Error(err)
+ }
+ }))
+ defer httpServer.Close()
+ connection, _, err := websocket.DefaultDialer.Dial("ws"+strings.TrimPrefix(httpServer.URL, "http"), nil)
+ if err != nil {
+ t.Fatal(err)
+ }
+ defer connection.Close()
+ for _, message := range []string{
+ `{`, `{}`, `null`, `[]`,
+ `{"reqId":1,"param":{}}`, `{"cmd":"ping","param":{}}`, `{"cmd":"ping","reqId":1}`,
+ `{"cmd":1,"reqId":1,"param":{}}`, `{"cmd":"ping","reqId":"1","param":{}}`,
+ `{"cmd":"ping","reqId":1,"param":null}`, `{"cmd":"ping","reqId":1,"param":[]}`,
+ `{"cmd":"ping","reqId":1,"param":{"pushMode":"invalid"}}`,
+ } {
+ if err = connection.WriteMessage(websocket.TextMessage, []byte(message)); err != nil {
+ t.Fatal(err)
+ }
+ connection.SetReadDeadline(time.Now().Add(5 * time.Second))
+ var result util.Result
+ if err = connection.ReadJSON(&result); err != nil {
+ t.Fatalf("read response to %s: %v", message, err)
+ }
+ if result.Code != -1 || result.Msg != "Bad Request" {
+ t.Fatalf("unexpected response to %s: %#v", message, result)
+ }
+ }
+ if err = connection.WriteMessage(websocket.TextMessage, []byte(`{"cmd":"unknown","reqId":1,"param":{}}`)); err != nil {
+ t.Fatal(err)
+ }
+ var result util.Result
+ if err = connection.ReadJSON(&result); err != nil {
+ t.Fatal(err)
+ }
+ if result.Msg != "can not find command [unknown]" {
+ t.Fatalf("valid message handling changed: %#v", result)
+ }
+}