mirror of
https://github.com/gin-gonic/gin.git
synced 2026-11-22 02:43:36 +08:00
fix(response): ignore writes after successful Hijack
Track hijack state and return errHijacked from Write/WriteString instead of touching the underlying ResponseWriter. WriteHeaderNow becomes a no-op after hijack. Websocket Accept path (WriteHeaderNow then Hijack) still works. Fixes #3921
This commit is contained in:
parent
34dac209ff
commit
bc80509535
@ -18,6 +18,7 @@ const (
|
||||
)
|
||||
|
||||
var errHijackAlreadyWritten = errors.New("gin: response body already written")
|
||||
var errHijacked = errors.New("gin: connection hijacked")
|
||||
|
||||
// ResponseWriter ...
|
||||
type ResponseWriter interface {
|
||||
@ -48,8 +49,9 @@ type ResponseWriter interface {
|
||||
|
||||
type responseWriter struct {
|
||||
http.ResponseWriter
|
||||
size int
|
||||
status int
|
||||
size int
|
||||
status int
|
||||
hijacked bool
|
||||
}
|
||||
|
||||
var _ ResponseWriter = (*responseWriter)(nil)
|
||||
@ -62,6 +64,7 @@ func (w *responseWriter) reset(writer http.ResponseWriter) {
|
||||
w.ResponseWriter = writer
|
||||
w.size = noWritten
|
||||
w.status = defaultStatus
|
||||
w.hijacked = false
|
||||
}
|
||||
|
||||
func (w *responseWriter) WriteHeader(code int) {
|
||||
@ -75,6 +78,9 @@ func (w *responseWriter) WriteHeader(code int) {
|
||||
}
|
||||
|
||||
func (w *responseWriter) WriteHeaderNow() {
|
||||
if w.hijacked {
|
||||
return
|
||||
}
|
||||
if !w.Written() {
|
||||
w.size = 0
|
||||
w.ResponseWriter.WriteHeader(w.status)
|
||||
@ -82,6 +88,9 @@ func (w *responseWriter) WriteHeaderNow() {
|
||||
}
|
||||
|
||||
func (w *responseWriter) Write(data []byte) (n int, err error) {
|
||||
if w.hijacked {
|
||||
return 0, errHijacked
|
||||
}
|
||||
w.WriteHeaderNow()
|
||||
n, err = w.ResponseWriter.Write(data)
|
||||
w.size += n
|
||||
@ -89,6 +98,9 @@ func (w *responseWriter) Write(data []byte) (n int, err error) {
|
||||
}
|
||||
|
||||
func (w *responseWriter) WriteString(s string) (n int, err error) {
|
||||
if w.hijacked {
|
||||
return 0, errHijacked
|
||||
}
|
||||
w.WriteHeaderNow()
|
||||
n, err = io.WriteString(w.ResponseWriter, s)
|
||||
w.size += n
|
||||
@ -121,7 +133,11 @@ func (w *responseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error) {
|
||||
if w.size < 0 {
|
||||
w.size = 0
|
||||
}
|
||||
return hijacker.Hijack()
|
||||
conn, rw, err := hijacker.Hijack()
|
||||
if err == nil {
|
||||
w.hijacked = true
|
||||
}
|
||||
return conn, rw, err
|
||||
}
|
||||
|
||||
// CloseNotify implements the http.CloseNotifier interface.
|
||||
|
||||
@ -278,6 +278,29 @@ func TestResponseWriterHijackAfterWriteHeaderNow(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestResponseWriterWriteAfterHijack(t *testing.T) {
|
||||
hijacker := &mockHijacker{ResponseRecorder: httptest.NewRecorder()}
|
||||
w := &responseWriter{}
|
||||
w.reset(hijacker)
|
||||
|
||||
_, _, err := w.Hijack()
|
||||
require.NoError(t, err)
|
||||
assert.True(t, w.hijacked)
|
||||
|
||||
n, err := w.Write([]byte("nope"))
|
||||
assert.Equal(t, 0, n)
|
||||
require.ErrorIs(t, err, errHijacked)
|
||||
|
||||
n, err = w.WriteString("nope")
|
||||
assert.Equal(t, 0, n)
|
||||
require.ErrorIs(t, err, errHijacked)
|
||||
|
||||
assert.NotPanics(t, func() { w.WriteHeaderNow() })
|
||||
// underlying recorder body must stay empty (no write-after-hijack)
|
||||
assert.Equal(t, 0, hijacker.Body.Len())
|
||||
}
|
||||
|
||||
|
||||
func TestResponseWriterFlush(t *testing.T) {
|
||||
testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
writer := &responseWriter{}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user