Files
tailscale/ipn/ipnlocal/serve_unix_test.go
T
Will Norris 3ec5be3f51 all: remove AUTHORS file and references to it
This file was never truly necessary and has never actually been used in
the history of Tailscale's open source releases.

A Brief History of AUTHORS files
---

The AUTHORS file was a pattern developed at Google, originally for
Chromium, then adopted by Go and a bunch of other projects. The problem
was that Chromium originally had a copyright line only recognizing
Google as the copyright holder. Because Google (and most open source
projects) do not require copyright assignemnt for contributions, each
contributor maintains their copyright. Some large corporate contributors
then tried to add their own name to the copyright line in the LICENSE
file or in file headers. This quickly becomes unwieldy, and puts a
tremendous burden on anyone building on top of Chromium, since the
license requires that they keep all copyright lines intact.

The compromise was to create an AUTHORS file that would list all of the
copyright holders. The LICENSE file and source file headers would then
include that list by reference, listing the copyright holder as "The
Chromium Authors".

This also become cumbersome to simply keep the file up to date with a
high rate of new contributors. Plus it's not always obvious who the
copyright holder is. Sometimes it is the individual making the
contribution, but many times it may be their employer. There is no way
for the proejct maintainer to know.

Eventually, Google changed their policy to no longer recommend trying to
keep the AUTHORS file up to date proactively, and instead to only add to
it when requested: https://opensource.google/docs/releasing/authors.
They are also clear that:

> Adding contributors to the AUTHORS file is entirely within the
> project's discretion and has no implications for copyright ownership.

It was primarily added to appease a small number of large contributors
that insisted that they be recognized as copyright holders (which was
entirely their right to do). But it's not truly necessary, and not even
the most accurate way of identifying contributors and/or copyright
holders.

In practice, we've never added anyone to our AUTHORS file. It only lists
Tailscale, so it's not really serving any purpose. It also causes
confusion because Tailscalars put the "Tailscale Inc & AUTHORS" header
in other open source repos which don't actually have an AUTHORS file, so
it's ambiguous what that means.

Instead, we just acknowledge that the contributors to Tailscale (whoever
they are) are copyright holders for their individual contributions. We
also have the benefit of using the DCO (developercertificate.org) which
provides some additional certification of their right to make the
contribution.

The source file changes were purely mechanical with:

    git ls-files | xargs sed -i -e 's/\(Tailscale Inc &\) AUTHORS/\1 contributors/g'

Updates #cleanup

Change-Id: Ia101a4a3005adb9118051b3416f5a64a4a45987d
Signed-off-by: Will Norris <will@tailscale.com>
2026-01-23 15:49:45 -08:00

219 lines
5.8 KiB
Go

// Copyright (c) Tailscale Inc & contributors
// SPDX-License-Identifier: BSD-3-Clause
//go:build unix
package ipnlocal
import (
"errors"
"fmt"
"net"
"net/http"
"net/http/httptest"
"net/url"
"os"
"path/filepath"
"testing"
"time"
"tailscale.com/tstest"
)
func TestExpandProxyArgUnix(t *testing.T) {
tests := []struct {
input string
wantURL string
wantInsecure bool
}{
{
input: "unix:/tmp/test.sock",
wantURL: "unix:/tmp/test.sock",
},
{
input: "unix:/var/run/docker.sock",
wantURL: "unix:/var/run/docker.sock",
},
{
input: "unix:./relative.sock",
wantURL: "unix:./relative.sock",
},
}
for _, tt := range tests {
t.Run(tt.input, func(t *testing.T) {
gotURL, gotInsecure := expandProxyArg(tt.input)
if gotURL != tt.wantURL {
t.Errorf("expandProxyArg(%q) url = %q, want %q", tt.input, gotURL, tt.wantURL)
}
if gotInsecure != tt.wantInsecure {
t.Errorf("expandProxyArg(%q) insecure = %v, want %v", tt.input, gotInsecure, tt.wantInsecure)
}
})
}
}
func TestServeUnixSocket(t *testing.T) {
// Create a temporary directory for our socket
tmpDir := t.TempDir()
socketPath := filepath.Join(tmpDir, "test.sock")
// Create a test HTTP server on Unix socket
listener, err := net.Listen("unix", socketPath)
if err != nil {
t.Fatalf("failed to create unix socket listener: %v", err)
}
defer listener.Close()
testResponse := "Hello from Unix socket!"
testServer := &http.Server{
Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Header().Set("Content-Type", "text/plain")
fmt.Fprint(w, testResponse)
}),
}
go testServer.Serve(listener)
defer testServer.Close()
// Wait for server to be ready
time.Sleep(50 * time.Millisecond)
// Create LocalBackend with test logger
logf := tstest.WhileTestRunningLogger(t)
b := newTestBackend(t)
b.logf = logf
// Test creating proxy handler for Unix socket
handler, err := b.proxyHandlerForBackend("unix:" + socketPath)
if err != nil {
t.Fatalf("proxyHandlerForBackend failed: %v", err)
}
// Verify it's a reverseProxy with correct socketPath
rp, ok := handler.(*reverseProxy)
if !ok {
t.Fatalf("expected *reverseProxy, got %T", handler)
}
if rp.socketPath != socketPath {
t.Errorf("socketPath = %q, want %q", rp.socketPath, socketPath)
}
if rp.url.Host != "localhost" {
t.Errorf("url.Host = %q, want %q", rp.url.Host, "localhost")
}
}
func TestServeUnixSocketErrors(t *testing.T) {
logf := tstest.WhileTestRunningLogger(t)
b := newTestBackend(t)
b.logf = logf
// Test empty socket path
_, err := b.proxyHandlerForBackend("unix:")
if err == nil {
t.Error("expected error for empty socket path")
}
// Test non-existent socket - should create handler but fail on request
nonExistentSocket := filepath.Join(t.TempDir(), "nonexistent.sock")
handler, err := b.proxyHandlerForBackend("unix:" + nonExistentSocket)
if err != nil {
t.Fatalf("proxyHandlerForBackend failed: %v", err)
}
req := httptest.NewRequest("GET", "http://foo.test.ts.net/", nil)
rec := httptest.NewRecorder()
handler.ServeHTTP(rec, req)
// Should get a 502 Bad Gateway when socket doesn't exist
if rec.Code != http.StatusBadGateway {
t.Errorf("got status %d, want %d for non-existent socket", rec.Code, http.StatusBadGateway)
}
}
func TestReverseProxyConfigurationUnix(t *testing.T) {
b := newTestBackend(t)
// Test that Unix socket backend creates proper reverseProxy
backend := "unix:/var/run/test.sock"
handler, err := b.proxyHandlerForBackend(backend)
if err != nil {
t.Fatalf("proxyHandlerForBackend failed: %v", err)
}
rp, ok := handler.(*reverseProxy)
if !ok {
t.Fatalf("expected *reverseProxy, got %T", handler)
}
// Verify configuration
if rp.socketPath != "/var/run/test.sock" {
t.Errorf("socketPath = %q, want %q", rp.socketPath, "/var/run/test.sock")
}
if rp.backend != backend {
t.Errorf("backend = %q, want %q", rp.backend, backend)
}
if rp.insecure {
t.Error("insecure should be false for unix sockets")
}
expectedURL := url.URL{Scheme: "http", Host: "localhost"}
if rp.url.Scheme != expectedURL.Scheme || rp.url.Host != expectedURL.Host {
t.Errorf("url = %v, want %v", rp.url, expectedURL)
}
}
func TestServeBlocksTailscaledSocket(t *testing.T) {
// Use /tmp to avoid macOS socket path length limits
tmpDir, err := os.MkdirTemp("/tmp", "ts-test-*")
if err != nil {
t.Fatalf("failed to create temp dir: %v", err)
}
defer os.RemoveAll(tmpDir)
tailscaledSocket := filepath.Join(tmpDir, "ts.sock")
// Create actual socket file
listener, err := net.Listen("unix", tailscaledSocket)
if err != nil {
t.Fatalf("failed to create tailscaled socket: %v", err)
}
defer listener.Close()
b := newTestBackend(t)
b.sys.SocketPath = tailscaledSocket
// Direct path to tailscaled socket should be blocked
_, err = b.proxyHandlerForBackend("unix:" + tailscaledSocket)
if !errors.Is(err, ErrProxyToTailscaledSocket) {
t.Errorf("direct path: got err=%v, want ErrProxyToTailscaledSocket", err)
}
// Symlink to tailscaled socket should be blocked
symlinkPath := filepath.Join(tmpDir, "link")
if err := os.Symlink(tailscaledSocket, symlinkPath); err != nil {
t.Fatalf("failed to create symlink: %v", err)
}
_, err = b.proxyHandlerForBackend("unix:" + symlinkPath)
if !errors.Is(err, ErrProxyToTailscaledSocket) {
t.Errorf("symlink: got err=%v, want ErrProxyToTailscaledSocket", err)
}
// Different socket should work
otherSocket := filepath.Join(tmpDir, "ok.sock")
listener2, err := net.Listen("unix", otherSocket)
if err != nil {
t.Fatalf("failed to create other socket: %v", err)
}
defer listener2.Close()
handler, err := b.proxyHandlerForBackend("unix:" + otherSocket)
if err != nil {
t.Errorf("legitimate socket should not be blocked: %v", err)
}
if handler == nil {
t.Error("expected valid handler for legitimate socket")
}
}