From 5bb2f7dfa35f23fb068d1ee277ff2e6b1e5881a9 Mon Sep 17 00:00:00 2001 From: Aarnav Tale Date: Tue, 26 Mar 2024 16:55:20 -0400 Subject: [PATCH] feat: add configuration loading --- .env.example | 5 +- app/routes/_data.settings._index.tsx | 18 ++ app/utils/config.ts | 131 +++++++++++ package.json | 3 +- pnpm-lock.yaml | 4 +- test/acl.json | 71 ++++++ test/config.yaml | 325 +++++++++++++++++++++++++++ 7 files changed, 551 insertions(+), 6 deletions(-) create mode 100644 app/routes/_data.settings._index.tsx create mode 100644 app/utils/config.ts create mode 100755 test/acl.json create mode 100644 test/config.yaml diff --git a/.env.example b/.env.example index e765522..3c0e349 100644 --- a/.env.example +++ b/.env.example @@ -1,9 +1,6 @@ -HEADSCALE_URL=https://tailscale.example.com API_KEY=abcdefghijklmnopqrstuvwxyz COOKIE_SECRET=abcdefghijklmnopqrstuvwxyz -OIDC_CLIENT_ID=headscale -OIDC_ISSUER=https://sso.example.com -OIDC_CLIENT_SECRET=super_secret_client_secret DISABLE_API_KEY_LOGIN=true HOST=0.0.0.0 PORT=3000 +CONFIG_FILE=/etc/headscale/config.yaml diff --git a/app/routes/_data.settings._index.tsx b/app/routes/_data.settings._index.tsx new file mode 100644 index 0000000..10844e9 --- /dev/null +++ b/app/routes/_data.settings._index.tsx @@ -0,0 +1,18 @@ +import { useLoaderData } from '@remix-run/react' + +import { getConfig } from '~/utils/config' + +export async function loader() { + const config = await getConfig() + return config +} + +export default function Page() { + const data = useLoaderData() + + return ( +
+ {JSON.stringify(data, null, 4)} +
+ ) +} diff --git a/app/utils/config.ts b/app/utils/config.ts new file mode 100644 index 0000000..af67bd4 --- /dev/null +++ b/app/utils/config.ts @@ -0,0 +1,131 @@ +import { readFile } from 'node:fs/promises' +import { resolve } from 'node:path' + +import { parse } from 'yaml' + +type Duration = `${string}s` | `${string}h` | `${string}m` | `${string}d` | `${string}y` + +type Config = { + server_url: string; + listen_addr: string; + metrics_listen_addr: string; + grpc_listen_addr: string; + grpc_allow_insecure: boolean; + + private_key_path: string; + noise: { + private_key_path: string; + }; + + prefixes: { + v4: string; + v6: string; + }; + + derp: { + server: { + enabled: boolean; + region_id: number; + region_code: string; + region_name: string; + stun_listen_addr: string; + }; + + urls: string[]; + paths: string[]; + auto_update_enabled: boolean; + update_frequency: Duration; + }; + + disable_check_updates: boolean; + epheremal_node_inactivity_timeout: Duration; + node_update_check_interval: Duration; + + // Database is probably dangerous + database: { + type: 'sqlite3' | 'sqlite' | 'postgres'; + sqlite?: { + path: string; + }; + + postgres?: { + host: string; + port: number; + name: string; + user: string; + pass: string; + max_open_conns: number; + max_idle_conns: number; + conn_max_idle_time_secs: number; + ssl: boolean; + }; + }; + + acme_url: string; + acme_email: string; + tls_letsencrypt_hostname: string; + tls_letsencrypt_cache_dir: string; + tls_letsencrypt_challenge_type: string; + tls_letsencrypt_listen: string; + tls_cert_path: string; + tls_key_path: string; + + log: { + format: 'text' | 'json'; + level: string; + }; + + acl_policy_path: string; + dns_config: { + override_local_dns: boolean; + nameservers: string[]; + restricted_nameservers: Record; // Split DNS + domains: string[]; + extra_records: Array<{ + name: string; + type: 'A'; + value: string; + }>; + + magic_dns: boolean; + base_domain: string; + }; + + unix_socket: string; + unix_socket_permission: string; + + oidc: { + only_start_if_oidc_is_available: boolean; + issuer: string; + client_id: string; + client_secret: string; + expiry: Duration; + use_expiry_from_token: boolean; + scope: string[]; + extra_params: Record; + + allowed_domains: string[]; + allowed_groups: string[]; + allowed_users: string[]; + + strip_email_domain: boolean; + }; + + logtail: { + enabled: boolean; + }; + + randomize_client_port: boolean; +} + +let config: Config + +export async function getConfig() { + if (!config) { + const path = resolve(process.env.CONFIG_FILE ?? '/etc/headscale/config.yaml') + const data = await readFile(path, 'utf8') + config = parse(data) as Config + } + + return config +} diff --git a/package.json b/package.json index 8d55179..86a0aa1 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,8 @@ "react": "^18.2.0", "react-dom": "^18.2.0", "react-hot-toast": "^2.4.1", - "usehooks-ts": "^3.0.2" + "usehooks-ts": "^3.0.2", + "yaml": "^2.4.1" }, "devDependencies": { "@remix-run/dev": "^2.8.1", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 0e95f3b..40e6e4d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -38,6 +38,9 @@ dependencies: usehooks-ts: specifier: ^3.0.2 version: 3.0.2(react@18.2.0) + yaml: + specifier: ^2.4.1 + version: 2.4.1 devDependencies: '@remix-run/dev': @@ -6501,7 +6504,6 @@ packages: resolution: {integrity: sha512-pIXzoImaqmfOrL7teGUBt/T7ZDnyeGBWyXQBvOVhLkWLN37GXv8NMLK406UY6dS51JfcQHsmcW5cJ441bHg6Lg==} engines: {node: '>= 14'} hasBin: true - dev: true /yocto-queue@0.1.0: resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==} diff --git a/test/acl.json b/test/acl.json new file mode 100755 index 0000000..9d47c35 --- /dev/null +++ b/test/acl.json @@ -0,0 +1,71 @@ +{ + // Declare static groups of users. Use autogroups for all users or users with a specific role. + "groups": { + "group:admin": ["tale"], + "group:user": ["tale", "arjun"], + "group:proxmox": ["tale", "arjun"] + }, + + // Define the tags which can be applied to devices and by which users. + "tagOwners": { + "tag:infra": ["group:admin"], + "tag:hyperv": ["group:admin"], + "tag:vm": ["group:admin", "group:proxmox"] + }, + + "acls": [ + { + "action": "accept", + "src": ["tag:vm", "tag:infra"], + "dst": ["tag:vm:*", "tag:infra:*"] + }, + //{ + // "action": "accept", + // "src": ["autogroup:member"], + // "dst": ["autogroup:internet:*"], + //}, + // Proxmox members have access to all traffic from VMs (including SSH) + { + "action": "accept", + "src": ["group:proxmox"], + "dst": ["tag:vm:*"] + }, + + // Anyone can access VM traffic + {"action": "accept", "src": ["group:user"], "dst": ["tag:vm:*"]}, + + // Admins get to override any destination restrictions + { + "action": "accept", + "src": ["group:admin"], + "dst": ["*:*"] + }, + ], + + "ssh": [ + { + // Any Proxmox members can SSH into VMs + "action": "accept", + "src": ["group:proxmox"], + "dst": ["tag:vm"], + "users": ["*"] + }, + { + // Any Admin can SSH into infrastructure + "action": "accept", + "src": ["group:admin"], + "dst": ["tag:infra"], + "users": ["*"] + } + ], + + // Test access rules every time they're saved. + // "tests": [ + // { + // "src": "alice@example.com", + // "accept": ["tag:example"], + // "deny": ["100.101.102.103:443"], + // }, + // ], +} + diff --git a/test/config.yaml b/test/config.yaml new file mode 100644 index 0000000..0352be5 --- /dev/null +++ b/test/config.yaml @@ -0,0 +1,325 @@ +--- +# headscale will look for a configuration file named `config.yaml` (or `config.json`) in the following order: +# +# - `/etc/headscale` +# - `~/.headscale` +# - current working directory + +# The url clients will connect to. +# Typically this will be a domain like: +# +# https://myheadscale.example.com:443 +# +server_url: https://tailscale.example.com + +# Address to listen to / bind to on the server +# +# For production: +listen_addr: 0.0.0.0:8080 + +# Address to listen to /metrics, you may want +# to keep this endpoint private to your internal +# network +# +metrics_listen_addr: 127.0.0.1:9090 + +# Address to listen for gRPC. +# gRPC is used for controlling a headscale server +# remotely with the CLI +# Note: Remote access _only_ works if you have +# valid certificates. +# +# For production: +grpc_listen_addr: 0.0.0.0:50443 + +# Allow the gRPC admin interface to run in INSECURE +# mode. This is not recommended as the traffic will +# be unencrypted. Only enable if you know what you +# are doing. +grpc_allow_insecure: false + +# Private key used to encrypt the traffic between headscale +# and Tailscale clients. +# The private key file will be autogenerated if it's missing. +# +private_key_path: /var/lib/headscale/private.key + +# The Noise section includes specific configuration for the +# TS2021 Noise protocol +noise: + # The Noise private key is used to encrypt the + # traffic between headscale and Tailscale clients when + # using the new Noise-based protocol. It must be different + # from the legacy private key. + private_key_path: /var/lib/headscale/noise_private.key + +# List of IP prefixes to allocate tailaddresses from. +# Each prefix consists of either an IPv4 or IPv6 address, +# and the associated prefix length, delimited by a slash. +# While this looks like it can take arbitrary values, it +# needs to be within IP ranges supported by the Tailscale +# client. +# IPv6: https://github.com/tailscale/tailscale/blob/22ebb25e833264f58d7c3f534a8b166894a89536/net/tsaddr/tsaddr.go#LL81C52-L81C71 +# IPv4: https://github.com/tailscale/tailscale/blob/22ebb25e833264f58d7c3f534a8b166894a89536/net/tsaddr/tsaddr.go#L33 +prefixes: + v4: 100.64.0.0/10 + v6: fd7a:115c:a1e0::/48 + +# DERP is a relay system that Tailscale uses when a direct +# connection cannot be established. +# https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp +# +# headscale needs a list of DERP servers that can be presented +# to the clients. +derp: + server: + # If enabled, runs the embedded DERP server and merges it into the rest of the DERP config + # The Headscale server_url defined above MUST be using https, DERP requires TLS to be in place + enabled: false + + # Region ID to use for the embedded DERP server. + # The local DERP prevails if the region ID collides with other region ID coming from + # the regular DERP config. + region_id: 999 + + # Region code and name are displayed in the Tailscale UI to identify a DERP region + region_code: "headscale" + region_name: "Headscale Embedded DERP" + + # Listens over UDP at the configured address for STUN connections - to help with NAT traversal. + # When the embedded DERP server is enabled stun_listen_addr MUST be defined. + # + # For more details on how this works, check this great article: https://tailscale.com/blog/how-tailscale-works/ + stun_listen_addr: "0.0.0.0:3478" + + # List of externally available DERP maps encoded in JSON + urls: + - https://controlplane.tailscale.com/derpmap/default + + # Locally available DERP map files encoded in YAML + # + # This option is mostly interesting for people hosting + # their own DERP servers: + # https://tailscale.com/kb/1118/custom-derp-servers/ + # + # paths: + # - /etc/headscale/derp-example.yaml + paths: [] + + # If enabled, a worker will be set up to periodically + # refresh the given sources and update the derpmap + # will be set up. + auto_update_enabled: true + + # How often should we check for DERP updates? + update_frequency: 24h + +# Disables the automatic check for headscale updates on startup +disable_check_updates: false + +# Time before an inactive ephemeral node is deleted? +ephemeral_node_inactivity_timeout: 30m + +# Period to check for node updates within the tailnet. A value too low will severely affect +# CPU consumption of Headscale. A value too high (over 60s) will cause problems +# for the nodes, as they won't get updates or keep alive messages frequently enough. +# In case of doubts, do not touch the default 10s. +node_update_check_interval: 10s + +database: + type: sqlite3 + sqlite: + path: '/var/lib/headscale/db.sqlite' + +# # Postgres config +# If using a Unix socket to connect to Postgres, set the socket path in the 'host' field and leave 'port' blank. +# db_type: postgres +# db_host: localhost +# db_port: 5432 +# db_name: headscale +# db_user: foo +# db_pass: bar + +# If other 'sslmode' is required instead of 'require(true)' and 'disabled(false)', set the 'sslmode' you need +# in the 'db_ssl' field. Refers to https://www.postgresql.org/docs/current/libpq-ssl.html Table 34.1. +# db_ssl: false + +### TLS configuration +# +## Let's encrypt / ACME +# +# headscale supports automatically requesting and setting up +# TLS for a domain with Let's Encrypt. +# +# URL to ACME directory +acme_url: https://acme-v02.api.letsencrypt.org/directory + +# Email to register with ACME provider +acme_email: "" + +# Domain name to request a TLS certificate for: +tls_letsencrypt_hostname: "" + +# Path to store certificates and metadata needed by +# letsencrypt +# For production: +tls_letsencrypt_cache_dir: /var/lib/headscale/cache + +# Type of ACME challenge to use, currently supported types: +# HTTP-01 or TLS-ALPN-01 +# See [docs/tls.md](docs/tls.md) for more information +tls_letsencrypt_challenge_type: HTTP-01 +# When HTTP-01 challenge is chosen, letsencrypt must set up a +# verification endpoint, and it will be listening on: +# :http = port 80 +tls_letsencrypt_listen: ":http" + +## Use already defined certificates: +tls_cert_path: "" +tls_key_path: "" + +log: + # Output formatting for logs: text or json + format: text + level: info + +# Path to a file containg ACL policies. +# ACLs can be defined as YAML or HUJSON. +# https://tailscale.com/kb/1018/acls/ +acl_policy_path: /etc/headscale/acl.json + +## DNS +# +# headscale supports Tailscale's DNS configuration and MagicDNS. +# Please have a look to their KB to better understand the concepts: +# +# - https://tailscale.com/kb/1054/dns/ +# - https://tailscale.com/kb/1081/magicdns/ +# - https://tailscale.com/blog/2021-09-private-dns-with-magicdns/ +# +dns_config: + # Whether to prefer using Headscale provided DNS or use local. + override_local_dns: true + + # List of DNS servers to expose to clients. + nameservers: + - 1.1.1.1 + - 1.0.0.1 + - 2606:4700:4700::1111 + - 2606:4700:4700::1001 + + # NextDNS (see https://tailscale.com/kb/1218/nextdns/). + # "abc123" is example NextDNS ID, replace with yours. + # + # With metadata sharing: + # nameservers: + # - https://dns.nextdns.io/abc123 + # + # Without metadata sharing: + # nameservers: + # - 2a07:a8c0::ab:c123 + # - 2a07:a8c1::ab:c123 + + # Split DNS (see https://tailscale.com/kb/1054/dns/), + # list of search domains and the DNS to query for each one. + # + # restricted_nameservers: + # foo.bar.com: + # - 1.1.1.1 + # darp.headscale.net: + # - 1.1.1.1 + # - 8.8.8.8 + + # Search domains to inject. + domains: [] + + # Extra DNS records + # so far only A-records are supported (on the tailscale side) + # See https://github.com/juanfont/headscale/blob/main/docs/dns-records.md#Limitations + # extra_records: + # - name: "grafana.myvpn.example.com" + # type: "A" + # value: "100.64.0.3" + # + # # you can also put it in one line + # - { name: "prometheus.myvpn.example.com", type: "A", value: "100.64.0.3" } + + # Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/). + # Only works if there is at least a nameserver defined. + magic_dns: true + + # Defines the base domain to create the hostnames for MagicDNS. + # `base_domain` must be a FQDNs, without the trailing dot. + # The FQDN of the hosts will be + # `hostname.user.base_domain` (e.g., _myhost.myuser.example.com_). + base_domain: ts.net + +# Unix socket used for the CLI to connect without authentication +# Note: for production you will want to set this to something like: +unix_socket: /var/run/headscale/headscale.sock +unix_socket_permission: "0777" +# +# headscale supports experimental OpenID connect support, +# it is still being tested and might have some bugs, please +# help us test it. +# OpenID Connect +oidc: + only_start_if_oidc_is_available: true + issuer: "https://sso.example.com" + client_id: "headscale" + client_secret: "super_secret_client_secret" +# # Alternatively, set `client_secret_path` to read the secret from the file. +# # It resolves environment variables, making integration to systemd's +# # `LoadCredential` straightforward: +# client_secret_path: "${CREDENTIALS_DIRECTORY}/oidc_client_secret" +# # client_secret and client_secret_path are mutually exclusive. +# +# # The amount of time from a node is authenticated with OpenID until it +# # expires and needs to reauthenticate. +# # Setting the value to "0" will mean no expiry. + expiry: 180d +# +# # Use the expiry from the token received from OpenID when the user logged +# # in, this will typically lead to frequent need to reauthenticate and should +# # only been enabled if you know what you are doing. +# # Note: enabling this will cause `oidc.expiry` to be ignored. +# use_expiry_from_token: false +# +# # Customize the scopes used in the OIDC flow, defaults to "openid", "profile" and "email" and add custom query +# # parameters to the Authorize Endpoint request. Scopes default to "openid", "profile" and "email". +# +# scope: ["openid", "profile", "email", "custom"] +# extra_params: +# domain_hint: example.com +# +# # List allowed principal domains and/or users. If an authenticated user's domain is not in this list, the +# # authentication request will be rejected. +# + allowed_domains: + - example.com +# # Note: Groups from keycloak have a leading '/' +# allowed_groups: +# - /headscale +# allowed_users: +# - alice@example.com +# +# # If `strip_email_domain` is set to `true`, the domain part of the username email address will be removed. +# # This will transform `first-name.last-name@example.com` to the user `first-name.last-name` +# # If `strip_email_domain` is set to `false` the domain part will NOT be removed resulting to the following +# user: `first-name.last-name.example.com` +# + strip_email_domain: true + +# Logtail configuration +# Logtail is Tailscales logging and auditing infrastructure, it allows the control panel +# to instruct tailscale nodes to log their activity to a remote server. +logtail: + # Enable logtail for this headscales clients. + # As there is currently no support for overriding the log server in headscale, this is + # disabled by default. Enabling this will make your clients send logs to Tailscale Inc. + enabled: true + +# Enabling this option makes devices prefer a random port for WireGuard traffic over the +# default static port 41641. This option is intended as a workaround for some buggy +# firewall devices. See https://tailscale.com/kb/1181/firewalls/ for more information. +randomize_client_port: false