Merge branch 'dev' into feat/tls

Author: ym

.github/workflows/golangci-lint.yml

@@ -0,0 +1,34 @@
+---
+name: golangci-lint
+on:
+  push:
+    paths:
+      - "go.sum"
+      - "go.mod"
+      - "**.go"
+      - ".github/workflows/golangci-lint.yml"
+      - ".golangci.yml"
+  pull_request:
+
+permissions:  # added using https://github.com/step-security/secure-repo
+  contents: read
+
+jobs:
+  golangci:
+    permissions:
+      contents: read  # for actions/checkout to fetch code
+      pull-requests: read  # for golangci/golangci-lint-action to fetch pull requests
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - name: Install Go
+        uses: actions/setup-go@41dfa10bad2bb2ae585af6ee5bb4d7d973ad74ed # v5.1.0
+        with:
+          go-version: 1.23.x
+      - name: Lint
+        uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # v6.1.1
+        with:
+          args: --verbose
+          version: v1.62.0

.golangci.yml

@@ -0,0 +1,12 @@
+---
+linters:
+  enable:
+  # - goimports
+  # - misspell
+  # - revive
+
+issues:
+  exclude-rules:
+    - path: _test.go
+      linters:
+        - errcheck

block_device.go

@@ -3,7 +3,6 @@ package kvm
 import (
 	"context"
 	"errors"
-	"log"
 	"net"
 	"os"
 	"time"
@@ -94,7 +93,8 @@ func (d *NBDDevice) Start() error {
 	// Remove the socket file if it already exists
 	if _, err := os.Stat(nbdSocketPath); err == nil {
 		if err := os.Remove(nbdSocketPath); err != nil {
-			log.Fatalf("Failed to remove existing socket file %s: %v", nbdSocketPath, err)
+			logger.Errorf("Failed to remove existing socket file %s: %v", nbdSocketPath, err)
+			os.Exit(1)
 		}
 	}
 
@@ -134,22 +134,22 @@ func (d *NBDDevice) runServerConn() {
 			MaximumBlockSize:   uint32(16 * 1024),
 			SupportsMultiConn:  false,
 		})
-	log.Println("nbd server exited:", err)
+	logger.Infof("nbd server exited: %v", err)
 }
 
 func (d *NBDDevice) runClientConn() {
 	err := client.Connect(d.clientConn, d.dev, &client.Options{
 		ExportName: "jetkvm",
 		BlockSize:  uint32(4 * 1024),
 	})
-	log.Println("nbd client exited:", err)
+	logger.Infof("nbd client exited: %v", err)
 }
 
 func (d *NBDDevice) Close() {
 	if d.dev != nil {
 		err := client.Disconnect(d.dev)
 		if err != nil {
-			log.Println("error disconnecting nbd client:", err)
+			logger.Warnf("error disconnecting nbd client: %v", err)
 		}
 		_ = d.dev.Close()
 	}

cloud.go

@@ -150,8 +150,8 @@ func runWebsocketClient() error {
 	if err != nil {
 		return err
 	}
-	defer c.CloseNow()
-	cloudLogger.Infof("websocket connected to %s", wsURL.String())
+	defer c.CloseNow() //nolint:errcheck
+	cloudLogger.Infof("websocket connected to %s", wsURL)
 	runCtx, cancelRun := context.WithCancel(context.Background())
 	defer cancelRun()
 	go func() {

cmd/main.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	"kvm"
+	"github.com/jetkvm/kvm"
 )
 
 func main() {

config.go

@@ -5,40 +5,35 @@ import (
 	"fmt"
 	"os"
 	"sync"
+
+	"github.com/jetkvm/kvm/internal/usbgadget"
 )
 
 type WakeOnLanDevice struct {
 	Name       string `json:"name"`
 	MacAddress string `json:"macAddress"`
 }
 
-type UsbConfig struct {
-	VendorId     string `json:"vendor_id"`
-	ProductId    string `json:"product_id"`
-	SerialNumber string `json:"serial_number"`
-	Manufacturer string `json:"manufacturer"`
-	Product      string `json:"product"`
-}
-
 type Config struct {
-	CloudURL             string            `json:"cloud_url"`
-	CloudAppURL          string            `json:"cloud_app_url"`
-	CloudToken           string            `json:"cloud_token"`
-	GoogleIdentity       string            `json:"google_identity"`
-	JigglerEnabled       bool              `json:"jiggler_enabled"`
-	AutoUpdateEnabled    bool              `json:"auto_update_enabled"`
-	IncludePreRelease    bool              `json:"include_pre_release"`
-	HashedPassword       string            `json:"hashed_password"`
-	LocalAuthToken       string            `json:"local_auth_token"`
-	LocalAuthMode        string            `json:"localAuthMode"` //TODO: fix it with migration
-	WakeOnLanDevices     []WakeOnLanDevice `json:"wake_on_lan_devices"`
-	EdidString           string            `json:"hdmi_edid_string"`
-	ActiveExtension      string            `json:"active_extension"`
-	DisplayMaxBrightness int               `json:"display_max_brightness"`
-	DisplayDimAfterSec   int               `json:"display_dim_after_sec"`
-	DisplayOffAfterSec   int               `json:"display_off_after_sec"`
-	TLSMode              string            `json:"tls_mode"`
-	UsbConfig            *UsbConfig        `json:"usb_config"`
+	CloudURL             string             `json:"cloud_url"`
+	CloudAppURL          string             `json:"cloud_app_url"`
+	CloudToken           string             `json:"cloud_token"`
+	GoogleIdentity       string             `json:"google_identity"`
+	JigglerEnabled       bool               `json:"jiggler_enabled"`
+	AutoUpdateEnabled    bool               `json:"auto_update_enabled"`
+	IncludePreRelease    bool               `json:"include_pre_release"`
+	HashedPassword       string             `json:"hashed_password"`
+	LocalAuthToken       string             `json:"local_auth_token"`
+	LocalAuthMode        string             `json:"localAuthMode"` //TODO: fix it with migration
+	WakeOnLanDevices     []WakeOnLanDevice  `json:"wake_on_lan_devices"`
+	EdidString           string             `json:"hdmi_edid_string"`
+	ActiveExtension      string             `json:"active_extension"`
+	DisplayMaxBrightness int                `json:"display_max_brightness"`
+	DisplayDimAfterSec   int                `json:"display_dim_after_sec"`
+	DisplayOffAfterSec   int                `json:"display_off_after_sec"`
+	TLSMode              string             `json:"tls_mode"`
+	UsbConfig            *usbgadget.Config  `json:"usb_config"`
+	UsbDevices           *usbgadget.Devices `json:"usb_devices"`
 }
 
 const configPath = "/userdata/kvm_config.json"
@@ -52,13 +47,19 @@ var defaultConfig = &Config{
 	DisplayDimAfterSec:   120,  // 2 minutes
 	DisplayOffAfterSec:   1800, // 30 minutes
 	TLSMode:              "",
-	UsbConfig: &UsbConfig{
+	UsbConfig: &usbgadget.Config{
 		VendorId:     "0x1d6b", //The Linux Foundation
 		ProductId:    "0x0104", //Multifunction Composite Gadget
 		SerialNumber: "",
 		Manufacturer: "JetKVM",
 		Product:      "USB Emulation Device",
 	},
+	UsbDevices: &usbgadget.Devices{
+		AbsoluteMouse: true,
+		RelativeMouse: true,
+		Keyboard:      true,
+		MassStorage:   true,
+	},
 }
 
 var (
@@ -97,6 +98,10 @@ func LoadConfig() {
 		loadedConfig.UsbConfig = defaultConfig.UsbConfig
 	}
 
+	if loadedConfig.UsbDevices == nil {
+		loadedConfig.UsbDevices = defaultConfig.UsbDevices
+	}
+
 	config = &loadedConfig
 }
 

display.go

@@ -3,7 +3,6 @@ package kvm
 import (
 	"errors"
 	"fmt"
-	"log"
 	"os"
 	"strconv"
 	"time"
@@ -25,7 +24,7 @@ const (
 func switchToScreen(screen string) {
 	_, err := CallCtrlAction("lv_scr_load", map[string]interface{}{"obj": screen})
 	if err != nil {
-		log.Printf("failed to switch to screen %s: %v", screen, err)
+		logger.Warnf("failed to switch to screen %s: %v", screen, err)
 		return
 	}
 	currentScreen = screen
@@ -41,7 +40,7 @@ func updateLabelIfChanged(objName string, newText string) {
 }
 
 func switchToScreenIfDifferent(screenName string) {
-	fmt.Println("switching screen from", currentScreen, screenName)
+	logger.Infof("switching screen from %s to %s", currentScreen, screenName)
 	if currentScreen != screenName {
 		switchToScreen(screenName)
 	}
@@ -75,12 +74,12 @@ var displayInited = false
 
 func requestDisplayUpdate() {
 	if !displayInited {
-		fmt.Println("display not inited, skipping updates")
+		logger.Info("display not inited, skipping updates")
 		return
 	}
 	go func() {
 		wakeDisplay(false)
-		fmt.Println("display updating........................")
+		logger.Info("display updating")
 		//TODO: only run once regardless how many pending updates
 		updateDisplay()
 	}()
@@ -119,7 +118,7 @@ func setDisplayBrightness(brightness int) error {
 		return err
 	}
 
-	fmt.Printf("display: set brightness to %v\n", brightness)
+	logger.Infof("display: set brightness to %v", brightness)
 	return nil
 }
 
@@ -128,7 +127,7 @@ func setDisplayBrightness(brightness int) error {
 func tick_displayDim() {
 	err := setDisplayBrightness(config.DisplayMaxBrightness / 2)
 	if err != nil {
-		fmt.Printf("display: failed to dim display: %s\n", err)
+		logger.Warnf("display: failed to dim display: %s", err)
 	}
 
 	dimTicker.Stop()
@@ -141,7 +140,7 @@ func tick_displayDim() {
 func tick_displayOff() {
 	err := setDisplayBrightness(0)
 	if err != nil {
-		fmt.Printf("display: failed to turn off display: %s\n", err)
+		logger.Warnf("display: failed to turn off display: %s", err)
 	}
 
 	offTicker.Stop()
@@ -164,7 +163,7 @@ func wakeDisplay(force bool) {
 
 	err := setDisplayBrightness(config.DisplayMaxBrightness)
 	if err != nil {
-		fmt.Printf("display wake failed, %s\n", err)
+		logger.Warnf("display wake failed, %s", err)
 	}
 
 	if config.DisplayDimAfterSec != 0 {
@@ -184,7 +183,7 @@ func wakeDisplay(force bool) {
 func watchTsEvents() {
 	ts, err := os.OpenFile(touchscreenDevice, os.O_RDONLY, 0666)
 	if err != nil {
-		fmt.Printf("display: failed to open touchscreen device: %s\n", err)
+		logger.Warnf("display: failed to open touchscreen device: %s", err)
 		return
 	}
 
@@ -197,7 +196,7 @@ func watchTsEvents() {
 	for {
 		_, err := ts.Read(buf)
 		if err != nil {
-			fmt.Printf("display: failed to read from touchscreen device: %s\n", err)
+			logger.Warnf("display: failed to read from touchscreen device: %s", err)
 			return
 		}
 
@@ -212,17 +211,17 @@ func startBacklightTickers() {
 	// Don't start the tickers if the display is switched off.
 	// Set the display to off if that's the case.
 	if config.DisplayMaxBrightness == 0 {
-		setDisplayBrightness(0)
+		_ = setDisplayBrightness(0)
 		return
 	}
 
 	if dimTicker == nil && config.DisplayDimAfterSec != 0 {
-		fmt.Printf("display: dim_ticker has started\n")
+		logger.Info("display: dim_ticker has started")
 		dimTicker = time.NewTicker(time.Duration(config.DisplayDimAfterSec) * time.Second)
 		defer dimTicker.Stop()
 
 		go func() {
-			for {
+			for { //nolint:gosimple
 				select {
 				case <-dimTicker.C:
 					tick_displayDim()
@@ -232,12 +231,12 @@ func startBacklightTickers() {
 	}
 
 	if offTicker == nil && config.DisplayOffAfterSec != 0 {
-		fmt.Printf("display: off_ticker has started\n")
+		logger.Info("display: off_ticker has started")
 		offTicker = time.NewTicker(time.Duration(config.DisplayOffAfterSec) * time.Second)
 		defer offTicker.Stop()
 
 		go func() {
-			for {
+			for { //nolint:gosimple
 				select {
 				case <-offTicker.C:
 					tick_displayOff()
@@ -252,11 +251,11 @@ func init() {
 
 	go func() {
 		waitCtrlClientConnected()
-		fmt.Println("setting initial display contents")
+		logger.Info("setting initial display contents")
 		time.Sleep(500 * time.Millisecond)
 		updateStaticContents()
 		displayInited = true
-		fmt.Println("display inited")
+		logger.Info("display inited")
 		startBacklightTickers()
 		wakeDisplay(true)
 		requestDisplayUpdate()

fuse.go

@@ -2,7 +2,6 @@ package kvm
 
 import (
 	"context"
-	"fmt"
 	"os"
 	"sync"
 	"syscall"
@@ -104,7 +103,7 @@ func RunFuseServer() {
 	var err error
 	fuseServer, err = fs.Mount(fuseMountPoint, &FuseRoot{}, opts)
 	if err != nil {
-		fmt.Println("failed to mount fuse: %w", err)
+		logger.Warnf("failed to mount fuse: %v", err)
 	}
 	fuseServer.Wait()
 }

go.mod

@@ -1,4 +1,4 @@
-module kvm
+module github.com/jetkvm/kvm
 
 go 1.21.0
 
@@ -15,7 +15,6 @@ require (
 	github.com/gwatts/rootcerts v0.0.0-20240401182218-3ab9db955caf
 	github.com/hanwen/go-fuse/v2 v2.5.1
 	github.com/hashicorp/go-envparse v0.1.0
-	github.com/openstadia/go-usb-gadget v0.0.0-20231115171102-aebd56bbb965
 	github.com/pion/logging v0.2.2
 	github.com/pion/mdns/v2 v2.0.7
 	github.com/pion/webrtc/v4 v4.0.0

go.sum

@@ -87,8 +87,6 @@ github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9G
 github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
-github.com/openstadia/go-usb-gadget v0.0.0-20231115171102-aebd56bbb965 h1:bZGtUfkOl0dqvem8ltx9KCYied0gSlRuDhaZDxgppN4=
-github.com/openstadia/go-usb-gadget v0.0.0-20231115171102-aebd56bbb965/go.mod h1:6cAIK2c4O3/yETSrRjmNwsBL3yE4Vcu9M9p/Qwx5+gM=
 github.com/pelletier/go-toml/v2 v2.2.2 h1:aYUidT7k73Pcl9nb2gScu7NSrKCSHIDE89b3+6Wq+LM=
 github.com/pelletier/go-toml/v2 v2.2.2/go.mod h1:1t835xjRzz80PqgE6HHgN2JOsmgYu/h4qDAS4n929Rs=
 github.com/pilebones/go-udev v0.9.0 h1:N1uEO/SxUwtIctc0WLU0t69JeBxIYEYnj8lT/Nabl9Q=