mirror of
https://github.com/juanfont/headscale.git
synced 2024-12-29 07:13:18 -05:00
TS2021: Add Noise upgrade handler
We have more code that we should, as Tailscale has a nice AcceptHTTP() method that should be able to use. However Gin is doing something different. We should have a look later on.
This commit is contained in:
parent
ce21718454
commit
55ba3021f1
8
app.go
8
app.go
@ -152,6 +152,8 @@ type Headscale struct {
|
|||||||
privateKey *key.MachinePrivate
|
privateKey *key.MachinePrivate
|
||||||
noisePrivateKey *key.MachinePrivate
|
noisePrivateKey *key.MachinePrivate
|
||||||
|
|
||||||
|
router *gin.Engine
|
||||||
|
|
||||||
DERPMap *tailcfg.DERPMap
|
DERPMap *tailcfg.DERPMap
|
||||||
DERPServer *DERPServer
|
DERPServer *DERPServer
|
||||||
|
|
||||||
@ -476,6 +478,8 @@ func (h *Headscale) createRouter(grpcMux *runtime.ServeMux) *gin.Engine {
|
|||||||
"/health",
|
"/health",
|
||||||
func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"healthy": "ok"}) },
|
func(c *gin.Context) { c.JSON(http.StatusOK, gin.H{"healthy": "ok"}) },
|
||||||
)
|
)
|
||||||
|
|
||||||
|
router.POST("/ts2021", h.NoiseUpgradeHandler)
|
||||||
router.GET("/key", h.KeyHandler)
|
router.GET("/key", h.KeyHandler)
|
||||||
router.GET("/register", h.RegisterWebAPI)
|
router.GET("/register", h.RegisterWebAPI)
|
||||||
router.POST("/machine/:id/map", h.PollNetMapHandler)
|
router.POST("/machine/:id/map", h.PollNetMapHandler)
|
||||||
@ -671,11 +675,11 @@ func (h *Headscale) Serve() error {
|
|||||||
// HTTP setup
|
// HTTP setup
|
||||||
//
|
//
|
||||||
|
|
||||||
router := h.createRouter(grpcGatewayMux)
|
h.router = h.createRouter(grpcGatewayMux)
|
||||||
|
|
||||||
httpServer := &http.Server{
|
httpServer := &http.Server{
|
||||||
Addr: h.cfg.Addr,
|
Addr: h.cfg.Addr,
|
||||||
Handler: router,
|
Handler: h.router,
|
||||||
ReadTimeout: HTTPReadTimeout,
|
ReadTimeout: HTTPReadTimeout,
|
||||||
// Go does not handle timeouts in HTTP very well, and there is
|
// Go does not handle timeouts in HTTP very well, and there is
|
||||||
// no good way to handle streaming timeouts, therefore we need to
|
// no good way to handle streaming timeouts, therefore we need to
|
||||||
|
127
noise.go
Normal file
127
noise.go
Normal file
@ -0,0 +1,127 @@
|
|||||||
|
package headscale
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/base64"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"github.com/gin-gonic/gin"
|
||||||
|
"github.com/rs/zerolog/log"
|
||||||
|
"golang.org/x/net/http2"
|
||||||
|
"golang.org/x/net/http2/h2c"
|
||||||
|
"tailscale.com/control/controlbase"
|
||||||
|
"tailscale.com/net/netutil"
|
||||||
|
"tailscale.com/types/key"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
errWrongConnectionUpgrade = Error("wrong connection upgrade")
|
||||||
|
errCannotHijack = Error("cannot hijack connection")
|
||||||
|
errNetClosing = Error("net is closing")
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// upgradeHeader is the value of the Upgrade HTTP header used to
|
||||||
|
// indicate the Tailscale control protocol.
|
||||||
|
upgradeHeaderValue = "tailscale-control-protocol"
|
||||||
|
|
||||||
|
// handshakeHeaderName is the HTTP request header that can
|
||||||
|
// optionally contain base64-encoded initial handshake
|
||||||
|
// payload, to save an RTT.
|
||||||
|
handshakeHeaderName = "X-Tailscale-Handshake"
|
||||||
|
)
|
||||||
|
|
||||||
|
type serverResult struct {
|
||||||
|
err error
|
||||||
|
clientAddr string
|
||||||
|
version int
|
||||||
|
peer key.MachinePublic
|
||||||
|
conn *controlbase.Conn
|
||||||
|
}
|
||||||
|
|
||||||
|
// NoiseUpgradeHandler is to upgrade the connection and hijack the net.Conn
|
||||||
|
// in order to use the Noise-based TS2021 protocol. Listens in /ts2021
|
||||||
|
func (h *Headscale) NoiseUpgradeHandler(ctx *gin.Context) {
|
||||||
|
log.Trace().Caller().Msgf("Noise upgrade handler for client %s", ctx.ClientIP())
|
||||||
|
|
||||||
|
// Under normal circumpstances, we should be able to use the controlhttp.AcceptHTTP()
|
||||||
|
// function to do this - kindly left there by the Tailscale authors for us to use.
|
||||||
|
// (https://github.com/tailscale/tailscale/blob/main/control/controlhttp/server.go)
|
||||||
|
//
|
||||||
|
// However, Gin seems to be doing something funny/different with its writer (see AcceptHTTP code).
|
||||||
|
// This causes problems when the upgrade headers are sent in AcceptHTTP.
|
||||||
|
// So have getNoiseConnection() that is essentially an AcceptHTTP but using the native Gin methods.
|
||||||
|
noiseConn, err := h.getNoiseConnection(ctx)
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
log.Error().Err(err).Msg("noise upgrade failed")
|
||||||
|
ctx.AbortWithError(http.StatusInternalServerError, err)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
server := http.Server{}
|
||||||
|
server.Handler = h2c.NewHandler(h.router, &http2.Server{})
|
||||||
|
server.Serve(netutil.NewOneConnListener(noiseConn, nil))
|
||||||
|
}
|
||||||
|
|
||||||
|
// getNoiseConnection is basically AcceptHTTP from tailscale, but more _alla_ Gin
|
||||||
|
// TODO(juan): Figure out why we need to do this at all.
|
||||||
|
func (h *Headscale) getNoiseConnection(ctx *gin.Context) (*controlbase.Conn, error) {
|
||||||
|
next := ctx.GetHeader("Upgrade")
|
||||||
|
if next == "" {
|
||||||
|
ctx.String(http.StatusBadRequest, "missing next protocol")
|
||||||
|
return nil, errors.New("no next protocol in HTTP request")
|
||||||
|
}
|
||||||
|
if next != upgradeHeaderValue {
|
||||||
|
ctx.String(http.StatusBadRequest, "unknown next protocol")
|
||||||
|
return nil, fmt.Errorf("client requested unhandled next protocol %q", next)
|
||||||
|
}
|
||||||
|
|
||||||
|
initB64 := ctx.GetHeader(handshakeHeaderName)
|
||||||
|
if initB64 == "" {
|
||||||
|
ctx.String(http.StatusBadRequest, "missing Tailscale handshake header")
|
||||||
|
return nil, errors.New("no tailscale handshake header in HTTP request")
|
||||||
|
}
|
||||||
|
init, err := base64.StdEncoding.DecodeString(initB64)
|
||||||
|
if err != nil {
|
||||||
|
ctx.String(http.StatusBadRequest, "invalid tailscale handshake header")
|
||||||
|
return nil, fmt.Errorf("decoding base64 handshake header: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
hijacker, ok := ctx.Writer.(http.Hijacker)
|
||||||
|
if !ok {
|
||||||
|
log.Error().Caller().Err(err).Msgf("Hijack failed")
|
||||||
|
ctx.String(http.StatusInternalServerError, "HTTP does not support general TCP support")
|
||||||
|
return nil, errors.New("can't hijack client connection")
|
||||||
|
}
|
||||||
|
|
||||||
|
// This is what changes from the original AcceptHTTP() function.
|
||||||
|
ctx.Header("Upgrade", upgradeHeaderValue)
|
||||||
|
ctx.Header("Connection", "upgrade")
|
||||||
|
ctx.Status(http.StatusSwitchingProtocols)
|
||||||
|
ctx.Writer.WriteHeaderNow()
|
||||||
|
// end
|
||||||
|
|
||||||
|
netConn, conn, err := hijacker.Hijack()
|
||||||
|
if err != nil {
|
||||||
|
log.Error().Caller().Err(err).Msgf("Hijack failed")
|
||||||
|
ctx.String(http.StatusInternalServerError, "HTTP does not support general TCP support")
|
||||||
|
|
||||||
|
return nil, errors.New("can't hijack client connection")
|
||||||
|
}
|
||||||
|
if err := conn.Flush(); err != nil {
|
||||||
|
netConn.Close()
|
||||||
|
return nil, fmt.Errorf("flushing hijacked HTTP buffer: %w", err)
|
||||||
|
}
|
||||||
|
netConn = netutil.NewDrainBufConn(netConn, conn.Reader)
|
||||||
|
|
||||||
|
nc, err := controlbase.Server(ctx.Request.Context(), netConn, *h.noisePrivateKey, init)
|
||||||
|
if err != nil {
|
||||||
|
netConn.Close()
|
||||||
|
return nil, fmt.Errorf("noise handshake failed: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nc, nil
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user