headscale/api.go

610 lines
16 KiB
Go
Raw Normal View History

2020-06-21 04:32:08 -06:00
package headscale
import (
"encoding/binary"
"encoding/json"
2021-06-24 07:44:19 -06:00
"errors"
2020-06-21 04:32:08 -06:00
"fmt"
"io"
"net/http"
"time"
2021-08-05 11:11:26 -06:00
"github.com/rs/zerolog/log"
2020-06-21 04:32:08 -06:00
"github.com/gin-gonic/gin"
"github.com/klauspost/compress/zstd"
2021-05-14 16:05:41 -06:00
"gorm.io/datatypes"
2021-06-24 07:44:19 -06:00
"gorm.io/gorm"
2021-02-20 14:43:07 -07:00
"inet.af/netaddr"
2020-06-21 04:32:08 -06:00
"tailscale.com/tailcfg"
2021-06-25 10:57:08 -06:00
"tailscale.com/types/wgkey"
2020-06-21 04:32:08 -06:00
)
// KeyHandler provides the Headscale pub key
// Listens in /key
2020-06-21 04:32:08 -06:00
func (h *Headscale) KeyHandler(c *gin.Context) {
c.Data(200, "text/plain; charset=utf-8", []byte(h.publicKey.HexString()))
}
// RegisterWebAPI shows a simple message in the browser to point to the CLI
// Listens in /register
func (h *Headscale) RegisterWebAPI(c *gin.Context) {
mKeyStr := c.Query("key")
if mKeyStr == "" {
c.String(http.StatusBadRequest, "Wrong params")
return
}
2021-05-05 17:03:43 -06:00
// spew.Dump(c.Params)
2021-05-05 16:59:26 -06:00
c.Data(http.StatusOK, "text/html; charset=utf-8", []byte(fmt.Sprintf(`
<html>
<body>
<h1>headscale</h1>
<p>
2021-05-14 16:05:41 -06:00
Run the command below in the headscale server to add this machine to your network:
</p>
<p>
<code>
2021-07-11 07:05:32 -06:00
<b>headscale -n NAMESPACE nodes register %s</b>
</code>
</p>
</body>
</html>
2021-05-24 13:59:03 -06:00
`, mKeyStr)))
}
// RegistrationHandler handles the actual registration process of a machine
// Endpoint /machine/:id
2020-06-21 04:32:08 -06:00
func (h *Headscale) RegistrationHandler(c *gin.Context) {
2021-02-21 15:54:15 -07:00
body, _ := io.ReadAll(c.Request.Body)
2020-06-21 04:32:08 -06:00
mKeyStr := c.Param("id")
2021-06-25 10:57:08 -06:00
mKey, err := wgkey.ParseHex(mKeyStr)
2020-06-21 04:32:08 -06:00
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "Registration").
Err(err).
Msg("Cannot parse machine key")
2020-06-21 04:32:08 -06:00
c.String(http.StatusInternalServerError, "Sad!")
return
}
req := tailcfg.RegisterRequest{}
err = decode(body, &req, &mKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "Registration").
Err(err).
Msg("Cannot decode message")
2020-06-21 04:32:08 -06:00
c.String(http.StatusInternalServerError, "Very sad!")
return
}
2021-05-05 16:59:26 -06:00
var m Machine
if result := h.db.Preload("Namespace").First(&m, "machine_key = ?", mKey.HexString()); errors.Is(result.Error, gorm.ErrRecordNotFound) {
2021-08-05 11:11:26 -06:00
log.Info().Str("Name", req.Hostinfo.Hostname).Msg("New machine")
m = Machine{
Expiry: &req.Expiry,
MachineKey: mKey.HexString(),
Name: req.Hostinfo.Hostname,
2021-06-25 10:57:08 -06:00
NodeKey: wgkey.Key(req.NodeKey).HexString(),
}
2021-07-04 13:40:46 -06:00
if err := h.db.Create(&m).Error; err != nil {
log.Printf("Could not create row: %s", err)
return
}
}
if !m.Registered && req.Auth.AuthKey != "" {
2021-07-04 13:40:46 -06:00
h.handleAuthKey(c, h.db, mKey, req, m)
2020-06-21 04:32:08 -06:00
return
}
resp := tailcfg.RegisterResponse{}
// We have the updated key!
2021-06-25 10:57:08 -06:00
if m.NodeKey == wgkey.Key(req.NodeKey).HexString() {
2020-06-21 04:32:08 -06:00
if m.Registered {
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Handler", "Registration").
Str("Machine", m.Name).
Msg("Client is registered and we have the current NodeKey. All clear to /mSending keepaliveap")
2020-06-21 04:32:08 -06:00
resp.AuthURL = ""
resp.MachineAuthorized = true
resp.User = *m.Namespace.toUser()
2020-06-21 04:32:08 -06:00
respBody, err := encode(resp, &mKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "Registration").
Err(err).
Msg("Cannot encode message")
c.String(http.StatusInternalServerError, "")
2020-06-21 04:32:08 -06:00
return
}
c.Data(200, "application/json; charset=utf-8", respBody)
return
}
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Handler", "Registration").
Str("Machine", m.Name).
Msg("Not registered and not NodeKey rotation. Sending a authurl to register")
2020-06-21 04:32:08 -06:00
resp.AuthURL = fmt.Sprintf("%s/register?key=%s",
h.cfg.ServerURL, mKey.HexString())
respBody, err := encode(resp, &mKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "Registration").
Err(err).
Msg("Cannot encode message")
c.String(http.StatusInternalServerError, "")
2020-06-21 04:32:08 -06:00
return
}
c.Data(200, "application/json; charset=utf-8", respBody)
return
}
// The NodeKey we have matches OldNodeKey, which means this is a refresh after an key expiration
2021-06-25 10:57:08 -06:00
if m.NodeKey == wgkey.Key(req.OldNodeKey).HexString() {
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Handler", "Registration").
Str("Machine", m.Name).
Msg("We have the OldNodeKey in the database. This is a key refresh")
2021-06-25 10:57:08 -06:00
m.NodeKey = wgkey.Key(req.NodeKey).HexString()
2021-07-04 13:40:46 -06:00
h.db.Save(&m)
2020-06-21 04:32:08 -06:00
resp.AuthURL = ""
resp.User = *m.Namespace.toUser()
2020-06-21 04:32:08 -06:00
respBody, err := encode(resp, &mKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "Registration").
Err(err).
Msg("Cannot encode message")
2020-06-21 04:32:08 -06:00
c.String(http.StatusInternalServerError, "Extremely sad!")
return
}
c.Data(200, "application/json; charset=utf-8", respBody)
return
}
// We arrive here after a client is restarted without finalizing the authentication flow or
// when headscale is stopped in the middle of the auth process.
if m.Registered {
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Handler", "Registration").
Str("Machine", m.Name).
Msg("The node is sending us a new NodeKey, but machine is registered. All clear for /map")
resp.AuthURL = ""
resp.MachineAuthorized = true
resp.User = *m.Namespace.toUser()
respBody, err := encode(resp, &mKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "Registration").
Err(err).
Msg("Cannot encode message")
c.String(http.StatusInternalServerError, "")
return
}
c.Data(200, "application/json; charset=utf-8", respBody)
return
}
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Handler", "Registration").
Str("Machine", m.Name).
Msg("The node is sending us a new NodeKey, sending auth url")
resp.AuthURL = fmt.Sprintf("%s/register?key=%s",
h.cfg.ServerURL, mKey.HexString())
respBody, err := encode(resp, &mKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "Registration").
Err(err).
Msg("Cannot encode message")
c.String(http.StatusInternalServerError, "")
return
}
c.Data(200, "application/json; charset=utf-8", respBody)
2020-06-21 04:32:08 -06:00
}
// PollNetMapHandler takes care of /machine/:id/map
//
// This is the busiest endpoint, as it keeps the HTTP long poll that updates
// the clients when something in the network changes.
//
// The clients POST stuff like HostInfo and their Endpoints here, but
// only after their first request (marked with the ReadOnly field).
//
// At this moment the updates are sent in a quite horrendous way, but they kinda work.
2020-06-21 04:32:08 -06:00
func (h *Headscale) PollNetMapHandler(c *gin.Context) {
2021-02-21 15:54:15 -07:00
body, _ := io.ReadAll(c.Request.Body)
2020-06-21 04:32:08 -06:00
mKeyStr := c.Param("id")
2021-06-25 10:57:08 -06:00
mKey, err := wgkey.ParseHex(mKeyStr)
2020-06-21 04:32:08 -06:00
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "PollNetMap").
Err(err).
Msg("Cannot parse client key")
2021-07-11 03:37:17 -06:00
c.String(http.StatusBadRequest, "")
2020-06-21 04:32:08 -06:00
return
}
req := tailcfg.MapRequest{}
err = decode(body, &req, &mKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "PollNetMap").
Err(err).
Msg("Cannot decode message")
2021-07-11 03:37:17 -06:00
c.String(http.StatusBadRequest, "")
return
2020-06-21 04:32:08 -06:00
}
var m Machine
if result := h.db.Preload("Namespace").First(&m, "machine_key = ?", mKey.HexString()); errors.Is(result.Error, gorm.ErrRecordNotFound) {
2021-08-05 11:11:26 -06:00
log.Warn().
Str("Handler", "PollNetMap").
Msgf("Ignoring request, cannot find machine with key %s", mKey.HexString())
2021-07-11 03:37:17 -06:00
c.String(http.StatusUnauthorized, "")
2020-06-21 04:32:08 -06:00
return
}
hostinfo, _ := json.Marshal(req.Hostinfo)
m.Name = req.Hostinfo.Hostname
2021-05-14 16:05:41 -06:00
m.HostInfo = datatypes.JSON(hostinfo)
2021-06-25 10:57:08 -06:00
m.DiscoKey = wgkey.Key(req.DiscoKey).HexString()
2020-06-21 04:32:08 -06:00
now := time.Now().UTC()
// From Tailscale client:
//
// ReadOnly is whether the client just wants to fetch the MapResponse,
// without updating their Endpoints. The Endpoints field will be ignored and
// LastSeen will not be updated and peers will not be notified of changes.
//
// The intended use is for clients to discover the DERP map at start-up
// before their first real endpoint update.
if !req.ReadOnly {
endpoints, _ := json.Marshal(req.Endpoints)
2021-05-14 16:05:41 -06:00
m.Endpoints = datatypes.JSON(endpoints)
m.LastSeen = &now
}
2021-07-04 13:40:46 -06:00
h.db.Save(&m)
2020-06-21 04:32:08 -06:00
pollData := make(chan []byte, 1)
update := make(chan []byte, 1)
cancelKeepAlive := make(chan []byte, 1)
defer close(pollData)
defer close(cancelKeepAlive)
h.pollMu.Lock()
h.clientsPolling[m.ID] = update
h.pollMu.Unlock()
2020-06-21 04:32:08 -06:00
data, err := h.getMapResponse(mKey, req, m)
if err != nil {
c.String(http.StatusInternalServerError, ":(")
return
}
2020-06-21 04:32:08 -06:00
// We update our peers if the client is not sending ReadOnly in the MapRequest
// so we don't distribute its initial request (it comes with
// empty endpoints to peers)
2021-05-24 13:59:03 -06:00
// Details on the protocol can be found in https://github.com/tailscale/tailscale/blob/main/tailcfg/tailcfg.go#L696
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Bool("ReadOnly", req.ReadOnly).
Bool("OmitPeers", req.OmitPeers).
Bool("Stream", req.Stream)
2021-05-24 13:59:03 -06:00
if req.ReadOnly {
2021-08-05 11:11:26 -06:00
log.Info().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Msg("Client is starting up. Asking for DERP map")
2021-05-24 13:59:03 -06:00
c.Data(200, "application/json; charset=utf-8", *data)
return
}
if req.OmitPeers && !req.Stream {
2021-08-05 11:11:26 -06:00
log.Info().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Msg("Client sent endpoint update and is ok with a response without peer list")
2021-05-24 13:59:03 -06:00
c.Data(200, "application/json; charset=utf-8", *data)
return
} else if req.OmitPeers && req.Stream {
2021-08-05 11:11:26 -06:00
log.Warn().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Msg("Ignoring request, don't know how to handle it")
c.String(http.StatusBadRequest, "")
return
2021-05-24 13:59:03 -06:00
}
2021-08-05 11:11:26 -06:00
log.Info().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Msg("Client is ready to access the tailnet")
log.Info().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Msg("Sending initial map")
2021-05-24 13:59:03 -06:00
pollData <- *data
2021-08-05 11:11:26 -06:00
log.Printf("[PollMap] (%s) Notifying peers", m.Name)
2021-05-24 13:59:03 -06:00
peers, _ := h.getPeers(m)
h.pollMu.Lock()
for _, p := range *peers {
pUp, ok := h.clientsPolling[uint64(p.ID)]
if ok {
2021-08-05 11:11:26 -06:00
log.Info().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Str("Peer", m.Name).
Str("Address", p.Addresses[0].String()).
Msgf("Notifying peer %s (%s)", p.Name, p.Addresses[0])
2021-05-24 13:59:03 -06:00
pUp <- []byte{}
} else {
2021-08-05 11:11:26 -06:00
log.Info().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Str("Peer", m.Name).
Msgf("Peer %s does not appear to be polling", p.Name)
2020-06-21 04:32:08 -06:00
}
}
2021-05-24 13:59:03 -06:00
h.pollMu.Unlock()
go h.keepAlive(cancelKeepAlive, pollData, mKey, req, m)
2020-06-21 04:32:08 -06:00
c.Stream(func(w io.Writer) bool {
select {
case data := <-pollData:
2021-08-05 11:11:26 -06:00
log.Trace().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Int("Bytes", len(data)).
Msg("Sending data")
_, err := w.Write(data)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Err(err).
Msg("Cannot write data")
}
now := time.Now().UTC()
m.LastSeen = &now
2021-07-04 13:40:46 -06:00
h.db.Save(&m)
2020-06-21 04:32:08 -06:00
return true
case <-update:
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Msg("Received a request for update")
data, err := h.getMapResponse(mKey, req, m)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Err(err).
Msg("Could not get the map update")
}
_, err = w.Write(*data)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Err(err).
Msg("Could not write the map response")
}
return true
case <-c.Request.Context().Done():
2021-08-05 11:11:26 -06:00
log.Info().
Str("Handler", "PollNetMap").
Str("Machine", m.Name).
Msg("The client has closed the connection")
now := time.Now().UTC()
m.LastSeen = &now
2021-07-04 13:40:46 -06:00
h.db.Save(&m)
h.pollMu.Lock()
cancelKeepAlive <- []byte{}
delete(h.clientsPolling, m.ID)
close(update)
h.pollMu.Unlock()
2020-06-21 04:32:08 -06:00
return false
2020-06-21 04:32:08 -06:00
}
})
}
2020-06-21 04:32:08 -06:00
2021-06-25 10:57:08 -06:00
func (h *Headscale) keepAlive(cancel chan []byte, pollData chan []byte, mKey wgkey.Key, req tailcfg.MapRequest, m Machine) {
for {
select {
case <-cancel:
return
default:
h.pollMu.Lock()
data, err := h.getMapKeepAliveResponse(mKey, req, m)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Func", "keepAlive").
Err(err).
Msg("Error generating the keep alive msg")
return
}
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Func", "keepAlive").
Str("Machine", m.Name).
Msg("Sending keepalive")
pollData <- *data
h.pollMu.Unlock()
time.Sleep(60 * time.Second)
}
}
2020-06-21 04:32:08 -06:00
}
2021-06-25 10:57:08 -06:00
func (h *Headscale) getMapResponse(mKey wgkey.Key, req tailcfg.MapRequest, m Machine) (*[]byte, error) {
2020-06-21 04:32:08 -06:00
node, err := m.toNode()
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Func", "getMapResponse").
Err(err).
Msg("Cannot convert to node")
2020-06-21 04:32:08 -06:00
return nil, err
}
peers, err := h.getPeers(m)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Func", "getMapResponse").
Err(err).
Msg("Cannot fetch peers")
2020-06-21 04:32:08 -06:00
return nil, err
}
profile := tailcfg.UserProfile{
ID: tailcfg.UserID(m.NamespaceID),
LoginName: m.Namespace.Name,
DisplayName: m.Namespace.Name,
}
2020-06-21 04:32:08 -06:00
resp := tailcfg.MapResponse{
KeepAlive: false,
Node: node,
Peers: *peers,
2021-02-20 14:43:07 -07:00
DNS: []netaddr.IP{},
2020-06-21 04:32:08 -06:00
SearchPaths: []string{},
Domain: "headscale.net",
2021-07-04 05:24:05 -06:00
PacketFilter: *h.aclRules,
2021-02-20 15:57:06 -07:00
DERPMap: h.cfg.DerpMap,
UserProfiles: []tailcfg.UserProfile{profile},
2021-02-23 16:31:58 -07:00
}
2020-06-21 04:32:08 -06:00
var respBody []byte
if req.Compress == "zstd" {
src, _ := json.Marshal(resp)
encoder, _ := zstd.NewWriter(nil)
srcCompressed := encoder.EncodeAll(src, nil)
respBody, err = encodeMsg(srcCompressed, &mKey, h.privateKey)
if err != nil {
return nil, err
}
} else {
respBody, err = encode(resp, &mKey, h.privateKey)
if err != nil {
return nil, err
}
}
// spew.Dump(resp)
2020-06-21 04:32:08 -06:00
// declare the incoming size on the first 4 bytes
data := make([]byte, 4)
binary.LittleEndian.PutUint32(data, uint32(len(respBody)))
data = append(data, respBody...)
return &data, nil
}
2021-06-25 10:57:08 -06:00
func (h *Headscale) getMapKeepAliveResponse(mKey wgkey.Key, req tailcfg.MapRequest, m Machine) (*[]byte, error) {
2020-06-21 04:32:08 -06:00
resp := tailcfg.MapResponse{
KeepAlive: true,
}
var respBody []byte
var err error
if req.Compress == "zstd" {
src, _ := json.Marshal(resp)
encoder, _ := zstd.NewWriter(nil)
srcCompressed := encoder.EncodeAll(src, nil)
respBody, err = encodeMsg(srcCompressed, &mKey, h.privateKey)
if err != nil {
return nil, err
}
} else {
respBody, err = encode(resp, &mKey, h.privateKey)
if err != nil {
return nil, err
}
}
data := make([]byte, 4)
binary.LittleEndian.PutUint32(data, uint32(len(respBody)))
data = append(data, respBody...)
return &data, nil
}
2021-06-25 10:57:08 -06:00
func (h *Headscale) handleAuthKey(c *gin.Context, db *gorm.DB, idKey wgkey.Key, req tailcfg.RegisterRequest, m Machine) {
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Func", "handleAuthKey").
Str("Machine", req.Hostinfo.Hostname).
Msgf("Processing auth key for %s", req.Hostinfo.Hostname)
2021-05-05 16:59:26 -06:00
resp := tailcfg.RegisterResponse{}
pak, err := h.checkKeyValidity(req.Auth.AuthKey)
if err != nil {
resp.MachineAuthorized = false
2021-05-05 16:59:26 -06:00
respBody, err := encode(resp, &idKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Func", "handleAuthKey").
Str("Machine", m.Name).
Err(err).
Msg("Cannot encode message")
c.String(http.StatusInternalServerError, "")
2021-05-05 16:59:26 -06:00
return
}
c.Data(200, "application/json; charset=utf-8", respBody)
2021-08-05 11:11:26 -06:00
log.Error().
Str("Func", "handleAuthKey").
Str("Machine", m.Name).
Msg("Failed authentication via AuthKey")
return
}
2021-08-05 11:11:26 -06:00
log.Debug().
Str("Func", "handleAuthKey").
Str("Machine", m.Name).
Msg("Authentication key was valid, proceeding to acquire an IP address")
ip, err := h.getAvailableIP()
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Func", "handleAuthKey").
Str("Machine", m.Name).
Msg("Failed to find an available IP")
2021-05-05 16:59:26 -06:00
return
2020-06-21 04:32:08 -06:00
}
2021-08-05 11:11:26 -06:00
log.Info().
Str("Func", "handleAuthKey").
Str("Machine", m.Name).
Str("IP", ip.String()).
Msgf("Assining %s to %s", ip, m.Name)
2020-06-21 04:32:08 -06:00
m.AuthKeyID = uint(pak.ID)
m.IPAddress = ip.String()
m.NamespaceID = pak.NamespaceID
2021-06-25 10:57:08 -06:00
m.NodeKey = wgkey.Key(req.NodeKey).HexString() // we update it just in case
m.Registered = true
m.RegisterMethod = "authKey"
db.Save(&m)
2021-05-05 16:59:26 -06:00
resp.MachineAuthorized = true
resp.User = *pak.Namespace.toUser()
2020-06-21 04:32:08 -06:00
respBody, err := encode(resp, &idKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
Str("Func", "handleAuthKey").
Str("Machine", m.Name).
Err(err).
Msg("Cannot encode message")
2020-06-21 04:32:08 -06:00
c.String(http.StatusInternalServerError, "Extremely sad!")
return
}
c.Data(200, "application/json; charset=utf-8", respBody)
2021-08-05 11:11:26 -06:00
log.Info().
Str("Func", "handleAuthKey").
Str("Machine", m.Name).
Str("IP", ip.String()).
Msg("Successfully authenticated via AuthKey")
2020-06-21 04:32:08 -06:00
}