diff --git a/config.go b/config.go index 23d4c8415..48220274a 100644 --- a/config.go +++ b/config.go @@ -75,28 +75,29 @@ func (m *KeyboardMacro) Validate() error { } 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"` - KeyboardMacros []KeyboardMacro `json:"keyboard_macros"` - 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"` // options: "self-signed", "user-defined", "" - UsbConfig *usbgadget.Config `json:"usb_config"` - UsbDevices *usbgadget.Devices `json:"usb_devices"` - NetworkConfig *network.NetworkConfig `json:"network_config"` - DefaultLogLevel string `json:"default_log_level"` + 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"` + KeyboardMacros []KeyboardMacro `json:"keyboard_macros"` + 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"` // options: "self-signed", "user-defined", "" + UsbConfig *usbgadget.Config `json:"usb_config"` + UsbDevices *usbgadget.Devices `json:"usb_devices"` + NetworkConfig *network.NetworkConfig `json:"network_config"` + UsbNetworkConfig *network.UsbNetworkConfig `json:"usb_network_config"` + DefaultLogLevel string `json:"default_log_level"` } const configPath = "/userdata/kvm_config.json" @@ -123,8 +124,18 @@ var defaultConfig = &Config{ RelativeMouse: true, Keyboard: true, MassStorage: true, + EthernetEcm: false, + EthernetEem: false, + EthernetNcm: false, + EthernetRndis: false, + }, + NetworkConfig: &network.NetworkConfig{ + NatEnable: false, + }, + UsbNetworkConfig: &network.UsbNetworkConfig{ + IPv4Addr: "172.16.55.1/24", + IPv4Network: "172.16.55.0/24", }, - NetworkConfig: &network.NetworkConfig{}, DefaultLogLevel: "INFO", } @@ -172,6 +183,10 @@ func LoadConfig() { loadedConfig.NetworkConfig = defaultConfig.NetworkConfig } + if loadedConfig.UsbNetworkConfig == nil { + loadedConfig.UsbNetworkConfig = defaultConfig.UsbNetworkConfig + } + config = &loadedConfig logging.GetRootLogger().UpdateLogLevel(config.DefaultLogLevel) diff --git a/internal/network/config.go b/internal/network/config.go index 74ddf19df..7216ebb1e 100644 --- a/internal/network/config.go +++ b/internal/network/config.go @@ -48,6 +48,13 @@ type NetworkConfig struct { TimeSyncOrdering []string `json:"time_sync_ordering,omitempty" one_of:"http,ntp,ntp_dhcp,ntp_user_provided,ntp_fallback" default:"ntp,http"` TimeSyncDisableFallback null.Bool `json:"time_sync_disable_fallback,omitempty" default:"false"` TimeSyncParallel null.Int `json:"time_sync_parallel,omitempty" default:"4"` + + NatEnable bool `json:"nat_enable,omitempty" default:"false" required:"true"` +} + +type UsbNetworkConfig struct { + IPv4Addr string `json:"ipv4_addr,omitempty" validate_type:"ipv4" default:"172.16.55.1/24" required:"true"` + IPv4Network string `json:"ipv4_network,omitempty" validate_type:"ipv4" default:"172.16.55.0/24" required:"true"` } func (c *NetworkConfig) GetMDNSMode() *mdns.MDNSListenOptions { diff --git a/internal/network/nat.go b/internal/network/nat.go new file mode 100644 index 000000000..0594a5e71 --- /dev/null +++ b/internal/network/nat.go @@ -0,0 +1,78 @@ +package network + +import ( + "fmt" + "os" + "os/exec" +) + +const ( + procIpv4ForwardPath = "/proc/sys/net/ipv4/ip_forward" +) + +func (s *NetworkInterfaceState) UsbNetworkConfig() *UsbNetworkConfig { + return s.usbNetConfig +} + +func (s *NetworkInterfaceState) reconfigureNat(wantNat bool, sourceAddr string) error { + scopedLogger := s.l.With().Str("iface", s.interfaceName).Logger() + + if !wantNat { + if s.natEnabled { + scopedLogger.Info().Msg("disabling NAT") + err := disableNat() + if err != nil { + s.l.Error().Err(err).Msg("failed to disable NAT") + } + } + return nil + } + + if wantNat && s.IsOnline() { + scopedLogger.Info().Msg("enabling NAT") + err := enableNat(sourceAddr, s.interfaceName, s.IPv4String()) + if err != nil { + s.l.Error().Err(err).Msg("failed to enable NAT") + } + s.natEnabled = true + return nil + } + + return nil +} + +func enableNat(sourceAddr string, oIfName string, snatToAddr string) error { + if err := os.WriteFile(procIpv4ForwardPath, []byte("1"), 0644); err != nil { + return fmt.Errorf("failed to write %s: %w", procIpv4ForwardPath, err) + } + + if err := exec.Command("nft", "add table nat").Run(); err != nil { + return fmt.Errorf("failed to add table nat: %w", err) + } + + if err := exec.Command("nft", "flush table nat").Run(); err != nil { + return fmt.Errorf("failed to flush table nat: %w", err) + } + + if err := exec.Command("nft", "add chain nat postrouting { type nat hook postrouting priority 100 ; }").Run(); err != nil { + return fmt.Errorf("failed to add chain nat: %w", err) + } + + if err := exec.Command("nft", "add rule nat postrouting ip saddr", sourceAddr, "oif", oIfName, "snat to", snatToAddr).Run(); err != nil { + return fmt.Errorf("failed to add postrouting rule: %w", err) + } + + return nil +} + +func disableNat() error { + if err := os.WriteFile(procIpv4ForwardPath, []byte("0"), 0644); err != nil { + return fmt.Errorf("failed to write %s: %w", procIpv4ForwardPath, err) + } + + if err := exec.Command("nft", "delete table nat").Run(); err != nil { + return fmt.Errorf("failed to run nft: %w", err) + } + + return nil +} diff --git a/internal/network/netif.go b/internal/network/netif.go index c5db8069f..b150b9e57 100644 --- a/internal/network/netif.go +++ b/internal/network/netif.go @@ -26,8 +26,9 @@ type NetworkInterfaceState struct { l *zerolog.Logger stateLock sync.Mutex - config *NetworkConfig - dhcpClient *udhcpc.DHCPClient + config *NetworkConfig + usbNetConfig *UsbNetworkConfig + dhcpClient *udhcpc.DHCPClient defaultHostname string currentHostname string @@ -37,6 +38,8 @@ type NetworkInterfaceState struct { onInitialCheck func(state *NetworkInterfaceState) cbConfigChange func(config *NetworkConfig) + natEnabled bool + checked bool } @@ -50,6 +53,7 @@ type NetworkInterfaceOptions struct { OnDhcpLeaseChange func(lease *udhcpc.Lease) OnConfigChange func(config *NetworkConfig) NetworkConfig *NetworkConfig + UsbNetworkConfig *UsbNetworkConfig } func NewNetworkInterfaceState(opts *NetworkInterfaceOptions) (*NetworkInterfaceState, error) { @@ -72,10 +76,17 @@ func NewNetworkInterfaceState(opts *NetworkInterfaceOptions) (*NetworkInterfaceS defaultHostname: opts.DefaultHostname, stateLock: sync.Mutex{}, l: l, - onStateChange: opts.OnStateChange, - onInitialCheck: opts.OnInitialCheck, - cbConfigChange: opts.OnConfigChange, - config: opts.NetworkConfig, + onStateChange: func(s *NetworkInterfaceState) { + s.reconfigureNat(opts.NetworkConfig.NatEnable, opts.UsbNetworkConfig.IPv4Network) + opts.OnStateChange(s) + }, + onInitialCheck: func(s *NetworkInterfaceState) { + s.reconfigureNat(opts.NetworkConfig.NatEnable, opts.UsbNetworkConfig.IPv4Network) + opts.OnInitialCheck(s) + }, + cbConfigChange: opts.OnConfigChange, + config: opts.NetworkConfig, + usbNetConfig: opts.UsbNetworkConfig, } // create the dhcp client @@ -174,11 +185,12 @@ func (s *NetworkInterfaceState) update() (DhcpTargetState, error) { } if changed { + scopedLogger := s.l.With().Str("iface", s.interfaceName).Logger() if interfaceGoingUp { - s.l.Info().Msg("interface state transitioned to up") + scopedLogger.Info().Msg("interface state transitioned to up") dhcpTargetState = DhcpTargetStateRenew } else if interfaceGoingDown { - s.l.Info().Msg("interface state transitioned to down") + scopedLogger.Info().Msg("interface state transitioned to down") } } diff --git a/internal/usbgadget/config.go b/internal/usbgadget/config.go index b73d392e8..a02b896ef 100644 --- a/internal/usbgadget/config.go +++ b/internal/usbgadget/config.go @@ -63,6 +63,11 @@ var defaultGadgetConfig = map[string]gadgetConfigItem{ // mass storage "mass_storage_base": massStorageBaseConfig, "mass_storage_lun0": massStorageLun0Config, + // ethernet + "ethernet_ecm": ethernetEcmConfig, + "ethernet_eem": ethernetEemConfig, + "ethernet_ncm": ethernetNcmConfig, + "ethernet_rndis": ethernetRndisConfig, } func (u *UsbGadget) isGadgetConfigItemEnabled(itemKey string) bool { @@ -77,6 +82,14 @@ func (u *UsbGadget) isGadgetConfigItemEnabled(itemKey string) bool { return u.enabledDevices.MassStorage case "mass_storage_lun0": return u.enabledDevices.MassStorage + case "ethernet_ecm": + return u.enabledDevices.EthernetEcm + case "ethernet_eem": + return u.enabledDevices.EthernetEem + case "ethernet_ncm": + return u.enabledDevices.EthernetNcm + case "ethernet_rndis": + return u.enabledDevices.EthernetRndis default: return true } diff --git a/internal/usbgadget/ethernet.go b/internal/usbgadget/ethernet.go new file mode 100644 index 000000000..4fda7d8c5 --- /dev/null +++ b/internal/usbgadget/ethernet.go @@ -0,0 +1,60 @@ +package usbgadget + +const ( + usbEthernetDevice = "usb0" +) + +// Ethernet Control Model (ECM) +var ethernetEcmConfig = gadgetConfigItem{ + order: 4000, + path: []string{"functions", "ecm.usb0"}, + configPath: []string{"ecm.usb0"}, + attrs: gadgetAttributes{ + "host_addr": "", // MAC address of target host (randomly select) + "dev_addr": "", // MAC address of JetKVM (randomly select) + }, +} + +// Ethernet Emulation Model (EEM) +var ethernetEemConfig = gadgetConfigItem{ + order: 4001, + path: []string{"functions", "eem.usb0"}, + configPath: []string{"eem.usb0"}, + attrs: gadgetAttributes{ + "host_addr": "", // MAC address of target host (randomly select) + "dev_addr": "", // MAC address of JetKVM (randomly select) + }, +} + +// Network Control Model (NCM) +var ethernetNcmConfig = gadgetConfigItem{ + order: 4001, + path: []string{"functions", "ncm.usb0"}, + configPath: []string{"ncm.usb0"}, + attrs: gadgetAttributes{ + "host_addr": "", // MAC address of target host (randomly select) + "dev_addr": "", // MAC address of JetKVM (randomly select) + }, +} + +// Remote Network Driver Interface Specification (RNDIS) +var ethernetRndisConfig = gadgetConfigItem{ + order: 4001, + path: []string{"functions", "rndis.usb0"}, + configPath: []string{"rndis.usb0"}, + attrs: gadgetAttributes{ + "host_addr": "", // MAC address of target host (randomly select) + "dev_addr": "", // MAC address of JetKVM (randomly select) + }, +} + +func (u *UsbGadget) UsbEthernetEnabled() bool { + return u.isGadgetConfigItemEnabled("ecm") || + u.isGadgetConfigItemEnabled("eem") || + u.isGadgetConfigItemEnabled("ncm") || + u.isGadgetConfigItemEnabled("rndis") +} + +func (u *UsbGadget) UsbEthernetDevice() string { + return usbEthernetDevice +} \ No newline at end of file diff --git a/internal/usbgadget/usbgadget.go b/internal/usbgadget/usbgadget.go index 1dff2f320..ffd923ab7 100644 --- a/internal/usbgadget/usbgadget.go +++ b/internal/usbgadget/usbgadget.go @@ -17,6 +17,10 @@ type Devices struct { RelativeMouse bool `json:"relative_mouse"` Keyboard bool `json:"keyboard"` MassStorage bool `json:"mass_storage"` + EthernetEcm bool `json:"ethernet_ecm"` + EthernetEem bool `json:"ethernet_eem"` + EthernetNcm bool `json:"ethernet_ncm"` + EthernetRndis bool `json:"ethernet_rndis"` } // Config is a struct that represents the customizations for a USB gadget. @@ -36,6 +40,10 @@ var defaultUsbGadgetDevices = Devices{ RelativeMouse: true, Keyboard: true, MassStorage: true, + EthernetEcm: false, + EthernetEem: false, + EthernetNcm: false, + EthernetRndis: false, } // UsbGadget is a struct that represents a USB gadget. diff --git a/network.go b/network.go index 8d9261b1c..2f77b81fc 100644 --- a/network.go +++ b/network.go @@ -32,10 +32,11 @@ func initNetwork() error { ensureConfigLoaded() state, err := network.NewNetworkInterfaceState(&network.NetworkInterfaceOptions{ - DefaultHostname: GetDefaultHostname(), - InterfaceName: NetIfName, - NetworkConfig: config.NetworkConfig, - Logger: networkLogger, + DefaultHostname: GetDefaultHostname(), + InterfaceName: NetIfName, + NetworkConfig: config.NetworkConfig, + UsbNetworkConfig: config.UsbNetworkConfig, + Logger: networkLogger, OnStateChange: func(state *network.NetworkInterfaceState) { networkStateChanged() }, diff --git a/usb.go b/usb.go index 91674c99a..be2730522 100644 --- a/usb.go +++ b/usb.go @@ -18,6 +18,11 @@ func initUsbGadget() { usbLogger, ) + err := initUsbEthernet(gadget) + if err != nil { + usbLogger.Err(err).Msg("Failed to initialize USB Ethernet") + } + go func() { for { checkUSBState() diff --git a/usb_ethernet.go b/usb_ethernet.go new file mode 100644 index 000000000..9eb3f4e78 --- /dev/null +++ b/usb_ethernet.go @@ -0,0 +1,30 @@ +package kvm + +import ( + "fmt" + "os/exec" + + "github.com/jetkvm/kvm/internal/usbgadget" +) + +func initUsbEthernet(gadget *usbgadget.UsbGadget) error { + if !gadget.UsbEthernetEnabled() { + return nil + } + + iface := gadget.UsbEthernetDevice() + ipv4addr := networkState.UsbNetworkConfig().IPv4Addr + + scopedLogger := usbLogger.With().Str("iface", iface).Str("ipv4addr", ipv4addr).Logger() + scopedLogger.Info().Msg("enabling USB Ethernet") + + if err := exec.Command("ip", "addr", "add", ipv4addr, "dev", iface).Run(); err != nil { + return fmt.Errorf("failed to add ip addr: %w", err) + } + + if err := exec.Command("ip", "link", "set", "dev", iface, "up").Run(); err != nil { + return fmt.Errorf("failed to set ip link: %w", err) + } + + return nil +}