Use the VM’s IP address on the same subnet as the host OS. #4175
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -83,6 +83,11 @@ type HostAgent struct { | |
|
|
||
| statusMu sync.RWMutex | ||
| currentStatus events.Status | ||
|
|
||
| // Guest IP address on the same subnet as the host. | ||
| guestIPv4 net.IP | ||
| guestIPv6 net.IP | ||
| guestIPMu sync.RWMutex | ||
| } | ||
|
|
||
| type options struct { | ||
|
|
@@ -258,6 +263,27 @@ func New(ctx context.Context, instName string, stdout io.Writer, signalCh chan o | |
| return a, nil | ||
| } | ||
|
|
||
| func (a *HostAgent) WriteSSHConfigFile(ctx context.Context) error { | ||
| sshExe, err := sshutil.NewSSHExe() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| sshOpts, err := sshutil.SSHOpts( | ||
| ctx, | ||
| sshExe, | ||
| a.instDir, | ||
| *a.instConfig.User.Name, | ||
| *a.instConfig.SSH.LoadDotSSHPubKeys, | ||
| *a.instConfig.SSH.ForwardAgent, | ||
| *a.instConfig.SSH.ForwardX11, | ||
| *a.instConfig.SSH.ForwardX11Trusted) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| sshAddress, sshPort := a.sshAddressPort() | ||
| return writeSSHConfigFile(sshExe.Exe, a.instName, a.instDir, sshAddress, sshPort, sshOpts) | ||
| } | ||
|
|
||
| func writeSSHConfigFile(sshPath, instName, instDir, instSSHAddress string, sshLocalPort int, sshOpts []string) error { | ||
| if instDir == "" { | ||
| return fmt.Errorf("directory is unknown for the instance %q", instName) | ||
|
|
@@ -336,6 +362,17 @@ func (a *HostAgent) emitCloudInitProgressEvent(ctx context.Context, progress *ev | |
| a.emitEvent(ctx, ev) | ||
| } | ||
|
|
||
| func (a *HostAgent) emitGuestIPEvent(ctx context.Context, ip string) { | ||
| a.statusMu.RLock() | ||
| currentStatus := a.currentStatus | ||
| a.statusMu.RUnlock() | ||
|
|
||
| currentStatus.GuestIP = net.ParseIP(ip) | ||
|
|
||
| ev := events.Event{Status: currentStatus} | ||
| a.emitEvent(ctx, ev) | ||
| } | ||
|
|
||
| func generatePassword(length int) (string, error) { | ||
| // avoid any special symbols, to make it easier to copy/paste | ||
| return password.Generate(length, length/4, 0, false, false) | ||
|
|
@@ -481,9 +518,31 @@ func (a *HostAgent) startRoutinesAndWait(ctx context.Context, errCh <-chan error | |
| return a.driver.Stop(ctx) | ||
| } | ||
|
|
||
| // GuestIP returns the guest's IPv4 address if available; otherwise the IPv6 address. | ||
| // It returns nil if the guest is not reachable by a direct IP. | ||
| func (a *HostAgent) GuestIP() net.IP { | ||
| a.guestIPMu.RLock() | ||
| defer a.guestIPMu.RUnlock() | ||
| if a.guestIPv4 != nil { | ||
| return a.guestIPv4 | ||
| } else if a.guestIPv6 != nil { | ||
| return a.guestIPv6 | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // GuestIPs returns the guest's IPv4 and IPv6 addresses if available; otherwise nil. | ||
| func (a *HostAgent) GuestIPs() (ipv4, ipv6 net.IP) { | ||
| a.guestIPMu.RLock() | ||
| defer a.guestIPMu.RUnlock() | ||
| return a.guestIPv4, a.guestIPv6 | ||
| } | ||
|
|
||
| func (a *HostAgent) Info(_ context.Context) (*hostagentapi.Info, error) { | ||
| guestIP := a.GuestIP() | ||
| info := &hostagentapi.Info{ | ||
| AutoStartedIdentifier: autostart.AutoStartedIdentifier(), | ||
| GuestIP: guestIP, | ||
| SSHLocalPort: a.sshLocalPort, | ||
| } | ||
| return info, nil | ||
|
|
@@ -492,6 +551,12 @@ func (a *HostAgent) Info(_ context.Context) (*hostagentapi.Info, error) { | |
| func (a *HostAgent) sshAddressPort() (sshAddress string, sshPort int) { | ||
| sshAddress = a.instSSHAddress | ||
| sshPort = a.sshLocalPort | ||
| guestIP := a.GuestIP() | ||
| if guestIP != nil { | ||
| sshAddress = guestIP.String() | ||
| sshPort = 22 | ||
| logrus.Debugf("Using the guest IP address %q directly", sshAddress) | ||
| } | ||
| return sshAddress, sshPort | ||
| } | ||
|
|
||
|
|
@@ -513,7 +578,8 @@ func (a *HostAgent) startHostAgentRoutines(ctx context.Context) error { | |
| return nil | ||
| } | ||
| logrus.Debugf("shutting down the SSH master") | ||
| sshAddress, sshPort := a.sshAddressPort() | ||
| if exitMasterErr := ssh.ExitMaster(sshAddress, sshPort, a.sshConfig); exitMasterErr != nil { | ||
| logrus.WithError(exitMasterErr).Warn("failed to exit SSH master") | ||
| } | ||
| return nil | ||
|
|
@@ -529,7 +595,8 @@ sudo mkdir -p -m 700 /run/host-services | |
| sudo ln -sf "${SSH_AUTH_SOCK}" /run/host-services/ssh-auth.sock | ||
| sudo chown -R "${USER}" /run/host-services` | ||
| faDesc := "linking ssh auth socket to static location /run/host-services/ssh-auth.sock" | ||
| sshAddress, sshPort := a.sshAddressPort() | ||
| stdout, stderr, err := ssh.ExecuteScript(sshAddress, sshPort, a.sshConfig, faScript, faDesc) | ||
| logrus.Debugf("stdout=%q, stderr=%q, err=%v", stdout, stderr, err) | ||
| if err != nil { | ||
| errs = append(errs, fmt.Errorf("stdout=%q, stderr=%q: %w", stdout, stderr, err)) | ||
|
|
@@ -836,7 +903,53 @@ func (a *HostAgent) processGuestAgentEvents(ctx context.Context, client *guestag | |
| if useSSHFwd { | ||
| a.portForwarder.OnEvent(ctx, ev) | ||
| } else { | ||
| useDirectIPPortForwarding := false | ||
| if envVar := os.Getenv("_LIMA_DIRECT_IP_PORT_FORWARDER"); envVar != "" { | ||
| b, err := strconv.ParseBool(envVar) | ||
| if err != nil { | ||
| logrus.WithError(err).Warnf("invalid _LIMA_DIRECT_IP_PORT_FORWARDER value %q", envVar) | ||
| } else { | ||
| useDirectIPPortForwarding = b | ||
| } | ||
| } | ||
| var dialContext func(ctx context.Context, network string, guestAddress string) (net.Conn, error) | ||
| if useDirectIPPortForwarding { | ||
| logrus.Warn("Direct IP Port forwarding is enabled. It may fall back to GRPC Port Forwarding in some cases.") | ||
|
Member
There was a problem hiding this comment. This should also support falling back to SSH ?
Member
There was a problem hiding this comment. Probably we should rather remove the env var and define the YAML to specify the candidates of the forwarder implementation per protocols (TCP, UDP, ...) portForwarderTypes:
tcp: [direct, ssh]
udp: [none]Similar to:
Probably we have no time to cover this in v2.0, so let me postpone this PR to v2.1+, sorry |
||
| dialContext = func(ctx context.Context, network, guestAddress string) (net.Conn, error) { | ||
| guestIPv4, guestIPv6 := a.GuestIPs() | ||
| if guestIPv4 == nil && guestIPv6 == nil { | ||
| return portfwd.DialContextToGRPCTunnel(client)(ctx, network, guestAddress) | ||
| } | ||
| // Check if the host part of guestAddress is either unspecified address or matches the known guest IP. | ||
| // If so, replace it with the known guest IP to avoid issues with dual-stack setups and DNS resolution. | ||
| // Otherwise, fall back to the gRPC tunnel. | ||
| if host, _, err := net.SplitHostPort(guestAddress); err != nil { | ||
| return nil, err | ||
| } else if ip := net.ParseIP(host); ip.IsUnspecified() || ip.Equal(guestIPv4) || ip.Equal(guestIPv6) { | ||
| if ip.To4() != nil { | ||
| if guestIPv4 != nil { | ||
| conn, err := DialContextToGuestIP(guestIPv4)(ctx, network, guestAddress) | ||
| if err == nil { | ||
| return conn, nil | ||
| } | ||
| logrus.WithError(err).Warn("failed to connect to the guest IPv4 directly, falling back to gRPC tunnel") | ||
| } | ||
| } else if ip.To16() != nil { | ||
| if guestIPv6 != nil { | ||
| conn, err := DialContextToGuestIP(guestIPv6)(ctx, network, guestAddress) | ||
| if err == nil { | ||
| return conn, nil | ||
| } | ||
| logrus.WithError(err).Warn("failed to connect to the guest IPv6 directly, falling back to gRPC tunnel") | ||
| } | ||
| } | ||
| // If we reach here, it means we couldn't find a suitable guest IP | ||
| } | ||
| return portfwd.DialContextToGRPCTunnel(client)(ctx, network, guestAddress) | ||
| } | ||
| } else { | ||
| dialContext = portfwd.DialContextToGRPCTunnel(client) | ||
| } | ||
| a.grpcPortForwarder.OnEvent(ctx, dialContext, ev) | ||
| } | ||
| } | ||
|
|
@@ -850,6 +963,24 @@ func (a *HostAgent) processGuestAgentEvents(ctx context.Context, client *guestag | |
| return io.EOF | ||
| } | ||
|
|
||
| // DialContextToGuestIP returns a DialContext function that connects to the guest IP directly. | ||
| // If the guest IP is not known, it returns nil. | ||
| func DialContextToGuestIP(guestIP net.IP) func(ctx context.Context, network, address string) (net.Conn, error) { | ||
| if guestIP == nil { | ||
| return nil | ||
| } | ||
| return func(ctx context.Context, network, address string) (net.Conn, error) { | ||
| var d net.Dialer | ||
| _, port, err := net.SplitHostPort(address) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| // Host part of address is ignored, because it already has been checked by forwarding rules | ||
| // and we want to connect to the guest IP directly. | ||
| return d.DialContext(ctx, network, net.JoinHostPort(guestIP.String(), port)) | ||
| } | ||
| } | ||
|
|
||
| const ( | ||
| verbForward = "forward" | ||
| verbCancel = "cancel" | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.