2023-01-27 21:37:20 +00:00
// Copyright (c) Tailscale Inc & AUTHORS
// SPDX-License-Identifier: BSD-3-Clause
2022-10-25 20:12:54 +00:00
//go:build linux
2022-12-16 22:09:46 +00:00
// The containerboot binary is a wrapper for starting tailscaled in a container.
// It handles reading the desired mode of operation out of environment
// variables, bringing up and authenticating Tailscale, and any other
// kubernetes-specific side jobs.
2022-10-25 20:12:54 +00:00
//
2022-12-16 22:09:46 +00:00
// As with most container things, configuration is passed through environment
// variables. All configuration is optional.
2022-10-25 20:12:54 +00:00
//
2023-01-03 23:17:44 +00:00
// - TS_AUTHKEY: the authkey to use for login.
2023-01-25 18:16:59 +00:00
// - TS_HOSTNAME: the hostname to request for the node.
2022-11-16 18:04:07 +00:00
// - TS_ROUTES: subnet routes to advertise.
// - TS_DEST_IP: proxy all incoming Tailscale traffic to the given
// destination.
// - TS_TAILSCALED_EXTRA_ARGS: extra arguments to 'tailscaled'.
2023-08-23 23:08:24 +00:00
// - TS_EXTRA_ARGS: extra arguments to 'tailscale login', these are not
// reset on restart.
2022-11-16 18:04:07 +00:00
// - TS_USERSPACE: run with userspace networking (the default)
// instead of kernel networking.
// - TS_STATE_DIR: the directory in which to store tailscaled
// state. The data should persist across container
// restarts.
// - TS_ACCEPT_DNS: whether to use the tailnet's DNS configuration.
// - TS_KUBE_SECRET: the name of the Kubernetes secret in which to
// store tailscaled state.
// - TS_SOCKS5_SERVER: the address on which to listen for SOCKS5
// proxying into the tailnet.
// - TS_OUTBOUND_HTTP_PROXY_LISTEN: the address on which to listen
// for HTTP proxying into the tailnet.
// - TS_SOCKET: the path where the tailscaled LocalAPI socket should
// be created.
// - TS_AUTH_ONCE: if true, only attempt to log in if not already
// logged in. If false (the default, for backwards
// compatibility), forcibly log in every time the
// container starts.
2023-08-24 16:08:50 +00:00
// - TS_SERVE_CONFIG: if specified, is the file path where the ipn.ServeConfig is located.
// It will be applied once tailscaled is up and running. If the file contains
// ${TS_CERT_DOMAIN}, it will be replaced with the value of the available FQDN.
// It cannot be used in conjunction with TS_DEST_IP.
2022-10-25 20:12:54 +00:00
//
2022-12-16 22:09:46 +00:00
// When running on Kubernetes, containerboot defaults to storing state in the
// "tailscale" kube secret. To store state on local disk instead, set
// TS_KUBE_SECRET="" and TS_STATE_DIR=/path/to/storage/dir. The state dir should
// be persistent storage.
//
2023-01-03 23:17:44 +00:00
// Additionally, if TS_AUTHKEY is not set and the TS_KUBE_SECRET contains an
2022-12-16 22:09:46 +00:00
// "authkey" field, that key is used as the tailscale authkey.
2022-10-25 20:12:54 +00:00
package main
import (
2023-08-24 16:08:50 +00:00
"bytes"
2022-10-25 20:12:54 +00:00
"context"
2023-08-24 16:08:50 +00:00
"encoding/json"
2022-10-25 20:12:54 +00:00
"errors"
"fmt"
"io/fs"
"log"
"net/netip"
"os"
"os/exec"
"os/signal"
2022-11-10 06:01:34 +00:00
"path/filepath"
2022-10-25 20:12:54 +00:00
"strconv"
"strings"
2023-08-24 16:08:50 +00:00
"sync/atomic"
2022-10-25 20:12:54 +00:00
"syscall"
"time"
2023-08-24 16:08:50 +00:00
"github.com/fsnotify/fsnotify"
2022-10-25 20:12:54 +00:00
"golang.org/x/sys/unix"
"tailscale.com/client/tailscale"
2022-12-07 20:29:45 +00:00
"tailscale.com/ipn"
2023-08-24 16:08:50 +00:00
"tailscale.com/types/ptr"
2022-12-07 20:29:45 +00:00
"tailscale.com/util/deephash"
2022-10-25 20:12:54 +00:00
)
func main ( ) {
log . SetPrefix ( "boot: " )
tailscale . I_Acknowledge_This_API_Is_Unstable = true
cfg := & settings {
2023-01-03 23:17:44 +00:00
AuthKey : defaultEnvs ( [ ] string { "TS_AUTHKEY" , "TS_AUTH_KEY" } , "" ) ,
2023-01-25 18:16:59 +00:00
Hostname : defaultEnv ( "TS_HOSTNAME" , "" ) ,
2022-10-25 20:12:54 +00:00
Routes : defaultEnv ( "TS_ROUTES" , "" ) ,
ProxyTo : defaultEnv ( "TS_DEST_IP" , "" ) ,
2023-08-24 16:08:50 +00:00
ServeConfigPath : defaultEnv ( "TS_SERVE_CONFIG" , "" ) ,
2022-10-25 20:12:54 +00:00
DaemonExtraArgs : defaultEnv ( "TS_TAILSCALED_EXTRA_ARGS" , "" ) ,
ExtraArgs : defaultEnv ( "TS_EXTRA_ARGS" , "" ) ,
InKubernetes : os . Getenv ( "KUBERNETES_SERVICE_HOST" ) != "" ,
UserspaceMode : defaultBool ( "TS_USERSPACE" , true ) ,
StateDir : defaultEnv ( "TS_STATE_DIR" , "" ) ,
AcceptDNS : defaultBool ( "TS_ACCEPT_DNS" , false ) ,
KubeSecret : defaultEnv ( "TS_KUBE_SECRET" , "tailscale" ) ,
SOCKSProxyAddr : defaultEnv ( "TS_SOCKS5_SERVER" , "" ) ,
HTTPProxyAddr : defaultEnv ( "TS_OUTBOUND_HTTP_PROXY_LISTEN" , "" ) ,
Socket : defaultEnv ( "TS_SOCKET" , "/tmp/tailscaled.sock" ) ,
AuthOnce : defaultBool ( "TS_AUTH_ONCE" , false ) ,
2022-11-10 06:01:34 +00:00
Root : defaultEnv ( "TS_TEST_ONLY_ROOT" , "/" ) ,
2022-10-25 20:12:54 +00:00
}
if cfg . ProxyTo != "" && cfg . UserspaceMode {
log . Fatal ( "TS_DEST_IP is not supported with TS_USERSPACE" )
}
2023-08-24 16:08:50 +00:00
if cfg . ProxyTo != "" && cfg . ServeConfigPath != "" {
log . Fatal ( "TS_DEST_IP is not supported with TS_SERVE_CONFIG" )
}
2022-10-25 20:12:54 +00:00
if ! cfg . UserspaceMode {
2022-11-10 06:01:34 +00:00
if err := ensureTunFile ( cfg . Root ) ; err != nil {
2022-10-25 20:12:54 +00:00
log . Fatalf ( "Unable to create tuntap device file: %v" , err )
}
2022-11-07 23:34:08 +00:00
if cfg . ProxyTo != "" || cfg . Routes != "" {
2022-11-10 06:01:34 +00:00
if err := ensureIPForwarding ( cfg . Root , cfg . ProxyTo , cfg . Routes ) ; err != nil {
2022-11-07 23:34:08 +00:00
log . Printf ( "Failed to enable IP forwarding: %v" , err )
log . Printf ( "To run tailscale as a proxy or router container, IP forwarding must be enabled." )
if cfg . InKubernetes {
log . Fatalf ( "You can either set the sysctls as a privileged initContainer, or run the tailscale container with privileged=true." )
} else {
log . Fatalf ( "You can fix this by running the container with privileged=true, or the equivalent in your container runtime that permits access to sysctls." )
}
2022-10-25 20:12:54 +00:00
}
}
}
2022-11-10 06:01:34 +00:00
if cfg . InKubernetes {
initKube ( cfg . Root )
}
2022-10-25 20:12:54 +00:00
// Context is used for all setup stuff until we're in steady
// state, so that if something is hanging we eventually time out
// and crashloop the container.
2023-08-24 16:08:50 +00:00
bootCtx , cancel := context . WithTimeout ( context . Background ( ) , 60 * time . Second )
2022-10-25 20:12:54 +00:00
defer cancel ( )
2022-12-06 22:52:22 +00:00
if cfg . InKubernetes && cfg . KubeSecret != "" {
2023-08-24 16:08:50 +00:00
canPatch , err := kc . CheckSecretPermissions ( bootCtx , cfg . KubeSecret )
2022-12-07 01:03:53 +00:00
if err != nil {
2022-12-06 22:52:22 +00:00
log . Fatalf ( "Some Kubernetes permissions are missing, please check your RBAC configuration: %v" , err )
2022-10-25 20:12:54 +00:00
}
2022-12-07 01:03:53 +00:00
cfg . KubernetesCanPatch = canPatch
2022-12-06 22:52:22 +00:00
if cfg . AuthKey == "" {
2023-08-24 16:08:50 +00:00
key , err := findKeyInKubeSecret ( bootCtx , cfg . KubeSecret )
2022-12-06 22:52:22 +00:00
if err != nil {
log . Fatalf ( "Getting authkey from kube secret: %v" , err )
}
if key != "" {
2022-12-07 01:03:53 +00:00
// This behavior of pulling authkeys from kube secrets was added
// at the same time as the patch permission, so we can enforce
// that we must be able to patch out the authkey after
// authenticating if you want to use this feature. This avoids
// us having to deal with the case where we might leave behind
// an unnecessary reusable authkey in a secret, like a rake in
// the grass.
if ! cfg . KubernetesCanPatch {
log . Fatalf ( "authkey found in TS_KUBE_SECRET, but the pod doesn't have patch permissions on the secret to manage the authkey." )
}
2022-12-06 22:52:22 +00:00
log . Print ( "Using authkey found in kube secret" )
cfg . AuthKey = key
} else {
log . Print ( "No authkey found in kube secret and TS_AUTHKEY not provided, login will be interactive if needed." )
}
2022-10-25 20:12:54 +00:00
}
}
2023-08-24 16:08:50 +00:00
client , daemonPid , err := startTailscaled ( bootCtx , cfg )
2022-10-25 20:12:54 +00:00
if err != nil {
log . Fatalf ( "failed to bring up tailscale: %v" , err )
}
2023-08-24 16:08:50 +00:00
w , err := client . WatchIPNBus ( bootCtx , ipn . NotifyInitialNetMap | ipn . NotifyInitialPrefs | ipn . NotifyInitialState )
2022-12-05 23:38:50 +00:00
if err != nil {
2022-12-07 20:29:45 +00:00
log . Fatalf ( "failed to watch tailscaled for updates: %v" , err )
2022-12-05 23:38:50 +00:00
}
2022-12-07 20:29:45 +00:00
// Because we're still shelling out to `tailscale up` to get access to its
// flag parser, we have to stop watching the IPN bus so that we can block on
// the subcommand without stalling anything. Then once it's done, we resume
// watching the bus.
//
// Depending on the requested mode of operation, this auth step happens at
// different points in containerboot's lifecycle, hence the helper function.
didLogin := false
authTailscale := func ( ) error {
if didLogin {
return nil
}
didLogin = true
w . Close ( )
2023-08-24 16:08:50 +00:00
if err := tailscaleLogin ( bootCtx , cfg ) ; err != nil {
2022-12-07 20:29:45 +00:00
return fmt . Errorf ( "failed to auth tailscale: %v" , err )
2022-10-25 20:12:54 +00:00
}
2023-08-24 16:08:50 +00:00
w , err = client . WatchIPNBus ( bootCtx , ipn . NotifyInitialNetMap | ipn . NotifyInitialState )
2022-12-07 20:29:45 +00:00
if err != nil {
return fmt . Errorf ( "rewatching tailscaled for updates after auth: %v" , err )
}
return nil
2022-10-25 20:12:54 +00:00
}
2022-12-07 20:29:45 +00:00
if ! cfg . AuthOnce {
if err := authTailscale ( ) ; err != nil {
log . Fatalf ( "failed to auth tailscale: %v" , err )
2022-10-25 20:12:54 +00:00
}
2022-12-07 20:29:45 +00:00
}
authLoop :
for {
n , err := w . Next ( )
if err != nil {
log . Fatalf ( "failed to read from tailscaled: %v" , err )
}
if n . State != nil {
switch * n . State {
case ipn . NeedsLogin :
if err := authTailscale ( ) ; err != nil {
log . Fatalf ( "failed to auth tailscale: %v" , err )
}
case ipn . NeedsMachineAuth :
log . Printf ( "machine authorization required, please visit the admin panel" )
case ipn . Running :
// Technically, all we want is to keep monitoring the bus for
// netmap updates. However, in order to make the container crash
// if tailscale doesn't initially come up, the watch has a
// startup deadline on it. So, we have to break out of this
// watch loop, cancel the watch, and watch again with no
// deadline to continue monitoring for changes.
break authLoop
default :
log . Printf ( "tailscaled in state %q, waiting" , * n . State )
2022-10-25 20:12:54 +00:00
}
}
}
2022-12-07 20:29:45 +00:00
w . Close ( )
2023-08-24 16:08:50 +00:00
ctx , cancel := context . WithCancel ( context . Background ( ) ) // no deadline now that we're in steady state
defer cancel ( )
// Now that we are authenticated, we can set/reset any of the
// settings that we need to.
if err := tailscaleSet ( ctx , cfg ) ; err != nil {
log . Fatalf ( "failed to auth tailscale: %v" , err )
}
// Remove any serve config that may have been set by a previous
// run of containerboot.
if err := client . SetServeConfig ( ctx , new ( ipn . ServeConfig ) ) ; err != nil {
log . Fatalf ( "failed to unset serve config: %v" , err )
}
2022-12-07 20:29:45 +00:00
if cfg . InKubernetes && cfg . KubeSecret != "" && cfg . KubernetesCanPatch && cfg . AuthOnce {
// We were told to only auth once, so any secret-bound
// authkey is no longer needed. We don't strictly need to
// wipe it, but it's good hygiene.
log . Printf ( "Deleting authkey from kube secret" )
if err := deleteAuthKey ( ctx , cfg . KubeSecret ) ; err != nil {
log . Fatalf ( "deleting authkey from kube secret: %v" , err )
2022-10-25 20:12:54 +00:00
}
2022-12-07 20:29:45 +00:00
}
2023-08-24 16:08:50 +00:00
w , err = client . WatchIPNBus ( ctx , ipn . NotifyInitialNetMap | ipn . NotifyInitialState )
2022-12-07 20:29:45 +00:00
if err != nil {
log . Fatalf ( "rewatching tailscaled for updates after auth: %v" , err )
}
var (
wantProxy = cfg . ProxyTo != ""
wantDeviceInfo = cfg . InKubernetes && cfg . KubeSecret != "" && cfg . KubernetesCanPatch
startupTasksDone = false
currentIPs deephash . Sum // tailscale IPs assigned to device
currentDeviceInfo deephash . Sum // device ID and fqdn
2023-08-24 16:08:50 +00:00
certDomain = new ( atomic . Pointer [ string ] )
certDomainChanged = make ( chan bool , 1 )
2022-12-07 20:29:45 +00:00
)
2023-08-24 16:08:50 +00:00
if cfg . ServeConfigPath != "" {
go watchServeConfigChanges ( ctx , cfg . ServeConfigPath , certDomainChanged , certDomain , client )
}
2022-12-07 20:29:45 +00:00
for {
n , err := w . Next ( )
2022-10-25 20:12:54 +00:00
if err != nil {
2022-12-07 20:29:45 +00:00
log . Fatalf ( "failed to read from tailscaled: %v" , err )
}
if n . State != nil && * n . State != ipn . Running {
// Something's gone wrong and we've left the authenticated state.
// Our container image never recovered gracefully from this, and the
// control flow required to make it work now is hard. So, just crash
// the container and rely on the container runtime to restart us,
// whereupon we'll go through initial auth again.
log . Fatalf ( "tailscaled left running state (now in state %q), exiting" , * n . State )
}
if n . NetMap != nil {
if cfg . ProxyTo != "" && len ( n . NetMap . Addresses ) > 0 && deephash . Update ( & currentIPs , & n . NetMap . Addresses ) {
if err := installIPTablesRule ( ctx , cfg . ProxyTo , n . NetMap . Addresses ) ; err != nil {
log . Fatalf ( "installing proxy rules: %v" , err )
}
}
2023-08-24 16:08:50 +00:00
if cfg . ServeConfigPath != "" && len ( n . NetMap . DNS . CertDomains ) > 0 {
cd := n . NetMap . DNS . CertDomains [ 0 ]
prev := certDomain . Swap ( ptr . To ( cd ) )
if prev == nil || * prev != cd {
select {
case certDomainChanged <- true :
default :
}
}
}
2023-08-21 17:53:57 +00:00
deviceInfo := [ ] any { n . NetMap . SelfNode . StableID ( ) , n . NetMap . SelfNode . Name ( ) }
2022-12-07 20:29:45 +00:00
if cfg . InKubernetes && cfg . KubernetesCanPatch && cfg . KubeSecret != "" && deephash . Update ( & currentDeviceInfo , & deviceInfo ) {
2023-08-21 17:53:57 +00:00
if err := storeDeviceInfo ( ctx , cfg . KubeSecret , n . NetMap . SelfNode . StableID ( ) , n . NetMap . SelfNode . Name ( ) ) ; err != nil {
2022-12-07 20:29:45 +00:00
log . Fatalf ( "storing device ID in kube secret: %v" , err )
}
}
2022-10-25 20:12:54 +00:00
}
2022-12-07 20:29:45 +00:00
if ! startupTasksDone {
if ( ! wantProxy || currentIPs != deephash . Sum { } ) && ( ! wantDeviceInfo || currentDeviceInfo != deephash . Sum { } ) {
// This log message is used in tests to detect when all
// post-auth configuration is done.
log . Println ( "Startup complete, waiting for shutdown signal" )
startupTasksDone = true
// Reap all processes, since we are PID1 and need to collect zombies. We can
// only start doing this once we've stopped shelling out to things
// `tailscale up`, otherwise this goroutine can reap the CLI subprocesses
// and wedge bringup.
go func ( ) {
for {
var status unix . WaitStatus
pid , err := unix . Wait4 ( - 1 , & status , 0 , nil )
if errors . Is ( err , unix . EINTR ) {
continue
}
if err != nil {
log . Fatalf ( "Waiting for exited processes: %v" , err )
}
if pid == daemonPid {
log . Printf ( "Tailscaled exited" )
os . Exit ( 0 )
}
}
} ( )
}
2022-10-25 20:12:54 +00:00
}
}
}
2023-08-24 16:08:50 +00:00
// watchServeConfigChanges watches path for changes, and when it sees one, reads
// the serve config from it, replacing ${TS_CERT_DOMAIN} with certDomain, and
// applies it to lc. It exits when ctx is canceled. cdChanged is a channel that
// is written to when the certDomain changes, causing the serve config to be
// re-read and applied.
func watchServeConfigChanges ( ctx context . Context , path string , cdChanged <- chan bool , certDomainAtomic * atomic . Pointer [ string ] , lc * tailscale . LocalClient ) {
if certDomainAtomic == nil {
panic ( "cd must not be nil" )
}
w , err := fsnotify . NewWatcher ( )
if err != nil {
log . Fatalf ( "failed to create fsnotify watcher: %v" , err )
}
defer w . Close ( )
if err := w . Add ( filepath . Dir ( path ) ) ; err != nil {
log . Fatalf ( "failed to add fsnotify watch: %v" , err )
}
var certDomain string
for {
select {
case <- ctx . Done ( ) :
return
case <- cdChanged :
certDomain = * certDomainAtomic . Load ( )
case e := <- w . Events :
if e . Name != path {
continue
}
}
if certDomain == "" {
continue
}
sc , err := readServeConfig ( path , certDomain )
if err != nil {
log . Fatalf ( "failed to read serve config: %v" , err )
}
if err := lc . SetServeConfig ( ctx , sc ) ; err != nil {
log . Fatalf ( "failed to set serve config: %v" , err )
}
}
}
// readServeConfig reads the ipn.ServeConfig from path, replacing
// ${TS_CERT_DOMAIN} with certDomain.
func readServeConfig ( path , certDomain string ) ( * ipn . ServeConfig , error ) {
if path == "" {
return nil , nil
}
j , err := os . ReadFile ( path )
if err != nil {
return nil , err
}
j = bytes . ReplaceAll ( j , [ ] byte ( "${TS_CERT_DOMAIN}" ) , [ ] byte ( certDomain ) )
var sc ipn . ServeConfig
if err := json . Unmarshal ( j , & sc ) ; err != nil {
return nil , err
}
return & sc , nil
}
2022-12-05 23:38:50 +00:00
func startTailscaled ( ctx context . Context , cfg * settings ) ( * tailscale . LocalClient , int , error ) {
2022-10-25 20:12:54 +00:00
args := tailscaledArgs ( cfg )
sigCh := make ( chan os . Signal , 1 )
signal . Notify ( sigCh , unix . SIGTERM , unix . SIGINT )
// tailscaled runs without context, since it needs to persist
// beyond the startup timeout in ctx.
cmd := exec . Command ( "tailscaled" , args ... )
cmd . Stdout = os . Stdout
cmd . Stderr = os . Stderr
cmd . SysProcAttr = & syscall . SysProcAttr {
Setpgid : true ,
}
log . Printf ( "Starting tailscaled" )
if err := cmd . Start ( ) ; err != nil {
return nil , 0 , fmt . Errorf ( "starting tailscaled failed: %v" , err )
}
go func ( ) {
<- sigCh
log . Printf ( "Received SIGTERM from container runtime, shutting down tailscaled" )
cmd . Process . Signal ( unix . SIGTERM )
} ( )
2022-12-05 23:38:50 +00:00
// Wait for the socket file to appear, otherwise API ops will racily fail.
2022-10-25 20:12:54 +00:00
log . Printf ( "Waiting for tailscaled socket" )
for {
if ctx . Err ( ) != nil {
log . Fatalf ( "Timed out waiting for tailscaled socket" )
}
_ , err := os . Stat ( cfg . Socket )
if errors . Is ( err , fs . ErrNotExist ) {
time . Sleep ( 100 * time . Millisecond )
continue
} else if err != nil {
log . Fatalf ( "Waiting for tailscaled socket: %v" , err )
}
break
}
2022-12-05 23:38:50 +00:00
tsClient := & tailscale . LocalClient {
Socket : cfg . Socket ,
UseSocketOnly : true ,
}
return tsClient , cmd . Process . Pid , nil
}
2022-10-25 20:12:54 +00:00
// tailscaledArgs uses cfg to construct the argv for tailscaled.
func tailscaledArgs ( cfg * settings ) [ ] string {
args := [ ] string { "--socket=" + cfg . Socket }
switch {
case cfg . InKubernetes && cfg . KubeSecret != "" :
2023-02-01 14:25:48 +00:00
args = append ( args , "--state=kube:" + cfg . KubeSecret )
if cfg . StateDir == "" {
cfg . StateDir = "/tmp"
}
fallthrough
2022-10-25 20:12:54 +00:00
case cfg . StateDir != "" :
2022-12-06 13:31:50 +00:00
args = append ( args , "--statedir=" + cfg . StateDir )
2022-10-25 20:12:54 +00:00
default :
args = append ( args , "--state=mem:" , "--statedir=/tmp" )
}
if cfg . UserspaceMode {
args = append ( args , "--tun=userspace-networking" )
2022-11-10 06:01:34 +00:00
} else if err := ensureTunFile ( cfg . Root ) ; err != nil {
2022-10-25 20:12:54 +00:00
log . Fatalf ( "ensuring that /dev/net/tun exists: %v" , err )
}
if cfg . SOCKSProxyAddr != "" {
args = append ( args , "--socks5-server=" + cfg . SOCKSProxyAddr )
}
if cfg . HTTPProxyAddr != "" {
args = append ( args , "--outbound-http-proxy-listen=" + cfg . HTTPProxyAddr )
}
if cfg . DaemonExtraArgs != "" {
args = append ( args , strings . Fields ( cfg . DaemonExtraArgs ) ... )
}
return args
}
2023-08-23 23:08:24 +00:00
// tailscaleLogin uses cfg to run 'tailscale login' everytime containerboot
// starts, or if TS_AUTH_ONCE is set, only the first time containerboot starts.
func tailscaleLogin ( ctx context . Context , cfg * settings ) error {
args := [ ] string { "--socket=" + cfg . Socket , "login" }
if cfg . AuthKey != "" {
args = append ( args , "--authkey=" + cfg . AuthKey )
}
if cfg . ExtraArgs != "" {
args = append ( args , strings . Fields ( cfg . ExtraArgs ) ... )
}
log . Printf ( "Running 'tailscale login'" )
cmd := exec . CommandContext ( ctx , "tailscale" , args ... )
cmd . Stdout = os . Stdout
cmd . Stderr = os . Stderr
if err := cmd . Run ( ) ; err != nil {
return fmt . Errorf ( "tailscale login failed: %v" , err )
}
return nil
}
// tailscaleSet uses cfg to run 'tailscale set' to set any known configuration
// options that are passed in via environment variables. This is run after the
// node is in Running state.
func tailscaleSet ( ctx context . Context , cfg * settings ) error {
args := [ ] string { "--socket=" + cfg . Socket , "set" }
2022-10-25 20:12:54 +00:00
if cfg . AcceptDNS {
args = append ( args , "--accept-dns=true" )
} else {
args = append ( args , "--accept-dns=false" )
}
if cfg . Routes != "" {
args = append ( args , "--advertise-routes=" + cfg . Routes )
}
2023-01-25 18:16:59 +00:00
if cfg . Hostname != "" {
args = append ( args , "--hostname=" + cfg . Hostname )
}
2023-08-23 23:08:24 +00:00
log . Printf ( "Running 'tailscale set'" )
2022-10-25 20:12:54 +00:00
cmd := exec . CommandContext ( ctx , "tailscale" , args ... )
cmd . Stdout = os . Stdout
cmd . Stderr = os . Stderr
if err := cmd . Run ( ) ; err != nil {
2023-08-23 23:08:24 +00:00
return fmt . Errorf ( "tailscale set failed: %v" , err )
2022-10-25 20:12:54 +00:00
}
return nil
}
// ensureTunFile checks that /dev/net/tun exists, creating it if
// missing.
2022-11-10 06:01:34 +00:00
func ensureTunFile ( root string ) error {
2022-10-25 20:12:54 +00:00
// Verify that /dev/net/tun exists, in some container envs it
// needs to be mknod-ed.
2022-11-10 06:01:34 +00:00
if _ , err := os . Stat ( filepath . Join ( root , "dev/net" ) ) ; errors . Is ( err , fs . ErrNotExist ) {
if err := os . MkdirAll ( filepath . Join ( root , "dev/net" ) , 0755 ) ; err != nil {
2022-10-25 20:12:54 +00:00
return err
}
}
2022-11-10 06:01:34 +00:00
if _ , err := os . Stat ( filepath . Join ( root , "dev/net/tun" ) ) ; errors . Is ( err , fs . ErrNotExist ) {
2022-10-25 20:12:54 +00:00
dev := unix . Mkdev ( 10 , 200 ) // tuntap major and minor
2022-11-10 06:01:34 +00:00
if err := unix . Mknod ( filepath . Join ( root , "dev/net/tun" ) , 0600 | unix . S_IFCHR , int ( dev ) ) ; err != nil {
2022-10-25 20:12:54 +00:00
return err
}
}
return nil
}
// ensureIPForwarding enables IPv4/IPv6 forwarding for the container.
2022-11-10 06:01:34 +00:00
func ensureIPForwarding ( root , proxyTo , routes string ) error {
2022-11-07 23:34:08 +00:00
var (
v4Forwarding , v6Forwarding bool
)
2022-11-10 06:01:34 +00:00
if proxyTo != "" {
proxyIP , err := netip . ParseAddr ( proxyTo )
2022-11-07 23:34:08 +00:00
if err != nil {
2022-11-10 06:01:34 +00:00
return fmt . Errorf ( "invalid proxy destination IP: %v" , err )
2022-11-07 23:34:08 +00:00
}
2022-11-10 06:01:34 +00:00
if proxyIP . Is4 ( ) {
2022-11-07 23:34:08 +00:00
v4Forwarding = true
} else {
v6Forwarding = true
}
}
2022-11-10 06:01:34 +00:00
if routes != "" {
for _ , route := range strings . Split ( routes , "," ) {
cidr , err := netip . ParsePrefix ( route )
if err != nil {
return fmt . Errorf ( "invalid subnet route: %v" , err )
}
if cidr . Addr ( ) . Is4 ( ) {
v4Forwarding = true
} else {
v6Forwarding = true
}
}
}
2022-11-07 23:34:08 +00:00
var paths [ ] string
if v4Forwarding {
2022-11-10 06:01:34 +00:00
paths = append ( paths , filepath . Join ( root , "proc/sys/net/ipv4/ip_forward" ) )
2022-11-07 23:34:08 +00:00
}
if v6Forwarding {
2022-11-10 06:01:34 +00:00
paths = append ( paths , filepath . Join ( root , "proc/sys/net/ipv6/conf/all/forwarding" ) )
2022-11-07 23:34:08 +00:00
}
2022-10-25 20:12:54 +00:00
// In some common configurations (e.g. default docker,
// kubernetes), the container environment denies write access to
// most sysctls, including IP forwarding controls. Check the
// sysctl values before trying to change them, so that we
// gracefully do nothing if the container's already been set up
// properly by e.g. a k8s initContainer.
2022-11-07 23:34:08 +00:00
for _ , path := range paths {
2022-10-25 20:12:54 +00:00
bs , err := os . ReadFile ( path )
if err != nil {
return fmt . Errorf ( "reading %q: %w" , path , err )
}
if v := strings . TrimSpace ( string ( bs ) ) ; v != "1" {
if err := os . WriteFile ( path , [ ] byte ( "1" ) , 0644 ) ; err != nil {
return fmt . Errorf ( "enabling %q: %w" , path , err )
}
}
}
return nil
}
2022-12-07 20:29:45 +00:00
func installIPTablesRule ( ctx context . Context , dstStr string , tsIPs [ ] netip . Prefix ) error {
2022-10-25 20:12:54 +00:00
dst , err := netip . ParseAddr ( dstStr )
if err != nil {
return err
}
argv0 := "iptables"
if dst . Is6 ( ) {
argv0 = "ip6tables"
}
var local string
2022-12-07 20:29:45 +00:00
for _ , pfx := range tsIPs {
if ! pfx . IsSingleIP ( ) {
continue
}
if pfx . Addr ( ) . Is4 ( ) != dst . Is4 ( ) {
2022-10-25 20:12:54 +00:00
continue
}
2022-12-07 20:29:45 +00:00
local = pfx . Addr ( ) . String ( )
2022-10-25 20:12:54 +00:00
break
}
if local == "" {
return fmt . Errorf ( "no tailscale IP matching family of %s found in %v" , dstStr , tsIPs )
}
2022-12-07 20:29:45 +00:00
// Technically, if the control server ever changes the IPs assigned to this
// node, we'll slowly accumulate iptables rules. This shouldn't happen, so
// for now we'll live with it.
2022-10-25 20:12:54 +00:00
cmd := exec . CommandContext ( ctx , argv0 , "-t" , "nat" , "-I" , "PREROUTING" , "1" , "-d" , local , "-j" , "DNAT" , "--to-destination" , dstStr )
cmd . Stdout = os . Stdout
cmd . Stderr = os . Stderr
if err := cmd . Run ( ) ; err != nil {
return fmt . Errorf ( "executing iptables failed: %w" , err )
}
return nil
}
// settings is all the configuration for containerboot.
type settings struct {
2022-12-07 01:03:53 +00:00
AuthKey string
2023-01-25 18:16:59 +00:00
Hostname string
2022-12-07 01:03:53 +00:00
Routes string
ProxyTo string
2023-08-24 16:08:50 +00:00
ServeConfigPath string
2022-12-07 01:03:53 +00:00
DaemonExtraArgs string
ExtraArgs string
InKubernetes bool
UserspaceMode bool
StateDir string
AcceptDNS bool
KubeSecret string
SOCKSProxyAddr string
HTTPProxyAddr string
Socket string
AuthOnce bool
Root string
KubernetesCanPatch bool
2022-10-25 20:12:54 +00:00
}
// defaultEnv returns the value of the given envvar name, or defVal if
// unset.
func defaultEnv ( name , defVal string ) string {
2022-12-16 22:09:46 +00:00
if v , ok := os . LookupEnv ( name ) ; ok {
2022-10-25 20:12:54 +00:00
return v
}
return defVal
}
2023-01-03 23:17:44 +00:00
func defaultEnvs ( names [ ] string , defVal string ) string {
for _ , name := range names {
if v , ok := os . LookupEnv ( name ) ; ok {
return v
}
}
return defVal
}
2022-10-25 20:12:54 +00:00
// defaultBool returns the boolean value of the given envvar name, or
// defVal if unset or not a bool.
func defaultBool ( name string , defVal bool ) bool {
v := os . Getenv ( name )
ret , err := strconv . ParseBool ( v )
if err != nil {
return defVal
}
return ret
}