headscale/api.go

439 lines
12 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"
2021-10-08 03:43:52 -06:00
"strings"
2020-06-21 04:32:08 -06:00
"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-06-24 07:44:19 -06:00
"gorm.io/gorm"
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
}
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().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
2021-08-05 11:11:26 -06:00
Err(err).
Msg("Cannot parse machine key")
2021-10-10 03:22:42 -06:00
machineRegistrations.WithLabelValues("unknown", "web", "error", "unknown").Inc()
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().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
2021-08-05 11:11:26 -06:00
Err(err).
Msg("Cannot decode message")
2021-10-10 03:22:42 -06:00
machineRegistrations.WithLabelValues("unknown", "web", "error", "unknown").Inc()
2020-06-21 04:32:08 -06:00
c.String(http.StatusInternalServerError, "Very sad!")
return
}
2021-05-05 16:59:26 -06:00
now := time.Now().UTC()
2021-10-10 03:22:42 -06:00
m, err := h.GetMachineByMachineKey(mKey.HexString())
if errors.Is(err, gorm.ErrRecordNotFound) {
2021-08-05 13:57:47 -06:00
log.Info().Str("machine", req.Hostinfo.Hostname).Msg("New machine")
2021-10-10 03:22:42 -06:00
newMachine := Machine{
Expiry: &time.Time{},
MachineKey: mKey.HexString(),
Name: req.Hostinfo.Hostname,
}
2021-10-10 03:22:42 -06:00
if err := h.db.Create(&newMachine).Error; err != nil {
2021-08-05 11:16:21 -06:00
log.Error().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
2021-08-05 11:16:21 -06:00
Err(err).
Msg("Could not create row")
2021-10-10 03:22:42 -06:00
machineRegistrations.WithLabelValues("unknown", "web", "error", m.Namespace.Name).Inc()
return
}
2021-10-10 03:22:42 -06:00
m = &newMachine
}
if !m.Registered && req.Auth.AuthKey != "" {
2021-10-10 03:22:42 -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() {
2021-10-08 03:43:52 -06:00
2021-10-10 03:22:42 -06:00
// The client sends an Expiry in the past if the client is requesting a logout
2021-10-08 03:43:52 -06:00
if !req.Expiry.IsZero() && req.Expiry.UTC().Before(now) {
2021-10-10 03:22:42 -06:00
log.Info().
2021-10-08 03:43:52 -06:00
Str("handler", "Registration").
Str("machine", m.Name).
Msg("Client requested logout")
2021-10-10 03:22:42 -06:00
m.Expiry = &req.Expiry // save the expiry so that the machine is marked as expired
2021-10-08 03:43:52 -06:00
h.db.Save(&m)
resp.AuthURL = ""
resp.MachineAuthorized = false
resp.User = *m.Namespace.toUser()
respBody, err := encode(resp, &mKey, h.privateKey)
if err != nil {
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
}
if m.Registered && m.Expiry.UTC().After(now) {
2021-10-10 03:22:42 -06:00
// The machine registration is valid, respond with redirect to /map
2021-08-05 11:11:26 -06:00
log.Debug().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
Str("machine", m.Name).
2021-08-05 16:21:34 -06:00
Msg("Client is registered and we have the current NodeKey. All clear to /map")
2021-08-05 11:11:26 -06:00
2020-06-21 04:32:08 -06:00
resp.AuthURL = ""
resp.MachineAuthorized = true
resp.User = *m.Namespace.toUser()
resp.Login = *m.Namespace.toLogin()
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().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
2021-08-05 11:11:26 -06:00
Err(err).
Msg("Cannot encode message")
machineRegistrations.WithLabelValues("update", "web", "error", m.Namespace.Name).Inc()
c.String(http.StatusInternalServerError, "")
2020-06-21 04:32:08 -06:00
return
}
machineRegistrations.WithLabelValues("update", "web", "success", m.Namespace.Name).Inc()
2020-06-21 04:32:08 -06:00
c.Data(200, "application/json; charset=utf-8", respBody)
return
}
2021-10-10 03:22:42 -06:00
// The client has registered before, but has expired
2021-08-05 11:11:26 -06:00
log.Debug().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
Str("machine", m.Name).
2021-10-10 03:22:42 -06:00
Msg("Machine registration has expired. Sending a authurl to register")
2021-09-26 02:53:05 -06:00
if h.cfg.OIDCIssuer != "" {
2021-10-08 03:43:52 -06:00
resp.AuthURL = fmt.Sprintf("%s/oidc/register/%s",
strings.TrimSuffix(h.cfg.ServerURL, "/"), mKey.HexString())
2021-09-26 02:53:05 -06:00
} else {
resp.AuthURL = fmt.Sprintf("%s/register?key=%s",
strings.TrimSuffix(h.cfg.ServerURL, "/"), mKey.HexString())
2021-09-26 02:53:05 -06:00
}
2021-10-08 03:43:52 -06:00
2021-10-10 03:22:42 -06:00
m.RequestedExpiry = &req.Expiry // save the requested expiry time for retrieval later in the authentication flow
2021-10-08 03:43:52 -06:00
h.db.Save(&m)
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().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
2021-08-05 11:11:26 -06:00
Err(err).
Msg("Cannot encode message")
machineRegistrations.WithLabelValues("new", "web", "error", m.Namespace.Name).Inc()
c.String(http.StatusInternalServerError, "")
2020-06-21 04:32:08 -06:00
return
}
machineRegistrations.WithLabelValues("new", "web", "success", m.Namespace.Name).Inc()
2020-06-21 04:32:08 -06:00
c.Data(200, "application/json; charset=utf-8", respBody)
return
}
2021-10-08 03:43:52 -06:00
// The NodeKey we have matches OldNodeKey, which means this is a refresh after a key expiration
if m.NodeKey == wgkey.Key(req.OldNodeKey).HexString() && m.Expiry.UTC().After(now) {
2021-08-05 11:11:26 -06:00
log.Debug().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
Str("machine", m.Name).
2021-08-05 11:11:26 -06:00
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().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
2021-08-05 11:11:26 -06:00
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
}
2021-10-10 03:22:42 -06:00
// The machine registration is new, redirect the client to the registration URL
2021-08-05 11:11:26 -06:00
log.Debug().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
Str("machine", m.Name).
2021-08-05 11:11:26 -06:00
Msg("The node is sending us a new NodeKey, sending auth url")
if h.cfg.OIDCIssuer != "" {
resp.AuthURL = fmt.Sprintf("%s/oidc/register/%s", strings.TrimSuffix(h.cfg.ServerURL, "/"), mKey.HexString())
2021-09-26 02:53:05 -06:00
} else {
resp.AuthURL = fmt.Sprintf("%s/register?key=%s",
strings.TrimSuffix(h.cfg.ServerURL, "/"), mKey.HexString())
2021-09-26 02:53:05 -06:00
}
2021-10-08 03:43:52 -06:00
2021-10-10 03:22:42 -06:00
m.RequestedExpiry = &req.Expiry // save the requested expiry time for retrieval later in the authentication flow
m.NodeKey = wgkey.Key(req.NodeKey).HexString() // save the NodeKey
2021-10-08 03:43:52 -06:00
h.db.Save(&m)
respBody, err := encode(resp, &mKey, h.privateKey)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
2021-08-05 13:57:47 -06:00
Str("handler", "Registration").
2021-08-05 11:11:26 -06:00
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
}
func (h *Headscale) getMapResponse(mKey wgkey.Key, req tailcfg.MapRequest, m *Machine) ([]byte, error) {
2021-08-05 14:47:06 -06:00
log.Trace().
Str("func", "getMapResponse").
Str("machine", req.Hostinfo.Hostname).
Msg("Creating Map response")
2021-09-02 08:59:03 -06:00
node, err := m.toNode(true)
2020-06-21 04:32:08 -06:00
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
2021-08-05 13:57:47 -06:00
Str("func", "getMapResponse").
2021-08-05 11:11:26 -06:00
Err(err).
Msg("Cannot convert to node")
2020-06-21 04:32:08 -06:00
return nil, err
}
2020-06-21 04:32:08 -06:00
peers, err := h.getPeers(m)
if err != nil {
2021-08-05 11:11:26 -06:00
log.Error().
2021-08-05 13:57:47 -06:00
Str("func", "getMapResponse").
2021-08-05 11:11:26 -06:00
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,
}
nodePeers, err := peers.toNodes(true)
if err != nil {
log.Error().
Str("func", "getMapResponse").
Err(err).
Msg("Failed to convert peers to Tailscale nodes")
return nil, err
}
2020-06-21 04:32:08 -06:00
resp := tailcfg.MapResponse{
2021-08-24 00:11:45 -06:00
KeepAlive: false,
Node: node,
Peers: nodePeers,
// TODO(kradalby): As per tailscale docs, if DNSConfig is nil,
2021-08-24 00:11:45 -06:00
// it means its not updated, maybe we can have some logic
// to check and only pass updates when its updates.
// This is probably more relevant if we try to implement
// "MagicDNS"
DNSConfig: h.cfg.DNSConfig,
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
}
2021-08-13 03:33:19 -06:00
log.Trace().
Str("func", "getMapResponse").
Str("machine", req.Hostinfo.Hostname).
2021-10-05 10:51:42 -06:00
// Interface("payload", resp).
2021-08-13 03:33:19 -06:00
Msgf("Generated map response: %s", tailMapResponseToString(resp))
2020-06-21 04:32:08 -06:00
var respBody []byte
if req.Compress == "zstd" {
src, _ := json.Marshal(resp)
2021-08-13 03:33:19 -06:00
2020-06-21 04:32:08 -06:00
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
}
}
// 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
2020-06-21 04:32: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
2020-06-21 04:32:08 -06:00
}
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().
2021-08-05 13:57:47 -06:00
Str("func", "handleAuthKey").
Str("machine", req.Hostinfo.Hostname).
2021-08-05 11:11:26 -06:00
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().
2021-08-05 13:57:47 -06:00
Str("func", "handleAuthKey").
Str("machine", m.Name).
2021-08-05 11:11:26 -06:00
Err(err).
Msg("Cannot encode message")
c.String(http.StatusInternalServerError, "")
machineRegistrations.WithLabelValues("new", "authkey", "error", m.Namespace.Name).Inc()
2021-05-05 16:59:26 -06:00
return
}
c.Data(401, "application/json; charset=utf-8", respBody)
2021-08-05 11:11:26 -06:00
log.Error().
2021-08-05 13:57:47 -06:00
Str("func", "handleAuthKey").
Str("machine", m.Name).
2021-08-05 11:11:26 -06:00
Msg("Failed authentication via AuthKey")
machineRegistrations.WithLabelValues("new", "authkey", "error", m.Namespace.Name).Inc()
return
}
2021-08-05 11:11:26 -06:00
log.Debug().
2021-08-05 13:57:47 -06:00
Str("func", "handleAuthKey").
Str("machine", m.Name).
2021-08-05 11:11:26 -06:00
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().
2021-08-05 13:57:47 -06:00
Str("func", "handleAuthKey").
Str("machine", m.Name).
2021-08-05 11:11:26 -06:00
Msg("Failed to find an available IP")
machineRegistrations.WithLabelValues("new", "authkey", "error", m.Namespace.Name).Inc()
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().
2021-08-05 13:57:47 -06:00
Str("func", "handleAuthKey").
Str("machine", m.Name).
Str("ip", ip.String()).
Msgf("Assigning %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
2021-10-10 03:22:42 -06:00
h.updateMachineExpiry(&m) // TODO: do we want to do different expiry times for AuthKeys?
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().
2021-08-05 13:57:47 -06:00
Str("func", "handleAuthKey").
Str("machine", m.Name).
2021-08-05 11:11:26 -06:00
Err(err).
Msg("Cannot encode message")
machineRegistrations.WithLabelValues("new", "authkey", "error", m.Namespace.Name).Inc()
2020-06-21 04:32:08 -06:00
c.String(http.StatusInternalServerError, "Extremely sad!")
return
}
machineRegistrations.WithLabelValues("new", "authkey", "success", m.Namespace.Name).Inc()
2020-06-21 04:32:08 -06:00
c.Data(200, "application/json; charset=utf-8", respBody)
2021-08-05 11:11:26 -06:00
log.Info().
2021-08-05 13:57:47 -06:00
Str("func", "handleAuthKey").
Str("machine", m.Name).
Str("ip", ip.String()).
2021-08-05 11:11:26 -06:00
Msg("Successfully authenticated via AuthKey")
2020-06-21 04:32:08 -06:00
}