本文深入探讨go语言中构建websocket服务时常见的403 forbidden错误，特别是由于默认的origin头部校验机制引起的。我们将通过示例代码展示问题产生的原因，并详细介绍如何使用`websocket.server`来禁用或自定义origin校验，从而确保websocket连接的成功建立，同时提供相关的安全考量和最佳实践。
go语言中的WebSocket服务基础
Go语言通过golang.org/x/net/websocket包（早期版本为code.google.com/p/go.net/websocket）提供了构建WebSocket服务的能力。这个包简化了WebSocket协议的处理，允许开发者快速搭建双向通信的应用。一个基本的WebSocket echo服务器通常会监听特定的http路径，并将传入的HTTP请求升级为全双工的WebSocket连接。
以下是一个常见的Go语言WebSocket echo服务器的初始实现示例：
package main import ( "fmt" "log" "net/http" "golang.org/x/net/websocket" // 推荐使用此路径 ) // webHandler 处理WebSocket连接，接收消息并打印 func webHandler(ws *websocket.Conn) { defer ws.Close() // 确保连接关闭 var msg string for { // 尝试从WebSocket连接读取消息 if _, err := fmt.Fscan(ws, &msg); err != nil { // 通常是EOF错误表示客户端断开连接 if err.Error() == "EOF" { log.Println("客户端断开连接。") } else { log.Printf("WebSocket读取错误: %v", err) } break // 读取失败或客户端断开，退出循环 } fmt.Printf("收到消息: %sn", msg) // 示例：将消息回传给客户端，实现echo功能 if _, err := fmt.Fprint(ws, "Echo: "+msg); err != nil { log.Printf("WebSocket写入错误: %v", err) break // 写入失败，断开连接 } } } func main() { fmt.Println("启动WebSocket服务器，监听:8080...") // 注册WebSocket处理器 http.Handle("/echo", websocket.Handler(webHandler)) // 启动HTTP服务器 err := http.ListenAndServe(":8080", nil) if err != nil { log.Fatalf("ListenAndServe失败: %v", err) } }
配套的javaScript客户端连接代码如下：
// 尝试连接到Go服务器的WebSocket端点 const ws = new WebSocket("ws://localhost:8080/echo"); ws.onopen = function() { console.log("WebSocket连接已建立"); ws.send("Hello from client!"); // 连接成功后发送消息 }; ws.onmessage = function(e) { console.log("收到服务器消息: " + e.data); }; ws.onclose = function() { console.log("WebSocket连接已关闭"); }; ws.onerror = function(err) { console.error("WebSocket错误: ", err); };
当使用上述客户端尝试连接时，可能会在浏览器控制台中看到如下错误：WebSocket connection to ‘ws://localhost:8080/echo’ failed: Unexpected response code: 403。
立即学习“go语言免费学习笔记（深入）”；
理解403 Forbidden错误：Origin校验机制
这个403 Forbidden错误通常不是由于服务器配置不当，而是Go语言golang.org/x/net/websocket包中的一个默认安全机制所致。websocket.Handler在处理WebSocket握手请求时，会默认检查HTTP请求头中的Origin字段。
根据websocket.Handler的文档说明：
Handler是一个简单的WebSocket浏览器客户端接口。它默认检查Origin头部是否是有效的URL。你可能需要验证websocket.Conn.Config().Origin在你的函数中。如果你使用Server而不是Handler，你可以调用websocket.Origin并在你的Handshake函数中检查Origin。因此，如果你想接受不发送Origin头部的非浏览器客户端，你可以使用Server，它在其Handshake中不检查Origin。
简而言之，websocket.Handler默认会尝试验证Origin头部。如果Origin头部缺失、无效，或者不符合默认的校验规则，它就会拒绝连接并返回403状态码。这对于跨域请求伪造（csrf）攻击是一种防御机制，但在某些场景下，例如服务器间通信或特定客户端不发送标准Origin头部时，这会成为一个障碍。
解决方案：使用websocket.Server进行Origin校验控制
为了解决这个问题，我们需要更精细地控制WebSocket的握手过程，特别是Origin校验。websocket.Server结构体提供了这种灵活性。通过它，我们可以自定义握手逻辑，或者像本例一样，简单地禁用默认的Origin校验。
以下是修改后的Go服务器代码，它使用websocket.Server来处理WebSocket连接，从而绕过默认的Origin校验：
package main import ( "fmt" "log" "net/http" "golang.org/x/net/websocket" ) // webHandler 处理WebSocket连接，接收消息并打印 func webHandler(ws *websocket.Conn) { defer ws.Close() var msg string for { if _, err := fmt.Fscan(ws, &msg); err != nil { if err.Error() == "EOF" { log.Println("客户端断开连接。") } else { log.Printf("WebSocket读取错误: %v", err) } break } fmt.Printf("收到消息: %sn", msg) // 示例：回传消息给客户端 if _, err := fmt.Fprint(ws, "Echo: "+msg); err != nil { log.Printf("WebSocket写入错误: %v", err) break } } } func main() { fmt.Println("启动WebSocket服务器，监听:8080...") // 使用http.HandleFunc注册一个处理函数 // 在这个处理函数内部，我们创建并使用websocket.Server http.HandleFunc("/echo", func(w http.ResponseWriter, req *http.Request) { // 创建一个websocket.Server实例 // 将我们的webHandler作为其Handler // 默认情况下，websocket.Server的Handshake函数不执行Origin校验 s := websocket.Server{Handler: websocket.Handler(webHandler)} // 调用ServeHTTP来处理HTTP请求并升级为WebSocket连接 s.ServeHTTP(w, req) }) // 启动HTTP服务器 err := http.ListenAndServe(":8080", nil) if err != nil { log.Fatalf("ListenAndServe失败: %v", err) } }
通过这种方式，websocket.Server的默认Handshake逻辑将不会强制执行严格的Origin校验，从而允许客户端成功连接。
重要的注意事项和最佳实践
-
安全性考量：
- 禁用Origin校验的风险：直接禁用Origin校验会降低安全性，因为它可能使您的WebSocket服务容易受到跨站请求伪造（CSRF）攻击。恶意网站可以诱导用户浏览器向您的WebSocket服务发送请求。
- 何时禁用：仅在您明确知道所有合法客户端的来源，并且这些客户端无法或不发送符合websocket.Handler默认校验规则的Origin头部时，才考虑禁用它。例如，服务器到服务器的WebSocket通信，或者特定的桌面/移动应用客户端。
- 替代方案：自定义Origin校验：如果需要更灵活的Origin校验，可以为websocket.Server提供一个自定义的Handshake函数。例如：
s := websocket.Server{ Handler: websocket.Handler(webHandler), Handshake: func(config *websocket.Config, req *http.Request) (err error) { // 在这里实现自定义的Origin校验逻辑 // 例如，只允许来自特定域的Origin allowedOrigins := map[string]bool{ "http://localhost:8080": true, // 允许本地开发环境 "https://your-frontend.com": true, // 允许生产环境前端 } if allowedOrigins[config.Origin.String()] { return nil // 允许连接 } return fmt.Errorf("不允许的Origin: %s", config.Origin.String()) }, }这样可以在允许特定来源的同时，拒绝其他来源。
-
包路径更新：
- 原始的code.google.com/p/go.net/websocket包已经废弃。在现代Go项目中，应使用golang.org/x/net/websocket。请确保您的go.mod文件中正确引入了该模块。
-
错误处理：
- 在webHandler中，对fmt.Fscan和fmt.Fprint的错误进行处理至关重要。例如，EOF错误通常表示客户端已断开连接，此时应停止读取并关闭连接。其他错误可能需要更具体的日志记录或处理。
-
WebSocket连接生命周期：
- 在webHandler的开头使用defer ws.Close()是一个好习惯，确保在处理函数结束时，无论何种原因，WebSocket连接都会被正确关闭，释放资源。
总结
在Go语言中构建WebSocket服务时，遇到403 Forbidden错误通常是由于golang.org/x/net/websocket包的默认Origin头部校验机制