headscale/api.go

574 lines
14 KiB
Go
Raw Normal View History

2020-06-21 12:32:08 +02:00
package headscale
import (
2021-12-22 19:43:53 -07:00
"bytes"
2020-06-21 12:32:08 +02:00
"encoding/json"
"fmt"
2021-12-22 19:43:53 -07:00
"html/template"
2020-06-21 12:32:08 +02:00
"net/http"
2021-10-08 17:43:52 +08:00
"strings"
2020-06-21 12:32:08 +02:00
"time"
"github.com/gorilla/mux"
2021-11-13 08:39:04 +00:00
"github.com/rs/zerolog/log"
2020-06-21 12:32:08 +02:00
"tailscale.com/tailcfg"
"tailscale.com/types/key"
2020-06-21 12:32:08 +02:00
)
2021-11-18 08:49:55 +00:00
const (
2022-08-12 09:36:17 +02:00
// TODO(juan): remove this once https://github.com/juanfont/headscale/issues/727 is fixed.
registrationHoldoff = time.Second * 5
reservedResponseHeaderSize = 4
2022-02-27 18:48:12 +01:00
RegisterMethodAuthKey = "authkey"
RegisterMethodOIDC = "oidc"
RegisterMethodCLI = "cli"
ErrRegisterMethodCLIDoesNotSupportExpire = Error(
"machines registered with CLI does not support expire",
)
2021-11-18 08:49:55 +00:00
)
2022-07-06 13:39:10 +02:00
func (h *Headscale) HealthHandler(
writer http.ResponseWriter,
req *http.Request,
) {
respond := func(err error) {
writer.Header().Set("Content-Type", "application/health+json; charset=utf-8")
res := struct {
Status string `json:"status"`
}{
Status: "pass",
}
if err != nil {
writer.WriteHeader(http.StatusInternalServerError)
log.Error().Caller().Err(err).Msg("health check failed")
res.Status = "fail"
}
buf, err := json.Marshal(res)
if err != nil {
log.Error().Caller().Err(err).Msg("marshal failed")
}
_, err = writer.Write(buf)
if err != nil {
log.Error().Caller().Err(err).Msg("write failed")
}
}
if err := h.pingDB(); err != nil {
respond(err)
return
}
respond(nil)
}
2021-12-22 19:43:53 -07:00
type registerWebAPITemplateConfig struct {
Key string
}
2021-12-22 19:43:53 -07: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 19:43:53 -07:00
// RegisterWebAPI shows a simple message in the browser to point to the CLI
// Listens in /register/:nkey.
//
// This is not part of the Tailscale control API, as we could send whatever URL
// in the RegisterResponse.AuthURL field.
func (h *Headscale) RegisterWebAPI(
2022-06-26 11:55:37 +02:00
writer http.ResponseWriter,
req *http.Request,
) {
vars := mux.Vars(req)
nodeKeyStr, ok := vars["nkey"]
if !ok || nodeKeyStr == "" {
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "text/plain; charset=utf-8")
writer.WriteHeader(http.StatusBadRequest)
2022-06-26 12:21:35 +02:00
_, err := writer.Write([]byte("Wrong params"))
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
2021-12-22 19:43:53 -07:00
return
}
var content bytes.Buffer
if err := registerWebAPITemplate.Execute(&content, registerWebAPITemplateConfig{
Key: nodeKeyStr,
2021-12-22 19:43:53 -07:00
}); err != nil {
log.Error().
Str("func", "RegisterWebAPI").
Err(err).
Msg("Could not render register web API template")
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "text/plain; charset=utf-8")
writer.WriteHeader(http.StatusInternalServerError)
2022-06-26 12:21:35 +02: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 11:55:37 +02:00
return
2021-12-22 19:43:53 -07:00
}
2021-05-24 21:59:03 +02:00
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "text/html; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 12:21:35 +02:00
_, err := writer.Write(content.Bytes())
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
}
func (h *Headscale) handleMachineLogOut(
2022-06-26 11:55:37 +02: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 12:30:52 +02: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 11:55:37 +02:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 12:21:35 +02: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 11:55:37 +02: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 11:55:37 +02:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
machineRegistrations.WithLabelValues("update", "web", "success", machine.Namespace.Name).
Inc()
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 12:21:35 +02: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 11:55:37 +02: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 11:55:37 +02:00
h.handleAuthKey(writer, req, machineKey, registerRequest)
return
}
if h.cfg.OIDC.Issuer != "" {
resp.AuthURL = fmt.Sprintf("%s/oidc/register/%s",
2022-08-14 12:10:20 +02:00
strings.TrimSuffix(h.cfg.ServerURL, "/"),
NodePublicKeyStripPrefix(registerRequest.NodeKey))
} else {
2022-08-13 21:17:05 +02:00
resp.AuthURL = fmt.Sprintf("%s/register/%s",
2022-08-14 12:10:20 +02:00
strings.TrimSuffix(h.cfg.ServerURL, "/"),
NodePublicKeyStripPrefix(registerRequest.NodeKey))
}
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 11:55:37 +02:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
machineRegistrations.WithLabelValues("reauth", "web", "success", machine.Namespace.Name).
Inc()
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 12:21:35 +02: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 11:55:37 +02:00
writer http.ResponseWriter,
req *http.Request,
machineKey key.MachinePublic,
2021-11-22 19:35:24 +00: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 15:39:24 +02: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 11:55:37 +02:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
2022-05-30 15:39:24 +02: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 11:55:37 +02:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 12:21:35 +02: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 11:55:37 +02:00
writer http.ResponseWriter,
req *http.Request,
machineKey key.MachinePublic,
2021-11-22 19:35:24 +00:00
registerRequest tailcfg.RegisterRequest,
) {
resp := tailcfg.RegisterResponse{}
// The machine registration is new, redirect the client to the registration URL
log.Debug().
2022-08-14 21:07:05 +02:00
Caller().
Str("machine", registerRequest.Hostinfo.Hostname).
Msg("The node seems to be new, sending auth url")
if h.cfg.OIDC.Issuer != "" {
resp.AuthURL = fmt.Sprintf(
"%s/oidc/register/%s",
strings.TrimSuffix(h.cfg.ServerURL, "/"),
2022-08-14 12:04:31 +02:00
NodePublicKeyStripPrefix(registerRequest.NodeKey),
)
} else {
resp.AuthURL = fmt.Sprintf("%s/register/%s",
2022-08-14 12:10:20 +02:00
strings.TrimSuffix(h.cfg.ServerURL, "/"),
NodePublicKeyStripPrefix(registerRequest.NodeKey))
}
respBody, err := encode(resp, &machineKey, h.privateKey)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Cannot encode message")
2022-06-26 11:55:37 +02:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
return
}
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 12:21:35 +02:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
}
2022-01-16 14:16:59 +01:00
// TODO: check if any locks are needed around IP allocation.
2021-10-22 16:56:00 +00:00
func (h *Headscale) handleAuthKey(
2022-06-26 11:55:37 +02:00
writer http.ResponseWriter,
req *http.Request,
machineKey key.MachinePublic,
2021-11-22 19:35:24 +00:00
registerRequest tailcfg.RegisterRequest,
2021-10-22 16:56:00 +00:00
) {
machineKeyStr := MachinePublicKeyStripPrefix(machineKey)
2021-08-05 18:11:26 +01:00
log.Debug().
2021-08-05 20:57:47 +01:00
Str("func", "handleAuthKey").
2021-11-22 19:35:24 +00:00
Str("machine", registerRequest.Hostinfo.Hostname).
Msgf("Processing auth key for %s", registerRequest.Hostinfo.Hostname)
2021-05-06 00:59:26 +02:00
resp := tailcfg.RegisterResponse{}
2021-11-22 19:35:24 +00:00
pak, err := h.checkKeyValidity(registerRequest.Auth.AuthKey)
if err != nil {
2021-10-04 18:03:44 +02:00
log.Error().
Caller().
2021-10-04 18:03:44 +02:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2021-10-04 18:03:44 +02:00
Err(err).
Msg("Failed authentication via AuthKey")
resp.MachineAuthorized = false
respBody, err := encode(resp, &machineKey, h.privateKey)
2021-05-06 00:59:26 +02:00
if err != nil {
2021-08-05 18:11:26 +01:00
log.Error().
Caller().
2021-08-05 20:57:47 +01:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2021-08-05 18:11:26 +01:00
Err(err).
Msg("Cannot encode message")
2022-06-26 11:55:37 +02:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", pak.Namespace.Name).
2021-11-13 08:36:45 +00:00
Inc()
2021-11-14 16:46:09 +01:00
2021-05-06 00:59:26 +02:00
return
}
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusUnauthorized)
2022-06-26 12:21:35 +02:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
2021-08-05 18:11:26 +01:00
log.Error().
Caller().
2021-08-05 20:57:47 +01:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2021-08-05 18:11:26 +01: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 16:46:09 +01:00
return
}
2021-08-05 18:11:26 +01: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 16:46:09 +01:00
machine.NodeKey = nodeKey
machine.AuthKeyID = uint(pak.ID)
2022-06-26 12:30:52 +02: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 11:55:37 +02: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 12:32:08 +02:00
}
2021-05-06 00:59:26 +02:00
2022-06-26 12:30:52 +02: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 17:22:42 +08:00
resp.MachineAuthorized = true
resp.User = *pak.Namespace.toUser()
respBody, err := encode(resp, &machineKey, h.privateKey)
2020-06-21 12:32:08 +02:00
if err != nil {
2021-08-05 18:11:26 +01:00
log.Error().
Caller().
2021-08-05 20:57:47 +01:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2021-08-05 18:11:26 +01:00
Err(err).
Msg("Cannot encode message")
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "error", pak.Namespace.Name).
2021-11-13 08:36:45 +00:00
Inc()
2022-06-26 11:55:37 +02:00
http.Error(writer, "Internal server error", http.StatusInternalServerError)
2021-11-14 16:46:09 +01:00
2020-06-21 12:32:08 +02:00
return
}
machineRegistrations.WithLabelValues("new", RegisterMethodAuthKey, "success", pak.Namespace.Name).
2021-11-13 08:36:45 +00:00
Inc()
2022-06-26 11:55:37 +02:00
writer.Header().Set("Content-Type", "application/json; charset=utf-8")
writer.WriteHeader(http.StatusOK)
2022-06-26 12:21:35 +02:00
_, err = writer.Write(respBody)
if err != nil {
log.Error().
Caller().
Err(err).
Msg("Failed to write response")
}
2021-08-05 18:11:26 +01:00
log.Info().
2021-08-05 20:57:47 +01:00
Str("func", "handleAuthKey").
Str("machine", registerRequest.Hostinfo.Hostname).
2022-01-16 14:16:59 +01:00
Str("ips", strings.Join(machine.IPAddresses.ToStringSlice(), ", ")).
2021-08-05 18:11:26 +01:00
Msg("Successfully authenticated via AuthKey")
2020-06-21 12:32:08 +02:00
}