headscale/api.go

828 lines
21 KiB
Go
Raw Normal View History

2020-06-21 06:32:08 -04:00
package headscale
import (
2021-12-22 21:43:53 -05:00
"bytes"
2020-06-21 06:32:08 -04:00
"encoding/binary"
"encoding/json"
2021-06-24 09:44:19 -04:00
"errors"
2020-06-21 06:32:08 -04:00
"fmt"
2021-12-22 21:43:53 -05:00
"html/template"
2020-06-21 06:32:08 -04:00
"io"
"net/http"
2021-10-08 05:43:52 -04:00
"strings"
2020-06-21 06:32:08 -04:00
"time"
"github.com/gorilla/mux"
2020-06-21 06:32:08 -04:00
"github.com/klauspost/compress/zstd"
2021-11-13 03:39:04 -05:00
"github.com/rs/zerolog/log"
2021-06-24 09:44:19 -04:00
"gorm.io/gorm"
2020-06-21 06:32:08 -04:00
"tailscale.com/tailcfg"
"tailscale.com/types/key"
2020-06-21 06:32:08 -04:00
)
2021-11-18 03:49:55 -05:00
const (
reservedResponseHeaderSize = 4
2022-02-27 12:48:12 -05:00
RegisterMethodAuthKey = "authkey"
RegisterMethodOIDC = "oidc"
RegisterMethodCLI = "cli"
ErrRegisterMethodCLIDoesNotSupportExpire = Error(
"machines registered with CLI does not support expire",
)
2021-11-18 03:49:55 -05:00
)
// KeyHandler provides the Headscale pub key
2021-11-13 03:39:04 -05:00
// Listens in /key.
func (h *Headscale) KeyHandler(
2022-06-26 05:55:37 -04:00
writer http.ResponseWriter,
req *http.Request,
) {
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "text/plain; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 06:21:35 -04:00
_, err := writer.Write([]byte(MachinePublicKeyStripPrefix(h.privateKey.Public())))
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
2020-06-21 06:32:08 -04:00
}
2021-12-22 21:43:53 -05:00
type registerWebAPITemplateConfig struct {
Key string
}
2021-12-22 21:43:53 -05:00
var registerWebAPITemplate = template.Must(
template.New("registerweb").Parse(`
<html>
<head>
<title>Registration - Headscale</title>
</head>
<body>
<h1>headscale</h1>
<h2>Machine registration</h2>
<p>
Run the command below in the headscale server to add this machine to your network:
</p>
<pre><code>headscale -n NAMESPACE nodes register --key {{.Key}}</code></pre>
</body>
</html>
`))
2021-12-22 21:43:53 -05:00
// RegisterWebAPI shows a simple message in the browser to point to the CLI
// Listens in /register.
func (h *Headscale) RegisterWebAPI(
2022-06-26 05:55:37 -04:00
writer http.ResponseWriter,
req *http.Request,
) {
2022-06-26 05:55:37 -04:00
machineKeyStr := req.URL.Query().Get("key")
2021-12-22 21:43:53 -05:00
if machineKeyStr == "" {
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "text/plain; charset=utf-8")
writer.WriteHeader(http.StatusBadRequest)
2022-06-26 06:21:35 -04:00
_, err := writer.Write([]byte("Wrong params"))
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
2021-12-22 21:43:53 -05:00
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")
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "text/plain; charset=utf-8")
writer.WriteHeader(http.StatusInternalServerError)
2022-06-26 06:21:35 -04:00
_, err = writer.Write([]byte("Could not render register web API template"))
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
2022-06-26 05:55:37 -04:00
return
2021-12-22 21:43:53 -05:00
}
2021-05-24 15:59:03 -04:00
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "text/html; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 06:21:35 -04:00
_, err := writer.Write(content.Bytes())
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
}
// RegistrationHandler handles the actual registration process of a machine
// Endpoint /machine/:mkey.
func (h *Headscale) RegistrationHandler(
2022-06-26 05:55:37 -04:00
writer http.ResponseWriter,
req *http.Request,
) {
2022-06-26 05:55:37 -04:00
vars := mux.Vars(req)
machineKeyStr, ok := vars["mkey"]
if !ok || machineKeyStr == "" {
log.Error().
Str("handler", "RegistrationHandler").
Msg("No machine ID in request")
2022-06-26 05:55:37 -04:00
http.Error(writer, "No machine ID in request", http.StatusBadRequest)
return
}
2022-06-26 05:55:37 -04:00
body, _ := io.ReadAll(req.Body)
var machineKey key.MachinePublic
err := machineKey.UnmarshalText([]byte(MachinePublicKeyEnsurePrefix(machineKeyStr)))
2020-06-21 06:32:08 -04:00
if err != nil {
2021-08-05 13:11:26 -04:00
log.Error().
Caller().
2021-08-05 13:11:26 -04:00
Err(err).
Msg("Cannot parse machine key")
2021-10-10 05:22:42 -04:00
machineRegistrations.WithLabelValues("unknown", "web", "error", "unknown").Inc()
2022-06-26 05:55:37 -04:00
http.Error(writer, "Cannot parse machine key", http.StatusBadRequest)
2021-11-14 10:46:09 -05:00
2020-06-21 06:32:08 -04:00
return
}
2022-06-26 05:55:37 -04:00
registerRequest := tailcfg.RegisterRequest{}
err = decode(body, &registerRequest, &machineKey, h.privateKey)
2020-06-21 06:32:08 -04:00
if err != nil {
2021-08-05 13:11:26 -04:00
log.Error().
Caller().
2021-08-05 13:11:26 -04:00
Err(err).
Msg("Cannot decode message")
2021-10-10 05:22:42 -04:00
machineRegistrations.WithLabelValues("unknown", "web", "error", "unknown").Inc()
2022-06-26 05:55:37 -04:00
http.Error(writer, "Cannot decode message", http.StatusBadRequest)
2021-11-14 10:46:09 -05:00
2020-06-21 06:32:08 -04:00
return
}
2021-05-05 18:59:26 -04:00
now := time.Now().UTC()
machine, err := h.GetMachineByMachineKey(machineKey)
2021-10-10 05:22:42 -04:00
if errors.Is(err, gorm.ErrRecordNotFound) {
2022-06-26 05:55:37 -04:00
log.Info().Str("machine", registerRequest.Hostinfo.Hostname).Msg("New machine")
machineKeyStr := MachinePublicKeyStripPrefix(machineKey)
// If the machine has AuthKey set, handle registration via PreAuthKeys
2022-06-26 05:55:37 -04:00
if registerRequest.Auth.AuthKey != "" {
h.handleAuthKey(writer, req, machineKey, registerRequest)
return
}
2022-04-24 16:12:45 -04:00
2022-06-26 05:55:37 -04:00
givenName, err := h.GenerateGivenName(registerRequest.Hostinfo.Hostname)
if err != nil {
log.Error().
Caller().
Str("func", "RegistrationHandler").
2022-06-26 05:55:37 -04:00
Str("hostinfo.name", registerRequest.Hostinfo.Hostname).
Err(err)
return
}
// The machine did not have a key to authenticate, which means
// that we rely on a method that calls back some how (OpenID or CLI)
// We create the machine and then keep it around until a callback
// happens
2021-10-10 05:22:42 -04:00
newMachine := Machine{
MachineKey: machineKeyStr,
2022-06-26 05:55:37 -04:00
Hostname: registerRequest.Hostinfo.Hostname,
GivenName: givenName,
2022-06-26 05:55:37 -04:00
NodeKey: NodePublicKeyStripPrefix(registerRequest.NodeKey),
LastSeen: &now,
2022-03-02 02:15:20 -05:00
Expiry: &time.Time{},
}
2021-11-14 10:46:09 -05:00
2022-06-26 05:55:37 -04:00
if !registerRequest.Expiry.IsZero() {
log.Trace().
Caller().
2022-06-26 05:55:37 -04:00
Str("machine", registerRequest.Hostinfo.Hostname).
Time("expiry", registerRequest.Expiry).
Msg("Non-zero expiry time requested")
2022-06-26 05:55:37 -04:00
newMachine.Expiry = &registerRequest.Expiry
}
h.registrationCache.Set(
machineKeyStr,
newMachine,
registerCacheExpiration,
)
2022-06-26 05:55:37 -04:00
h.handleMachineRegistrationNew(writer, req, machineKey, registerRequest)
return
}
// The machine is already registered, so we need to pass through reauth or key update.
if machine != nil {
// 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
2022-06-26 05:55:37 -04:00
if machine.NodeKey == NodePublicKeyStripPrefix(registerRequest.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
2022-06-26 05:55:37 -04:00
if !registerRequest.Expiry.IsZero() && registerRequest.Expiry.UTC().Before(now) {
h.handleMachineLogOut(writer, req, 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() {
2022-06-26 05:55:37 -04:00
h.handleMachineValidRegistration(writer, req, machineKey, *machine)
return
}
2021-10-08 05:43:52 -04:00
}
// The NodeKey we have matches OldNodeKey, which means this is a refresh after a key expiration
2022-06-26 05:55:37 -04:00
if machine.NodeKey == NodePublicKeyStripPrefix(registerRequest.OldNodeKey) &&
!machine.isExpired() {
2022-06-26 05:55:37 -04:00
h.handleMachineRefreshKey(writer, req, machineKey, registerRequest, *machine)
2021-11-14 10:46:09 -05:00
2020-06-21 06:32:08 -04:00
return
}
// The machine has expired
2022-06-26 05:55:37 -04:00
h.handleMachineExpired(writer, req, machineKey, registerRequest, *machine)
return
2020-06-21 06:32:08 -04:00
}
}
2021-11-13 03:36:45 -05:00
func (h *Headscale) getMapResponse(
machineKey key.MachinePublic,
2022-06-26 05:55:37 -04:00
mapRequest tailcfg.MapRequest,
machine *Machine,
2021-11-13 03:36:45 -05:00
) ([]byte, error) {
2021-08-05 16:47:06 -04:00
log.Trace().
Str("func", "getMapResponse").
2022-06-26 05:55:37 -04:00
Str("machine", mapRequest.Hostinfo.Hostname).
2021-08-05 16:47:06 -04:00
Msg("Creating Map response")
node, err := machine.toNode(h.cfg.BaseDomain, h.cfg.DNSConfig, true)
2020-06-21 06:32:08 -04:00
if err != nil {
2021-08-05 13:11:26 -04:00
log.Error().
Caller().
2021-08-05 15:57:47 -04:00
Str("func", "getMapResponse").
2021-08-05 13:11:26 -04:00
Err(err).
Msg("Cannot convert to node")
2021-11-14 10:46:09 -05:00
2020-06-21 06:32:08 -04:00
return nil, err
}
peers, err := h.getValidPeers(machine)
2020-06-21 06:32:08 -04:00
if err != nil {
2021-08-05 13:11:26 -04:00
log.Error().
Caller().
2021-08-05 15:57:47 -04:00
Str("func", "getMapResponse").
2021-08-05 13:11:26 -04:00
Err(err).
Msg("Cannot fetch peers")
2021-11-14 10:46:09 -05:00
2020-06-21 06:32:08 -04:00
return nil, err
}
profiles := getMapResponseUserProfiles(*machine, peers)
2021-10-04 17:49:16 -04: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 10:46:09 -05:00
return nil, err
}
2021-11-14 12:03:21 -05:00
dnsConfig := getMapResponseDNSConfig(
2021-11-13 03:36:45 -05:00
h.cfg.DNSConfig,
h.cfg.BaseDomain,
*machine,
2021-11-13 03:36:45 -05:00
peers,
)
2021-10-02 06:13:19 -04:00
2020-06-21 06:32:08 -04:00
resp := tailcfg.MapResponse{
KeepAlive: false,
Node: node,
2021-10-04 17:43:42 -04:00
Peers: nodePeers,
2021-10-02 06:13:19 -04:00
DNSConfig: dnsConfig,
Domain: h.cfg.BaseDomain,
PacketFilter: h.aclRules,
2021-10-22 12:56:00 -04:00
DERPMap: h.DERPMap,
UserProfiles: profiles,
2022-05-30 08:52:50 -04:00
Debug: &tailcfg.Debug{
2022-06-09 15:20:11 -04:00
DisableLogTail: !h.cfg.LogTail.Enabled,
RandomizeClientPort: h.cfg.RandomizeClientPort,
2022-05-30 08:52:50 -04:00
},
2021-02-23 18:31:58 -05:00
}
2021-08-13 05:33:19 -04:00
log.Trace().
Str("func", "getMapResponse").
2022-06-26 05:55:37 -04:00
Str("machine", mapRequest.Hostinfo.Hostname).
2021-10-05 12:51:42 -04:00
// Interface("payload", resp).
2021-08-13 05:33:19 -04:00
Msgf("Generated map response: %s", tailMapResponseToString(resp))
2020-06-21 06:32:08 -04:00
var respBody []byte
2022-06-26 05:55:37 -04:00
if mapRequest.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 05:33:19 -04:00
2020-06-21 06:32:08 -04:00
encoder, _ := zstd.NewWriter(nil)
srcCompressed := encoder.EncodeAll(src, nil)
respBody = h.privateKey.SealTo(machineKey, srcCompressed)
2020-06-21 06:32:08 -04:00
} else {
respBody, err = encode(resp, &machineKey, h.privateKey)
2020-06-21 06:32:08 -04:00
if err != nil {
return nil, err
}
}
// declare the incoming size on the first 4 bytes
data := make([]byte, reservedResponseHeaderSize)
2020-06-21 06:32:08 -04:00
binary.LittleEndian.PutUint32(data, uint32(len(respBody)))
data = append(data, respBody...)
2021-11-14 10:46:09 -05:00
return data, nil
2020-06-21 06:32:08 -04:00
}
2021-11-13 03:36:45 -05:00
func (h *Headscale) getMapKeepAliveResponse(
machineKey key.MachinePublic,
mapRequest tailcfg.MapRequest,
2021-11-13 03:36:45 -05:00
) ([]byte, error) {
mapResponse := tailcfg.MapResponse{
2020-06-21 06:32:08 -04: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 06:32:08 -04:00
encoder, _ := zstd.NewWriter(nil)
srcCompressed := encoder.EncodeAll(src, nil)
respBody = h.privateKey.SealTo(machineKey, srcCompressed)
2020-06-21 06:32:08 -04:00
} else {
respBody, err = encode(mapResponse, &machineKey, h.privateKey)
2020-06-21 06:32:08 -04:00
if err != nil {
return nil, err
}
}
data := make([]byte, reservedResponseHeaderSize)
2020-06-21 06:32:08 -04:00
binary.LittleEndian.PutUint32(data, uint32(len(respBody)))
data = append(data, respBody...)
2021-11-14 10:46:09 -05:00
return data, nil
2020-06-21 06:32:08 -04:00
}
func (h *Headscale) handleMachineLogOut(
2022-06-26 05:55:37 -04:00
writer http.ResponseWriter,
req *http.Request,
machineKey key.MachinePublic,
machine Machine,
) {
resp := tailcfg.RegisterResponse{}
log.Info().
Str("machine", machine.Hostname).
Msg("Client requested logout")
2022-06-26 06:30:52 -04:00
err := h.ExpireMachine(&machine)
if err != nil {
log.Error().
Caller().
Str("func", "handleMachineLogOut").
Err(err).
Msg("Failed to expire machine")
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
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")
2022-06-26 05:55:37 -04:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 06:21:35 -04:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
}
func (h *Headscale) handleMachineValidRegistration(
2022-06-26 05:55:37 -04:00
writer http.ResponseWriter,
req *http.Request,
machineKey key.MachinePublic,
machine Machine,
) {
resp := tailcfg.RegisterResponse{}
// The machine registration is valid, respond with redirect to /map
log.Debug().
Str("machine", machine.Hostname).
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()
2022-06-26 05:55:37 -04:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
machineRegistrations.WithLabelValues("update", "web", "success", machine.Namespace.Name).
Inc()
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 06:21:35 -04:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
}
func (h *Headscale) handleMachineExpired(
2022-06-26 05:55:37 -04:00
writer http.ResponseWriter,
req *http.Request,
machineKey key.MachinePublic,
registerRequest tailcfg.RegisterRequest,
machine Machine,
) {
resp := tailcfg.RegisterResponse{}
// The client has registered before, but has expired
log.Debug().
Str("machine", machine.Hostname).
Msg("Machine registration has expired. Sending a authurl to register")
if registerRequest.Auth.AuthKey != "" {
2022-06-26 05:55:37 -04:00
h.handleAuthKey(writer, req, machineKey, registerRequest)
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()
2022-06-26 05:55:37 -04:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
machineRegistrations.WithLabelValues("reauth", "web", "success", machine.Namespace.Name).
Inc()
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 06:21:35 -04:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
}
func (h *Headscale) handleMachineRefreshKey(
2022-06-26 05:55:37 -04:00
writer http.ResponseWriter,
req *http.Request,
machineKey key.MachinePublic,
2021-11-22 14:35:24 -05:00
registerRequest tailcfg.RegisterRequest,
machine Machine,
) {
resp := tailcfg.RegisterResponse{}
log.Debug().
Str("machine", machine.Hostname).
Msg("We have the OldNodeKey in the database. This is a key refresh")
machine.NodeKey = NodePublicKeyStripPrefix(registerRequest.NodeKey)
2022-05-30 09:39:24 -04:00
if err := h.db.Save(&machine).Error; err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to update machine key in the database")
2022-06-26 05:55:37 -04:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
2022-05-30 09:39:24 -04:00
return
}
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")
2022-06-26 05:55:37 -04:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 06:21:35 -04:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
}
func (h *Headscale) handleMachineRegistrationNew(
2022-06-26 05:55:37 -04:00
writer http.ResponseWriter,
req *http.Request,
machineKey key.MachinePublic,
2021-11-22 14:35:24 -05:00
registerRequest tailcfg.RegisterRequest,
) {
resp := tailcfg.RegisterResponse{}
// The machine registration is new, redirect the client to the registration URL
log.Debug().
Str("machine", registerRequest.Hostinfo.Hostname).
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))
}
respBody, err := encode(resp, &machineKey, h.privateKey)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Cannot encode message")
2022-06-26 05:55:37 -04:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 06:21:35 -04:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
}
2022-01-16 08:16:59 -05:00
// TODO: check if any locks are needed around IP allocation.
2021-10-22 12:56:00 -04:00
func (h *Headscale) handleAuthKey(
2022-06-26 05:55:37 -04:00
writer http.ResponseWriter,
req *http.Request,
machineKey key.MachinePublic,
2021-11-22 14:35:24 -05:00
registerRequest tailcfg.RegisterRequest,
2021-10-22 12:56:00 -04:00
) {
machineKeyStr := MachinePublicKeyStripPrefix(machineKey)
2021-08-05 13:11:26 -04:00
log.Debug().
2021-08-05 15:57:47 -04:00
Str("func", "handleAuthKey").
2021-11-22 14:35:24 -05:00
Str("machine", registerRequest.Hostinfo.Hostname).
Msgf("Processing auth key for %s", registerRequest.Hostinfo.Hostname)
2021-05-05 18:59:26 -04:00
resp := tailcfg.RegisterResponse{}
2021-11-22 14:35:24 -05:00
pak, err := h.checkKeyValidity(registerRequest.Auth.AuthKey)
if err != nil {
2021-10-04 12:03:44 -04:00
log.Error().
Caller().
2021-10-04 12:03:44 -04:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2021-10-04 12:03:44 -04:00
Err(err).
Msg("Failed authentication via AuthKey")
resp.MachineAuthorized = false
respBody, err := encode(resp, &machineKey, h.privateKey)
2021-05-05 18:59:26 -04:00
if err != nil {
2021-08-05 13:11:26 -04:00
log.Error().
Caller().
2021-08-05 15:57:47 -04:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2021-08-05 13:11:26 -04:00
Err(err).
Msg("Cannot encode message")
2022-06-26 05:55:37 -04:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", pak.Namespace.Name).
2021-11-13 03:36:45 -05:00
Inc()
2021-11-14 10:46:09 -05:00
2021-05-05 18:59:26 -04:00
return
}
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusUnauthorized)
2022-06-26 06:21:35 -04:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
2021-08-05 13:11:26 -04:00
log.Error().
Caller().
2021-08-05 15:57:47 -04:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2021-08-05 13:11:26 -04:00
Msg("Failed authentication via AuthKey")
if pak != nil {
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", pak.Namespace.Name).
Inc()
} else {
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", "unknown").Inc()
}
2021-11-14 10:46:09 -05:00
return
}
2021-08-05 13:11:26 -04:00
log.Debug().
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
Msg("Authentication key was valid, proceeding to acquire IP addresses")
nodeKey := NodePublicKeyStripPrefix(registerRequest.NodeKey)
// retrieve machine information if it exist
// The error is not important, because if it does not
// exist, then this is a new machine and we will move
// on to registration.
machine, _ := h.GetMachineByMachineKey(machineKey)
if machine != nil {
log.Trace().
Caller().
Str("machine", machine.Hostname).
Msg("machine already registered, refreshing with new auth key")
2021-11-14 10:46:09 -05:00
machine.NodeKey = nodeKey
machine.AuthKeyID = uint(pak.ID)
2022-06-26 06:30:52 -04:00
err := h.RefreshMachine(machine, registerRequest.Expiry)
if err != nil {
log.Error().
Caller().
Str("machine", machine.Hostname).
Err(err).
Msg("Failed to refresh machine")
return
}
} else {
now := time.Now().UTC()
givenName, err := h.GenerateGivenName(registerRequest.Hostinfo.Hostname)
if err != nil {
log.Error().
Caller().
Str("func", "RegistrationHandler").
Str("hostinfo.name", registerRequest.Hostinfo.Hostname).
Err(err)
return
}
machineToRegister := Machine{
Hostname: registerRequest.Hostinfo.Hostname,
GivenName: givenName,
NamespaceID: pak.Namespace.ID,
MachineKey: machineKeyStr,
RegisterMethod: RegisterMethodAuthKey,
Expiry: &registerRequest.Expiry,
NodeKey: nodeKey,
LastSeen: &now,
AuthKeyID: uint(pak.ID),
}
2022-03-10 10:22:21 -05:00
machine, err = h.RegisterMachine(
machineToRegister,
)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("could not register machine")
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", pak.Namespace.Name).
Inc()
2022-06-26 05:55:37 -04:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
2022-03-10 10:22:21 -05:00
return
2022-03-10 10:22:21 -05:00
}
2020-06-21 06:32:08 -04:00
}
2021-05-05 18:59:26 -04:00
2022-06-26 06:30:52 -04:00
err = h.UsePreAuthKey(pak)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to use pre-auth key")
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", pak.Namespace.Name).
Inc()
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
2021-10-10 05:22:42 -04:00
resp.MachineAuthorized = true
resp.User = *pak.Namespace.toUser()
respBody, err := encode(resp, &machineKey, h.privateKey)
2020-06-21 06:32:08 -04:00
if err != nil {
2021-08-05 13:11:26 -04:00
log.Error().
Caller().
2021-08-05 15:57:47 -04:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2021-08-05 13:11:26 -04:00
Err(err).
Msg("Cannot encode message")
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", pak.Namespace.Name).
2021-11-13 03:36:45 -05:00
Inc()
2022-06-26 05:55:37 -04:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
2021-11-14 10:46:09 -05:00
2020-06-21 06:32:08 -04:00
return
}
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "success", pak.Namespace.Name).
2021-11-13 03:36:45 -05:00
Inc()
2022-06-26 05:55:37 -04:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 06:21:35 -04:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
2021-08-05 13:11:26 -04:00
log.Info().
2021-08-05 15:57:47 -04:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2022-01-16 08:16:59 -05:00
Str("ips", strings.Join(machine.IPAddresses.ToStringSlice(), ", ")).
2021-08-05 13:11:26 -04:00
Msg("Successfully authenticated via AuthKey")
2020-06-21 06:32:08 -04:00
}