headscale/api.go

633 lines
16 KiB
Go
Raw Normal View History

2020-06-21 18:32:08 +08:00
package headscale
import (
2021-12-23 10:43:53 +08:00
"bytes"
2020-06-21 18:32:08 +08:00
"encoding/binary"
"encoding/json"
2021-06-24 21:44:19 +08:00
"errors"
2020-06-21 18:32:08 +08:00
"fmt"
2021-12-23 10:43:53 +08:00
"html/template"
2020-06-21 18:32:08 +08:00
"io"
"net/http"
2021-10-08 17:43:52 +08:00
"strings"
2020-06-21 18:32:08 +08:00
"time"
"github.com/gin-gonic/gin"
"github.com/klauspost/compress/zstd"
2021-11-13 16:39:04 +08:00
"github.com/rs/zerolog/log"
2021-06-24 21:44:19 +08:00
"gorm.io/gorm"
2020-06-21 18:32:08 +08:00
"tailscale.com/tailcfg"
"tailscale.com/types/key"
2020-06-21 18:32:08 +08:00
)
2021-11-18 16:49:55 +08:00
const (
reservedResponseHeaderSize = 4
2022-02-28 01:48:12 +08:00
RegisterMethodAuthKey = "authkey"
RegisterMethodOIDC = "oidc"
RegisterMethodCLI = "cli"
ErrRegisterMethodCLIDoesNotSupportExpire = Error(
"machines registered with CLI does not support expire",
)
2021-11-18 16:49:55 +08:00
)
// KeyHandler provides the Headscale pub key
2021-11-13 16:39:04 +08:00
// Listens in /key.
func (h *Headscale) KeyHandler(ctx *gin.Context) {
ctx.Data(
http.StatusOK,
"text/plain; charset=utf-8",
[]byte(MachinePublicKeyStripPrefix(h.privateKey.Public())),
)
2020-06-21 18:32:08 +08:00
}
2021-12-23 10:43:53 +08:00
type registerWebAPITemplateConfig struct {
Key string
}
2021-12-23 10:43:53 +08:00
var registerWebAPITemplate = template.Must(
template.New("registerweb").Parse(`<html>
<body>
<h1>headscale</h1>
<p>
2021-05-15 06:05:41 +08:00
Run the command below in the headscale server to add this machine to your network:
</p>
<p>
<code>
2021-12-23 10:43:53 +08:00
<b>headscale -n NAMESPACE nodes register --key {{.Key}}</b>
</code>
</p>
</body>
2021-12-23 10:43:53 +08:00
</html>`),
)
// RegisterWebAPI shows a simple message in the browser to point to the CLI
// Listens in /register.
func (h *Headscale) RegisterWebAPI(ctx *gin.Context) {
machineKeyStr := ctx.Query("key")
if machineKeyStr == "" {
ctx.String(http.StatusBadRequest, "Wrong params")
return
}
var content bytes.Buffer
if err := registerWebAPITemplate.Execute(&content, registerWebAPITemplateConfig{
Key: machineKeyStr,
}); err != nil {
log.Error().
Str("func", "RegisterWebAPI").
Err(err).
Msg("Could not render register web API template")
ctx.Data(
http.StatusInternalServerError,
"text/html; charset=utf-8",
[]byte("Could not render register web API template"),
)
}
2021-05-25 03:59:03 +08:00
2021-12-23 10:43:53 +08:00
ctx.Data(http.StatusOK, "text/html; charset=utf-8", content.Bytes())
}
// RegistrationHandler handles the actual registration process of a machine
2021-11-13 16:39:04 +08:00
// Endpoint /machine/:id.
func (h *Headscale) RegistrationHandler(ctx *gin.Context) {
body, _ := io.ReadAll(ctx.Request.Body)
machineKeyStr := ctx.Param("id")
var machineKey key.MachinePublic
err := machineKey.UnmarshalText([]byte(MachinePublicKeyEnsurePrefix(machineKeyStr)))
2020-06-21 18:32:08 +08:00
if err != nil {
2021-08-06 01:11:26 +08:00
log.Error().
Caller().
2021-08-06 01:11:26 +08:00
Err(err).
Msg("Cannot parse machine key")
2021-10-10 17:22:42 +08:00
machineRegistrations.WithLabelValues("unknown", "web", "error", "unknown").Inc()
ctx.String(http.StatusInternalServerError, "Sad!")
2021-11-14 23:46:09 +08:00
2020-06-21 18:32:08 +08:00
return
}
req := tailcfg.RegisterRequest{}
err = decode(body, &req, &machineKey, h.privateKey)
2020-06-21 18:32:08 +08:00
if err != nil {
2021-08-06 01:11:26 +08:00
log.Error().
Caller().
2021-08-06 01:11:26 +08:00
Err(err).
Msg("Cannot decode message")
2021-10-10 17:22:42 +08:00
machineRegistrations.WithLabelValues("unknown", "web", "error", "unknown").Inc()
ctx.String(http.StatusInternalServerError, "Very sad!")
2021-11-14 23:46:09 +08:00
2020-06-21 18:32:08 +08:00
return
}
2021-05-06 06:59:26 +08:00
now := time.Now().UTC()
machine, err := h.GetMachineByMachineKey(machineKey)
2021-10-10 17:22:42 +08:00
if errors.Is(err, gorm.ErrRecordNotFound) {
2021-08-06 03:57:47 +08:00
log.Info().Str("machine", req.Hostinfo.Hostname).Msg("New machine")
2021-10-10 17:22:42 +08:00
newMachine := Machine{
Expiry: &time.Time{},
MachineKey: MachinePublicKeyStripPrefix(machineKey),
2021-10-10 17:22:42 +08:00
Name: req.Hostinfo.Hostname,
}
2021-10-10 17:22:42 +08:00
if err := h.db.Create(&newMachine).Error; err != nil {
2021-08-06 01:16:21 +08:00
log.Error().
Caller().
2021-08-06 01:16:21 +08:00
Err(err).
Msg("Could not create row")
machineRegistrations.WithLabelValues("unknown", "web", "error", machine.Namespace.Name).
2021-11-13 16:36:45 +08:00
Inc()
2021-11-14 23:46:09 +08:00
return
}
machine = &newMachine
}
if machine.Registered {
// If the NodeKey stored in headscale is the same as the key presented in a registration
// request, then we have a node that is either:
// - Trying to log out (sending a expiry in the past)
// - A valid, registered machine, looking for the node map
// - Expired machine wanting to reauthenticate
if machine.NodeKey == NodePublicKeyStripPrefix(req.NodeKey) {
// The client sends an Expiry in the past if the client is requesting to expire the key (aka logout)
// https://github.com/tailscale/tailscale/blob/main/tailcfg/tailcfg.go#L648
if !req.Expiry.IsZero() && req.Expiry.UTC().Before(now) {
2021-11-21 22:00:48 +08:00
h.handleMachineLogOut(ctx, machineKey, *machine)
return
}
// If machine is not expired, and is register, we have a already accepted this machine,
// let it proceed with a valid registration
if !machine.isExpired() {
h.handleMachineValidRegistration(ctx, machineKey, *machine)
return
}
2021-10-08 17:43:52 +08:00
}
// The NodeKey we have matches OldNodeKey, which means this is a refresh after a key expiration
if machine.NodeKey == NodePublicKeyStripPrefix(req.OldNodeKey) &&
!machine.isExpired() {
h.handleMachineRefreshKey(ctx, machineKey, req, *machine)
2021-11-14 23:46:09 +08:00
2020-06-21 18:32:08 +08:00
return
}
// The machine has expired
2021-11-24 20:16:56 +08:00
h.handleMachineExpired(ctx, machineKey, req, *machine)
return
2020-06-21 18:32:08 +08:00
}
// If the machine has AuthKey set, handle registration via PreAuthKeys
if req.Auth.AuthKey != "" {
h.handleAuthKey(ctx, machineKey, req, *machine)
2021-11-14 23:46:09 +08:00
2020-06-21 18:32:08 +08:00
return
}
h.handleMachineRegistrationNew(ctx, machineKey, req, *machine)
2020-06-21 18:32:08 +08:00
}
2021-11-13 16:36:45 +08:00
func (h *Headscale) getMapResponse(
machineKey key.MachinePublic,
2021-11-13 16:36:45 +08:00
req tailcfg.MapRequest,
machine *Machine,
2021-11-13 16:36:45 +08:00
) ([]byte, error) {
2021-08-06 04:47:06 +08:00
log.Trace().
Str("func", "getMapResponse").
Str("machine", req.Hostinfo.Hostname).
Msg("Creating Map response")
node, err := machine.toNode(h.cfg.BaseDomain, h.cfg.DNSConfig, true)
2020-06-21 18:32:08 +08:00
if err != nil {
2021-08-06 01:11:26 +08:00
log.Error().
Caller().
2021-08-06 03:57:47 +08:00
Str("func", "getMapResponse").
2021-08-06 01:11:26 +08:00
Err(err).
Msg("Cannot convert to node")
2021-11-14 23:46:09 +08:00
2020-06-21 18:32:08 +08:00
return nil, err
}
peers, err := h.getValidPeers(machine)
2020-06-21 18:32:08 +08:00
if err != nil {
2021-08-06 01:11:26 +08:00
log.Error().
Caller().
2021-08-06 03:57:47 +08:00
Str("func", "getMapResponse").
2021-08-06 01:11:26 +08:00
Err(err).
Msg("Cannot fetch peers")
2021-11-14 23:46:09 +08:00
2020-06-21 18:32:08 +08:00
return nil, err
}
profiles := getMapResponseUserProfiles(*machine, peers)
2021-10-05 05:49:16 +08:00
nodePeers, err := peers.toNodes(h.cfg.BaseDomain, h.cfg.DNSConfig, true)
if err != nil {
log.Error().
Caller().
Str("func", "getMapResponse").
Err(err).
Msg("Failed to convert peers to Tailscale nodes")
2021-11-14 23:46:09 +08:00
return nil, err
}
2021-11-15 01:03:21 +08:00
dnsConfig := getMapResponseDNSConfig(
2021-11-13 16:36:45 +08:00
h.cfg.DNSConfig,
h.cfg.BaseDomain,
*machine,
2021-11-13 16:36:45 +08:00
peers,
)
2021-10-02 18:13:19 +08:00
2020-06-21 18:32:08 +08:00
resp := tailcfg.MapResponse{
KeepAlive: false,
Node: node,
2021-10-05 05:43:42 +08:00
Peers: nodePeers,
2021-10-02 18:13:19 +08:00
DNSConfig: dnsConfig,
Domain: h.cfg.BaseDomain,
PacketFilter: h.aclRules,
2021-10-23 00:56:00 +08:00
DERPMap: h.DERPMap,
UserProfiles: profiles,
2021-02-24 07:31:58 +08:00
}
2021-08-13 17:33:19 +08:00
log.Trace().
Str("func", "getMapResponse").
Str("machine", req.Hostinfo.Hostname).
2021-10-06 00:51:42 +08:00
// Interface("payload", resp).
2021-08-13 17:33:19 +08:00
Msgf("Generated map response: %s", tailMapResponseToString(resp))
2020-06-21 18:32:08 +08:00
var respBody []byte
if req.Compress == "zstd" {
src, err := json.Marshal(resp)
if err != nil {
log.Error().
Caller().
Str("func", "getMapResponse").
Err(err).
Msg("Failed to marshal response for the client")
return nil, err
}
2021-08-13 17:33:19 +08:00
2020-06-21 18:32:08 +08:00
encoder, _ := zstd.NewWriter(nil)
srcCompressed := encoder.EncodeAll(src, nil)
respBody = h.privateKey.SealTo(machineKey, srcCompressed)
2020-06-21 18:32:08 +08:00
} else {
respBody, err = encode(resp, &machineKey, h.privateKey)
2020-06-21 18:32:08 +08:00
if err != nil {
return nil, err
}
}
// declare the incoming size on the first 4 bytes
data := make([]byte, reservedResponseHeaderSize)
2020-06-21 18:32:08 +08:00
binary.LittleEndian.PutUint32(data, uint32(len(respBody)))
data = append(data, respBody...)
2021-11-14 23:46:09 +08:00
return data, nil
2020-06-21 18:32:08 +08:00
}
2021-11-13 16:36:45 +08:00
func (h *Headscale) getMapKeepAliveResponse(
machineKey key.MachinePublic,
mapRequest tailcfg.MapRequest,
2021-11-13 16:36:45 +08:00
) ([]byte, error) {
mapResponse := tailcfg.MapResponse{
2020-06-21 18:32:08 +08:00
KeepAlive: true,
}
var respBody []byte
var err error
if mapRequest.Compress == "zstd" {
src, err := json.Marshal(mapResponse)
if err != nil {
log.Error().
Caller().
Str("func", "getMapKeepAliveResponse").
Err(err).
Msg("Failed to marshal keepalive response for the client")
return nil, err
}
2020-06-21 18:32:08 +08:00
encoder, _ := zstd.NewWriter(nil)
srcCompressed := encoder.EncodeAll(src, nil)
respBody = h.privateKey.SealTo(machineKey, srcCompressed)
2020-06-21 18:32:08 +08:00
} else {
respBody, err = encode(mapResponse, &machineKey, h.privateKey)
2020-06-21 18:32:08 +08:00
if err != nil {
return nil, err
}
}
data := make([]byte, reservedResponseHeaderSize)
2020-06-21 18:32:08 +08:00
binary.LittleEndian.PutUint32(data, uint32(len(respBody)))
data = append(data, respBody...)
2021-11-14 23:46:09 +08:00
return data, nil
2020-06-21 18:32:08 +08:00
}
func (h *Headscale) handleMachineLogOut(
ctx *gin.Context,
machineKey key.MachinePublic,
machine Machine,
) {
resp := tailcfg.RegisterResponse{}
log.Info().
Str("machine", machine.Name).
Msg("Client requested logout")
h.ExpireMachine(&machine)
resp.AuthURL = ""
resp.MachineAuthorized = false
resp.User = *machine.Namespace.toUser()
respBody, err := encode(resp, &machineKey, h.privateKey)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Cannot encode message")
ctx.String(http.StatusInternalServerError, "")
return
}
ctx.Data(http.StatusOK, "application/json; charset=utf-8", respBody)
}
func (h *Headscale) handleMachineValidRegistration(
ctx *gin.Context,
machineKey key.MachinePublic,
machine Machine,
) {
resp := tailcfg.RegisterResponse{}
// The machine registration is valid, respond with redirect to /map
log.Debug().
Str("machine", machine.Name).
Msg("Client is registered and we have the current NodeKey. All clear to /map")
resp.AuthURL = ""
resp.MachineAuthorized = true
resp.User = *machine.Namespace.toUser()
resp.Login = *machine.Namespace.toLogin()
respBody, err := encode(resp, &machineKey, h.privateKey)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Cannot encode message")
machineRegistrations.WithLabelValues("update", "web", "error", machine.Namespace.Name).
Inc()
ctx.String(http.StatusInternalServerError, "")
return
}
machineRegistrations.WithLabelValues("update", "web", "success", machine.Namespace.Name).
Inc()
ctx.Data(http.StatusOK, "application/json; charset=utf-8", respBody)
}
func (h *Headscale) handleMachineExpired(
ctx *gin.Context,
machineKey key.MachinePublic,
registerRequest tailcfg.RegisterRequest,
machine Machine,
) {
resp := tailcfg.RegisterResponse{}
// The client has registered before, but has expired
log.Debug().
Str("machine", machine.Name).
Msg("Machine registration has expired. Sending a authurl to register")
if registerRequest.Auth.AuthKey != "" {
h.handleAuthKey(ctx, machineKey, registerRequest, machine)
return
}
if h.cfg.OIDC.Issuer != "" {
resp.AuthURL = fmt.Sprintf("%s/oidc/register/%s",
strings.TrimSuffix(h.cfg.ServerURL, "/"), machineKey.String())
} else {
resp.AuthURL = fmt.Sprintf("%s/register?key=%s",
strings.TrimSuffix(h.cfg.ServerURL, "/"), machineKey.String())
}
respBody, err := encode(resp, &machineKey, h.privateKey)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Cannot encode message")
machineRegistrations.WithLabelValues("reauth", "web", "error", machine.Namespace.Name).
Inc()
ctx.String(http.StatusInternalServerError, "")
return
}
machineRegistrations.WithLabelValues("reauth", "web", "success", machine.Namespace.Name).
Inc()
ctx.Data(http.StatusOK, "application/json; charset=utf-8", respBody)
}
func (h *Headscale) handleMachineRefreshKey(
ctx *gin.Context,
machineKey key.MachinePublic,
2021-11-23 03:35:24 +08:00
registerRequest tailcfg.RegisterRequest,
machine Machine,
) {
resp := tailcfg.RegisterResponse{}
log.Debug().
Str("machine", machine.Name).
Msg("We have the OldNodeKey in the database. This is a key refresh")
machine.NodeKey = NodePublicKeyStripPrefix(registerRequest.NodeKey)
h.db.Save(&machine)
resp.AuthURL = ""
resp.User = *machine.Namespace.toUser()
respBody, err := encode(resp, &machineKey, h.privateKey)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Cannot encode message")
ctx.String(http.StatusInternalServerError, "Extremely sad!")
return
}
ctx.Data(http.StatusOK, "application/json; charset=utf-8", respBody)
}
func (h *Headscale) handleMachineRegistrationNew(
ctx *gin.Context,
machineKey key.MachinePublic,
2021-11-23 03:35:24 +08:00
registerRequest tailcfg.RegisterRequest,
machine Machine,
) {
resp := tailcfg.RegisterResponse{}
// The machine registration is new, redirect the client to the registration URL
log.Debug().
Str("machine", machine.Name).
Msg("The node is sending us a new NodeKey, sending auth url")
if h.cfg.OIDC.Issuer != "" {
resp.AuthURL = fmt.Sprintf(
"%s/oidc/register/%s",
strings.TrimSuffix(h.cfg.ServerURL, "/"),
machineKey.String(),
)
} else {
resp.AuthURL = fmt.Sprintf("%s/register?key=%s",
strings.TrimSuffix(h.cfg.ServerURL, "/"), MachinePublicKeyStripPrefix(machineKey))
}
2021-11-23 03:35:24 +08:00
if !registerRequest.Expiry.IsZero() {
log.Trace().
Caller().
Str("machine", machine.Name).
2021-11-23 03:35:24 +08:00
Time("expiry", registerRequest.Expiry).
Msg("Non-zero expiry time requested, adding to cache")
h.requestedExpiryCache.Set(
machineKey.String(),
2021-11-23 03:35:24 +08:00
registerRequest.Expiry,
requestedExpiryCacheExpiration,
)
}
machine.NodeKey = NodePublicKeyStripPrefix(registerRequest.NodeKey)
// save the NodeKey
h.db.Save(&machine)
respBody, err := encode(resp, &machineKey, h.privateKey)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Cannot encode message")
ctx.String(http.StatusInternalServerError, "")
return
}
ctx.Data(http.StatusOK, "application/json; charset=utf-8", respBody)
}
2022-01-16 21:16:59 +08:00
// TODO: check if any locks are needed around IP allocation.
2021-10-23 00:56:00 +08:00
func (h *Headscale) handleAuthKey(
ctx *gin.Context,
machineKey key.MachinePublic,
2021-11-23 03:35:24 +08:00
registerRequest tailcfg.RegisterRequest,
machine Machine,
2021-10-23 00:56:00 +08:00
) {
2021-08-06 01:11:26 +08:00
log.Debug().
2021-08-06 03:57:47 +08:00
Str("func", "handleAuthKey").
2021-11-23 03:35:24 +08:00
Str("machine", registerRequest.Hostinfo.Hostname).
Msgf("Processing auth key for %s", registerRequest.Hostinfo.Hostname)
2021-05-06 06:59:26 +08:00
resp := tailcfg.RegisterResponse{}
2021-11-23 03:35:24 +08:00
pak, err := h.checkKeyValidity(registerRequest.Auth.AuthKey)
if err != nil {
2021-10-05 00:03:44 +08:00
log.Error().
Caller().
2021-10-05 00:03:44 +08:00
Str("func", "handleAuthKey").
Str("machine", machine.Name).
2021-10-05 00:03:44 +08:00
Err(err).
Msg("Failed authentication via AuthKey")
resp.MachineAuthorized = false
respBody, err := encode(resp, &machineKey, h.privateKey)
2021-05-06 06:59:26 +08:00
if err != nil {
2021-08-06 01:11:26 +08:00
log.Error().
Caller().
2021-08-06 03:57:47 +08:00
Str("func", "handleAuthKey").
Str("machine", machine.Name).
2021-08-06 01:11:26 +08:00
Err(err).
Msg("Cannot encode message")
ctx.String(http.StatusInternalServerError, "")
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", machine.Namespace.Name).
2021-11-13 16:36:45 +08:00
Inc()
2021-11-14 23:46:09 +08:00
2021-05-06 06:59:26 +08:00
return
}
ctx.Data(http.StatusUnauthorized, "application/json; charset=utf-8", respBody)
2021-08-06 01:11:26 +08:00
log.Error().
Caller().
2021-08-06 03:57:47 +08:00
Str("func", "handleAuthKey").
Str("machine", machine.Name).
2021-08-06 01:11:26 +08:00
Msg("Failed authentication via AuthKey")
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", machine.Namespace.Name).
2021-11-13 16:36:45 +08:00
Inc()
2021-11-14 23:46:09 +08:00
return
}
2021-08-06 01:11:26 +08:00
if machine.isRegistered() {
log.Trace().
Caller().
Str("machine", machine.Name).
Msg("machine already registered, reauthenticating")
2021-11-23 03:35:24 +08:00
h.RefreshMachine(&machine, registerRequest.Expiry)
} else {
log.Debug().
2021-08-06 03:57:47 +08:00
Str("func", "handleAuthKey").
Str("machine", machine.Name).
2022-01-16 21:16:59 +08:00
Msg("Authentication key was valid, proceeding to acquire IP addresses")
nodeKey := NodePublicKeyStripPrefix(registerRequest.NodeKey)
now := time.Now().UTC()
_, err = h.RegisterMachine(
machine.Name,
machine.Namespace.Name,
RegisterMethodAuthKey,
&registerRequest.Expiry,
pak,
&nodeKey,
&now,
)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("could not register machine")
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", machine.Namespace.Name).Inc()
ctx.String(
http.StatusInternalServerError,
"could not register machine",
)
2021-11-14 23:46:09 +08:00
return
}
2020-06-21 18:32:08 +08:00
}
2021-05-06 06:59:26 +08:00
pak.Used = true
h.db.Save(&pak)
2021-10-10 17:22:42 +08:00
resp.MachineAuthorized = true
resp.User = *pak.Namespace.toUser()
respBody, err := encode(resp, &machineKey, h.privateKey)
2020-06-21 18:32:08 +08:00
if err != nil {
2021-08-06 01:11:26 +08:00
log.Error().
Caller().
2021-08-06 03:57:47 +08:00
Str("func", "handleAuthKey").
Str("machine", machine.Name).
2021-08-06 01:11:26 +08:00
Err(err).
Msg("Cannot encode message")
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", machine.Namespace.Name).
2021-11-13 16:36:45 +08:00
Inc()
ctx.String(http.StatusInternalServerError, "Extremely sad!")
2021-11-14 23:46:09 +08:00
2020-06-21 18:32:08 +08:00
return
}
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "success", machine.Namespace.Name).
2021-11-13 16:36:45 +08:00
Inc()
ctx.Data(http.StatusOK, "application/json; charset=utf-8", respBody)
2021-08-06 01:11:26 +08:00
log.Info().
2021-08-06 03:57:47 +08:00
Str("func", "handleAuthKey").
Str("machine", machine.Name).
2022-01-16 21:16:59 +08:00
Str("ips", strings.Join(machine.IPAddresses.ToStringSlice(), ", ")).
2021-08-06 01:11:26 +08:00
Msg("Successfully authenticated via AuthKey")
2020-06-21 18:32:08 +08:00
}