Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

9.5 KB
Raw Blame
package api

import (
	"net/http"
	"net/http/httptest"
	"testing"
	"time"

	"github.com/rcourtman/pulse-go-rewrite/internal/config"
	internalauth "github.com/rcourtman/pulse-go-rewrite/pkg/auth"
)

func newRouterWithSession(t *testing.T) (*Router, string) {
	t.Helper()
	t.Setenv("PULSE_TRUSTED_PROXY_CIDRS", "")
	resetTrustedProxyConfig()

	dir := t.TempDir()
	InitSessionStore(dir)
	InitCSRFStore(dir)
	InitRecoveryTokenStore(dir)

	hashed, err := internalauth.HashPassword("Password!1")
	if err != nil {
		t.Fatalf("hash password: %v", err)
	}

	cfg := &config.Config{
		AuthUser:   "admin",
		AuthPass:   hashed,
		DataPath:   dir,
		ConfigPath: dir,
	}

	router := &Router{
		mux:    http.NewServeMux(),
		config: cfg,
	}

	token := generateSessionToken()
	GetSessionStore().CreateSession(token, time.Hour, "test-agent", "127.0.0.1", "admin")

	return router, token
}

func newRouterWithProxyAuth(t *testing.T) *Router {
	t.Helper()
	t.Setenv("PULSE_TRUSTED_PROXY_CIDRS", "")
	resetTrustedProxyConfig()

	dir := t.TempDir()
	InitSessionStore(dir)
	InitCSRFStore(dir)

	cfg := &config.Config{
		ProxyAuthSecret:     "proxy-secret",
		ProxyAuthUserHeader: "X-Proxy-User",
		DataPath:            dir,
		ConfigPath:          dir,
	}

	return &Router{
		mux:    http.NewServeMux(),
		config: cfg,
	}
}

func TestRouterCSRFEnforcedForSessionRequests(t *testing.T) {
	router, sessionToken := newRouterWithSession(t)

	router.mux.HandleFunc("/api/secure", func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	req := httptest.NewRequest(http.MethodPost, "/api/secure", nil)
	req.AddCookie(&http.Cookie{Name: "pulse_session", Value: sessionToken})
	rec := httptest.NewRecorder()

	router.ServeHTTP(rec, req)

	if rec.Code != http.StatusForbidden {
		t.Fatalf("expected status %d, got %d (%s)", http.StatusForbidden, rec.Code, rec.Body.String())
	}
}

func TestRouterCSRFAllowsValidToken(t *testing.T) {
	router, sessionToken := newRouterWithSession(t)

	router.mux.HandleFunc("/api/secure", func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	csrfToken := generateCSRFToken(sessionToken)
	req := httptest.NewRequest(http.MethodPost, "/api/secure", nil)
	req.AddCookie(&http.Cookie{Name: "pulse_session", Value: sessionToken})
	req.Header.Set("X-CSRF-Token", csrfToken)
	rec := httptest.NewRecorder()

	router.ServeHTTP(rec, req)

	if rec.Code != http.StatusOK {
		t.Fatalf("expected status %d, got %d (%s)", http.StatusOK, rec.Code, rec.Body.String())
	}
}

func TestRouterCSRFRetainsConcurrentReplacementTokens(t *testing.T) {
	router, sessionToken := newRouterWithSession(t)

	router.mux.HandleFunc("/api/secure", func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	replacementTokens := make([]string, 0, 2)
	for _, staleToken := range []string{"stale-token-a", "stale-token-b"} {
		req := httptest.NewRequest(http.MethodPost, "/api/secure", nil)
		req.AddCookie(&http.Cookie{Name: "pulse_session", Value: sessionToken})
		req.Header.Set("X-CSRF-Token", staleToken)
		rec := httptest.NewRecorder()

		router.ServeHTTP(rec, req)

		if rec.Code != http.StatusForbidden {
			t.Fatalf("expected status %d for stale token, got %d (%s)", http.StatusForbidden, rec.Code, rec.Body.String())
		}
		replacementToken := rec.Header().Get("X-CSRF-Token")
		if replacementToken == "" {
			t.Fatal("expected replacement CSRF token header after stale token")
		}
		replacementTokens = append(replacementTokens, replacementToken)
	}

	for i, replacementToken := range replacementTokens {
		req := httptest.NewRequest(http.MethodPost, "/api/secure", nil)
		req.AddCookie(&http.Cookie{Name: "pulse_session", Value: sessionToken})
		req.Header.Set("X-CSRF-Token", replacementToken)
		rec := httptest.NewRecorder()

		router.ServeHTTP(rec, req)

		if rec.Code != http.StatusOK {
			t.Fatalf("replacement token %d should remain valid, got status %d (%s)", i, rec.Code, rec.Body.String())
		}
	}
}

func TestRouterCSRFBlocksCrossSiteProxyAuthMutation(t *testing.T) {
	router := newRouterWithProxyAuth(t)

	router.mux.HandleFunc("/api/secure", func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	req := httptest.NewRequest(http.MethodPost, "/api/secure", nil)
	req.Host = "pulse.example.com"
	req.Header.Set("X-Proxy-Secret", "proxy-secret")
	req.Header.Set("X-Proxy-User", "alice")
	req.Header.Set("Origin", "https://evil.example.com")
	rec := httptest.NewRecorder()

	router.ServeHTTP(rec, req)

	if rec.Code != http.StatusForbidden {
		t.Fatalf("expected status %d, got %d (%s)", http.StatusForbidden, rec.Code, rec.Body.String())
	}
}

func TestRouterCSRFAcceptsSameOriginProxyAuthMutation(t *testing.T) {
	router := newRouterWithProxyAuth(t)

	router.mux.HandleFunc("/api/secure", func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	req := httptest.NewRequest(http.MethodPost, "/api/secure", nil)
	req.Host = "pulse.example.com"
	req.Header.Set("X-Proxy-Secret", "proxy-secret")
	req.Header.Set("X-Proxy-User", "alice")
	req.Header.Set("Origin", "http://pulse.example.com")
	rec := httptest.NewRecorder()

	router.ServeHTTP(rec, req)

	if rec.Code != http.StatusOK {
		t.Fatalf("expected status %d, got %d (%s)", http.StatusOK, rec.Code, rec.Body.String())
	}
}

func TestRouterCSRFSpecialCaseSkips(t *testing.T) {
	router, sessionToken := newRouterWithSession(t)

	skipPaths := []string{
		"/api/login",
		"/api/security/validate-bootstrap-token",
		"/api/setup-script-url",
	}

	for _, path := range skipPaths {
		router.mux.HandleFunc(path, func(w http.ResponseWriter, r *http.Request) {
			w.WriteHeader(http.StatusOK)
		})

		req := httptest.NewRequest(http.MethodPost, path, nil)
		req.AddCookie(&http.Cookie{Name: "pulse_session", Value: sessionToken})
		rec := httptest.NewRecorder()

		router.ServeHTTP(rec, req)

		if rec.Code != http.StatusOK {
			t.Fatalf("path %s: expected status %d, got %d (%s)", path, http.StatusOK, rec.Code, rec.Body.String())
		}
	}
}

func TestRouterCSRFEnforcedForSecurityMutationRoutesWhenAuthConfigured(t *testing.T) {
	router, sessionToken := newRouterWithSession(t)

	protectedPaths := []string{
		"/api/security/apply-restart",
		"/api/security/quick-setup",
	}

	for _, path := range protectedPaths {
		router.mux.HandleFunc(path, func(w http.ResponseWriter, r *http.Request) {
			w.WriteHeader(http.StatusOK)
		})

		req := httptest.NewRequest(http.MethodPost, path, nil)
		req.AddCookie(&http.Cookie{Name: "pulse_session", Value: sessionToken})
		rec := httptest.NewRecorder()

		router.ServeHTTP(rec, req)

		if rec.Code != http.StatusForbidden {
			t.Fatalf("path %s: expected status %d, got %d (%s)", path, http.StatusForbidden, rec.Code, rec.Body.String())
		}
	}
}

func TestRouterCSRFNotBypassedForQuickSetupWithInvalidRecoveryToken(t *testing.T) {
	router, sessionToken := newRouterWithSession(t)

	router.mux.HandleFunc("/api/security/quick-setup", func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	req := httptest.NewRequest(http.MethodPost, "/api/security/quick-setup", nil)
	req.AddCookie(&http.Cookie{Name: "pulse_session", Value: sessionToken})
	req.Header.Set("X-Recovery-Token", "invalid-token")
	rec := httptest.NewRecorder()

	router.ServeHTTP(rec, req)

	if rec.Code != http.StatusForbidden {
		t.Fatalf("expected status %d, got %d (%s)", http.StatusForbidden, rec.Code, rec.Body.String())
	}
}

func TestRouterCSRFBypassedForQuickSetupWithValidRecoveryToken(t *testing.T) {
	router, sessionToken := newRouterWithSession(t)

	router.mux.HandleFunc("/api/security/quick-setup", func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	token, err := GetRecoveryTokenStore().GenerateRecoveryToken(5*time.Minute, "127.0.0.1")
	if err != nil {
		t.Fatalf("generate recovery token: %v", err)
	}

	req := httptest.NewRequest(http.MethodPost, "/api/security/quick-setup", nil)
	req.RemoteAddr = "127.0.0.1:12345"
	req.AddCookie(&http.Cookie{Name: "pulse_session", Value: sessionToken})
	req.Header.Set("X-Recovery-Token", token)
	rec := httptest.NewRecorder()

	router.ServeHTTP(rec, req)

	if rec.Code != http.StatusOK {
		t.Fatalf("expected status %d, got %d (%s)", http.StatusOK, rec.Code, rec.Body.String())
	}
}

func TestRouterIssuesCSRFCookieForGetWithSession(t *testing.T) {
	router, sessionToken := newRouterWithSession(t)

	router.mux.HandleFunc("/api/ping", func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	req := httptest.NewRequest(http.MethodGet, "/api/ping", nil)
	req.AddCookie(&http.Cookie{Name: "pulse_session", Value: sessionToken})
	rec := httptest.NewRecorder()

	router.ServeHTTP(rec, req)

	if rec.Code != http.StatusOK {
		t.Fatalf("expected status %d, got %d (%s)", http.StatusOK, rec.Code, rec.Body.String())
	}

	var csrfCookie *http.Cookie
	for _, c := range rec.Result().Cookies() {
		if c.Name == "pulse_csrf" {
			csrfCookie = c
			break
		}
	}
	if csrfCookie == nil {
		t.Fatalf("expected pulse_csrf cookie to be set")
	}
	if csrfCookie.Value == "" {
		t.Fatalf("expected pulse_csrf cookie to have a value")
	}
}

func TestRouterDoesNotIssueCSRFCookieWithoutSession(t *testing.T) {
	router, _ := newRouterWithSession(t)

	router.mux.HandleFunc("/api/ping", func(w http.ResponseWriter, r *http.Request) {
		w.WriteHeader(http.StatusOK)
	})

	req := httptest.NewRequest(http.MethodGet, "/api/ping", nil)
	rec := httptest.NewRecorder()

	router.ServeHTTP(rec, req)

	if rec.Code != http.StatusUnauthorized {
		t.Fatalf("expected status %d, got %d (%s)", http.StatusUnauthorized, rec.Code, rec.Body.String())
	}

	for _, c := range rec.Result().Cookies() {
		if c.Name == "pulse_csrf" {
			t.Fatalf("did not expect pulse_csrf cookie to be set")
		}
	}
}