headscale

package module
v0.10.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 13, 2021 License: BSD-3-Clause Imports: 39 Imported by: 1

README ¶

headscale

ci

An open source, self-hosted implementation of the Tailscale coordination server.

Join our Discord server for a chat.

Overview

Tailscale is a modern VPN built on top of Wireguard. It works like an overlay network between the computers of your networks - using all kinds of NAT traversal sorcery.

Everything in Tailscale is Open Source, except the GUI clients for proprietary OS (Windows and macOS/iOS), and the 'coordination/control server'.

The control server works as an exchange point of Wireguard public keys for the nodes in the Tailscale network. It also assigns the IP addresses of the clients, creates the boundaries between each user, enables sharing machines between users, and exposes the advertised routes of your nodes.

Headscale implements this coordination server.

Status

  • Base functionality (nodes can communicate with each other)
  • Node registration through the web flow
  • Network changes are relayed to the nodes
  • Namespace support (~equivalent to multi-user in Tailscale.com)
  • Routing (advertise & accept, including exit nodes)
  • Node registration via pre-auth keys (including reusable keys, and ephemeral node support)
  • JSON-formatted output
  • ACLs
  • Taildrop (File Sharing)
  • Support for alternative IP ranges in the tailnets (default Tailscale's 100.64.0.0/10)
  • DNS (passing DNS servers to nodes)
  • Share nodes between users namespaces
  • MagicDNS (see docs/)

Client OS support

OS Supports headscale
Linux Yes
OpenBSD Yes
macOS Yes (see /apple on your headscale for more information)
Windows Yes
Android You need to compile the client yourself
iOS Not yet

Roadmap 🤷

Suggestions/PRs welcomed!

Running it

  1. Download the Headscale binary https://github.com/juanfont/headscale/releases, and place it somewhere in your PATH or use the docker container

    docker pull headscale/headscale:x.x.x

  2. (Optional, you can also use SQLite) Get yourself a PostgreSQL DB running

    docker run --name headscale -e POSTGRES_DB=headscale -e \
  POSTGRES_USER=foo -e POSTGRES_PASSWORD=bar -p 5432:5432 -d postgres

  3. Set some stuff up (headscale Wireguard keys & the config.json file)

    wg genkey > private.key
wg pubkey < private.key > public.key  # not needed

# Postgres
cp config.json.postgres.example config.json
# or
# SQLite
cp config.json.sqlite.example config.json

  4. Create a namespace (a namespace is a 'tailnet', a group of Tailscale nodes that can talk to each other)

    headscale namespaces create myfirstnamespace

    or docker:

    the db.sqlite mount is only needed if you use sqlite

    touch db.sqlite
docker run -v $(pwd)/private.key:/private.key -v $(pwd)/config.json:/config.json -v $(pwd)/derp.yaml:/derp.yaml -v $(pwd)/db.sqlite:/db.sqlite -p 127.0.0.1:8080:8080 headscale/headscale:x.x.x headscale namespaces create myfirstnamespace

    or if your server is already running in docker:

    docker exec <container_name> headscale create myfirstnamespace

  5. Run the server

    headscale serve

    or docker:

    the db.sqlite mount is only needed if you use sqlite

    docker run -v $(pwd)/private.key:/private.key -v $(pwd)/config.json:/config.json -v $(pwd)/derp.yaml:/derp.yaml -v $(pwd)/db.sqlite:/db.sqlite -p 127.0.0.1:8080:8080 headscale/headscale:x.x.x headscale serve

  6. If you used tailscale.com before in your nodes, make sure you clear the tailscald data folder

    systemctl stop tailscaled
rm -fr /var/lib/tailscale
systemctl start tailscaled

  7. Add your first machine

    tailscale up --login-server YOUR_HEADSCALE_URL

  8. Navigate to the URL you will get with tailscale up, where you'll find your machine key.

  9. In the server, register your machine to a namespace with the CLI

    headscale -n myfirstnamespace nodes register YOURMACHINEKEY

    or docker:

    docker run -v $(pwd)/private.key:/private.key -v $(pwd)/config.json:/config.json -v $(pwd)/derp.yaml:/derp.yaml headscale/headscale:x.x.x headscale -n myfirstnamespace nodes register YOURMACHINEKEY

    or if your server is already running in docker:

    docker exec <container_name> headscale -n myfirstnamespace nodes register YOURMACHINEKEY

Alternatively, you can use Auth Keys to register your machines:

  1. Create an authkey

    headscale -n myfirstnamespace preauthkeys create --reusable --expiration 24h

    or docker:

    docker run -v $(pwd)/private.key:/private.key -v $(pwd)/config.json:/config.json -v$(pwd)/derp.yaml:/derp.yaml -v $(pwd)/db.sqlite:/db.sqlite headscale/headscale:x.x.x headscale -n myfirstnamespace preauthkeys create --reusable --expiration 24h

    or if your server is already running in docker:

    docker exec <container_name> headscale -n myfirstnamespace preauthkeys create --reusable --expiration 24h

  2. Use the authkey from your machine to register it

    tailscale up --login-server YOUR_HEADSCALE_URL --authkey YOURAUTHKEY

If you create an authkey with the --ephemeral flag, that key will create ephemeral nodes. This implies that --reusable is true.

Please bear in mind that all the commands from headscale support adding -o json or -o json-line to get a nicely JSON-formatted output.

Configuration reference

Headscale's configuration file is named config.json or config.yaml. Headscale will look for it in /etc/headscale, ~/.headscale and finally the directory from where the Headscale binary is executed.

    "server_url": "http://192.168.1.12:8080",
    "listen_addr": "0.0.0.0:8080",
    "ip_prefix": "100.64.0.0/10"

server_url is the external URL via which Headscale is reachable. listen_addr is the IP address and port the Headscale program should listen on. ip_prefix is the IP prefix (range) in which IP addresses for nodes will be allocated (default 100.64.0.0/10, e.g., 192.168.4.0/24, 10.0.0.0/8)

    "log_level": "debug"

log_level can be used to set the Log level for Headscale, it defaults to debug, and the available levels are: trace, debug, info, warn and error.

    "private_key_path": "private.key",

private_key_path is the path to the Wireguard private key. If the path is relative, it will be interpreted as relative to the directory the configuration file was read from.

    "derp_map_path": "derp.yaml",

derp_map_path is the path to the DERP map file. If the path is relative, it will be interpreted as relative to the directory the configuration file was read from.

    "ephemeral_node_inactivity_timeout": "30m",

ephemeral_node_inactivity_timeout is the timeout after which inactive ephemeral node records will be deleted from the database. The default is 30 minutes. This value must be higher than 65 seconds (the keepalive timeout for the HTTP long poll is 60 seconds, plus a few seconds to avoid race conditions).

    "db_host": "localhost",
    "db_port": 5432,
    "db_name": "headscale",
    "db_user": "foo",
    "db_pass": "bar",

The fields starting with db_ are used for the PostgreSQL connection information.

Running the service via TLS (optional)
    "tls_cert_path": ""
    "tls_key_path": ""

Headscale can be configured to expose its web service via TLS. To configure the certificate and key file manually, set the tls_cert_path and tls_cert_path configuration parameters. If the path is relative, it will be interpreted as relative to the directory the configuration file was read from.

    "tls_letsencrypt_hostname": "",
    "tls_letsencrypt_listen": ":http",
    "tls_letsencrypt_cache_dir": ".cache",
    "tls_letsencrypt_challenge_type": "HTTP-01",

To get a certificate automatically via Let's Encrypt, set tls_letsencrypt_hostname to the desired certificate hostname. This name must resolve to the IP address(es) Headscale is reachable on (i.e., it must correspond to the server_url configuration parameter). The certificate and Let's Encrypt account credentials will be stored in the directory configured in tls_letsencrypt_cache_dir. If the path is relative, it will be interpreted as relative to the directory the configuration file was read from. The certificate will automatically be renewed as needed.

Challenge type HTTP-01

The default challenge type HTTP-01 requires that Headscale is reachable on port 80 for the Let's Encrypt automated validation, in addition to whatever port is configured in listen_addr. By default, Headscale listens on port 80 on all local IPs for Let's Encrypt automated validation.

If you need to change the ip and/or port used by Headscale for the Let's Encrypt validation process, set tls_letsencrypt_listen to the appropriate value. This can be handy if you are running Headscale as a non-root user (or can't run setcap). Keep in mind, however, that Let's Encrypt will only connect to port 80 for the validation callback, so if you change tls_letsencrypt_listen you will also need to configure something else (e.g. a firewall rule) to forward the traffic from port 80 to the ip:port combination specified in tls_letsencrypt_listen.

Challenge type TLS-ALPN-01

Alternatively, tls_letsencrypt_challenge_type can be set to TLS-ALPN-01. In this configuration, Headscale listens on the ip:port combination defined in listen_addr. Let's Encrypt will only connect to port 443 for the validation callback, so if listen_addr is not set to port 443, something else (e.g. a firewall rule) will be required to forward the traffic from port 443 to the ip:port combination specified in listen_addr.

Policy ACLs

Headscale implements the same policy ACLs as Tailscale.com, adapted to the self-hosted environment.

For instance, instead of referring to users when defining groups you must use namespaces (which are the equivalent to user/logins in Tailscale.com).

Please check https://tailscale.com/kb/1018/acls/, and ./tests/acls/ in this repo for working examples.

Apple devices

An endpoint with information on how to connect your Apple devices (currently macOS only) is available at /apple on your running instance.

Disclaimer

  1. We have nothing to do with Tailscale, or Tailscale Inc.
  2. The purpose of writing this was to learn how Tailscale works.

More on Tailscale

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ACL ¶ added in v0.3.0 

type ACL struct {
	Action string   `json:"Action"`
	Users  []string `json:"Users"`
	Ports  []string `json:"Ports"`
}

ACL is a basic rule for the ACL Policy

type ACLPolicy ¶ added in v0.3.0 

type ACLPolicy struct {
	Groups    Groups    `json:"Groups"`
	Hosts     Hosts     `json:"Hosts"`
	TagOwners TagOwners `json:"TagOwners"`
	ACLs      []ACL     `json:"ACLs"`
	Tests     []ACLTest `json:"Tests"`
}

ACLPolicy represents a Tailscale ACL Policy

func (ACLPolicy) IsZero ¶ added in v0.3.0 

func (p ACLPolicy) IsZero() bool

IsZero is perhaps a bit naive here

type ACLTest ¶ added in v0.3.0 

type ACLTest struct {
	User  string   `json:"User"`
	Allow []string `json:"Allow"`
	Deny  []string `json:"Deny,omitempty"`
}

ACLTest is not implemented, but should be use to check if a certain rule is allowed

type AppleMobileConfig ¶ added in v0.9.2 

type AppleMobileConfig struct {
	UUID    uuid.UUID
	Url     string
	Payload string
}

type AppleMobilePlatformConfig ¶ added in v0.9.2 

type AppleMobilePlatformConfig struct {
	UUID uuid.UUID
	Url  string
}

type Config ¶ 

type Config struct {
	ServerURL                      string
	Addr                           string
	PrivateKeyPath                 string
	DerpMap                        *tailcfg.DERPMap
	EphemeralNodeInactivityTimeout time.Duration
	IPPrefix                       netaddr.IPPrefix
	BaseDomain                     string

	DBtype string
	DBpath string
	DBhost string
	DBport int
	DBname string
	DBuser string
	DBpass string

	TLSLetsEncryptListen        string
	TLSLetsEncryptHostname      string
	TLSLetsEncryptCacheDir      string
	TLSLetsEncryptChallengeType string

	TLSCertPath string
	TLSKeyPath  string

	ACMEURL   string
	ACMEEmail string

	DNSConfig *tailcfg.DNSConfig
}

Config contains the initial Headscale configuration

type Error ¶ 

type Error string

Error is used to compare errors as per https://dave.cheney.net/2016/04/07/constant-errors

func (Error) Error ¶ 

func (e Error) Error() string

type Groups ¶ added in v0.3.0 

type Groups map[string][]string

Groups references a series of alias in the ACL rules

type Headscale ¶ 

type Headscale struct {
	// contains filtered or unexported fields
}

Headscale represents the base app of the service

func NewHeadscale ¶ 

func NewHeadscale(cfg Config) (*Headscale, error)

NewHeadscale returns the Headscale app

func (*Headscale) AddSharedMachineToNamespace ¶ added in v0.8.0 

func (h *Headscale) AddSharedMachineToNamespace(m *Machine, ns *Namespace) error

AddSharedMachineToNamespace adds a machine as a shared node to a namespace

func (*Headscale) AppleMobileConfig ¶ added in v0.9.2 

func (h *Headscale) AppleMobileConfig(c *gin.Context)

AppleMobileConfig shows a simple message in the browser to point to the CLI Listens in /register

func (*Headscale) ApplePlatformConfig ¶ added in v0.9.2 

func (h *Headscale) ApplePlatformConfig(c *gin.Context)

func (*Headscale) CreateNamespace ¶ 

func (h *Headscale) CreateNamespace(name string) (*Namespace, error)

CreateNamespace creates a new Namespace. Returns error if could not be created or another namespace already exists

func (*Headscale) CreatePreAuthKey ¶ 

func (h *Headscale) CreatePreAuthKey(namespaceName string, reusable bool, ephemeral bool, expiration *time.Time) (*PreAuthKey, error)

CreatePreAuthKey creates a new PreAuthKey in a namespace, and returns it

func (*Headscale) DeleteMachine ¶ added in v0.6.1 

func (h *Headscale) DeleteMachine(m *Machine) error

DeleteMachine softs deletes a Machine from the database

func (*Headscale) DestroyNamespace ¶ 

func (h *Headscale) DestroyNamespace(name string) error

DestroyNamespace destroys a Namespace. Returns error if the Namespace does not exist or if there are machines associated with it.

func (*Headscale) EnableNodeRoute ¶ 

func (h *Headscale) EnableNodeRoute(namespace string, nodeName string, routeStr string) error

EnableNodeRoute enables a subnet route advertised by a node (identified by namespace and node name)

func (*Headscale) GetAdvertisedNodeRoutes ¶ added in v0.7.0 

func (h *Headscale) GetAdvertisedNodeRoutes(namespace string, nodeName string) (*[]netaddr.IPPrefix, error)

GetAdvertisedNodeRoutes returns the subnet routes advertised by a node (identified by namespace and node name)

func (*Headscale) GetEnabledNodeRoutes ¶ added in v0.7.0 

func (h *Headscale) GetEnabledNodeRoutes(namespace string, nodeName string) ([]netaddr.IPPrefix, error)

GetEnabledNodeRoutes returns the subnet routes enabled by a node (identified by namespace and node name)

func (*Headscale) GetMachine ¶ 

func (h *Headscale) GetMachine(namespace string, name string) (*Machine, error)

GetMachine finds a Machine by name and namespace and returns the Machine struct

func (*Headscale) GetMachineByID ¶ added in v0.6.1 

func (h *Headscale) GetMachineByID(id uint64) (*Machine, error)

GetMachineByID finds a Machine by ID and returns the Machine struct

func (*Headscale) GetMachineByMachineKey ¶ added in v0.9.3 

func (h *Headscale) GetMachineByMachineKey(mKey string) (*Machine, error)

GetMachineByMachineKey finds a Machine by ID and returns the Machine struct

func (*Headscale) GetNamespace ¶ 

func (h *Headscale) GetNamespace(name string) (*Namespace, error)

GetNamespace fetches a namespace by name

func (*Headscale) GetPreAuthKey ¶ added in v0.6.1 

func (h *Headscale) GetPreAuthKey(namespace string, key string) (*PreAuthKey, error)

GetPreAuthKey returns a PreAuthKey for a given key

func (*Headscale) GetPreAuthKeys ¶ 

func (h *Headscale) GetPreAuthKeys(namespaceName string) (*[]PreAuthKey, error)

GetPreAuthKeys returns the list of PreAuthKeys for a namespace

func (*Headscale) HardDeleteMachine ¶ added in v0.6.1 

func (h *Headscale) HardDeleteMachine(m *Machine) error

HardDeleteMachine hard deletes a Machine from the database

func (*Headscale) IsNodeRouteEnabled ¶ added in v0.7.0 

func (h *Headscale) IsNodeRouteEnabled(namespace string, nodeName string, routeStr string) bool

IsNodeRouteEnabled checks if a certain route has been enabled

func (*Headscale) KeyHandler ¶ 

func (h *Headscale) KeyHandler(c *gin.Context)

KeyHandler provides the Headscale pub key Listens in /key

func (*Headscale) ListMachinesInNamespace ¶ 

func (h *Headscale) ListMachinesInNamespace(name string) (*[]Machine, error)

ListMachinesInNamespace gets all the nodes in a given namespace

func (*Headscale) ListNamespaces ¶ 

func (h *Headscale) ListNamespaces() (*[]Namespace, error)

ListNamespaces gets all the existing namespaces

func (*Headscale) ListSharedMachinesInNamespace ¶ added in v0.8.0 

func (h *Headscale) ListSharedMachinesInNamespace(name string) (*[]Machine, error)

ListSharedMachinesInNamespace returns all the machines that are shared to the specified namespace

func (*Headscale) LoadACLPolicy ¶ added in v0.3.0 

func (h *Headscale) LoadACLPolicy(path string) error

LoadACLPolicy loads the ACL policy from the specify path, and generates the ACL rules

func (*Headscale) MarkExpirePreAuthKey ¶ added in v0.6.1 

func (h *Headscale) MarkExpirePreAuthKey(k *PreAuthKey) error

MarkExpirePreAuthKey marks a PreAuthKey as expired

func (*Headscale) PollNetMapHandler ¶ 

func (h *Headscale) PollNetMapHandler(c *gin.Context)

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.

func (*Headscale) PollNetMapStream ¶ added in v0.6.1 

func (h *Headscale) PollNetMapStream(
	c *gin.Context,
	m *Machine,
	req tailcfg.MapRequest,
	mKey wgkey.Key,
	pollDataChan chan []byte,
	keepAliveChan chan []byte,
	updateChan chan struct{},
	cancelKeepAlive chan struct{},
)

PollNetMapStream takes care of /machine/:id/map stream logic, ensuring we communicate updates and data to the connected clients.

func (*Headscale) RegisterMachine ¶ 

func (h *Headscale) RegisterMachine(key string, namespace string) (*Machine, error)

RegisterMachine is executed from the CLI to register a new Machine using its MachineKey

func (*Headscale) RegisterWebAPI ¶ 

func (h *Headscale) RegisterWebAPI(c *gin.Context)

RegisterWebAPI shows a simple message in the browser to point to the CLI Listens in /register

func (*Headscale) RegistrationHandler ¶ 

func (h *Headscale) RegistrationHandler(c *gin.Context)

RegistrationHandler handles the actual registration process of a machine Endpoint /machine/:id

func (*Headscale) RemoveSharedMachineFromAllNamespaces ¶ added in v0.10.1 

func (h *Headscale) RemoveSharedMachineFromAllNamespaces(m *Machine) error

RemoveSharedMachineFromAllNamespaces removes a machine as a shared node from all namespaces

func (*Headscale) RequestMapUpdates ¶ added in v0.6.1 

func (h *Headscale) RequestMapUpdates(namespaceID uint) error

RequestMapUpdates signals the KV worker to update the maps for this namespace

func (*Headscale) RoutesToPtables ¶ added in v0.7.0 

func (h *Headscale) RoutesToPtables(namespace string, nodeName string, availableRoutes []netaddr.IPPrefix) pterm.TableData

RoutesToPtables converts the list of routes to a nice table

func (*Headscale) Serve ¶ 

func (h *Headscale) Serve() error

Serve launches a GIN server with the Headscale API

func (*Headscale) SetMachineNamespace ¶ 

func (h *Headscale) SetMachineNamespace(m *Machine, namespaceName string) error

SetMachineNamespace assigns a Machine to a namespace

func (*Headscale) UpdateMachine ¶ added in v0.7.0 

func (h *Headscale) UpdateMachine(m *Machine) error

UpdateMachine takes a Machine struct pointer (typically already loaded from database and updates it with the latest data from the database.

type Hosts ¶ added in v0.3.0 

type Hosts map[string]netaddr.IPPrefix

Hosts are alias for IP addresses or subnets

func (*Hosts) UnmarshalJSON ¶ added in v0.3.0 

func (h *Hosts) UnmarshalJSON(data []byte) error

UnmarshalJSON allows to parse the Hosts directly into netaddr objects

type KV ¶ 

type KV struct {
	Key   string
	Value string
}

KV is a key-value store in a psql table. For future use...

type Machine ¶ 

type Machine struct {
	ID          uint64 `gorm:"primary_key"`
	MachineKey  string `gorm:"type:varchar(64);unique_index"`
	NodeKey     string
	DiscoKey    string
	IPAddress   string
	Name        string
	NamespaceID uint
	Namespace   Namespace `gorm:"foreignKey:NamespaceID"`

	Registered     bool // temp
	RegisterMethod string
	AuthKeyID      uint
	AuthKey        *PreAuthKey

	LastSeen             *time.Time
	LastSuccessfulUpdate *time.Time
	Expiry               *time.Time

	HostInfo      datatypes.JSON
	Endpoints     datatypes.JSON
	EnabledRoutes datatypes.JSON

	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt *time.Time
}

Machine is a Headscale client

func (*Machine) GetHostInfo ¶ 

func (m *Machine) GetHostInfo() (*tailcfg.Hostinfo, error)

GetHostInfo returns a Hostinfo struct for the machine

func (Machine) String ¶ added in v0.9.3 

func (m Machine) String() string

type Machines ¶ added in v0.9.3 

type Machines []Machine

func (Machines) String ¶ added in v0.9.3 

func (ms Machines) String() string

type MachinesP ¶ added in v0.9.3 

type MachinesP []*Machine

func (MachinesP) String ¶ added in v0.9.3 

func (ms MachinesP) String() string

TODO(kradalby): Remove when we have generics...

type Namespace ¶ 

type Namespace struct {
	gorm.Model
	Name string `gorm:"unique"`
}

Namespace is the way Headscale implements the concept of users in Tailscale

At the end of the day, users in Tailscale are some kind of 'bubbles' or namespaces that contain our machines.

type PreAuthKey ¶ 

type PreAuthKey struct {
	ID          uint64 `gorm:"primary_key"`
	Key         string
	NamespaceID uint
	Namespace   Namespace
	Reusable    bool
	Ephemeral   bool `gorm:"default:false"`
	Used        bool `gorm:"default:false"`

	CreatedAt  *time.Time
	Expiration *time.Time
}

PreAuthKey describes a pre-authorization key usable in a particular namespace

type SharedMachine ¶ added in v0.8.0 

type SharedMachine struct {
	gorm.Model
	MachineID   uint64
	Machine     Machine
	NamespaceID uint
	Namespace   Namespace
}

SharedMachine is a join table to support sharing nodes between namespaces

type TagOwners ¶ added in v0.3.0 

type TagOwners map[string][]string

TagOwners specify what users (namespaces?) are allow to use certain tags

Source Files ¶

View all Source files

Directories ¶

Path Synopsis
cmd
headscale
headscale/cli

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.