mirror of
https://github.com/sipeed/picoclaw.git
synced 2026-06-12 18:08:54 +00:00
06023c79fa
* feat(launcher): replace token-in-logs auth with standard HTTP login flow
## Problem
Previously users had to find the one-time token from console logs or
log files to access the dashboard - a non-standard, error-prone workflow
with no clear path for changing credentials.
## Solution: standard HTTP API login with bcrypt-backed password store
### Auth flow (new)
1. First run: browser opens, session guard detects uninitialized state,
redirects to /launcher-setup
2. User sets a password (min 8 chars) via POST /api/auth/setup {password, confirm},
bcrypt(cost=12) hash stored in ~/.picoclaw/launcher-auth.db (SQLite)
3. Subsequent logins: POST /api/auth/login {password}, HttpOnly cookie
picoclaw_launcher_auth (HMAC-SHA256 signed, 7-day expiry)
4. 401 on any API call, frontend redirects to /launcher-login
5. Logout: POST /api/auth/logout, cookie cleared, redirect to login
### Backend changes
- web/backend/api/auth.go: renamed Token to Password; added handleSetup;
launcherAuthStatusResponse now includes Initialized bool; PasswordStore
interface wires bcrypt store into handlers
- web/backend/dashboardauth/: new package - Store with New(dir) / Open(path);
SetPassword (bcrypt cost=12), VerifyPassword, IsInitialized
- sql.go: all DB-layer constants (DBFilename, sqliteDriver, bcryptCost,
four SQL query strings) - compile-time constants, zero runtime overhead
- web/backend/middleware/launcher_dashboard_auth.go: /launcher-setup and
/api/auth/setup added to public paths
- web/backend/main.go:
- dashboardauth.New(picoHome) replaces manual path construction
- maskSecret(): suffix only revealed when >=5 chars hidden (length >= 12),
preventing 8-char minimum passwords from leaking their tail
- web/backend/main_test.go: TestMaskSecret updated with boundary cases
### Forward-compatibility: pkg/credential integration
If the dashboard password is later reused as the enc:// passphrase,
the bcrypt hash in launcher-auth.db becomes an offline oracle.
Recommended mitigation (not yet implemented): derive two independent
subkeys via HKDF before use:
bcrypt(HKDF(password, info="picoclaw-dashboard-login-v1")) stored in DB
HKDF(password, info="picoclaw-credential-enc-v1") passed to PassphraseProvider
This isolates the two domains: cracking the bcrypt hash yields only the
login subkey, which is computationally independent of the enc:// subkey.
* fix(auth): replace wastedassign ok := false with var ok bool
* refactor(tray): remove copy-token clipboard feature
Dashboard login now uses standard web auth (bcrypt + session cookie).
The system tray 'Copy dashboard token' menu item is no longer needed.
- Delete tray_offers_copy.go and tray_offers_copy_stub.go
- Remove mCopyTok menu item and clipboard handler from systray.go
- Remove launcherDashboardTokenForClipboard var from main.go
- Remove MenuCopyToken/MenuCopyTokenHint keys from i18n.go
* feat(launcher-ui): standard HTTP login/setup/logout flow for dashboard
Replaces the previous "find token in logs" workflow with a proper
browser-based authentication UI backed by the new /api/auth/* endpoints.
### New pages
- /launcher-setup: first-run password initialization form (password +
confirm, min 8 chars); calls POST /api/auth/setup; redirects to login
on success
- /launcher-login: standard password login form; calls POST /api/auth/login;
sets HttpOnly session cookie on success
### Session guard (src/routes/__root.tsx)
A useEffect on every non-auth page load calls GET /api/auth/status:
- initialized=false -> redirect to /launcher-setup
- authenticated=false -> redirect to /launcher-login
This ensures the setup/login UI is shown even when the ?token= URL
mechanism auto-logs in (first-run case).
### Logout button (src/components/app-header.tsx)
IconLogout button added to the header with a confirm AlertDialog;
calls POST /api/auth/logout then redirects to /launcher-login.
### API layer
- src/api/launcher-auth.ts: LauncherAuthStatus gains initialized bool;
postLauncherDashboardSetup() added; LauncherAuthTokenHelp removed
- src/api/http.ts: 401 guard uses isLauncherAuthPathname() (covers both
/launcher-login and /launcher-setup) to prevent redirect loops
- src/lib/launcher-login-path.ts: isLauncherSetupPathname() and
isLauncherAuthPathname() added
### Routing
- src/routeTree.gen.ts: /launcher-setup route registered throughout
- src/routes/launcher-login.tsx: tokenHelp UI removed; useEffect added
to redirect to setup when initialized=false
### i18n
- en.json / zh.json: launcherSetup block added; launcherLogin keys
updated to use passwordLabel/passwordPlaceholder
* fix(lint): ts lint fixed 1
* fix(auth): detail auth error handle
* fix(login): frontend web auth error handle
* fix(frontend): auth error handler 5xx
385 lines
11 KiB
Go
385 lines
11 KiB
Go
// PicoClaw Web Console - Web-based chat and management interface
|
|
//
|
|
// Provides a web UI for chatting with PicoClaw via the Pico Channel WebSocket,
|
|
// with configuration management and gateway process control.
|
|
//
|
|
// Usage:
|
|
//
|
|
// go build -o picoclaw-web ./web/backend/
|
|
// ./picoclaw-web [config.json]
|
|
// ./picoclaw-web -public config.json
|
|
|
|
package main
|
|
|
|
import (
|
|
"errors"
|
|
"flag"
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"os"
|
|
"os/signal"
|
|
"path/filepath"
|
|
"strconv"
|
|
"syscall"
|
|
"time"
|
|
|
|
"github.com/sipeed/picoclaw/pkg/config"
|
|
"github.com/sipeed/picoclaw/pkg/logger"
|
|
"github.com/sipeed/picoclaw/web/backend/api"
|
|
"github.com/sipeed/picoclaw/web/backend/dashboardauth"
|
|
"github.com/sipeed/picoclaw/web/backend/launcherconfig"
|
|
"github.com/sipeed/picoclaw/web/backend/middleware"
|
|
"github.com/sipeed/picoclaw/web/backend/utils"
|
|
)
|
|
|
|
const (
|
|
appName = "PicoClaw"
|
|
|
|
logPath = "logs"
|
|
panicFile = "launcher_panic.log"
|
|
logFile = "launcher.log"
|
|
)
|
|
|
|
var (
|
|
appVersion = config.Version
|
|
|
|
server *http.Server
|
|
serverAddr string
|
|
// browserLaunchURL is opened by openBrowser() (auto-open + tray "open console").
|
|
// Includes ?token= for same-machine dashboard login; keep serverAddr without secrets for other use.
|
|
browserLaunchURL string
|
|
apiHandler *api.Handler
|
|
|
|
noBrowser *bool
|
|
)
|
|
|
|
func shouldEnableLauncherFileLogging(enableConsole, debug bool) bool {
|
|
return !enableConsole || debug
|
|
}
|
|
|
|
func dashboardTokenConfigHelpPath(source launcherconfig.DashboardTokenSource, launcherPath string) string {
|
|
if source != launcherconfig.DashboardTokenSourceConfig {
|
|
return ""
|
|
}
|
|
return launcherPath
|
|
}
|
|
|
|
// maskSecret masks a secret for display. It always shows up to the first 3
|
|
// runes. The last 4 runes are only appended when at least 5 runes remain
|
|
// hidden in the middle (i.e. string length >= 12), so an 8-char minimum
|
|
// password never exposes its tail. Strings of 3 chars or fewer are fully
|
|
// masked.
|
|
func maskSecret(s string) string {
|
|
runes := []rune(s)
|
|
n := len(runes)
|
|
const prefixLen, suffixLen, minHidden = 3, 4, 5
|
|
if n < prefixLen+suffixLen+minHidden {
|
|
if n <= prefixLen {
|
|
return "**********"
|
|
}
|
|
return string(runes[:prefixLen]) + "**********"
|
|
}
|
|
return string(runes[:prefixLen]) + "**********" + string(runes[n-suffixLen:])
|
|
}
|
|
|
|
func main() {
|
|
port := flag.String("port", "18800", "Port to listen on")
|
|
public := flag.Bool("public", false, "Listen on all interfaces (0.0.0.0) instead of localhost only")
|
|
noBrowser = flag.Bool("no-browser", false, "Do not auto-open browser on startup")
|
|
lang := flag.String("lang", "", "Language: en (English) or zh (Chinese). Default: auto-detect from system locale")
|
|
console := flag.Bool("console", false, "Console mode, no GUI")
|
|
|
|
var debug bool
|
|
flag.BoolVar(&debug, "d", false, "Enable debug logging")
|
|
flag.BoolVar(&debug, "debug", false, "Enable debug logging")
|
|
|
|
flag.Usage = func() {
|
|
fmt.Fprintf(os.Stderr, "%s Launcher - Web console and gateway manager\n\n", appName)
|
|
fmt.Fprintf(os.Stderr, "Usage: %s [options] [config.json]\n\n", os.Args[0])
|
|
fmt.Fprintf(os.Stderr, "Arguments:\n")
|
|
fmt.Fprintf(os.Stderr, " config.json Path to the configuration file (default: ~/.picoclaw/config.json)\n\n")
|
|
fmt.Fprintf(os.Stderr, "Options:\n")
|
|
flag.PrintDefaults()
|
|
fmt.Fprintf(os.Stderr, "\nExamples:\n")
|
|
fmt.Fprintf(os.Stderr, " %s\n", os.Args[0])
|
|
fmt.Fprintf(os.Stderr, " Use default config path in GUI mode\n")
|
|
fmt.Fprintf(os.Stderr, " %s ./config.json\n", os.Args[0])
|
|
fmt.Fprintf(os.Stderr, " Specify a config file\n")
|
|
fmt.Fprintf(
|
|
os.Stderr,
|
|
" %s -public ./config.json\n",
|
|
os.Args[0],
|
|
)
|
|
fmt.Fprintf(os.Stderr, " Allow access from other devices on the local network\n")
|
|
fmt.Fprintf(os.Stderr, " %s -console -d ./config.json\n", os.Args[0])
|
|
fmt.Fprintf(os.Stderr, " Run in the terminal with debug logs enabled\n")
|
|
}
|
|
flag.Parse()
|
|
|
|
// Initialize logger
|
|
picoHome := utils.GetPicoclawHome()
|
|
|
|
f := filepath.Join(picoHome, logPath, panicFile)
|
|
panicFunc, err := logger.InitPanic(f)
|
|
if err != nil {
|
|
panic(fmt.Sprintf("error initializing panic log: %v", err))
|
|
}
|
|
defer panicFunc()
|
|
|
|
enableConsole := *console
|
|
fileLoggingEnabled := shouldEnableLauncherFileLogging(enableConsole, debug)
|
|
if fileLoggingEnabled {
|
|
// GUI mode writes launcher logs to file. Debug mode keeps file logging enabled in console mode too.
|
|
if !debug {
|
|
logger.DisableConsole()
|
|
}
|
|
|
|
f := filepath.Join(picoHome, logPath, logFile)
|
|
if err = logger.EnableFileLogging(f); err != nil {
|
|
panic(fmt.Sprintf("error enabling file logging: %v", err))
|
|
}
|
|
defer logger.DisableFileLogging()
|
|
}
|
|
if debug {
|
|
logger.SetLevel(logger.DEBUG)
|
|
}
|
|
|
|
// Set language from command line or auto-detect
|
|
if *lang != "" {
|
|
SetLanguage(*lang)
|
|
}
|
|
|
|
// Resolve config path
|
|
configPath := utils.GetDefaultConfigPath()
|
|
if flag.NArg() > 0 {
|
|
configPath = flag.Arg(0)
|
|
}
|
|
|
|
absPath, err := filepath.Abs(configPath)
|
|
if err != nil {
|
|
logger.Fatalf("Failed to resolve config path: %v", err)
|
|
}
|
|
err = utils.EnsureOnboarded(absPath)
|
|
if err != nil {
|
|
logger.Errorf("Warning: Failed to initialize %s config automatically: %v", appName, err)
|
|
}
|
|
if !debug {
|
|
logger.SetLevelFromString(config.ResolveGatewayLogLevel(absPath))
|
|
}
|
|
|
|
logger.InfoC("web", fmt.Sprintf("%s launcher starting (version %s)...", appName, appVersion))
|
|
logger.InfoC("web", fmt.Sprintf("%s Home: %s", appName, picoHome))
|
|
if debug {
|
|
logger.InfoC("web", "Debug mode enabled")
|
|
logger.DebugC(
|
|
"web",
|
|
fmt.Sprintf(
|
|
"Launcher flags: console=%t public=%t no_browser=%t config=%s",
|
|
enableConsole,
|
|
*public,
|
|
*noBrowser,
|
|
absPath,
|
|
),
|
|
)
|
|
}
|
|
|
|
var explicitPort bool
|
|
var explicitPublic bool
|
|
flag.Visit(func(f *flag.Flag) {
|
|
switch f.Name {
|
|
case "port":
|
|
explicitPort = true
|
|
case "public":
|
|
explicitPublic = true
|
|
}
|
|
})
|
|
|
|
launcherPath := launcherconfig.PathForAppConfig(absPath)
|
|
launcherCfg, err := launcherconfig.Load(launcherPath, launcherconfig.Default())
|
|
if err != nil {
|
|
logger.ErrorC("web", fmt.Sprintf("Warning: Failed to load %s: %v", launcherPath, err))
|
|
launcherCfg = launcherconfig.Default()
|
|
}
|
|
|
|
effectivePort := *port
|
|
effectivePublic := *public
|
|
if !explicitPort {
|
|
effectivePort = strconv.Itoa(launcherCfg.Port)
|
|
}
|
|
if !explicitPublic {
|
|
effectivePublic = launcherCfg.Public
|
|
}
|
|
|
|
portNum, err := strconv.Atoi(effectivePort)
|
|
if err != nil || portNum < 1 || portNum > 65535 {
|
|
if err == nil {
|
|
err = errors.New("must be in range 1-65535")
|
|
}
|
|
logger.Fatalf("Invalid port %q: %v", effectivePort, err)
|
|
}
|
|
|
|
dashboardToken, dashboardSigningKey, dashboardTokenSource, dashErr := launcherconfig.EnsureDashboardSecrets(
|
|
launcherCfg,
|
|
)
|
|
if dashErr != nil {
|
|
logger.Fatalf("Dashboard auth setup failed: %v", dashErr)
|
|
}
|
|
dashboardSessionCookie := middleware.SessionCookieValue(dashboardSigningKey, dashboardToken)
|
|
|
|
// Open the bcrypt password store (creates the DB file on first run).
|
|
authStore, authStoreErr := dashboardauth.New(picoHome)
|
|
if authStoreErr != nil {
|
|
logger.ErrorC("web", fmt.Sprintf("Warning: could not open auth store: %v", authStoreErr))
|
|
authStore = nil
|
|
} else {
|
|
defer authStore.Close()
|
|
}
|
|
|
|
// Determine listen address
|
|
var addr string
|
|
if effectivePublic {
|
|
addr = "0.0.0.0:" + effectivePort
|
|
} else {
|
|
addr = "127.0.0.1:" + effectivePort
|
|
}
|
|
|
|
// Initialize Server components
|
|
mux := http.NewServeMux()
|
|
|
|
api.RegisterLauncherAuthRoutes(mux, api.LauncherAuthRouteOpts{
|
|
DashboardToken: dashboardToken,
|
|
SessionCookie: dashboardSessionCookie,
|
|
PasswordStore: authStore,
|
|
StoreError: authStoreErr,
|
|
})
|
|
|
|
// API Routes (e.g. /api/status)
|
|
apiHandler = api.NewHandler(absPath)
|
|
apiHandler.SetDebug(debug)
|
|
if _, err = apiHandler.EnsurePicoChannel(""); err != nil {
|
|
logger.ErrorC("web", fmt.Sprintf("Warning: failed to ensure pico channel on startup: %v", err))
|
|
}
|
|
apiHandler.SetServerOptions(portNum, effectivePublic, explicitPublic, launcherCfg.AllowedCIDRs)
|
|
apiHandler.RegisterRoutes(mux)
|
|
|
|
// Frontend Embedded Assets
|
|
registerEmbedRoutes(mux)
|
|
|
|
accessControlledMux, err := middleware.IPAllowlist(launcherCfg.AllowedCIDRs, mux)
|
|
if err != nil {
|
|
logger.Fatalf("Invalid allowed CIDR configuration: %v", err)
|
|
}
|
|
|
|
dashAuth := middleware.LauncherDashboardAuth(middleware.LauncherDashboardAuthConfig{
|
|
ExpectedCookie: dashboardSessionCookie,
|
|
Token: dashboardToken,
|
|
}, accessControlledMux)
|
|
|
|
// Apply middleware stack
|
|
handler := middleware.Recoverer(
|
|
middleware.Logger(
|
|
middleware.ReferrerPolicyNoReferrer(
|
|
middleware.JSONContentType(dashAuth),
|
|
),
|
|
),
|
|
)
|
|
|
|
// Print startup banner and token (console mode only).
|
|
if enableConsole || debug {
|
|
fmt.Print(utils.Banner)
|
|
fmt.Println()
|
|
fmt.Println(" Open the following URL in your browser:")
|
|
fmt.Println()
|
|
fmt.Printf(" >> http://localhost:%s <<\n", effectivePort)
|
|
if effectivePublic {
|
|
if ip := utils.GetLocalIP(); ip != "" {
|
|
fmt.Printf(" >> http://%s:%s <<\n", ip, effectivePort)
|
|
}
|
|
}
|
|
fmt.Println()
|
|
switch dashboardTokenSource {
|
|
case launcherconfig.DashboardTokenSourceRandom:
|
|
fmt.Printf(" Dashboard password (this run): %s\n", maskSecret(dashboardToken))
|
|
case launcherconfig.DashboardTokenSourceEnv:
|
|
fmt.Printf(" Dashboard password: from environment variable PICOCLAW_LAUNCHER_TOKEN\n")
|
|
case launcherconfig.DashboardTokenSourceConfig:
|
|
fmt.Printf(" Dashboard password: configured in %s\n", launcherPath)
|
|
}
|
|
fmt.Println()
|
|
}
|
|
|
|
switch dashboardTokenSource {
|
|
case launcherconfig.DashboardTokenSourceEnv:
|
|
logger.InfoC("web", "Dashboard password: environment PICOCLAW_LAUNCHER_TOKEN")
|
|
case launcherconfig.DashboardTokenSourceConfig:
|
|
logger.InfoC("web", fmt.Sprintf("Dashboard password: configured in %s", launcherPath))
|
|
case launcherconfig.DashboardTokenSourceRandom:
|
|
if !enableConsole {
|
|
logger.InfoC("web", "Dashboard password (this run): "+maskSecret(dashboardToken))
|
|
}
|
|
}
|
|
|
|
// Log startup info to file
|
|
logger.InfoC("web", fmt.Sprintf("Server will listen on http://localhost:%s", effectivePort))
|
|
if effectivePublic {
|
|
if ip := utils.GetLocalIP(); ip != "" {
|
|
logger.InfoC("web", fmt.Sprintf("Public access enabled at http://%s:%s", ip, effectivePort))
|
|
}
|
|
}
|
|
|
|
// Share the local URL with the launcher runtime.
|
|
serverAddr = fmt.Sprintf("http://localhost:%s", effectivePort)
|
|
if dashboardToken != "" {
|
|
browserLaunchURL = serverAddr + "?token=" + url.QueryEscape(dashboardToken)
|
|
} else {
|
|
browserLaunchURL = serverAddr
|
|
}
|
|
|
|
// Auto-open browser will be handled by the launcher runtime.
|
|
|
|
// Auto-start gateway after backend starts listening.
|
|
go func() {
|
|
time.Sleep(1 * time.Second)
|
|
apiHandler.TryAutoStartGateway()
|
|
}()
|
|
|
|
// Start the Server in a goroutine
|
|
server = &http.Server{Addr: addr, Handler: handler}
|
|
go func() {
|
|
logger.InfoC("web", fmt.Sprintf("Server listening on %s", addr))
|
|
if err := server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
|
logger.Fatalf("Server failed to start: %v", err)
|
|
}
|
|
}()
|
|
|
|
defer shutdownApp()
|
|
|
|
// Start system tray or run in console mode
|
|
if enableConsole {
|
|
if !*noBrowser {
|
|
// Auto-open browser after systray is ready (if not disabled)
|
|
// Check no-browser flag via environment or pass as parameter if needed
|
|
if err := openBrowser(); err != nil {
|
|
logger.Errorf("Warning: Failed to auto-open browser: %v", err)
|
|
}
|
|
}
|
|
|
|
sigChan := make(chan os.Signal, 1)
|
|
signal.Notify(sigChan, os.Interrupt, syscall.SIGTERM)
|
|
|
|
// Main event loop - wait for signals or config changes
|
|
for {
|
|
select {
|
|
case <-sigChan:
|
|
logger.Info("Shutting down...")
|
|
|
|
return
|
|
}
|
|
}
|
|
} else {
|
|
// GUI mode: start system tray
|
|
runTray()
|
|
}
|
|
}
|