From eeaeac8dc80e14bb866ff1f84716064be5d44fab Mon Sep 17 00:00:00 2001 From: sawka Date: Fri, 10 Jun 2022 00:35:24 -0700 Subject: [PATCH] initial runner commit --- LICENSE | 373 +++++++++++++++++++++++++++++++++++++++++++ NOTICE.md | 5 + go.mod | 8 + go.sum | 4 + main-runner.go | 60 +++++++ pkg/base/base.go | 156 ++++++++++++++++++ pkg/packet/packet.go | 187 ++++++++++++++++++++++ pkg/shexec/shexec.go | 226 ++++++++++++++++++++++++++ 8 files changed, 1019 insertions(+) create mode 100644 LICENSE create mode 100644 NOTICE.md create mode 100644 go.mod create mode 100644 go.sum create mode 100644 main-runner.go create mode 100644 pkg/base/base.go create mode 100644 pkg/packet/packet.go create mode 100644 pkg/shexec/shexec.go diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..ee6256cd --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at https://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/NOTICE.md b/NOTICE.md new file mode 100644 index 00000000..5a9ef9f4 --- /dev/null +++ b/NOTICE.md @@ -0,0 +1,5 @@ +Copyright (c) 2021-2022 Dashborg Inc + +This Source Code Form is subject to the terms of the Mozilla Public +License, v. 2.0. If a copy of the MPL was not distributed with this +file, You can obtain one at https://mozilla.org/MPL/2.0/. diff --git a/go.mod b/go.mod new file mode 100644 index 00000000..a794172c --- /dev/null +++ b/go.mod @@ -0,0 +1,8 @@ +module github.com/scripthaus-dev/sh2-runner + +go 1.17 + +require ( + github.com/creack/pty v1.1.18 // indirect + github.com/google/uuid v1.3.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 00000000..12d5eadc --- /dev/null +++ b/go.sum @@ -0,0 +1,4 @@ +github.com/creack/pty v1.1.18 h1:n56/Zwd5o6whRC5PMGretI4IdRLlmBXYNjScPaBgsbY= +github.com/creack/pty v1.1.18/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= +github.com/google/uuid v1.3.0 h1:t6JiXgmwXMjEs8VusXIJk2BXHsn+wx8BZdTaoZ5fu7I= +github.com/google/uuid v1.3.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= diff --git a/main-runner.go b/main-runner.go new file mode 100644 index 00000000..04fb9f4a --- /dev/null +++ b/main-runner.go @@ -0,0 +1,60 @@ +// Copyright 2022 Dashborg Inc +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at https://mozilla.org/MPL/2.0/. + +package main + +import ( + "fmt" + "os" + "os/signal" + "syscall" + + "github.com/scripthaus-dev/sh2-runner/pkg/packet" + "github.com/scripthaus-dev/sh2-runner/pkg/shexec" +) + +func setupSignals(cmd *shexec.ShExecType) { + sigCh := make(chan os.Signal, 1) + signal.Notify(sigCh, syscall.SIGINT, syscall.SIGTERM) + go func() { + for sig := range sigCh { + cmd.Cmd.Process.Signal(sig) + } + }() +} + +func main() { + packetCh := packet.PacketParser(os.Stdin) + var runPacket *packet.RunPacketType + for pk := range packetCh { + if pk.GetType() == packet.PingPacketStr { + continue + } + if pk.GetType() == packet.RunPacketStr { + runPacket, _ = pk.(*packet.RunPacketType) + break + } + if pk.GetType() == packet.ErrorPacketStr { + packet.SendPacket(os.Stdout, pk) + return + } + packet.SendErrorPacket(os.Stdout, fmt.Sprintf("invalid packet '%s' sent to runner", pk.GetType())) + return + } + if runPacket == nil { + packet.SendErrorPacket(os.Stdout, "did not receive a 'run' packet") + return + } + cmd, err := shexec.RunCommand(runPacket) + if err != nil { + packet.SendErrorPacket(os.Stdout, fmt.Sprintf("error running command: %v", err)) + return + } + setupSignals(cmd) + packet.SendPacket(os.Stdout, packet.MakeOkCmdPacket(fmt.Sprintf("running command %s/%s", runPacket.SessionId, runPacket.CmdId), runPacket.CmdId, cmd.Cmd.Process.Pid)) + cmd.WaitForCommand() + packet.SendPacket(os.Stdout, packet.MakeDonePacket()) +} diff --git a/pkg/base/base.go b/pkg/base/base.go new file mode 100644 index 00000000..ae6774ce --- /dev/null +++ b/pkg/base/base.go @@ -0,0 +1,156 @@ +// Copyright 2022 Dashborg Inc +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at https://mozilla.org/MPL/2.0/. + +package base + +import ( + "errors" + "fmt" + "io/fs" + "os" + "path" + "path/filepath" +) + +const ScRunnerVarName = "SCRIPTHAUS_RUNNER" +const ScHomeVarName = "SCRIPTHAUS_HOME" +const HomeVarName = "HOME" +const ScShell = "bash" +const SessionsDirBaseName = ".sessions" +const RunnerBaseName = "runner" +const SessionDBName = "session.db" +const ScReadyString = "scripthaus runner ready" + +const OSCEscError = "error" + +type CommandFileNames struct { + PtyOutFile string + StdinFifo string + DoneFile string +} + +func GetScHomeDir() (string, error) { + scHome := os.Getenv(ScHomeVarName) + if scHome == "" { + homeVar := os.Getenv(HomeVarName) + if homeVar == "" { + return "", fmt.Errorf("Cannot resolve scripthaus home directory (SCRIPTHAUS_HOME and HOME not set)") + } + scHome = path.Join(homeVar, "scripthaus") + } + return scHome, nil +} + +func GetCommandFileNames(sessionId string, cmdId string) (*CommandFileNames, error) { + if sessionId == "" || cmdId == "" { + return nil, fmt.Errorf("cannot get command-files when sessionid or cmdid is empty") + } + sdir, err := EnsureSessionDir(sessionId) + if err != nil { + return nil, err + } + base := path.Join(sdir, cmdId) + return &CommandFileNames{ + PtyOutFile: base + ".ptyout", + StdinFifo: base + ".stdin", + DoneFile: base + ".done", + }, nil +} + +func CleanUpCmdFiles(sessionId string, cmdId string) error { + if cmdId == "" { + return fmt.Errorf("bad cmdid, cannot clean up") + } + sdir, err := EnsureSessionDir(sessionId) + if err != nil { + return err + } + cmdFileGlob := path.Join(sdir, cmdId+".*") + matches, err := filepath.Glob(cmdFileGlob) + if err != nil { + return err + } + for _, file := range matches { + rmErr := os.Remove(file) + if err == nil && rmErr != nil { + err = rmErr + } + } + return err +} + +func EnsureSessionDir(sessionId string) (string, error) { + if sessionId == "" { + return "", fmt.Errorf("Bad sessionid, cannot be empty") + } + shhome, err := GetScHomeDir() + if err != nil { + return "", err + } + sdir := path.Join(shhome, ".sessions", sessionId) + info, err := os.Stat(sdir) + if errors.Is(err, fs.ErrNotExist) { + err = os.MkdirAll(sdir, 0777) + if err != nil { + return "", err + } + info, err = os.Stat(sdir) + } + if err != nil { + return "", err + } + if !info.IsDir() { + return "", fmt.Errorf("session dir '%s' must be a directory", sdir) + } + return sdir, nil +} + +func GetScRunnerPath() string { + runnerPath := os.Getenv(ScRunnerVarName) + if runnerPath != "" { + return runnerPath + } + scHome, err := GetScHomeDir() + if err != nil { + panic(err) + } + return path.Join(scHome, RunnerBaseName) +} + +func GetScSessionsDir() string { + scHome, err := GetScHomeDir() + if err != nil { + panic(err) + } + return path.Join(scHome, SessionsDirBaseName) +} + +func GetSessionDBName(sessionId string) string { + scHome, err := GetScHomeDir() + if err != nil { + panic(err) + } + return path.Join(scHome, SessionDBName) +} + +// SH OSC Escapes (code 198, S=19, H=8) +// \e]198;cmdid;(cmd-id)BEL - return command-id to server +// \e]198;remote;0BEL - runner program not available +// \e]198;remote;1BEL - runner program is available +// \e]198;error;(error-str)BEL - communicate an internal error +func MakeSHOSCEsc(escName string, data string) string { + return fmt.Sprintf("\033]198;%s;%s\007", escName, data) +} + +func WriteErrorMsg(fileName string, errVal string) error { + fd, err := os.OpenFile(fileName, os.O_APPEND|os.O_WRONLY, 0600) + if err != nil { + return err + } + oscEsc := MakeSHOSCEsc(OSCEscError, errVal) + _, writeErr := fd.Write([]byte(oscEsc)) + return writeErr +} diff --git a/pkg/packet/packet.go b/pkg/packet/packet.go new file mode 100644 index 00000000..52e3a0da --- /dev/null +++ b/pkg/packet/packet.go @@ -0,0 +1,187 @@ +// Copyright 2022 Dashborg Inc +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at https://mozilla.org/MPL/2.0/. + +package packet + +import ( + "bufio" + "encoding/json" + "fmt" + "io" +) + +const RunPacketStr = "run" +const PingPacketStr = "ping" +const DonePacketStr = "done" +const ErrorPacketStr = "error" +const OkCmdPacketStr = "okcmd" + +type PingPacketType struct { + Type string `json:"type"` +} + +func (*PingPacketType) GetType() string { + return PingPacketStr +} + +func MakePingPacket() *PingPacketType { + return &PingPacketType{Type: PingPacketStr} +} + +type DonePacketType struct { + Type string `json:"type"` +} + +func (*DonePacketType) GetType() string { + return DonePacketStr +} + +func MakeDonePacket() *DonePacketType { + return &DonePacketType{Type: DonePacketStr} +} + +type OkCmdPacketType struct { + Type string `json:"type"` + Message string `json:"message"` + CmdId string `json:"cmdid"` + Pid int `json:"pid"` +} + +func (*OkCmdPacketType) GetType() string { + return OkCmdPacketStr +} + +func MakeOkCmdPacket(message string, cmdId string, pid int) *OkCmdPacketType { + return &OkCmdPacketType{Type: OkCmdPacketStr, Message: message, CmdId: cmdId, Pid: pid} +} + +type RunPacketType struct { + Type string `json:"type"` + SessionId string `json:"sessionid"` + CmdId string `json:"cmdid"` + ChDir string `json:"chdir"` + Env map[string]string `json:"env"` + Command string `json:"command"` +} + +func (ct *RunPacketType) GetType() string { + return RunPacketStr +} + +type BarePacketType struct { + Type string `json:"type"` +} + +type ErrorPacketType struct { + Type string `json:"type"` + Error string `json:"error"` +} + +func (et *ErrorPacketType) GetType() string { + return ErrorPacketStr +} + +func MakeErrorPacket(errorStr string) *ErrorPacketType { + return &ErrorPacketType{Type: ErrorPacketStr, Error: errorStr} +} + +type PacketType interface { + GetType() string +} + +func ParseJsonPacket(jsonBuf []byte) (PacketType, error) { + var bareCmd BarePacketType + err := json.Unmarshal(jsonBuf, &bareCmd) + if err != nil { + return nil, err + } + if bareCmd.Type == "" { + return nil, fmt.Errorf("received packet with no type") + } + if bareCmd.Type == RunPacketStr { + var runPacket RunPacketType + err = json.Unmarshal(jsonBuf, &runPacket) + if err != nil { + return nil, err + } + return &runPacket, nil + } + if bareCmd.Type == PingPacketStr { + return MakePingPacket(), nil + } + if bareCmd.Type == DonePacketStr { + return MakeDonePacket(), nil + } + if bareCmd.Type == ErrorPacketStr { + var errorPacket ErrorPacketType + err = json.Unmarshal(jsonBuf, &errorPacket) + if err != nil { + return nil, err + } + return &errorPacket, nil + } + if bareCmd.Type == OkCmdPacketStr { + var okPacket OkCmdPacketType + err = json.Unmarshal(jsonBuf, &okPacket) + if err != nil { + return nil, err + } + return &okPacket, nil + } + return nil, fmt.Errorf("invalid packet-type '%s'", bareCmd.Type) +} + +func SendPacket(w io.Writer, packet PacketType) error { + if packet == nil { + return nil + } + barr, err := json.Marshal(packet) + if err != nil { + return fmt.Errorf("marshaling '%s' packet: %w", packet.GetType(), err) + } + barr = append(barr, '\n') + _, err = w.Write(barr) + if err != nil { + return err + } + return nil +} + +func SendErrorPacket(w io.Writer, errorStr string) error { + return SendPacket(w, MakeErrorPacket(errorStr)) +} + +func PacketParser(input io.Reader) chan PacketType { + bufReader := bufio.NewReader(input) + rtnCh := make(chan PacketType) + go func() { + defer func() { + close(rtnCh) + }() + for { + line, err := bufReader.ReadString('\n') + if err == io.EOF { + return + } + if err != nil { + errPacket := MakeErrorPacket(fmt.Sprintf("reading packets from input: %v", err)) + rtnCh <- errPacket + return + } + pk, err := ParseJsonPacket([]byte(line)) + if err != nil { + errPk := MakeErrorPacket(fmt.Sprintf("parsing packet json from input: %v", err)) + rtnCh <- errPk + return + } + if pk.GetType() == DonePacketStr { + return + } + rtnCh <- pk + } + }() + return rtnCh +} diff --git a/pkg/shexec/shexec.go b/pkg/shexec/shexec.go new file mode 100644 index 00000000..4ef5f660 --- /dev/null +++ b/pkg/shexec/shexec.go @@ -0,0 +1,226 @@ +// Copyright 2022 Dashborg Inc +// +// This Source Code Form is subject to the terms of the Mozilla Public +// License, v. 2.0. If a copy of the MPL was not distributed with this +// file, You can obtain one at https://mozilla.org/MPL/2.0/. + +package shexec + +import ( + "encoding/json" + "errors" + "fmt" + "io" + "io/fs" + "os" + "os/exec" + "strings" + "syscall" + "time" + + "github.com/creack/pty" + "github.com/google/uuid" + "github.com/scripthaus-dev/sh2-runner/pkg/base" + "github.com/scripthaus-dev/sh2-runner/pkg/packet" +) + +type DoneData struct { + DurationMs int64 `json:"durationms"` + ExitCode int `json:"exitcode"` +} + +type ShExecType struct { + FileNames *base.CommandFileNames + Cmd *exec.Cmd + CmdPty *os.File + StartTs time.Time +} + +func (c *ShExecType) Close() { + c.CmdPty.Close() +} + +func getEnvStrKey(envStr string) string { + eqIdx := strings.Index(envStr, "=") + if eqIdx == -1 { + return envStr + } + return envStr[0:eqIdx] +} + +func UpdateCmdEnv(cmd *exec.Cmd, envVars map[string]string) { + if len(envVars) == 0 { + return + } + if cmd.Env != nil { + cmd.Env = os.Environ() + } + found := make(map[string]bool) + var newEnv []string + for _, envStr := range cmd.Env { + envKey := getEnvStrKey(envStr) + newEnvVal, ok := envVars[envKey] + if ok { + if newEnvVal == "" { + continue + } + newEnv = append(newEnv, envKey+"="+newEnvVal) + found[envKey] = true + } else { + newEnv = append(newEnv, envStr) + } + } + for envKey, envVal := range envVars { + if found[envKey] { + continue + } + newEnv = append(newEnv, envKey+"="+envVal) + } + cmd.Env = newEnv +} + +func MakeExecCmd(pk *packet.RunPacketType, cmdTty *os.File) *exec.Cmd { + ecmd := exec.Command("bash", "-c", pk.Command) + UpdateCmdEnv(ecmd, pk.Env) + if pk.ChDir != "" { + ecmd.Dir = pk.ChDir + } + ecmd.Stdin = cmdTty + ecmd.Stdout = cmdTty + ecmd.Stderr = cmdTty + ecmd.SysProcAttr = &syscall.SysProcAttr{ + Setsid: true, + Setctty: true, + } + return ecmd +} + +// this will never return (unless there is an error creating/opening the file), as fifoFile will never EOF +func MakeAndCopyStdinFifo(dst *os.File, fifoName string) error { + os.Remove(fifoName) + err := syscall.Mkfifo(fifoName, 0600) // only read/write from user for security + if err != nil { + return fmt.Errorf("cannot make stdin-fifo '%s': %v", fifoName, err) + } + // rw is non-blocking, will keep the fifo "open" for the blocking reader + rwfd, err := os.OpenFile(fifoName, os.O_RDWR, 0600) + if err != nil { + return fmt.Errorf("cannot open stdin-fifo(1) '%s': %v", fifoName, err) + } + defer rwfd.Close() + fifoReader, err := os.Open(fifoName) // blocking open/reads (open won't block because of rwfd) + if err != nil { + return fmt.Errorf("cannot open stdin-fifo(2) '%s': %w", fifoName, err) + } + defer fifoReader.Close() + io.Copy(dst, fifoReader) + return nil +} + +func ValidateRunPacket(pk *packet.RunPacketType) error { + if pk.Type != packet.RunPacketStr { + return fmt.Errorf("run packet has wrong type: %s", pk.Type) + } + if pk.SessionId == "" { + return fmt.Errorf("run packet does not have sessionid") + } + _, err := uuid.Parse(pk.SessionId) + if err != nil { + return fmt.Errorf("invalid sessionid '%s' for command", pk.SessionId) + } + if pk.CmdId == "" { + return fmt.Errorf("run packet does not have cmdid") + } + _, err = uuid.Parse(pk.CmdId) + if err != nil { + return fmt.Errorf("invalid cmdid '%s' for command", pk.CmdId) + } + if pk.ChDir != "" { + dirInfo, err := os.Stat(pk.ChDir) + if err != nil { + return fmt.Errorf("invalid cwd '%s' for command: %v", pk.ChDir, err) + } + if !dirInfo.IsDir() { + return fmt.Errorf("invalid cwd '%s' for command, not a directory", pk.ChDir) + } + } + return nil +} + +// returning nil error means the process has successfully been kicked-off +func RunCommand(pk *packet.RunPacketType) (*ShExecType, error) { + if pk.CmdId == "" { + pk.CmdId = uuid.New().String() + } + err := ValidateRunPacket(pk) + if err != nil { + return nil, err + } + fileNames, err := base.GetCommandFileNames(pk.SessionId, pk.CmdId) + if err != nil { + return nil, err + } + if _, err = os.Stat(fileNames.PtyOutFile); !errors.Is(err, fs.ErrNotExist) { + return nil, fmt.Errorf("cmdid '%s' was already used", pk.CmdId) + } + cmdPty, cmdTty, err := pty.Open() + if err != nil { + return nil, fmt.Errorf("opening new pty: %w", err) + } + defer func() { + cmdTty.Close() + }() + startTs := time.Now() + ecmd := MakeExecCmd(pk, cmdTty) + err = ecmd.Start() + if err != nil { + return nil, fmt.Errorf("starting command: %w", err) + } + ptyOutFd, err := os.OpenFile(fileNames.PtyOutFile, os.O_TRUNC|os.O_CREATE|os.O_WRONLY, 0600) + if err != nil { + return nil, fmt.Errorf("cannot open ptyout file '%s': %w", fileNames.PtyOutFile, err) + } + go func() { + // copy pty output to .ptyout file + _, copyErr := io.Copy(ptyOutFd, cmdPty) + if copyErr != nil { + base.WriteErrorMsg(fileNames.PtyOutFile, fmt.Sprintf("copying pty output to ptyout file: %v", copyErr)) + } + }() + go func() { + // copy .stdin fifo contents to pty input + copyFifoErr := MakeAndCopyStdinFifo(cmdPty, fileNames.StdinFifo) + if copyFifoErr != nil { + base.WriteErrorMsg(fileNames.PtyOutFile, fmt.Sprintf("reading from stdin fifo: %v", copyFifoErr)) + } + }() + return &ShExecType{ + FileNames: fileNames, + Cmd: ecmd, + CmdPty: cmdPty, + StartTs: startTs, + }, nil +} + +func (c *ShExecType) WaitForCommand() { + err := c.Cmd.Wait() + cmdDuration := time.Since(c.StartTs) + exitCode := 0 + if err != nil { + exitErr, ok := err.(*exec.ExitError) + if ok { + exitCode = exitErr.ExitCode() + } + } + doneData := DoneData{ + DurationMs: int64(cmdDuration / time.Millisecond), + ExitCode: exitCode, + } + doneDataBytes, _ := json.Marshal(doneData) + doneDataBytes = append(doneDataBytes, '\n') + err = os.WriteFile(c.FileNames.DoneFile, doneDataBytes, 0600) + if err != nil { + base.WriteErrorMsg(c.FileNames.PtyOutFile, fmt.Sprintf("reading from stdin fifo: %v", err)) + } + return +}