waveterm/wavesrv/pkg/remote/remote.go

2093 lines
58 KiB
Go
Raw Normal View History

2023-10-17 06:31:13 +02:00
// Copyright 2023, Command Line Inc.
// SPDX-License-Identifier: Apache-2.0
2022-07-01 21:17:19 +02:00
package remote
import (
"bytes"
"context"
"encoding/base64"
"errors"
2022-07-01 21:17:19 +02:00
"fmt"
"io"
"log"
"os"
"os/exec"
"path"
2022-09-14 22:01:52 +02:00
"regexp"
2022-08-24 06:05:49 +02:00
"strconv"
"strings"
2022-07-01 21:17:19 +02:00
"sync"
"syscall"
2022-10-01 02:22:28 +02:00
"time"
2022-07-01 21:17:19 +02:00
2022-09-15 08:10:35 +02:00
"github.com/armon/circbuf"
"github.com/creack/pty"
"github.com/google/uuid"
2023-10-16 22:30:10 +02:00
"github.com/wavetermdev/waveterm/waveshell/pkg/base"
"github.com/wavetermdev/waveterm/waveshell/pkg/packet"
"github.com/wavetermdev/waveterm/waveshell/pkg/shexec"
"github.com/wavetermdev/waveterm/waveshell/pkg/statediff"
"github.com/wavetermdev/waveterm/wavesrv/pkg/scbase"
"github.com/wavetermdev/waveterm/wavesrv/pkg/scpacket"
"github.com/wavetermdev/waveterm/wavesrv/pkg/sstore"
"golang.org/x/mod/semver"
2022-07-01 21:17:19 +02:00
)
const RemoteTypeMShell = "mshell"
const DefaultTerm = "xterm-256color"
const DefaultMaxPtySize = 1024 * 1024
2022-09-15 08:10:35 +02:00
const CircBufSize = 64 * 1024
const RemoteTermRows = 8
2022-09-15 09:17:23 +02:00
const RemoteTermCols = 80
const PtyReadBufSize = 100
const RemoteConnectTimeout = 15 * time.Second
2022-07-01 21:17:19 +02:00
// we add this ping packet to the MShellServer Commands in order to deal with spurious SSH output
// basically we guarantee the parser will see a valid packet (either an init error or a ping)
// so we can pass ignoreUntilValid to PacketParser
const PrintPingPacket = `printf "\n##N{\"type\": \"ping\"}\n"`
2022-09-27 06:09:43 +02:00
const MShellServerCommandFmt = `
PATH=$PATH:~/.mshell;
2022-09-27 06:09:43 +02:00
which mshell-[%VERSION%] > /dev/null;
if [[ "$?" -ne 0 ]]
then
printf "\n##N{\"type\": \"init\", \"notfound\": true, \"uname\": \"%s | %s\"}\n" "$(uname -s)" "$(uname -m)"
else
[%PINGPACKET%]
2022-09-27 06:09:43 +02:00
mshell-[%VERSION%] --server
fi
`
2022-12-29 09:07:16 +01:00
func MakeLocalMShellCommandStr(isSudo bool) (string, error) {
mshellPath, err := scbase.LocalMShellBinaryPath()
if err != nil {
return "", err
}
2022-12-29 09:07:16 +01:00
if isSudo {
return fmt.Sprintf(`%s; sudo %s --server`, PrintPingPacket, mshellPath), nil
2022-12-29 09:07:16 +01:00
} else {
return fmt.Sprintf(`%s; %s --server`, PrintPingPacket, mshellPath), nil
2022-12-29 09:07:16 +01:00
}
}
2022-09-27 06:09:43 +02:00
func MakeServerCommandStr() string {
rtn := strings.ReplaceAll(MShellServerCommandFmt, "[%VERSION%]", semver.MajorMinor(scbase.MShellVersion))
rtn = strings.ReplaceAll(rtn, "[%PINGPACKET%]", PrintPingPacket)
return rtn
2022-09-27 06:09:43 +02:00
}
const (
ssh config import (#156) * create migrations for required database change This is a first attempt that does not appear to be working properly. It requires review. * fix errors in db migrations The previous commit had an extra json call that broke the update and did not remove the imported interies during a downgrade. * change migrations to use column instead of json It makes more sense to associate the source of a config with the remote type than the sshopts type. This change makes that clear in the database structure. * ensure adding a remote manually tags correctly Using the usual way of adding a remote should result in a sshconfigsrc of "waveterm-manual". This will be important for filtering out remotes installed manually and remotes installed via import * create basic structure for parsing ssh config This entails creating a new command, making it possible to query only the imported remotes from the database, and implementing the logic to handle all of the updates needed. This needs improvements in a few areas: - the /etc/ssh/config needs to be parsed as well - the logic for editing exisiting imported remotes needs to be written - error handling needs to be improved - update packet responses need to be provided * add sshkey support and implement editing We now search for the ssh identity keyfile and add it if it is found. Additionally, the logic to edit previously imported ssh hosts has been added. * combine hosts from user and system ssh config We now check both the user ~/.ssh/config as well as the /etc/ssh/config for hosts. This loops through each file starting with the user one. For each host, it selects the first pattern without a wildcard and chooses that to be the alias. If any future hosts are found to have the same alias, they are skipped. Errors are raised if neither config file can be opened or no aliases were found. * improve logging and error reporting Error reporting is now shortcircuited in cases of individual remotes in order to allow the other remotes to continue. These errors are now printed to logs instead. * allow imports to edit ssh port Previously, ssh ports could not be edited after the fact. Unfortunately, this can cause problems since the port can be changed in an ssh config file. To address this, we allow imports to change the port if a host with the same canonical name had previously been imported. * fix response to parse command * fix error handline for alias parsing Small mistake of checking for equality instead of inequality * fix the ability to overwrite hostName with alias if ssh_config does not find Hostname, it won't output an error. Now we compare against the result instead of looking for an error. * fix the error catching for User and Port This fixes the same problem where parsing the config doesn't give an error in the case when nothing is found. As before, this checks for a blank result instead. * remove unused code * remove repeated canonical name check The logic that checks for an existing canonical name already exists in the AddRemote function, so it is not needed here. Secondly, we now only allow edits of previously created remotes if they have not been archived. If they have, the usual logic for creating a new remote takes precedence. Lastly, there is no need to archive a remote that has already been archived so an additional check has been added. * allow archives to preserve the SSHConfigSrc * add log message for archiving of imported remotes * create variables for string variants Matches existing code style * add cleanup for opened files * move migration 25 to migration 26 (already merged a migration 25) * fix RemoteRuntimeState in ModelUpdate by moving type to sstore.go. Fix some bugs in remote:parse. Fix key/identityfile, return value, and remote editing (should go through msh). remote sudo. add info messages around parse status * fix issue with archiving the sshconfigsrc A bug in RemoteType's FromMap caused the loss of sshconfigsrc during the conversion. This has been corrected and the schema has been updated. * fix order of archiving removed imported remotes Previously, if the canonical name changed, the code would try to create a new remote before archiving the old one. This did not work if the alias didn't change. Now we archive first and add a new remote after. * fix ability to change port when importing config Importing from sshconfig needs to allow the port to change. This was not happening because of a bug that has been corrected. * always use host in place of hostname Since host is the key actually searched for in the ssh config file, searching for user@hostName may not actually work. To avoid this, we now always use user@host instead. * automatically determine ConnectMode This aims to select a connection mode based off what is provided in the ssh config file. It aims for auto connections when possible but will fall back to manual if we can't easily support it * remove sshkeysource migration number confilict Previously had conflicting migration numbers of 26. The change not in the main branch has been moved to 27 to remove the conflict. * move sshkeysource migration to migration 28 * add WaveOptions flag parsing for ssh config This is currently being used to allow users to force manual connect mode if desired. It will also be used to force skipping options in the future but that is not complete in this commit. * implement ignore flag for ssh config parsing The ignore flag will now archive an imported remote if it previously existed and not create a new remote in its place. * fix discovery of identity file Previously, a ~ in the identity file's path was not expanded to the home dir. Because of this, files with a ~ were previously identified as invalid files. By expanding it during the search, this is no longer the case. * disable frontend edit button for imported remotes Imported Remotes should not be editable in waveterm by users. This edit makes it clear that the button will not work for those cases. Further edits may be needed to explain why it doesn't work and what to do instead. * add backend rejection of updating imported remote As before, we don't want manual editing of an imported remote inside the app. This ensures that it can't happen on the backend. * create tooltips for sshconfig edit/delete buttons For remotes that are imported, edits are not allowed. This adds a tooltip that explains what to do instead. Deleting remotes that are imported is allowed, but they will come back if the user imports again. The tooltip explains a way to avoid this. * add logo after name for imported remotes In the connections screen, there previously was not a way to tell imported connections from manually created connections. This change adds a logo after the imported ones to differentiate them. * small formatting updates * add import tooltip to connection modal Added the logo for an imported config to the connection modal. It also provides a short description when it the mouse hovers over it. * add button to import ssh config Make the command into a button for a simple gui interface. Also ran prettier to clean up some syntax. * remove strict casing on WaveOptions WaveOptions was previously very specific about the casing of the ignore and connectmode subcommands. With this update, the casing is automatically converted to lowercase and can be ignored. * add status dot before name in connections screen * add space and tooltip to connection imported icon * re-prettier
2023-12-28 20:09:41 +01:00
StatusConnected = sstore.RemoteStatus_Connected
StatusConnecting = sstore.RemoteStatus_Connecting
StatusDisconnected = sstore.RemoteStatus_Disconnected
StatusError = sstore.RemoteStatus_Error
)
func init() {
if scbase.MShellVersion != base.MShellVersion {
panic(fmt.Sprintf("prompt-server apishell version must match '%s' vs '%s'", scbase.MShellVersion, base.MShellVersion))
}
}
var GlobalStore *Store
2022-07-01 23:57:42 +02:00
type Store struct {
Lock *sync.Mutex
Map map[string]*MShellProc // key=remoteid
CmdWaitMap map[base.CommandKey][]func()
2022-07-01 23:57:42 +02:00
}
type pendingStateKey struct {
ScreenId string
RemotePtr sstore.RemotePtrType
}
type MShellProc struct {
Lock *sync.Mutex
Remote *sstore.RemoteType
// runtime
2022-10-28 07:22:17 +02:00
RemoteId string // can be read without a lock
Status string
ServerProc *shexec.ClientProc
UName string
Err error
ErrNoInitPk bool
ControllingPty *os.File
PtyBuffer *circbuf.Buffer
MakeClientCancelFn context.CancelFunc
MakeClientDeadline *time.Time
2022-11-28 09:13:00 +01:00
StateMap map[string]*packet.ShellState // sha1->state
CurrentState string // sha1
2022-12-28 22:56:19 +01:00
NumTryConnect int
2022-09-27 06:09:43 +02:00
// install
InstallStatus string
NeedsMShellUpgrade bool
2022-09-27 06:09:43 +02:00
InstallCancelFn context.CancelFunc
InstallErr error
2022-10-28 07:22:17 +02:00
RunningCmds map[base.CommandKey]RunCmdType
WaitingCmds []RunCmdType
PendingStateCmds map[pendingStateKey]base.CommandKey // key=[remoteinstance name]
}
type RunCmdType struct {
2022-10-28 07:22:17 +02:00
SessionId string
2023-03-15 00:37:22 +01:00
ScreenId string
RemotePtr sstore.RemotePtrType
RunPacket *packet.RunPacketType
}
ssh config import (#156) * create migrations for required database change This is a first attempt that does not appear to be working properly. It requires review. * fix errors in db migrations The previous commit had an extra json call that broke the update and did not remove the imported interies during a downgrade. * change migrations to use column instead of json It makes more sense to associate the source of a config with the remote type than the sshopts type. This change makes that clear in the database structure. * ensure adding a remote manually tags correctly Using the usual way of adding a remote should result in a sshconfigsrc of "waveterm-manual". This will be important for filtering out remotes installed manually and remotes installed via import * create basic structure for parsing ssh config This entails creating a new command, making it possible to query only the imported remotes from the database, and implementing the logic to handle all of the updates needed. This needs improvements in a few areas: - the /etc/ssh/config needs to be parsed as well - the logic for editing exisiting imported remotes needs to be written - error handling needs to be improved - update packet responses need to be provided * add sshkey support and implement editing We now search for the ssh identity keyfile and add it if it is found. Additionally, the logic to edit previously imported ssh hosts has been added. * combine hosts from user and system ssh config We now check both the user ~/.ssh/config as well as the /etc/ssh/config for hosts. This loops through each file starting with the user one. For each host, it selects the first pattern without a wildcard and chooses that to be the alias. If any future hosts are found to have the same alias, they are skipped. Errors are raised if neither config file can be opened or no aliases were found. * improve logging and error reporting Error reporting is now shortcircuited in cases of individual remotes in order to allow the other remotes to continue. These errors are now printed to logs instead. * allow imports to edit ssh port Previously, ssh ports could not be edited after the fact. Unfortunately, this can cause problems since the port can be changed in an ssh config file. To address this, we allow imports to change the port if a host with the same canonical name had previously been imported. * fix response to parse command * fix error handline for alias parsing Small mistake of checking for equality instead of inequality * fix the ability to overwrite hostName with alias if ssh_config does not find Hostname, it won't output an error. Now we compare against the result instead of looking for an error. * fix the error catching for User and Port This fixes the same problem where parsing the config doesn't give an error in the case when nothing is found. As before, this checks for a blank result instead. * remove unused code * remove repeated canonical name check The logic that checks for an existing canonical name already exists in the AddRemote function, so it is not needed here. Secondly, we now only allow edits of previously created remotes if they have not been archived. If they have, the usual logic for creating a new remote takes precedence. Lastly, there is no need to archive a remote that has already been archived so an additional check has been added. * allow archives to preserve the SSHConfigSrc * add log message for archiving of imported remotes * create variables for string variants Matches existing code style * add cleanup for opened files * move migration 25 to migration 26 (already merged a migration 25) * fix RemoteRuntimeState in ModelUpdate by moving type to sstore.go. Fix some bugs in remote:parse. Fix key/identityfile, return value, and remote editing (should go through msh). remote sudo. add info messages around parse status * fix issue with archiving the sshconfigsrc A bug in RemoteType's FromMap caused the loss of sshconfigsrc during the conversion. This has been corrected and the schema has been updated. * fix order of archiving removed imported remotes Previously, if the canonical name changed, the code would try to create a new remote before archiving the old one. This did not work if the alias didn't change. Now we archive first and add a new remote after. * fix ability to change port when importing config Importing from sshconfig needs to allow the port to change. This was not happening because of a bug that has been corrected. * always use host in place of hostname Since host is the key actually searched for in the ssh config file, searching for user@hostName may not actually work. To avoid this, we now always use user@host instead. * automatically determine ConnectMode This aims to select a connection mode based off what is provided in the ssh config file. It aims for auto connections when possible but will fall back to manual if we can't easily support it * remove sshkeysource migration number confilict Previously had conflicting migration numbers of 26. The change not in the main branch has been moved to 27 to remove the conflict. * move sshkeysource migration to migration 28 * add WaveOptions flag parsing for ssh config This is currently being used to allow users to force manual connect mode if desired. It will also be used to force skipping options in the future but that is not complete in this commit. * implement ignore flag for ssh config parsing The ignore flag will now archive an imported remote if it previously existed and not create a new remote in its place. * fix discovery of identity file Previously, a ~ in the identity file's path was not expanded to the home dir. Because of this, files with a ~ were previously identified as invalid files. By expanding it during the search, this is no longer the case. * disable frontend edit button for imported remotes Imported Remotes should not be editable in waveterm by users. This edit makes it clear that the button will not work for those cases. Further edits may be needed to explain why it doesn't work and what to do instead. * add backend rejection of updating imported remote As before, we don't want manual editing of an imported remote inside the app. This ensures that it can't happen on the backend. * create tooltips for sshconfig edit/delete buttons For remotes that are imported, edits are not allowed. This adds a tooltip that explains what to do instead. Deleting remotes that are imported is allowed, but they will come back if the user imports again. The tooltip explains a way to avoid this. * add logo after name for imported remotes In the connections screen, there previously was not a way to tell imported connections from manually created connections. This change adds a logo after the imported ones to differentiate them. * small formatting updates * add import tooltip to connection modal Added the logo for an imported config to the connection modal. It also provides a short description when it the mouse hovers over it. * add button to import ssh config Make the command into a button for a simple gui interface. Also ran prettier to clean up some syntax. * remove strict casing on WaveOptions WaveOptions was previously very specific about the casing of the ignore and connectmode subcommands. With this update, the casing is automatically converted to lowercase and can be ignored. * add status dot before name in connections screen * add space and tooltip to connection imported icon * re-prettier
2023-12-28 20:09:41 +01:00
type RemoteRuntimeState = sstore.RemoteRuntimeState
2022-08-24 22:21:54 +02:00
func CanComplete(remoteType string) bool {
switch remoteType {
case sstore.RemoteTypeSsh:
return true
default:
return false
}
}
func (msh *MShellProc) GetStatus() string {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.Status
}
func (msh *MShellProc) GetDefaultState() *packet.ShellState {
msh.Lock.Lock()
defer msh.Lock.Unlock()
2022-11-28 09:13:00 +01:00
return msh.StateMap[msh.CurrentState]
}
func (msh *MShellProc) GetDefaultStatePtr() *sstore.ShellStatePtr {
msh.Lock.Lock()
defer msh.Lock.Unlock()
if msh.CurrentState == "" {
return nil
}
return &sstore.ShellStatePtr{BaseHash: msh.CurrentState}
}
func (msh *MShellProc) GetDefaultFeState() map[string]string {
state := msh.GetDefaultState()
return sstore.FeStateFromShellState(state)
}
2022-11-28 09:13:00 +01:00
func (msh *MShellProc) GetStateByHash(hval string) *packet.ShellState {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.StateMap[hval]
}
func (msh *MShellProc) GetRemoteId() string {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.Remote.RemoteId
}
2022-09-27 06:09:43 +02:00
func (msh *MShellProc) GetInstallStatus() string {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.InstallStatus
}
func LoadRemotes(ctx context.Context) error {
GlobalStore = &Store{
Lock: &sync.Mutex{},
Map: make(map[string]*MShellProc),
CmdWaitMap: make(map[base.CommandKey][]func()),
}
allRemotes, err := sstore.GetAllRemotes(ctx)
if err != nil {
return err
}
var numLocal int
2022-12-29 09:07:16 +01:00
var numSudoLocal int
for _, remote := range allRemotes {
msh := MakeMShell(remote)
GlobalStore.Map[remote.RemoteId] = msh
if remote.ConnectMode == sstore.ConnectModeStartup {
go msh.Launch(false)
}
if remote.Local {
if remote.IsSudo() {
2022-12-29 09:07:16 +01:00
numSudoLocal++
} else {
numLocal++
}
}
}
if numLocal == 0 {
return fmt.Errorf("no local remote found")
}
if numLocal > 1 {
return fmt.Errorf("multiple local remotes found")
}
2022-12-29 09:07:16 +01:00
if numSudoLocal > 1 {
return fmt.Errorf("multiple local sudo remotes found")
}
return nil
}
func LoadRemoteById(ctx context.Context, remoteId string) error {
r, err := sstore.GetRemoteById(ctx, remoteId)
if err != nil {
return err
}
if r == nil {
return fmt.Errorf("remote %s not found", remoteId)
}
msh := MakeMShell(r)
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
existingRemote := GlobalStore.Map[remoteId]
if existingRemote != nil {
2022-12-28 22:56:19 +01:00
return fmt.Errorf("cannot add remote %s, already in global map", remoteId)
}
GlobalStore.Map[r.RemoteId] = msh
if r.ConnectMode == sstore.ConnectModeStartup {
go msh.Launch(false)
}
return nil
}
2022-09-15 08:10:35 +02:00
func ReadRemotePty(ctx context.Context, remoteId string) (int64, []byte, error) {
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
msh := GlobalStore.Map[remoteId]
if msh == nil {
return 0, nil, nil
}
msh.Lock.Lock()
defer msh.Lock.Unlock()
barr := msh.PtyBuffer.Bytes()
offset := msh.PtyBuffer.TotalWritten() - int64(len(barr))
return offset, barr, nil
}
func AddRemote(ctx context.Context, r *sstore.RemoteType, shouldStart bool) error {
2022-09-14 02:11:36 +02:00
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
existingRemote := getRemoteByCanonicalName_nolock(r.RemoteCanonicalName)
if existingRemote != nil {
erCopy := existingRemote.GetRemoteCopy()
2022-09-14 02:11:36 +02:00
if !erCopy.Archived {
return fmt.Errorf("duplicate canonical name %q: cannot create new remote", r.RemoteCanonicalName)
}
r.RemoteId = erCopy.RemoteId
}
if r.Local {
return fmt.Errorf("cannot create another local remote (there can be only one)")
}
2022-09-14 02:11:36 +02:00
err := sstore.UpsertRemote(ctx, r)
if err != nil {
return fmt.Errorf("cannot create remote %q: %v", r.RemoteCanonicalName, err)
}
newMsh := MakeMShell(r)
GlobalStore.Map[r.RemoteId] = newMsh
go newMsh.NotifyRemoteUpdate()
if shouldStart {
go newMsh.Launch(true)
2022-09-14 02:11:36 +02:00
}
return nil
}
func ArchiveRemote(ctx context.Context, remoteId string) error {
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
msh := GlobalStore.Map[remoteId]
if msh == nil {
return fmt.Errorf("remote not found, cannot archive")
}
if msh.Status == StatusConnected {
return fmt.Errorf("cannot archive connected remote")
}
if msh.Remote.Local {
return fmt.Errorf("cannot archive local remote")
}
rcopy := msh.GetRemoteCopy()
2022-09-14 02:11:36 +02:00
archivedRemote := &sstore.RemoteType{
RemoteId: rcopy.RemoteId,
RemoteType: rcopy.RemoteType,
RemoteCanonicalName: rcopy.RemoteCanonicalName,
ConnectMode: sstore.ConnectModeManual,
Archived: true,
ssh config import (#156) * create migrations for required database change This is a first attempt that does not appear to be working properly. It requires review. * fix errors in db migrations The previous commit had an extra json call that broke the update and did not remove the imported interies during a downgrade. * change migrations to use column instead of json It makes more sense to associate the source of a config with the remote type than the sshopts type. This change makes that clear in the database structure. * ensure adding a remote manually tags correctly Using the usual way of adding a remote should result in a sshconfigsrc of "waveterm-manual". This will be important for filtering out remotes installed manually and remotes installed via import * create basic structure for parsing ssh config This entails creating a new command, making it possible to query only the imported remotes from the database, and implementing the logic to handle all of the updates needed. This needs improvements in a few areas: - the /etc/ssh/config needs to be parsed as well - the logic for editing exisiting imported remotes needs to be written - error handling needs to be improved - update packet responses need to be provided * add sshkey support and implement editing We now search for the ssh identity keyfile and add it if it is found. Additionally, the logic to edit previously imported ssh hosts has been added. * combine hosts from user and system ssh config We now check both the user ~/.ssh/config as well as the /etc/ssh/config for hosts. This loops through each file starting with the user one. For each host, it selects the first pattern without a wildcard and chooses that to be the alias. If any future hosts are found to have the same alias, they are skipped. Errors are raised if neither config file can be opened or no aliases were found. * improve logging and error reporting Error reporting is now shortcircuited in cases of individual remotes in order to allow the other remotes to continue. These errors are now printed to logs instead. * allow imports to edit ssh port Previously, ssh ports could not be edited after the fact. Unfortunately, this can cause problems since the port can be changed in an ssh config file. To address this, we allow imports to change the port if a host with the same canonical name had previously been imported. * fix response to parse command * fix error handline for alias parsing Small mistake of checking for equality instead of inequality * fix the ability to overwrite hostName with alias if ssh_config does not find Hostname, it won't output an error. Now we compare against the result instead of looking for an error. * fix the error catching for User and Port This fixes the same problem where parsing the config doesn't give an error in the case when nothing is found. As before, this checks for a blank result instead. * remove unused code * remove repeated canonical name check The logic that checks for an existing canonical name already exists in the AddRemote function, so it is not needed here. Secondly, we now only allow edits of previously created remotes if they have not been archived. If they have, the usual logic for creating a new remote takes precedence. Lastly, there is no need to archive a remote that has already been archived so an additional check has been added. * allow archives to preserve the SSHConfigSrc * add log message for archiving of imported remotes * create variables for string variants Matches existing code style * add cleanup for opened files * move migration 25 to migration 26 (already merged a migration 25) * fix RemoteRuntimeState in ModelUpdate by moving type to sstore.go. Fix some bugs in remote:parse. Fix key/identityfile, return value, and remote editing (should go through msh). remote sudo. add info messages around parse status * fix issue with archiving the sshconfigsrc A bug in RemoteType's FromMap caused the loss of sshconfigsrc during the conversion. This has been corrected and the schema has been updated. * fix order of archiving removed imported remotes Previously, if the canonical name changed, the code would try to create a new remote before archiving the old one. This did not work if the alias didn't change. Now we archive first and add a new remote after. * fix ability to change port when importing config Importing from sshconfig needs to allow the port to change. This was not happening because of a bug that has been corrected. * always use host in place of hostname Since host is the key actually searched for in the ssh config file, searching for user@hostName may not actually work. To avoid this, we now always use user@host instead. * automatically determine ConnectMode This aims to select a connection mode based off what is provided in the ssh config file. It aims for auto connections when possible but will fall back to manual if we can't easily support it * remove sshkeysource migration number confilict Previously had conflicting migration numbers of 26. The change not in the main branch has been moved to 27 to remove the conflict. * move sshkeysource migration to migration 28 * add WaveOptions flag parsing for ssh config This is currently being used to allow users to force manual connect mode if desired. It will also be used to force skipping options in the future but that is not complete in this commit. * implement ignore flag for ssh config parsing The ignore flag will now archive an imported remote if it previously existed and not create a new remote in its place. * fix discovery of identity file Previously, a ~ in the identity file's path was not expanded to the home dir. Because of this, files with a ~ were previously identified as invalid files. By expanding it during the search, this is no longer the case. * disable frontend edit button for imported remotes Imported Remotes should not be editable in waveterm by users. This edit makes it clear that the button will not work for those cases. Further edits may be needed to explain why it doesn't work and what to do instead. * add backend rejection of updating imported remote As before, we don't want manual editing of an imported remote inside the app. This ensures that it can't happen on the backend. * create tooltips for sshconfig edit/delete buttons For remotes that are imported, edits are not allowed. This adds a tooltip that explains what to do instead. Deleting remotes that are imported is allowed, but they will come back if the user imports again. The tooltip explains a way to avoid this. * add logo after name for imported remotes In the connections screen, there previously was not a way to tell imported connections from manually created connections. This change adds a logo after the imported ones to differentiate them. * small formatting updates * add import tooltip to connection modal Added the logo for an imported config to the connection modal. It also provides a short description when it the mouse hovers over it. * add button to import ssh config Make the command into a button for a simple gui interface. Also ran prettier to clean up some syntax. * remove strict casing on WaveOptions WaveOptions was previously very specific about the casing of the ignore and connectmode subcommands. With this update, the casing is automatically converted to lowercase and can be ignored. * add status dot before name in connections screen * add space and tooltip to connection imported icon * re-prettier
2023-12-28 20:09:41 +01:00
SSHConfigSrc: rcopy.SSHConfigSrc,
2022-09-14 02:11:36 +02:00
}
err := sstore.UpsertRemote(ctx, archivedRemote)
if err != nil {
return err
}
newMsh := MakeMShell(archivedRemote)
GlobalStore.Map[remoteId] = newMsh
go newMsh.NotifyRemoteUpdate()
return nil
}
2022-09-14 22:01:52 +02:00
var partialUUIDRe = regexp.MustCompile("^[0-9a-f]{8}$")
func isPartialUUID(s string) bool {
return partialUUIDRe.MatchString(s)
}
2023-02-22 07:41:56 +01:00
func NumRemotes() int {
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
return len(GlobalStore.Map)
}
2022-09-14 22:01:52 +02:00
func GetRemoteByArg(arg string) *MShellProc {
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
2022-09-14 22:01:52 +02:00
isPuid := isPartialUUID(arg)
for _, msh := range GlobalStore.Map {
rcopy := msh.GetRemoteCopy()
2022-09-14 22:01:52 +02:00
if rcopy.RemoteAlias == arg || rcopy.RemoteCanonicalName == arg || rcopy.RemoteId == arg {
return msh
}
if isPuid && strings.HasPrefix(rcopy.RemoteId, arg) {
return msh
}
}
return nil
}
2022-09-14 02:11:36 +02:00
func getRemoteByCanonicalName_nolock(name string) *MShellProc {
for _, msh := range GlobalStore.Map {
rcopy := msh.GetRemoteCopy()
2022-09-14 02:11:36 +02:00
if rcopy.RemoteCanonicalName == name {
return msh
}
}
return nil
}
func GetRemoteById(remoteId string) *MShellProc {
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
return GlobalStore.Map[remoteId]
}
2022-07-01 23:57:42 +02:00
func GetRemoteCopyById(remoteId string) *sstore.RemoteType {
msh := GetRemoteById(remoteId)
if msh == nil {
return nil
}
rcopy := msh.GetRemoteCopy()
return &rcopy
}
2022-12-31 02:01:17 +01:00
func GetRemoteMap() map[string]*MShellProc {
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
rtn := make(map[string]*MShellProc)
for remoteId, msh := range GlobalStore.Map {
rtn[remoteId] = msh
}
return rtn
}
func GetLocalRemote() *MShellProc {
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
for _, msh := range GlobalStore.Map {
2022-12-29 09:07:16 +01:00
if msh.IsLocal() && !msh.IsSudo() {
return msh
}
}
return nil
}
func ResolveRemoteRef(remoteRef string) *RemoteRuntimeState {
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
_, err := uuid.Parse(remoteRef)
if err == nil {
msh := GlobalStore.Map[remoteRef]
if msh != nil {
state := msh.GetRemoteRuntimeState()
return &state
}
return nil
}
for _, msh := range GlobalStore.Map {
if msh.Remote.RemoteAlias == remoteRef || msh.Remote.RemoteCanonicalName == remoteRef {
state := msh.GetRemoteRuntimeState()
return &state
}
}
return nil
}
2022-08-23 01:00:25 +02:00
func unquoteDQBashString(str string) (string, bool) {
if len(str) < 2 {
return str, false
}
if str[0] != '"' || str[len(str)-1] != '"' {
return str, false
}
rtn := make([]byte, 0, len(str)-2)
for idx := 1; idx < len(str)-1; idx++ {
ch := str[idx]
if ch == '"' {
return str, false
}
if ch == '\\' {
if idx == len(str)-2 {
return str, false
}
nextCh := str[idx+1]
if nextCh == '\n' {
idx++
continue
}
if nextCh == '$' || nextCh == '"' || nextCh == '\\' || nextCh == '`' {
idx++
rtn = append(rtn, nextCh)
continue
}
rtn = append(rtn, '\\')
continue
} else {
rtn = append(rtn, ch)
}
}
return string(rtn), true
}
2022-08-24 06:05:49 +02:00
func makeShortHost(host string) string {
dotIdx := strings.Index(host, ".")
if dotIdx == -1 {
return host
}
return host[0:dotIdx]
}
func (msh *MShellProc) IsLocal() bool {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.Remote.Local
}
2022-12-29 09:07:16 +01:00
func (msh *MShellProc) IsSudo() bool {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.Remote.IsSudo()
2022-12-29 09:07:16 +01:00
}
func (msh *MShellProc) tryAutoInstall() {
msh.Lock.Lock()
defer msh.Lock.Unlock()
if !msh.Remote.AutoInstall || !msh.NeedsMShellUpgrade || msh.InstallErr != nil {
return
}
msh.writeToPtyBuffer_nolock("trying auto-install\n")
go msh.RunInstall()
}
func (msh *MShellProc) GetRemoteRuntimeState() RemoteRuntimeState {
msh.Lock.Lock()
defer msh.Lock.Unlock()
state := RemoteRuntimeState{
RemoteType: msh.Remote.RemoteType,
RemoteId: msh.Remote.RemoteId,
RemoteAlias: msh.Remote.RemoteAlias,
RemoteCanonicalName: msh.Remote.RemoteCanonicalName,
Status: msh.Status,
ConnectMode: msh.Remote.ConnectMode,
AutoInstall: msh.Remote.AutoInstall,
2022-09-14 02:11:36 +02:00
Archived: msh.Remote.Archived,
2022-09-14 21:06:55 +02:00
RemoteIdx: msh.Remote.RemoteIdx,
ssh config import (#156) * create migrations for required database change This is a first attempt that does not appear to be working properly. It requires review. * fix errors in db migrations The previous commit had an extra json call that broke the update and did not remove the imported interies during a downgrade. * change migrations to use column instead of json It makes more sense to associate the source of a config with the remote type than the sshopts type. This change makes that clear in the database structure. * ensure adding a remote manually tags correctly Using the usual way of adding a remote should result in a sshconfigsrc of "waveterm-manual". This will be important for filtering out remotes installed manually and remotes installed via import * create basic structure for parsing ssh config This entails creating a new command, making it possible to query only the imported remotes from the database, and implementing the logic to handle all of the updates needed. This needs improvements in a few areas: - the /etc/ssh/config needs to be parsed as well - the logic for editing exisiting imported remotes needs to be written - error handling needs to be improved - update packet responses need to be provided * add sshkey support and implement editing We now search for the ssh identity keyfile and add it if it is found. Additionally, the logic to edit previously imported ssh hosts has been added. * combine hosts from user and system ssh config We now check both the user ~/.ssh/config as well as the /etc/ssh/config for hosts. This loops through each file starting with the user one. For each host, it selects the first pattern without a wildcard and chooses that to be the alias. If any future hosts are found to have the same alias, they are skipped. Errors are raised if neither config file can be opened or no aliases were found. * improve logging and error reporting Error reporting is now shortcircuited in cases of individual remotes in order to allow the other remotes to continue. These errors are now printed to logs instead. * allow imports to edit ssh port Previously, ssh ports could not be edited after the fact. Unfortunately, this can cause problems since the port can be changed in an ssh config file. To address this, we allow imports to change the port if a host with the same canonical name had previously been imported. * fix response to parse command * fix error handline for alias parsing Small mistake of checking for equality instead of inequality * fix the ability to overwrite hostName with alias if ssh_config does not find Hostname, it won't output an error. Now we compare against the result instead of looking for an error. * fix the error catching for User and Port This fixes the same problem where parsing the config doesn't give an error in the case when nothing is found. As before, this checks for a blank result instead. * remove unused code * remove repeated canonical name check The logic that checks for an existing canonical name already exists in the AddRemote function, so it is not needed here. Secondly, we now only allow edits of previously created remotes if they have not been archived. If they have, the usual logic for creating a new remote takes precedence. Lastly, there is no need to archive a remote that has already been archived so an additional check has been added. * allow archives to preserve the SSHConfigSrc * add log message for archiving of imported remotes * create variables for string variants Matches existing code style * add cleanup for opened files * move migration 25 to migration 26 (already merged a migration 25) * fix RemoteRuntimeState in ModelUpdate by moving type to sstore.go. Fix some bugs in remote:parse. Fix key/identityfile, return value, and remote editing (should go through msh). remote sudo. add info messages around parse status * fix issue with archiving the sshconfigsrc A bug in RemoteType's FromMap caused the loss of sshconfigsrc during the conversion. This has been corrected and the schema has been updated. * fix order of archiving removed imported remotes Previously, if the canonical name changed, the code would try to create a new remote before archiving the old one. This did not work if the alias didn't change. Now we archive first and add a new remote after. * fix ability to change port when importing config Importing from sshconfig needs to allow the port to change. This was not happening because of a bug that has been corrected. * always use host in place of hostname Since host is the key actually searched for in the ssh config file, searching for user@hostName may not actually work. To avoid this, we now always use user@host instead. * automatically determine ConnectMode This aims to select a connection mode based off what is provided in the ssh config file. It aims for auto connections when possible but will fall back to manual if we can't easily support it * remove sshkeysource migration number confilict Previously had conflicting migration numbers of 26. The change not in the main branch has been moved to 27 to remove the conflict. * move sshkeysource migration to migration 28 * add WaveOptions flag parsing for ssh config This is currently being used to allow users to force manual connect mode if desired. It will also be used to force skipping options in the future but that is not complete in this commit. * implement ignore flag for ssh config parsing The ignore flag will now archive an imported remote if it previously existed and not create a new remote in its place. * fix discovery of identity file Previously, a ~ in the identity file's path was not expanded to the home dir. Because of this, files with a ~ were previously identified as invalid files. By expanding it during the search, this is no longer the case. * disable frontend edit button for imported remotes Imported Remotes should not be editable in waveterm by users. This edit makes it clear that the button will not work for those cases. Further edits may be needed to explain why it doesn't work and what to do instead. * add backend rejection of updating imported remote As before, we don't want manual editing of an imported remote inside the app. This ensures that it can't happen on the backend. * create tooltips for sshconfig edit/delete buttons For remotes that are imported, edits are not allowed. This adds a tooltip that explains what to do instead. Deleting remotes that are imported is allowed, but they will come back if the user imports again. The tooltip explains a way to avoid this. * add logo after name for imported remotes In the connections screen, there previously was not a way to tell imported connections from manually created connections. This change adds a logo after the imported ones to differentiate them. * small formatting updates * add import tooltip to connection modal Added the logo for an imported config to the connection modal. It also provides a short description when it the mouse hovers over it. * add button to import ssh config Make the command into a button for a simple gui interface. Also ran prettier to clean up some syntax. * remove strict casing on WaveOptions WaveOptions was previously very specific about the casing of the ignore and connectmode subcommands. With this update, the casing is automatically converted to lowercase and can be ignored. * add status dot before name in connections screen * add space and tooltip to connection imported icon * re-prettier
2023-12-28 20:09:41 +01:00
SSHConfigSrc: msh.Remote.SSHConfigSrc,
UName: msh.UName,
2022-09-27 08:23:04 +02:00
InstallStatus: msh.InstallStatus,
NeedsMShellUpgrade: msh.NeedsMShellUpgrade,
Local: msh.Remote.Local,
NoInitPk: msh.ErrNoInitPk,
AuthType: sstore.RemoteAuthTypeNone,
}
if msh.Remote.SSHOpts != nil {
state.AuthType = msh.Remote.SSHOpts.GetAuthType()
}
2022-12-29 09:07:16 +01:00
if msh.Remote.RemoteOpts != nil {
optsCopy := *msh.Remote.RemoteOpts
state.RemoteOpts = &optsCopy
}
if msh.Err != nil {
state.ErrorStr = msh.Err.Error()
}
2022-09-27 08:23:04 +02:00
if msh.InstallErr != nil {
state.InstallErrorStr = msh.InstallErr.Error()
}
2022-10-01 02:22:28 +02:00
if msh.Status == StatusConnecting {
state.WaitingForPassword = msh.isWaitingForPassword_nolock()
if msh.MakeClientDeadline != nil {
state.ConnectTimeout = int((*msh.MakeClientDeadline).Sub(time.Now()) / time.Second)
if state.ConnectTimeout < 0 {
state.ConnectTimeout = 0
}
}
2022-10-01 02:22:28 +02:00
}
vars := msh.Remote.StateVars
if vars == nil {
vars = make(map[string]string)
}
vars["user"] = msh.Remote.RemoteUser
vars["bestuser"] = vars["user"]
vars["host"] = msh.Remote.RemoteHost
vars["shorthost"] = makeShortHost(msh.Remote.RemoteHost)
vars["alias"] = msh.Remote.RemoteAlias
vars["cname"] = msh.Remote.RemoteCanonicalName
vars["remoteid"] = msh.Remote.RemoteId
vars["status"] = msh.Status
vars["type"] = msh.Remote.RemoteType
if msh.Remote.IsSudo() {
vars["sudo"] = "1"
}
if msh.Remote.Local {
vars["local"] = "1"
}
2022-10-03 21:25:43 +02:00
vars["port"] = "22"
2022-10-04 04:04:48 +02:00
if msh.Remote.SSHOpts != nil {
if msh.Remote.SSHOpts.SSHPort != 0 {
vars["port"] = strconv.Itoa(msh.Remote.SSHOpts.SSHPort)
}
}
if msh.Remote.RemoteOpts != nil && msh.Remote.RemoteOpts.Color != "" {
vars["color"] = msh.Remote.RemoteOpts.Color
2022-10-03 21:25:43 +02:00
}
if msh.ServerProc != nil && msh.ServerProc.InitPk != nil {
initPk := msh.ServerProc.InitPk
if initPk.BuildTime == "" || initPk.BuildTime == "0" {
state.MShellVersion = initPk.Version
} else {
state.MShellVersion = fmt.Sprintf("%s+%s", initPk.Version, initPk.BuildTime)
}
vars["home"] = initPk.HomeDir
vars["remoteuser"] = initPk.User
vars["bestuser"] = vars["remoteuser"]
vars["remotehost"] = initPk.HostName
vars["remoteshorthost"] = makeShortHost(initPk.HostName)
vars["besthost"] = vars["remotehost"]
vars["bestshorthost"] = vars["remoteshorthost"]
}
2022-11-28 09:13:00 +01:00
curState := msh.StateMap[msh.CurrentState]
if curState != nil {
state.DefaultFeState = sstore.FeStateFromShellState(curState)
vars["cwd"] = curState.Cwd
}
if msh.Remote.Local && msh.Remote.IsSudo() {
vars["bestuser"] = "sudo"
} else if msh.Remote.IsSudo() {
vars["bestuser"] = "sudo@" + vars["bestuser"]
}
if msh.Remote.Local {
vars["bestname"] = vars["bestuser"] + "@local"
vars["bestshortname"] = vars["bestuser"] + "@local"
} else {
vars["bestname"] = vars["bestuser"] + "@" + vars["besthost"]
vars["bestshortname"] = vars["bestuser"] + "@" + vars["bestshorthost"]
2022-08-23 23:01:52 +02:00
}
if vars["remoteuser"] == "root" || vars["sudo"] == "1" {
vars["isroot"] = "1"
}
2022-08-23 23:01:52 +02:00
state.RemoteVars = vars
return state
}
func (msh *MShellProc) NotifyRemoteUpdate() {
rstate := msh.GetRemoteRuntimeState()
ssh config import (#156) * create migrations for required database change This is a first attempt that does not appear to be working properly. It requires review. * fix errors in db migrations The previous commit had an extra json call that broke the update and did not remove the imported interies during a downgrade. * change migrations to use column instead of json It makes more sense to associate the source of a config with the remote type than the sshopts type. This change makes that clear in the database structure. * ensure adding a remote manually tags correctly Using the usual way of adding a remote should result in a sshconfigsrc of "waveterm-manual". This will be important for filtering out remotes installed manually and remotes installed via import * create basic structure for parsing ssh config This entails creating a new command, making it possible to query only the imported remotes from the database, and implementing the logic to handle all of the updates needed. This needs improvements in a few areas: - the /etc/ssh/config needs to be parsed as well - the logic for editing exisiting imported remotes needs to be written - error handling needs to be improved - update packet responses need to be provided * add sshkey support and implement editing We now search for the ssh identity keyfile and add it if it is found. Additionally, the logic to edit previously imported ssh hosts has been added. * combine hosts from user and system ssh config We now check both the user ~/.ssh/config as well as the /etc/ssh/config for hosts. This loops through each file starting with the user one. For each host, it selects the first pattern without a wildcard and chooses that to be the alias. If any future hosts are found to have the same alias, they are skipped. Errors are raised if neither config file can be opened or no aliases were found. * improve logging and error reporting Error reporting is now shortcircuited in cases of individual remotes in order to allow the other remotes to continue. These errors are now printed to logs instead. * allow imports to edit ssh port Previously, ssh ports could not be edited after the fact. Unfortunately, this can cause problems since the port can be changed in an ssh config file. To address this, we allow imports to change the port if a host with the same canonical name had previously been imported. * fix response to parse command * fix error handline for alias parsing Small mistake of checking for equality instead of inequality * fix the ability to overwrite hostName with alias if ssh_config does not find Hostname, it won't output an error. Now we compare against the result instead of looking for an error. * fix the error catching for User and Port This fixes the same problem where parsing the config doesn't give an error in the case when nothing is found. As before, this checks for a blank result instead. * remove unused code * remove repeated canonical name check The logic that checks for an existing canonical name already exists in the AddRemote function, so it is not needed here. Secondly, we now only allow edits of previously created remotes if they have not been archived. If they have, the usual logic for creating a new remote takes precedence. Lastly, there is no need to archive a remote that has already been archived so an additional check has been added. * allow archives to preserve the SSHConfigSrc * add log message for archiving of imported remotes * create variables for string variants Matches existing code style * add cleanup for opened files * move migration 25 to migration 26 (already merged a migration 25) * fix RemoteRuntimeState in ModelUpdate by moving type to sstore.go. Fix some bugs in remote:parse. Fix key/identityfile, return value, and remote editing (should go through msh). remote sudo. add info messages around parse status * fix issue with archiving the sshconfigsrc A bug in RemoteType's FromMap caused the loss of sshconfigsrc during the conversion. This has been corrected and the schema has been updated. * fix order of archiving removed imported remotes Previously, if the canonical name changed, the code would try to create a new remote before archiving the old one. This did not work if the alias didn't change. Now we archive first and add a new remote after. * fix ability to change port when importing config Importing from sshconfig needs to allow the port to change. This was not happening because of a bug that has been corrected. * always use host in place of hostname Since host is the key actually searched for in the ssh config file, searching for user@hostName may not actually work. To avoid this, we now always use user@host instead. * automatically determine ConnectMode This aims to select a connection mode based off what is provided in the ssh config file. It aims for auto connections when possible but will fall back to manual if we can't easily support it * remove sshkeysource migration number confilict Previously had conflicting migration numbers of 26. The change not in the main branch has been moved to 27 to remove the conflict. * move sshkeysource migration to migration 28 * add WaveOptions flag parsing for ssh config This is currently being used to allow users to force manual connect mode if desired. It will also be used to force skipping options in the future but that is not complete in this commit. * implement ignore flag for ssh config parsing The ignore flag will now archive an imported remote if it previously existed and not create a new remote in its place. * fix discovery of identity file Previously, a ~ in the identity file's path was not expanded to the home dir. Because of this, files with a ~ were previously identified as invalid files. By expanding it during the search, this is no longer the case. * disable frontend edit button for imported remotes Imported Remotes should not be editable in waveterm by users. This edit makes it clear that the button will not work for those cases. Further edits may be needed to explain why it doesn't work and what to do instead. * add backend rejection of updating imported remote As before, we don't want manual editing of an imported remote inside the app. This ensures that it can't happen on the backend. * create tooltips for sshconfig edit/delete buttons For remotes that are imported, edits are not allowed. This adds a tooltip that explains what to do instead. Deleting remotes that are imported is allowed, but they will come back if the user imports again. The tooltip explains a way to avoid this. * add logo after name for imported remotes In the connections screen, there previously was not a way to tell imported connections from manually created connections. This change adds a logo after the imported ones to differentiate them. * small formatting updates * add import tooltip to connection modal Added the logo for an imported config to the connection modal. It also provides a short description when it the mouse hovers over it. * add button to import ssh config Make the command into a button for a simple gui interface. Also ran prettier to clean up some syntax. * remove strict casing on WaveOptions WaveOptions was previously very specific about the casing of the ignore and connectmode subcommands. With this update, the casing is automatically converted to lowercase and can be ignored. * add status dot before name in connections screen * add space and tooltip to connection imported icon * re-prettier
2023-12-28 20:09:41 +01:00
update := &sstore.ModelUpdate{Remotes: []RemoteRuntimeState{rstate}}
2023-03-21 03:20:57 +01:00
sstore.MainBus.SendUpdate(update)
2022-08-26 22:12:17 +02:00
}
func GetAllRemoteRuntimeState() []RemoteRuntimeState {
2022-07-05 07:18:01 +02:00
GlobalStore.Lock.Lock()
defer GlobalStore.Lock.Unlock()
var rtn []RemoteRuntimeState
2022-07-05 07:18:01 +02:00
for _, proc := range GlobalStore.Map {
state := proc.GetRemoteRuntimeState()
2022-07-05 07:18:01 +02:00
rtn = append(rtn, state)
}
return rtn
}
func GetDefaultRemoteStateById(remoteId string) (*packet.ShellState, error) {
remote := GetRemoteById(remoteId)
if remote == nil {
return nil, fmt.Errorf("remote not found")
}
if !remote.IsConnected() {
return nil, fmt.Errorf("remote not connected")
}
state := remote.GetDefaultState()
if state == nil {
return nil, fmt.Errorf("could not get default remote state")
}
return state, nil
}
func MakeMShell(r *sstore.RemoteType) *MShellProc {
2022-09-15 08:10:35 +02:00
buf, err := circbuf.NewBuffer(CircBufSize)
if err != nil {
panic(err) // this should never happen (NewBuffer only returns an error if CirBufSize <= 0)
}
rtn := &MShellProc{
Lock: &sync.Mutex{},
Remote: r,
2022-10-28 07:22:17 +02:00
RemoteId: r.RemoteId,
Status: StatusDisconnected,
PtyBuffer: buf,
InstallStatus: StatusDisconnected,
2022-10-28 07:22:17 +02:00
RunningCmds: make(map[base.CommandKey]RunCmdType),
PendingStateCmds: make(map[pendingStateKey]base.CommandKey),
2022-11-28 09:13:00 +01:00
StateMap: make(map[string]*packet.ShellState),
2022-09-15 08:10:35 +02:00
}
2023-04-04 06:31:40 +02:00
rtn.WriteToPtyBuffer("console for connection [%s]\n", r.GetName())
return rtn
2022-07-01 23:57:42 +02:00
}
func SendRemoteInput(pk *scpacket.RemoteInputPacketType) error {
data, err := base64.StdEncoding.DecodeString(pk.InputData64)
if err != nil {
return fmt.Errorf("cannot decode base64: %v\n", err)
}
msh := GetRemoteById(pk.RemoteId)
if msh == nil {
return fmt.Errorf("remote not found")
}
var cmdPty *os.File
msh.WithLock(func() {
cmdPty = msh.ControllingPty
})
if cmdPty == nil {
return fmt.Errorf("remote has no attached pty")
}
_, err = cmdPty.Write(data)
if err != nil {
return fmt.Errorf("writing to pty: %v", err)
}
msh.resetClientDeadline()
return nil
}
func (msh *MShellProc) getClientDeadline() *time.Time {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.MakeClientDeadline
}
func (msh *MShellProc) resetClientDeadline() {
msh.Lock.Lock()
defer msh.Lock.Unlock()
if msh.Status != StatusConnecting {
return
}
deadline := msh.MakeClientDeadline
if deadline == nil {
return
}
newDeadline := time.Now().Add(RemoteConnectTimeout)
msh.MakeClientDeadline = &newDeadline
}
func (msh *MShellProc) watchClientDeadlineTime() {
for {
time.Sleep(1 * time.Second)
status := msh.GetStatus()
if status != StatusConnecting {
break
}
deadline := msh.getClientDeadline()
if deadline == nil {
break
}
if time.Now().After(*deadline) {
msh.Disconnect(false)
break
}
go msh.NotifyRemoteUpdate()
}
}
func convertSSHOpts(opts *sstore.SSHOpts) shexec.SSHOpts {
if opts == nil || opts.Local {
opts = &sstore.SSHOpts{}
}
return shexec.SSHOpts{
SSHHost: opts.SSHHost,
SSHOptsStr: opts.SSHOptsStr,
SSHIdentity: opts.SSHIdentity,
SSHUser: opts.SSHUser,
SSHPort: opts.SSHPort,
}
}
2022-08-25 07:57:41 +02:00
func (msh *MShellProc) addControllingTty(ecmd *exec.Cmd) (*os.File, error) {
msh.Lock.Lock()
defer msh.Lock.Unlock()
cmdPty, cmdTty, err := pty.Open()
if err != nil {
2022-08-25 07:57:41 +02:00
return nil, err
}
2022-09-15 09:17:23 +02:00
pty.Setsize(cmdPty, &pty.Winsize{Rows: RemoteTermRows, Cols: RemoteTermCols})
msh.ControllingPty = cmdPty
ecmd.ExtraFiles = append(ecmd.ExtraFiles, cmdTty)
if ecmd.SysProcAttr == nil {
ecmd.SysProcAttr = &syscall.SysProcAttr{}
}
ecmd.SysProcAttr.Setsid = true
ecmd.SysProcAttr.Setctty = true
ecmd.SysProcAttr.Ctty = len(ecmd.ExtraFiles) + 3 - 1
2022-08-25 07:57:41 +02:00
return cmdPty, nil
}
2022-08-25 07:57:41 +02:00
func (msh *MShellProc) setErrorStatus(err error) {
msh.Lock.Lock()
defer msh.Lock.Unlock()
2022-08-25 07:57:41 +02:00
msh.Status = StatusError
msh.Err = err
go msh.NotifyRemoteUpdate()
2022-08-25 07:57:41 +02:00
}
2022-09-27 06:09:43 +02:00
func (msh *MShellProc) setInstallErrorStatus(err error) {
2022-09-27 08:23:04 +02:00
msh.WriteToPtyBuffer("*error, %s\n", err.Error())
2022-09-27 06:09:43 +02:00
msh.Lock.Lock()
defer msh.Lock.Unlock()
msh.InstallStatus = StatusError
msh.InstallErr = err
go msh.NotifyRemoteUpdate()
}
func (msh *MShellProc) GetRemoteCopy() sstore.RemoteType {
2022-08-25 07:57:41 +02:00
msh.Lock.Lock()
defer msh.Lock.Unlock()
return *msh.Remote
}
func (msh *MShellProc) GetUName() string {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.UName
}
func (msh *MShellProc) GetNumRunningCommands() int {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return len(msh.RunningCmds)
}
2022-10-03 03:52:55 +02:00
func (msh *MShellProc) UpdateRemote(ctx context.Context, editMap map[string]interface{}) error {
msh.Lock.Lock()
defer msh.Lock.Unlock()
updatedRemote, err := sstore.UpdateRemote(ctx, msh.Remote.RemoteId, editMap)
if err != nil {
return err
}
if updatedRemote == nil {
return fmt.Errorf("no remote returned from UpdateRemote")
}
msh.Remote = updatedRemote
go msh.NotifyRemoteUpdate()
return nil
}
2022-09-27 08:23:04 +02:00
func (msh *MShellProc) Disconnect(force bool) {
status := msh.GetStatus()
if status != StatusConnected && status != StatusConnecting {
msh.WriteToPtyBuffer("remote already disconnected (no action taken)\n")
return
}
numCommands := msh.GetNumRunningCommands()
if numCommands > 0 && !force {
msh.WriteToPtyBuffer("remote not disconnected, has %d running commands. use force=1 to force disconnection\n", numCommands)
return
}
msh.Lock.Lock()
defer msh.Lock.Unlock()
2022-09-14 02:11:36 +02:00
if msh.ServerProc != nil {
msh.ServerProc.Close()
}
if msh.MakeClientCancelFn != nil {
msh.MakeClientCancelFn()
msh.MakeClientCancelFn = nil
}
}
2022-09-27 08:23:04 +02:00
func (msh *MShellProc) CancelInstall() {
msh.Lock.Lock()
defer msh.Lock.Unlock()
if msh.InstallCancelFn != nil {
msh.InstallCancelFn()
msh.InstallCancelFn = nil
}
}
2022-09-06 21:58:16 +02:00
func (msh *MShellProc) GetRemoteName() string {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.Remote.GetName()
}
2022-09-15 08:10:35 +02:00
func (msh *MShellProc) WriteToPtyBuffer(strFmt string, args ...interface{}) {
msh.Lock.Lock()
defer msh.Lock.Unlock()
msh.writeToPtyBuffer_nolock(strFmt, args...)
}
func (msh *MShellProc) writeToPtyBuffer_nolock(strFmt string, args ...interface{}) {
// inefficient string manipulation here and read of PtyBuffer, but these messages are rare, nbd
realStr := fmt.Sprintf(strFmt, args...)
if !strings.HasPrefix(realStr, "~") {
realStr = strings.ReplaceAll(realStr, "\n", "\r\n")
if !strings.HasSuffix(realStr, "\r\n") {
realStr = realStr + "\r\n"
}
2022-09-15 09:37:17 +02:00
if strings.HasPrefix(realStr, "*") {
realStr = "\033[0m\033[31mprompt>\033[0m " + realStr[1:]
2022-09-15 09:37:17 +02:00
} else {
realStr = "\033[0m\033[32mprompt>\033[0m " + realStr
2022-09-15 09:37:17 +02:00
}
2022-09-15 08:10:35 +02:00
barr := msh.PtyBuffer.Bytes()
if len(barr) > 0 && barr[len(barr)-1] != '\n' {
realStr = "\r\n" + realStr
}
} else {
realStr = realStr[1:]
}
2022-09-15 09:17:23 +02:00
curOffset := msh.PtyBuffer.TotalWritten()
data := []byte(realStr)
msh.PtyBuffer.Write(data)
sendRemotePtyUpdate(msh.Remote.RemoteId, curOffset, data)
}
func sendRemotePtyUpdate(remoteId string, dataOffset int64, data []byte) {
data64 := base64.StdEncoding.EncodeToString(data)
update := &sstore.PtyDataUpdate{
RemoteId: remoteId,
PtyPos: dataOffset,
PtyData64: data64,
PtyDataLen: int64(len(data)),
}
2023-03-21 03:20:57 +01:00
sstore.MainBus.SendUpdate(update)
2022-09-15 08:10:35 +02:00
}
2022-10-01 02:22:28 +02:00
func (msh *MShellProc) isWaitingForPassword_nolock() bool {
barr := msh.PtyBuffer.Bytes()
if len(barr) == 0 {
return false
}
nlIdx := bytes.LastIndex(barr, []byte{'\n'})
var lastLine string
if nlIdx == -1 {
lastLine = string(barr)
} else {
lastLine = string(barr[nlIdx+1:])
}
pwIdx := strings.Index(lastLine, "assword")
return pwIdx != -1
}
func (msh *MShellProc) isWaitingForPassphrase_nolock() bool {
barr := msh.PtyBuffer.Bytes()
if len(barr) == 0 {
return false
}
nlIdx := bytes.LastIndex(barr, []byte{'\n'})
var lastLine string
if nlIdx == -1 {
lastLine = string(barr)
} else {
lastLine = string(barr[nlIdx+1:])
}
pwIdx := strings.Index(lastLine, "Enter passphrase for key")
return pwIdx != -1
}
2022-09-16 02:44:39 +02:00
func (msh *MShellProc) RunPtyReadLoop(cmdPty *os.File) {
buf := make([]byte, PtyReadBufSize)
2022-10-01 02:22:28 +02:00
var isWaiting bool
2022-09-16 02:44:39 +02:00
for {
n, readErr := cmdPty.Read(buf)
if readErr == io.EOF {
break
}
if readErr != nil {
msh.WriteToPtyBuffer("*error reading from controlling-pty: %v\n", readErr)
break
}
2022-10-01 02:22:28 +02:00
var newIsWaiting bool
2022-09-16 02:44:39 +02:00
msh.WithLock(func() {
curOffset := msh.PtyBuffer.TotalWritten()
msh.PtyBuffer.Write(buf[0:n])
sendRemotePtyUpdate(msh.Remote.RemoteId, curOffset, buf[0:n])
2022-10-01 02:22:28 +02:00
newIsWaiting = msh.isWaitingForPassword_nolock()
2022-09-16 02:44:39 +02:00
})
2022-10-01 02:22:28 +02:00
if newIsWaiting != isWaiting {
isWaiting = newIsWaiting
go msh.NotifyRemoteUpdate()
}
}
}
func (msh *MShellProc) WaitAndSendPassword(pw string) {
var numWaits int
for {
var isWaiting bool
var isConnecting bool
msh.WithLock(func() {
if msh.Remote.SSHOpts.GetAuthType() == sstore.RemoteAuthTypeKeyPassword {
isWaiting = msh.isWaitingForPassphrase_nolock()
} else {
isWaiting = msh.isWaitingForPassword_nolock()
}
2022-10-01 02:22:28 +02:00
isConnecting = msh.Status == StatusConnecting
})
if !isConnecting {
break
}
if !isWaiting {
numWaits = 0
time.Sleep(100 * time.Millisecond)
continue
}
numWaits++
if numWaits < 10 {
time.Sleep(100 * time.Millisecond)
} else {
// send password
msh.WithLock(func() {
if msh.ControllingPty == nil {
return
}
pwBytes := []byte(pw + "\r")
msh.writeToPtyBuffer_nolock("~[sent password]\r\n")
_, err := msh.ControllingPty.Write(pwBytes)
if err != nil {
msh.writeToPtyBuffer_nolock("*cannot write password to controlling pty: %v\n", err)
}
})
break
}
2022-09-16 02:44:39 +02:00
}
}
2022-09-27 06:09:43 +02:00
func (msh *MShellProc) RunInstall() {
remoteCopy := msh.GetRemoteCopy()
if remoteCopy.Archived {
2022-09-27 08:23:04 +02:00
msh.WriteToPtyBuffer("*error: cannot install on archived remote\n")
return
}
baseStatus := msh.GetStatus()
if baseStatus == StatusConnecting || baseStatus == StatusConnected {
msh.WriteToPtyBuffer("*error: cannot install on remote that is connected/connecting, disconnect to install\n")
2022-09-27 06:09:43 +02:00
return
}
curStatus := msh.GetInstallStatus()
if curStatus == StatusConnecting {
2022-09-27 08:23:04 +02:00
msh.WriteToPtyBuffer("*error: cannot install on remote that is already trying to install, cancel current install to try again\n")
2022-09-27 06:09:43 +02:00
return
}
msh.WriteToPtyBuffer("installing mshell %s to %s...\n", scbase.MShellVersion, remoteCopy.RemoteCanonicalName)
2022-09-27 06:09:43 +02:00
sshOpts := convertSSHOpts(remoteCopy.SSHOpts)
sshOpts.SSHErrorsToTty = true
cmdStr := shexec.MakeInstallCommandStr()
ecmd := sshOpts.MakeSSHExecCmd(cmdStr)
cmdPty, err := msh.addControllingTty(ecmd)
if err != nil {
statusErr := fmt.Errorf("cannot attach controlling tty to mshell install command: %w", err)
msh.setInstallErrorStatus(statusErr)
return
}
defer func() {
if len(ecmd.ExtraFiles) > 0 {
ecmd.ExtraFiles[len(ecmd.ExtraFiles)-1].Close()
}
2022-09-27 08:23:04 +02:00
cmdPty.Close()
2022-09-27 06:09:43 +02:00
}()
go msh.RunPtyReadLoop(cmdPty)
clientCtx, clientCancelFn := context.WithCancel(context.Background())
defer clientCancelFn()
msh.WithLock(func() {
2022-09-27 08:23:04 +02:00
msh.InstallErr = nil
2022-09-27 06:09:43 +02:00
msh.InstallStatus = StatusConnecting
msh.InstallCancelFn = clientCancelFn
go msh.NotifyRemoteUpdate()
})
msgFn := func(msg string) {
msh.WriteToPtyBuffer("%s", msg)
}
err = shexec.RunInstallFromCmd(clientCtx, ecmd, true, nil, scbase.MShellBinaryReader, msgFn)
2022-09-27 08:23:04 +02:00
if err == context.Canceled {
msh.WriteToPtyBuffer("*install canceled\n")
msh.WithLock(func() {
msh.InstallStatus = StatusDisconnected
go msh.NotifyRemoteUpdate()
})
return
}
2022-09-27 06:09:43 +02:00
if err != nil {
statusErr := fmt.Errorf("install failed: %w", err)
msh.setInstallErrorStatus(statusErr)
return
}
var connectMode string
2022-09-27 08:23:04 +02:00
msh.WithLock(func() {
msh.InstallStatus = StatusDisconnected
msh.InstallCancelFn = nil
msh.NeedsMShellUpgrade = false
msh.Status = StatusDisconnected
msh.Err = nil
connectMode = msh.Remote.ConnectMode
2022-09-27 08:23:04 +02:00
})
msh.WriteToPtyBuffer("successfully installed mshell %s to ~/.mshell\n", scbase.MShellVersion)
2022-09-27 08:23:04 +02:00
go msh.NotifyRemoteUpdate()
if connectMode == sstore.ConnectModeStartup || connectMode == sstore.ConnectModeAuto {
// the install was successful, and we don't have a manual connect mode, try to connect
go msh.Launch(true)
}
2022-09-27 06:09:43 +02:00
return
}
func (msh *MShellProc) updateRemoteStateVars(ctx context.Context, remoteId string, initPk *packet.InitPacketType) {
msh.Lock.Lock()
defer msh.Lock.Unlock()
stateVars := getStateVarsFromInitPk(initPk)
if stateVars == nil {
return
}
msh.Remote.StateVars = stateVars
err := sstore.UpdateRemoteStateVars(ctx, remoteId, stateVars)
if err != nil {
// ignore error, nothing to do
log.Printf("error updating remote statevars: %v\n", err)
}
}
func getStateVarsFromInitPk(initPk *packet.InitPacketType) map[string]string {
if initPk == nil || initPk.NotFound {
return nil
}
rtn := make(map[string]string)
rtn["home"] = initPk.HomeDir
rtn["remoteuser"] = initPk.User
rtn["remotehost"] = initPk.HostName
rtn["remoteuname"] = initPk.UName
return rtn
}
func (msh *MShellProc) ReInit(ctx context.Context) (*packet.InitPacketType, error) {
reinitPk := packet.MakeReInitPacket()
reinitPk.ReqId = uuid.New().String()
resp, err := msh.PacketRpcRaw(ctx, reinitPk)
if err != nil {
return nil, err
}
if resp == nil {
return nil, fmt.Errorf("no response")
}
initPk, ok := resp.(*packet.InitPacketType)
if !ok {
return nil, fmt.Errorf("invalid reinit response (not an initpacket): %T", resp)
}
if initPk.State == nil {
return nil, fmt.Errorf("invalid reinit response initpk does not contain remote state")
}
2022-11-28 09:13:00 +01:00
hval := initPk.State.GetHashVal(false)
sstore.StoreStateBase(ctx, initPk.State)
msh.WithLock(func() {
2022-11-28 09:13:00 +01:00
msh.CurrentState = hval
msh.StateMap[hval] = initPk.State
})
msh.updateRemoteStateVars(ctx, msh.RemoteId, initPk)
return initPk, nil
}
func (msh *MShellProc) StreamFile(ctx context.Context, streamPk *packet.StreamFilePacketType) (*packet.RpcResponseIter, error) {
return msh.PacketRpcIter(ctx, streamPk)
}
func addScVarsToState(state *packet.ShellState) *packet.ShellState {
if state == nil {
return nil
}
rtn := *state
envMap := shexec.DeclMapFromState(&rtn)
envMap["PROMPT"] = &shexec.DeclareDeclType{Name: "PROMPT", Value: "1", Args: "x"}
envMap["PROMPT_VERSION"] = &shexec.DeclareDeclType{Name: "PROMPT_VERSION", Value: scbase.WaveVersion, Args: "x"}
rtn.ShellVars = shexec.SerializeDeclMap(envMap)
return &rtn
}
func stripScVarsFromState(state *packet.ShellState) *packet.ShellState {
if state == nil {
return nil
}
rtn := *state
rtn.HashVal = ""
envMap := shexec.DeclMapFromState(&rtn)
delete(envMap, "PROMPT")
delete(envMap, "PROMPT_VERSION")
rtn.ShellVars = shexec.SerializeDeclMap(envMap)
return &rtn
}
func stripScVarsFromStateDiff(stateDiff *packet.ShellStateDiff) *packet.ShellStateDiff {
if stateDiff == nil || len(stateDiff.VarsDiff) == 0 {
return stateDiff
}
rtn := *stateDiff
rtn.HashVal = ""
var mapDiff statediff.MapDiffType
err := mapDiff.Decode(stateDiff.VarsDiff)
if err != nil {
log.Printf("error decoding statediff in stripScVarsFromStateDiff: %v\n", err)
return stateDiff
}
delete(mapDiff.ToAdd, "PROMPT")
delete(mapDiff.ToAdd, "PROMPT_VERSION")
rtn.VarsDiff = mapDiff.Encode()
return &rtn
}
func (msh *MShellProc) Launch(interactive bool) {
remoteCopy := msh.GetRemoteCopy()
2022-09-14 02:11:36 +02:00
if remoteCopy.Archived {
2022-09-15 08:10:35 +02:00
msh.WriteToPtyBuffer("cannot launch archived remote\n")
2022-09-13 21:06:12 +02:00
return
}
curStatus := msh.GetStatus()
2022-09-27 08:23:04 +02:00
if curStatus == StatusConnected {
msh.WriteToPtyBuffer("remote is already connected (no action taken)\n")
return
}
if curStatus == StatusConnecting {
msh.WriteToPtyBuffer("remote is already connecting, disconnect before trying to connect again\n")
return
}
2022-09-27 08:23:04 +02:00
istatus := msh.GetInstallStatus()
if istatus == StatusConnecting {
msh.WriteToPtyBuffer("remote is trying to install, cancel install before trying to connect again\n")
return
}
if remoteCopy.SSHOpts.SSHPort != 0 && remoteCopy.SSHOpts.SSHPort != 22 {
msh.WriteToPtyBuffer("connecting to %s (port %d)...\n", remoteCopy.RemoteCanonicalName, remoteCopy.SSHOpts.SSHPort)
} else {
msh.WriteToPtyBuffer("connecting to %s...\n", remoteCopy.RemoteCanonicalName)
}
2022-09-14 02:11:36 +02:00
sshOpts := convertSSHOpts(remoteCopy.SSHOpts)
sshOpts.SSHErrorsToTty = true
if remoteCopy.ConnectMode != sstore.ConnectModeManual && remoteCopy.SSHOpts.SSHPassword == "" && !interactive {
sshOpts.BatchMode = true
}
var cmdStr string
2022-12-29 09:07:16 +01:00
if sshOpts.SSHHost == "" && remoteCopy.Local {
var err error
cmdStr, err = MakeLocalMShellCommandStr(remoteCopy.IsSudo())
if err != nil {
msh.WriteToPtyBuffer("*error, cannot find local mshell binary: %v\n", err)
return
}
} else {
cmdStr = MakeServerCommandStr()
}
2022-09-27 06:09:43 +02:00
ecmd := sshOpts.MakeSSHExecCmd(cmdStr)
2022-08-25 07:57:41 +02:00
cmdPty, err := msh.addControllingTty(ecmd)
if err != nil {
2022-09-04 08:36:15 +02:00
statusErr := fmt.Errorf("cannot attach controlling tty to mshell command: %w", err)
2022-09-15 09:37:17 +02:00
msh.WriteToPtyBuffer("*error, %s\n", statusErr.Error())
2022-09-04 08:36:15 +02:00
msh.setErrorStatus(statusErr)
return
}
defer func() {
if len(ecmd.ExtraFiles) > 0 {
ecmd.ExtraFiles[len(ecmd.ExtraFiles)-1].Close()
}
}()
2022-09-16 02:44:39 +02:00
go msh.RunPtyReadLoop(cmdPty)
2022-10-01 02:22:28 +02:00
if remoteCopy.SSHOpts.SSHPassword != "" {
go msh.WaitAndSendPassword(remoteCopy.SSHOpts.SSHPassword)
}
makeClientCtx, makeClientCancelFn := context.WithCancel(context.Background())
defer makeClientCancelFn()
2022-09-16 02:44:39 +02:00
msh.WithLock(func() {
2022-09-27 08:23:04 +02:00
msh.Err = nil
msh.ErrNoInitPk = false
2022-09-16 02:44:39 +02:00
msh.Status = StatusConnecting
msh.MakeClientCancelFn = makeClientCancelFn
deadlineTime := time.Now().Add(RemoteConnectTimeout)
msh.MakeClientDeadline = &deadlineTime
2022-09-16 02:44:39 +02:00
go msh.NotifyRemoteUpdate()
})
go msh.watchClientDeadlineTime()
2022-10-19 03:03:02 +02:00
cproc, initPk, err := shexec.MakeClientProc(makeClientCtx, ecmd)
// TODO check if initPk.State is not nil
var mshellVersion string
2022-11-28 09:13:00 +01:00
var stateBaseHash string
var hitDeadline bool
2022-08-25 07:57:41 +02:00
msh.WithLock(func() {
msh.MakeClientCancelFn = nil
if time.Now().After(*msh.MakeClientDeadline) {
hitDeadline = true
}
msh.MakeClientDeadline = nil
if initPk == nil {
msh.ErrNoInitPk = true
}
2022-10-19 03:03:02 +02:00
if initPk != nil {
msh.UName = initPk.UName
mshellVersion = initPk.Version
if semver.Compare(mshellVersion, scbase.MShellVersion) < 0 {
// only set NeedsMShellUpgrade if we got an InitPk
msh.NeedsMShellUpgrade = true
}
}
2022-11-28 09:13:00 +01:00
if initPk != nil && initPk.State != nil {
hval := initPk.State.GetHashVal(false)
msh.CurrentState = hval
msh.StateMap[hval] = initPk.State
sstore.StoreStateBase(context.Background(), initPk.State)
stateBaseHash = hval
} else {
msh.CurrentState = ""
}
// no notify here, because we'll call notify in either case below
2022-08-25 07:57:41 +02:00
})
if err == context.Canceled {
if hitDeadline {
msh.WriteToPtyBuffer("*connect timeout\n")
msh.setErrorStatus(errors.New("connect timeout"))
} else {
msh.WriteToPtyBuffer("*forced disconnection\n")
msh.WithLock(func() {
msh.Status = StatusDisconnected
go msh.NotifyRemoteUpdate()
})
}
2022-09-27 08:23:04 +02:00
return
}
if err == nil && semver.MajorMinor(mshellVersion) != semver.MajorMinor(scbase.MShellVersion) {
err = fmt.Errorf("mshell version is not compatible current=%s remote=%s", scbase.MShellVersion, mshellVersion)
}
if err != nil {
2022-08-25 07:57:41 +02:00
msh.setErrorStatus(err)
msh.WriteToPtyBuffer("*error connecting to remote: %v\n", err)
go msh.tryAutoInstall()
return
2022-07-01 21:17:19 +02:00
}
msh.updateRemoteStateVars(context.Background(), msh.RemoteId, initPk)
2022-11-28 09:13:00 +01:00
msh.WriteToPtyBuffer("connected state:%s\n", stateBaseHash)
2022-08-25 07:57:41 +02:00
msh.WithLock(func() {
msh.ServerProc = cproc
msh.Status = StatusConnected
go msh.NotifyRemoteUpdate()
2022-08-25 07:57:41 +02:00
})
2022-07-01 21:17:19 +02:00
go func() {
exitErr := cproc.Cmd.Wait()
2022-07-01 21:17:19 +02:00
exitCode := shexec.GetExitCode(exitErr)
msh.WithLock(func() {
2022-09-16 02:44:39 +02:00
if msh.Status == StatusConnected || msh.Status == StatusConnecting {
msh.Status = StatusDisconnected
go msh.NotifyRemoteUpdate()
}
})
2022-09-15 09:37:17 +02:00
msh.WriteToPtyBuffer("*disconnected exitcode=%d\n", exitCode)
2022-07-01 21:17:19 +02:00
}()
go msh.ProcessPackets()
return
}
func (msh *MShellProc) IsConnected() bool {
msh.Lock.Lock()
defer msh.Lock.Unlock()
return msh.Status == StatusConnected
2022-07-01 21:17:19 +02:00
}
func replaceHomePath(pathStr string, homeDir string) string {
if homeDir == "" {
return pathStr
}
if pathStr == homeDir {
return "~"
}
if strings.HasPrefix(pathStr, homeDir+"/") {
return "~" + pathStr[len(homeDir):]
}
return pathStr
}
2022-07-08 07:46:28 +02:00
func (msh *MShellProc) IsCmdRunning(ck base.CommandKey) bool {
msh.Lock.Lock()
defer msh.Lock.Unlock()
2023-12-08 22:39:13 +01:00
for runningCk := range msh.RunningCmds {
2022-07-08 07:46:28 +02:00
if runningCk == ck {
return true
}
}
return false
}
func (msh *MShellProc) SendInput(dataPk *packet.DataPacketType) error {
2022-07-08 07:46:28 +02:00
if !msh.IsConnected() {
return fmt.Errorf("remote is not connected, cannot send input")
}
if !msh.IsCmdRunning(dataPk.CK) {
2022-07-08 07:46:28 +02:00
return fmt.Errorf("cannot send input, cmd is not running")
}
return msh.ServerProc.Input.SendPacket(dataPk)
}
func (msh *MShellProc) SendSpecialInput(siPk *packet.SpecialInputPacketType) error {
if !msh.IsConnected() {
return fmt.Errorf("remote is not connected, cannot send input")
}
if !msh.IsCmdRunning(siPk.CK) {
return fmt.Errorf("cannot send input, cmd is not running")
}
return msh.ServerProc.Input.SendPacket(siPk)
}
func (msh *MShellProc) SendFileData(dataPk *packet.FileDataPacketType) error {
if !msh.IsConnected() {
return fmt.Errorf("remote is not connected, cannot send input")
}
return msh.ServerProc.Input.SendPacket(dataPk)
}
2022-09-04 08:36:15 +02:00
func makeTermOpts(runPk *packet.RunPacketType) sstore.TermOpts {
return sstore.TermOpts{Rows: int64(runPk.TermOpts.Rows), Cols: int64(runPk.TermOpts.Cols), FlexRows: runPk.TermOpts.FlexRows, MaxPtySize: DefaultMaxPtySize}
2022-07-07 09:10:37 +02:00
}
// returns (ok, currentPSC)
func (msh *MShellProc) testAndSetPendingStateCmd(screenId string, rptr sstore.RemotePtrType, newCK *base.CommandKey) (bool, *base.CommandKey) {
key := pendingStateKey{ScreenId: screenId, RemotePtr: rptr}
msh.Lock.Lock()
defer msh.Lock.Unlock()
ck, found := msh.PendingStateCmds[key]
if found {
return false, &ck
}
if newCK != nil {
msh.PendingStateCmds[key] = *newCK
}
return true, nil
}
func (msh *MShellProc) removePendingStateCmd(screenId string, rptr sstore.RemotePtrType, ck base.CommandKey) {
key := pendingStateKey{ScreenId: screenId, RemotePtr: rptr}
msh.Lock.Lock()
defer msh.Lock.Unlock()
existingCK, found := msh.PendingStateCmds[key]
if !found {
return
}
if existingCK == ck {
delete(msh.PendingStateCmds, key)
}
}
// returns (cmdtype, allow-updates-callback, err)
2023-03-15 00:37:22 +01:00
func RunCommand(ctx context.Context, sessionId string, screenId string, remotePtr sstore.RemotePtrType, runPacket *packet.RunPacketType) (rtnCmd *sstore.CmdType, rtnCallback func(), rtnErr error) {
2022-10-28 07:22:17 +02:00
rct := RunCmdType{
SessionId: sessionId,
2023-03-15 00:37:22 +01:00
ScreenId: screenId,
2022-10-28 07:22:17 +02:00
RemotePtr: remotePtr,
RunPacket: runPacket,
}
2022-08-24 22:21:54 +02:00
if remotePtr.OwnerId != "" {
return nil, nil, fmt.Errorf("cannot run command against another user's remote '%s'", remotePtr.MakeFullRemoteRef())
2022-08-24 22:21:54 +02:00
}
2023-03-21 03:20:57 +01:00
if screenId != runPacket.CK.GetGroupId() {
return nil, nil, fmt.Errorf("run commands screenids do not match")
}
2022-08-24 22:21:54 +02:00
msh := GetRemoteById(remotePtr.RemoteId)
if msh == nil {
return nil, nil, fmt.Errorf("no remote id=%s found", remotePtr.RemoteId)
}
if !msh.IsConnected() {
return nil, nil, fmt.Errorf("remote '%s' is not connected", remotePtr.RemoteId)
}
if runPacket.State != nil {
return nil, nil, fmt.Errorf("runPacket.State should not be set, it is set in RunCommand")
}
var newPSC *base.CommandKey
if runPacket.ReturnState {
newPSC = &runPacket.CK
}
ok, existingPSC := msh.testAndSetPendingStateCmd(screenId, remotePtr, newPSC)
if !ok {
2023-07-31 02:16:43 +02:00
line, _, err := sstore.GetLineCmdByLineId(ctx, screenId, existingPSC.GetCmdId())
if err != nil {
return nil, nil, fmt.Errorf("cannot run command while a stateful command is still running: %v", err)
}
if line == nil {
2022-12-28 22:56:19 +01:00
return nil, nil, fmt.Errorf("cannot run command while a stateful command is still running %s", *existingPSC)
}
return nil, nil, fmt.Errorf("cannot run command while a stateful command (linenum=%d) is still running", line.LineNum)
}
startCmdWait(runPacket.CK)
defer func() {
if rtnErr != nil {
2022-10-28 07:22:17 +02:00
removeCmdWait(runPacket.CK)
if newPSC != nil {
msh.removePendingStateCmd(screenId, remotePtr, *newPSC)
}
}
}()
// get current remote-instance state
2023-03-15 00:37:22 +01:00
statePtr, err := sstore.GetRemoteStatePtr(ctx, sessionId, screenId, remotePtr)
if err != nil {
return nil, nil, fmt.Errorf("cannot get current remote stateptr: %w", err)
}
if statePtr == nil {
statePtr = msh.GetDefaultStatePtr()
}
if statePtr == nil {
return nil, nil, fmt.Errorf("cannot run command, no valid remote stateptr")
}
currentState, err := sstore.GetFullState(ctx, *statePtr)
if err != nil || currentState == nil {
return nil, nil, fmt.Errorf("cannot get current remote state: %w", err)
}
runPacket.State = addScVarsToState(currentState)
runPacket.StateComplete = true
msh.ServerProc.Output.RegisterRpc(runPacket.ReqId)
err = shexec.SendRunPacketAndRunData(ctx, msh.ServerProc.Input, runPacket)
if err != nil {
return nil, nil, fmt.Errorf("sending run packet to remote: %w", err)
}
rtnPk := msh.ServerProc.Output.WaitForResponse(ctx, runPacket.ReqId)
if rtnPk == nil {
return nil, nil, ctx.Err()
}
2022-07-07 09:10:37 +02:00
startPk, ok := rtnPk.(*packet.CmdStartPacketType)
if !ok {
respPk, ok := rtnPk.(*packet.ResponsePacketType)
if !ok {
return nil, nil, fmt.Errorf("invalid response received from server for run packet: %s", packet.AsString(rtnPk))
2022-07-07 09:10:37 +02:00
}
if respPk.Error != "" {
return nil, nil, errors.New(respPk.Error)
}
return nil, nil, fmt.Errorf("invalid response received from server for run packet: %s", packet.AsString(rtnPk))
2022-07-07 09:10:37 +02:00
}
status := sstore.CmdStatusRunning
if runPacket.Detached {
status = sstore.CmdStatusDetached
}
2022-07-07 09:10:37 +02:00
cmd := &sstore.CmdType{
2023-07-31 02:16:43 +02:00
ScreenId: runPacket.CK.GetGroupId(),
LineId: runPacket.CK.GetCmdId(),
CmdStr: runPacket.Command,
RawCmdStr: runPacket.Command,
Remote: remotePtr,
FeState: sstore.FeStateFromShellState(currentState),
StatePtr: *statePtr,
TermOpts: makeTermOpts(runPacket),
Status: status,
CmdPid: startPk.Pid,
RemotePid: startPk.MShellPid,
ExitCode: 0,
DurationMs: 0,
RunOut: nil,
RtnState: runPacket.ReturnState,
}
err = sstore.CreateCmdPtyFile(ctx, cmd.ScreenId, cmd.LineId, cmd.TermOpts.MaxPtySize)
if err != nil {
// TODO the cmd is running, so this is a tricky error to handle
return nil, nil, fmt.Errorf("cannot create local ptyout file for running command: %v", err)
}
2022-10-28 07:22:17 +02:00
msh.AddRunningCmd(rct)
return cmd, func() { removeCmdWait(runPacket.CK) }, nil
}
func (msh *MShellProc) AddWaitingCmd(rct RunCmdType) {
msh.Lock.Lock()
defer msh.Lock.Unlock()
msh.WaitingCmds = append(msh.WaitingCmds, rct)
}
func (msh *MShellProc) reExecSingle(rct RunCmdType) {
// TODO fixme
ctx, cancelFn := context.WithTimeout(context.Background(), 15*time.Second)
defer cancelFn()
2023-03-15 00:37:22 +01:00
_, callback, _ := RunCommand(ctx, rct.SessionId, rct.ScreenId, rct.RemotePtr, rct.RunPacket)
if callback != nil {
defer callback()
}
}
func (msh *MShellProc) ReExecWaitingCmds() {
msh.Lock.Lock()
defer msh.Lock.Unlock()
for len(msh.WaitingCmds) > 0 {
rct := msh.WaitingCmds[0]
go msh.reExecSingle(rct)
if rct.RunPacket.ReturnState {
break
}
}
if len(msh.WaitingCmds) == 0 {
msh.WaitingCmds = nil
}
}
2022-10-28 07:22:17 +02:00
func (msh *MShellProc) AddRunningCmd(rct RunCmdType) {
msh.Lock.Lock()
defer msh.Lock.Unlock()
msh.RunningCmds[rct.RunPacket.CK] = rct
}
2022-10-28 07:22:17 +02:00
func (msh *MShellProc) GetRunningCmd(ck base.CommandKey) *RunCmdType {
msh.Lock.Lock()
defer msh.Lock.Unlock()
2022-10-28 07:22:17 +02:00
rct, found := msh.RunningCmds[ck]
if !found {
return nil
}
return &rct
2022-09-27 08:23:04 +02:00
}
func (msh *MShellProc) RemoveRunningCmd(ck base.CommandKey) {
msh.Lock.Lock()
defer msh.Lock.Unlock()
delete(msh.RunningCmds, ck)
for key, pendingCk := range msh.PendingStateCmds {
if pendingCk == ck {
delete(msh.PendingStateCmds, key)
}
}
}
func (msh *MShellProc) PacketRpcIter(ctx context.Context, pk packet.RpcPacketType) (*packet.RpcResponseIter, error) {
if !msh.IsConnected() {
return nil, fmt.Errorf("remote is not connected")
}
if pk == nil {
return nil, fmt.Errorf("PacketRpc passed nil packet")
}
reqId := pk.GetReqId()
msh.ServerProc.Output.RegisterRpc(reqId)
err := msh.ServerProc.Input.SendPacketCtx(ctx, pk)
if err != nil {
return nil, err
}
return msh.ServerProc.Output.GetResponseIter(reqId), nil
}
func (msh *MShellProc) PacketRpcRaw(ctx context.Context, pk packet.RpcPacketType) (packet.RpcResponsePacketType, error) {
if !msh.IsConnected() {
return nil, fmt.Errorf("remote is not connected")
}
2022-07-01 21:17:19 +02:00
if pk == nil {
return nil, fmt.Errorf("PacketRpc passed nil packet")
}
reqId := pk.GetReqId()
msh.ServerProc.Output.RegisterRpc(reqId)
defer msh.ServerProc.Output.UnRegisterRpc(reqId)
err := msh.ServerProc.Input.SendPacketCtx(ctx, pk)
if err != nil {
return nil, err
}
rtnPk := msh.ServerProc.Output.WaitForResponse(ctx, reqId)
if rtnPk == nil {
return nil, ctx.Err()
2022-07-01 21:17:19 +02:00
}
return rtnPk, nil
}
func (msh *MShellProc) PacketRpc(ctx context.Context, pk packet.RpcPacketType) (*packet.ResponsePacketType, error) {
rtnPk, err := msh.PacketRpcRaw(ctx, pk)
if err != nil {
return nil, err
}
if respPk, ok := rtnPk.(*packet.ResponsePacketType); ok {
return respPk, nil
}
return nil, fmt.Errorf("invalid response packet received: %s", packet.AsString(rtnPk))
2022-07-01 21:17:19 +02:00
}
func (msh *MShellProc) WithLock(fn func()) {
msh.Lock.Lock()
defer msh.Lock.Unlock()
fn()
}
func makeDataAckPacket(ck base.CommandKey, fdNum int, ackLen int, err error) *packet.DataAckPacketType {
ack := packet.MakeDataAckPacket()
ack.CK = ck
ack.FdNum = fdNum
ack.AckLen = ackLen
if err != nil {
ack.Error = err.Error()
}
return ack
}
func (msh *MShellProc) notifyHangups_nolock() {
2023-12-08 22:39:13 +01:00
for ck := range msh.RunningCmds {
2023-03-21 03:20:57 +01:00
cmd, err := sstore.GetCmdByScreenId(context.Background(), ck.GetGroupId(), ck.GetCmdId())
if err != nil {
continue
}
update := &sstore.ModelUpdate{Cmd: cmd}
2023-03-21 03:20:57 +01:00
sstore.MainBus.SendScreenUpdate(ck.GetGroupId(), update)
}
2022-10-28 07:22:17 +02:00
msh.RunningCmds = make(map[base.CommandKey]RunCmdType)
msh.PendingStateCmds = make(map[pendingStateKey]base.CommandKey)
msh.WaitingCmds = nil
}
func (msh *MShellProc) handleCmdDonePacket(donePk *packet.CmdDonePacketType) {
2022-10-28 07:22:17 +02:00
// this will remove from RunningCmds and from PendingStateCmds
defer msh.RemoveRunningCmd(donePk.CK)
if donePk.FinalState != nil {
donePk.FinalState = stripScVarsFromState(donePk.FinalState)
}
if donePk.FinalStateDiff != nil {
donePk.FinalStateDiff = stripScVarsFromStateDiff(donePk.FinalStateDiff)
}
2023-07-31 02:16:43 +02:00
update, err := sstore.UpdateCmdDoneInfo(context.Background(), donePk.CK, donePk, sstore.CmdStatusDone)
if err != nil {
2022-10-28 07:22:17 +02:00
msh.WriteToPtyBuffer("*error updating cmddone: %v\n", err)
return
}
screen, err := sstore.UpdateScreenFocusForDoneCmd(context.Background(), donePk.CK.GetGroupId(), donePk.CK.GetCmdId())
if err != nil {
msh.WriteToPtyBuffer("*error trying to update screen focus type: %v\n", err)
// fall-through (nothing to do)
}
2023-03-25 02:35:29 +01:00
if screen != nil {
update.Screens = []*sstore.ScreenType{screen}
}
2022-11-28 09:13:00 +01:00
rct := msh.GetRunningCmd(donePk.CK)
var statePtr *sstore.ShellStatePtr
2022-11-28 09:13:00 +01:00
if donePk.FinalState != nil && rct != nil {
feState := sstore.FeStateFromShellState(donePk.FinalState)
remoteInst, err := sstore.UpdateRemoteState(context.Background(), rct.SessionId, rct.ScreenId, rct.RemotePtr, feState, donePk.FinalState, nil)
2022-11-28 09:13:00 +01:00
if err != nil {
msh.WriteToPtyBuffer("*error trying to update remotestate: %v\n", err)
// fall-through (nothing to do)
}
if remoteInst != nil {
update.Sessions = sstore.MakeSessionsUpdateForRemote(rct.SessionId, remoteInst)
}
statePtr = &sstore.ShellStatePtr{BaseHash: donePk.FinalState.GetHashVal(false)}
2022-11-28 09:13:00 +01:00
} else if donePk.FinalStateDiff != nil && rct != nil {
feState, err := msh.getFeStateFromDiff(donePk.FinalStateDiff)
if err != nil {
msh.WriteToPtyBuffer("*error trying to update remotestate: %v\n", err)
// fall-through (nothing to do)
} else {
remoteInst, err := sstore.UpdateRemoteState(context.Background(), rct.SessionId, rct.ScreenId, rct.RemotePtr, feState, nil, donePk.FinalStateDiff)
2022-10-28 07:22:17 +02:00
if err != nil {
msh.WriteToPtyBuffer("*error trying to update remotestate: %v\n", err)
// fall-through (nothing to do)
}
if remoteInst != nil {
update.Sessions = sstore.MakeSessionsUpdateForRemote(rct.SessionId, remoteInst)
}
diffHashArr := append(([]string)(nil), donePk.FinalStateDiff.DiffHashArr...)
diffHashArr = append(diffHashArr, donePk.FinalStateDiff.GetHashVal(false))
statePtr = &sstore.ShellStatePtr{BaseHash: donePk.FinalStateDiff.BaseHash, DiffHashArr: diffHashArr}
}
}
if statePtr != nil {
err = sstore.UpdateCmdRtnState(context.Background(), donePk.CK, *statePtr)
if err != nil {
msh.WriteToPtyBuffer("*error trying to update cmd rtnstate: %v\n", err)
// fall-through (nothing to do)
2022-10-28 07:22:17 +02:00
}
}
sstore.MainBus.SendUpdate(update)
return
}
func (msh *MShellProc) handleCmdFinalPacket(finalPk *packet.CmdFinalPacketType) {
defer msh.RemoveRunningCmd(finalPk.CK)
2023-03-21 03:20:57 +01:00
rtnCmd, err := sstore.GetCmdByScreenId(context.Background(), finalPk.CK.GetGroupId(), finalPk.CK.GetCmdId())
if err != nil {
log.Printf("error calling GetCmdById in handleCmdFinalPacket: %v\n", err)
return
}
2023-07-31 02:16:43 +02:00
if rtnCmd == nil || rtnCmd.DoneTs > 0 {
return
}
log.Printf("finalpk %s (hangup): %s\n", finalPk.CK, finalPk.Error)
screen, err := sstore.HangupCmd(context.Background(), finalPk.CK)
if err != nil {
log.Printf("error in hangup-cmd in handleCmdFinalPacket: %v\n", err)
return
}
2023-03-21 03:20:57 +01:00
rtnCmd, err = sstore.GetCmdByScreenId(context.Background(), finalPk.CK.GetGroupId(), finalPk.CK.GetCmdId())
if err != nil {
log.Printf("error getting cmd(2) in handleCmdFinalPacket: %v\n", err)
return
}
if rtnCmd == nil {
log.Printf("error getting cmd(2) in handleCmdFinalPacket (not found)\n")
return
}
update := &sstore.ModelUpdate{Cmd: rtnCmd}
if screen != nil {
update.Screens = []*sstore.ScreenType{screen}
}
sstore.MainBus.SendUpdate(update)
}
// TODO notify FE about cmd errors
func (msh *MShellProc) handleCmdErrorPacket(errPk *packet.CmdErrorPacketType) {
err := sstore.AppendCmdErrorPk(context.Background(), errPk)
if err != nil {
2022-09-15 08:10:35 +02:00
msh.WriteToPtyBuffer("cmderr> [remote %s] [error] adding cmderr: %v\n", msh.GetRemoteName(), err)
return
}
return
}
func (msh *MShellProc) handleDataPacket(dataPk *packet.DataPacketType, dataPosMap map[base.CommandKey]int64) {
realData, err := base64.StdEncoding.DecodeString(dataPk.Data64)
if err != nil {
ack := makeDataAckPacket(dataPk.CK, dataPk.FdNum, 0, err)
msh.ServerProc.Input.SendPacket(ack)
return
}
var ack *packet.DataAckPacketType
if len(realData) > 0 {
dataPos := dataPosMap[dataPk.CK]
rcmd := msh.GetRunningCmd(dataPk.CK)
2023-03-21 03:20:57 +01:00
update, err := sstore.AppendToCmdPtyBlob(context.Background(), rcmd.ScreenId, dataPk.CK.GetCmdId(), realData, dataPos)
2022-08-20 02:14:53 +02:00
if err != nil {
ack = makeDataAckPacket(dataPk.CK, dataPk.FdNum, 0, err)
} else {
ack = makeDataAckPacket(dataPk.CK, dataPk.FdNum, len(realData), nil)
}
dataPosMap[dataPk.CK] += int64(len(realData))
if update != nil {
2023-03-21 03:20:57 +01:00
sstore.MainBus.SendScreenUpdate(dataPk.CK.GetGroupId(), update)
}
}
if ack != nil {
msh.ServerProc.Input.SendPacket(ack)
}
2022-10-31 20:40:45 +01:00
// log.Printf("data %s fd=%d len=%d eof=%v err=%v\n", dataPk.CK, dataPk.FdNum, len(realData), dataPk.Eof, dataPk.Error)
}
func (msh *MShellProc) makeHandleDataPacketClosure(dataPk *packet.DataPacketType, dataPosMap map[base.CommandKey]int64) func() {
return func() {
msh.handleDataPacket(dataPk, dataPosMap)
}
}
func (msh *MShellProc) makeHandleCmdDonePacketClosure(donePk *packet.CmdDonePacketType) func() {
return func() {
msh.handleCmdDonePacket(donePk)
}
}
func (msh *MShellProc) makeHandleCmdFinalPacketClosure(finalPk *packet.CmdFinalPacketType) func() {
return func() {
msh.handleCmdFinalPacket(finalPk)
}
}
func sendScreenUpdates(screens []*sstore.ScreenType) {
for _, screen := range screens {
sstore.MainBus.SendUpdate(&sstore.ModelUpdate{Screens: []*sstore.ScreenType{screen}})
}
}
func (msh *MShellProc) ProcessPackets() {
defer msh.WithLock(func() {
if msh.Status == StatusConnected {
msh.Status = StatusDisconnected
}
screens, err := sstore.HangupRunningCmdsByRemoteId(context.Background(), msh.Remote.RemoteId)
if err != nil {
2022-09-15 08:10:35 +02:00
msh.writeToPtyBuffer_nolock("error calling HUP on cmds %v\n", err)
}
msh.notifyHangups_nolock()
go msh.NotifyRemoteUpdate()
if len(screens) > 0 {
go sendScreenUpdates(screens)
}
})
// TODO need to clean dataPosMap
2022-08-13 19:27:22 +02:00
dataPosMap := make(map[base.CommandKey]int64)
for pk := range msh.ServerProc.Output.MainCh {
if pk.GetType() == packet.DataPacketStr {
dataPk := pk.(*packet.DataPacketType)
runCmdUpdateFn(dataPk.CK, msh.makeHandleDataPacketClosure(dataPk, dataPosMap))
continue
2022-07-01 21:17:19 +02:00
}
if pk.GetType() == packet.DataAckPacketStr {
// TODO process ack (need to keep track of buffer size for sending)
// this is low priority though since most input is coming from keyboard and won't overflow this buffer
continue
}
2022-07-01 21:17:19 +02:00
if pk.GetType() == packet.CmdDataPacketStr {
dataPacket := pk.(*packet.CmdDataPacketType)
2022-09-15 08:10:35 +02:00
msh.WriteToPtyBuffer("cmd-data> [remote %s] [%s] pty=%d run=%d\n", msh.GetRemoteName(), dataPacket.CK, dataPacket.PtyDataLen, dataPacket.RunDataLen)
2022-07-01 21:17:19 +02:00
continue
}
if pk.GetType() == packet.CmdDonePacketStr {
donePk := pk.(*packet.CmdDonePacketType)
runCmdUpdateFn(donePk.CK, msh.makeHandleCmdDonePacketClosure(donePk))
continue
}
if pk.GetType() == packet.CmdFinalPacketStr {
finalPk := pk.(*packet.CmdFinalPacketType)
runCmdUpdateFn(finalPk.CK, msh.makeHandleCmdFinalPacketClosure(finalPk))
continue
}
if pk.GetType() == packet.CmdErrorPacketStr {
msh.handleCmdErrorPacket(pk.(*packet.CmdErrorPacketType))
2022-07-01 21:17:19 +02:00
continue
}
if pk.GetType() == packet.MessagePacketStr {
msgPacket := pk.(*packet.MessagePacketType)
2022-09-15 08:10:35 +02:00
msh.WriteToPtyBuffer("msg> [remote %s] [%s] %s\n", msh.GetRemoteName(), msgPacket.CK, msgPacket.Message)
2022-07-01 21:17:19 +02:00
continue
}
if pk.GetType() == packet.RawPacketStr {
rawPacket := pk.(*packet.RawPacketType)
2022-09-15 08:10:35 +02:00
msh.WriteToPtyBuffer("stderr> [remote %s] %s\n", msh.GetRemoteName(), rawPacket.Data)
2022-07-01 21:17:19 +02:00
continue
}
if pk.GetType() == packet.CmdStartPacketStr {
startPk := pk.(*packet.CmdStartPacketType)
2022-09-15 08:10:35 +02:00
msh.WriteToPtyBuffer("start> [remote %s] reqid=%s (%p)\n", msh.GetRemoteName(), startPk.RespId, msh.ServerProc.Output)
continue
}
2022-09-15 08:10:35 +02:00
msh.WriteToPtyBuffer("MSH> [remote %s] unhandled packet %s\n", msh.GetRemoteName(), packet.AsString(pk))
2022-07-01 21:17:19 +02:00
}
}
2022-08-24 06:05:49 +02:00
// returns number of chars (including braces) for brace-expr
func getBracedStr(runeStr []rune) int {
if len(runeStr) < 3 {
return 0
}
if runeStr[0] != '{' {
return 0
2022-08-24 06:05:49 +02:00
}
for i := 1; i < len(runeStr); i++ {
if runeStr[i] == '}' {
if i == 1 { // cannot have {}
return 0
}
return i + 1
}
}
return 0
}
func isDigit(r rune) bool {
return r >= '0' && r <= '9' // just check ascii digits (not unicode)
}
func EvalPrompt(promptFmt string, vars map[string]string, state *packet.ShellState) string {
var buf bytes.Buffer
promptRunes := []rune(promptFmt)
for i := 0; i < len(promptRunes); i++ {
ch := promptRunes[i]
if ch == '\\' && i != len(promptRunes)-1 {
nextCh := promptRunes[i+1]
if nextCh == 'x' || nextCh == 'y' {
nr := getBracedStr(promptRunes[i+2:])
if nr > 0 {
escCode := string(promptRunes[i+1 : i+1+nr+1]) // start at "x" or "y", extend nr+1 runes
escStr := evalPromptEsc(escCode, vars, state)
buf.WriteString(escStr)
i += nr + 1
continue
} else {
buf.WriteRune(ch) // invalid escape, so just write ch and move on
continue
}
} else if isDigit(nextCh) {
if len(promptRunes) >= i+4 && isDigit(promptRunes[i+2]) && isDigit(promptRunes[i+3]) {
i += 3
escStr := evalPromptEsc(string(promptRunes[i+1:i+4]), vars, state)
buf.WriteString(escStr)
continue
} else {
buf.WriteRune(ch) // invalid escape, so just write ch and move on
continue
}
} else {
i += 1
escStr := evalPromptEsc(string(nextCh), vars, state)
buf.WriteString(escStr)
continue
}
}
buf.WriteRune(ch)
}
return buf.String()
}
func evalPromptEsc(escCode string, vars map[string]string, state *packet.ShellState) string {
2022-08-24 06:05:49 +02:00
if strings.HasPrefix(escCode, "x{") && strings.HasSuffix(escCode, "}") {
varName := escCode[2 : len(escCode)-1]
return vars[varName]
}
if strings.HasPrefix(escCode, "y{") && strings.HasSuffix(escCode, "}") {
if state == nil {
return ""
}
2022-08-24 06:05:49 +02:00
varName := escCode[2 : len(escCode)-1]
2022-10-25 21:31:29 +02:00
varMap := shexec.ShellVarMapFromState(state)
2022-08-24 06:05:49 +02:00
return varMap[varName]
}
if escCode == "h" {
return vars["remoteshorthost"]
}
if escCode == "H" {
return vars["remotehost"]
}
if escCode == "s" {
return "mshell"
}
if escCode == "u" {
return vars["remoteuser"]
}
if escCode == "w" {
if state == nil {
return "?"
}
return replaceHomePath(state.Cwd, vars["home"])
2022-08-24 06:05:49 +02:00
}
if escCode == "W" {
if state == nil {
return "?"
}
return path.Base(replaceHomePath(state.Cwd, vars["home"]))
2022-08-24 06:05:49 +02:00
}
if escCode == "$" {
if vars["remoteuser"] == "root" || vars["sudo"] == "1" {
2022-08-24 06:05:49 +02:00
return "#"
} else {
return "$"
}
}
if len(escCode) == 3 {
// \nnn escape
ival, err := strconv.ParseInt(escCode, 8, 32)
if err != nil {
return escCode
}
if ival >= 0 && ival <= 255 {
return string([]byte{byte(ival)})
} else {
// if it was out of range just return the string (invalid escape)
return escCode
}
2022-08-24 06:05:49 +02:00
}
if escCode == "e" {
return "\033"
}
if escCode == "n" {
return "\n"
}
if escCode == "r" {
return "\r"
}
if escCode == "a" {
return "\007"
}
if escCode == "\\" {
return "\\"
}
if escCode == "[" {
return ""
}
if escCode == "]" {
return ""
}
// we don't support date/time escapes (d, t, T, @), version escapes (v, V), cmd number (#, !), terminal device (l), jobs (j)
2022-08-24 06:05:49 +02:00
return "(" + escCode + ")"
}
2022-11-28 09:13:00 +01:00
func (msh *MShellProc) getFullState(stateDiff *packet.ShellStateDiff) (*packet.ShellState, error) {
baseState := msh.GetStateByHash(stateDiff.BaseHash)
if baseState != nil && len(stateDiff.DiffHashArr) == 0 {
newState, err := shexec.ApplyShellStateDiff(*baseState, *stateDiff)
if err != nil {
return nil, err
}
return &newState, nil
} else {
2023-12-08 22:39:13 +01:00
fullState, err := sstore.GetFullState(context.Background(), sstore.ShellStatePtr{BaseHash: stateDiff.BaseHash, DiffHashArr: stateDiff.DiffHashArr})
2022-11-28 09:13:00 +01:00
if err != nil {
return nil, err
}
newState, err := shexec.ApplyShellStateDiff(*fullState, *stateDiff)
return &newState, nil
}
}
// internal func, first tries the StateMap, otherwise will fallback on sstore.GetFullState
func (msh *MShellProc) getFeStateFromDiff(stateDiff *packet.ShellStateDiff) (map[string]string, error) {
2022-11-28 09:13:00 +01:00
baseState := msh.GetStateByHash(stateDiff.BaseHash)
if baseState != nil && len(stateDiff.DiffHashArr) == 0 {
newState, err := shexec.ApplyShellStateDiff(*baseState, *stateDiff)
if err != nil {
return nil, err
}
return sstore.FeStateFromShellState(&newState), nil
} else {
2023-12-08 22:39:13 +01:00
fullState, err := sstore.GetFullState(context.Background(), sstore.ShellStatePtr{BaseHash: stateDiff.BaseHash, DiffHashArr: stateDiff.DiffHashArr})
2022-11-28 09:13:00 +01:00
if err != nil {
return nil, err
}
newState, err := shexec.ApplyShellStateDiff(*fullState, *stateDiff)
if err != nil {
return nil, err
}
return sstore.FeStateFromShellState(&newState), nil
}
}
2022-12-28 22:56:19 +01:00
func (msh *MShellProc) TryAutoConnect() error {
if msh.IsConnected() {
return nil
}
rcopy := msh.GetRemoteCopy()
2022-12-29 01:59:54 +01:00
if rcopy.ConnectMode == sstore.ConnectModeManual {
2022-12-28 22:56:19 +01:00
return nil
}
var err error
msh.WithLock(func() {
if msh.NumTryConnect > 5 {
2022-12-29 01:59:54 +01:00
err = fmt.Errorf("too many unsuccessful tries")
2022-12-28 22:56:19 +01:00
return
}
msh.NumTryConnect++
})
if err != nil {
return err
}
msh.Launch(false)
2022-12-29 01:59:54 +01:00
if !msh.IsConnected() {
return fmt.Errorf("error connecting")
}
2022-12-28 22:56:19 +01:00
return nil
}
2022-12-31 02:01:17 +01:00
func (msh *MShellProc) GetDisplayName() string {
rcopy := msh.GetRemoteCopy()
return rcopy.GetName()
}