sshcode/sshcode.go at master · AlexSJ/sshcode · GitHub

Repository navigation

History

427 lines (356 loc) · 9.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

package main

import (

"context"

"fmt"

"math/rand"

"net"

"net/http"

"os"

"os/exec"

"os/signal"

"path/filepath"

"strconv"

"strings"

"time"

"github.com/pkg/browser"

"go.coder.com/flog"

"golang.org/x/xerrors"

)

const codeServerPath = "~/.cache/sshcode/sshcode-server"

type options struct {

skipSync bool

syncBack bool

noOpen bool

bindAddr string

remotePort string

sshFlags string

}

func sshCode(host, dir string, o options) error {

flog.Info("ensuring code-server is updated...")

host, extraSSHFlags, err := parseHost(host)

if err != nil {

return xerrors.Errorf("failed to parse host IP: %w", err)

}

if extraSSHFlags != "" {

o.sshFlags = strings.Join([]string{extraSSHFlags, o.sshFlags}, " ")

}

o.bindAddr, err = parseBindAddr(o.bindAddr)

if err != nil {

return xerrors.Errorf("failed to parse bind address: %w", err)

}

if o.remotePort == "" {

o.remotePort, err = randomPort()

}

if err != nil {

return xerrors.Errorf("failed to find available remote port: %w", err)

}

dlScript := downloadScript(codeServerPath)

// Downloads the latest code-server and allows it to be executed.

sshCmdStr := fmt.Sprintf("ssh %v %v /bin/bash", o.sshFlags, host)

sshCmd := exec.Command("sh", "-c", sshCmdStr)

sshCmd.Stdout = os.Stdout

sshCmd.Stderr = os.Stderr

sshCmd.Stdin = strings.NewReader(dlScript)

err = sshCmd.Run()

if err != nil {

return xerrors.Errorf("failed to update code-server: \n---ssh cmd---\n%s\n---download script---\n%s: %w",

sshCmdStr,

dlScript,

err,

)

}

if !o.skipSync {

start := time.Now()

flog.Info("syncing settings")

err = syncUserSettings(o.sshFlags, host, false)

if err != nil {

return xerrors.Errorf("failed to sync settings: %w", err)

}

flog.Info("synced settings in %s", time.Since(start))

flog.Info("syncing extensions")

err = syncExtensions(o.sshFlags, host, false)

if err != nil {

return xerrors.Errorf("failed to sync extensions: %w", err)

}

flog.Info("synced extensions in %s", time.Since(start))

}

flog.Info("starting code-server...")

flog.Info("Tunneling remote port %v to %v", o.remotePort, o.bindAddr)

sshCmdStr =

fmt.Sprintf("ssh -tt -q -L %v:localhost:%v %v %v 'cd %v; %v --host 127.0.0.1 --allow-http --no-auth --port=%v'",

o.bindAddr, o.remotePort, o.sshFlags, host, dir, codeServerPath, o.remotePort,

)

// Starts code-server and forwards the remote port.

sshCmd = exec.Command("sh", "-c", sshCmdStr)

sshCmd.Stdin = os.Stdin

sshCmd.Stdout = os.Stdout

sshCmd.Stderr = os.Stderr

err = sshCmd.Start()

if err != nil {

return xerrors.Errorf("failed to start code-server: %w", err)

}

url := fmt.Sprintf("http://%s", o.bindAddr)

ctx, cancel := context.WithTimeout(context.Background(), 15*time.Second)

defer cancel()

client := http.Client{

Timeout: time.Second * 3,

}

for {

if ctx.Err() != nil {

return xerrors.Errorf("code-server didn't start in time: %w", ctx.Err())

}

// Waits for code-server to be available before opening the browser.

resp, err := client.Get(url)

if err != nil {

continue

}

resp.Body.Close()

break

}

ctx, cancel = context.WithCancel(context.Background())

if !o.noOpen {

openBrowser(url)

}

go func() {

defer cancel()

sshCmd.Wait()

}()

c := make(chan os.Signal)

signal.Notify(c, os.Interrupt)

select {

case <-ctx.Done():

case <-c:

}

if !o.syncBack || o.skipSync {

flog.Info("shutting down")

return nil

}

flog.Info("synchronizing VS Code back to local")

err = syncExtensions(o.sshFlags, host, true)

if err != nil {

return xerrors.Errorf("failed to sync extensions back: %w", err)

}

err = syncUserSettings(o.sshFlags, host, true)

if err != nil {

return xerrors.Errorf("failed to sync user settings settings back: %w", err)

}

return nil

}

func parseBindAddr(bindAddr string) (string, error) {

if bindAddr == "" {

bindAddr = ":"

}

host, port, err := net.SplitHostPort(bindAddr)

if err != nil {

return "", err

}

if host == "" {

host = "127.0.0.1"

}

if port == "" {

port, err = randomPort()

}

if err != nil {

return "", err

}

return net.JoinHostPort(host, port), nil

}

func openBrowser(url string) {

var openCmd *exec.Cmd

const (

macPath = "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"

wslPath = "/mnt/c/Program Files (x86)/Google/Chrome/Application/chrome.exe"

)

switch {

case commandExists("google-chrome"):

openCmd = exec.Command("google-chrome", chromeOptions(url)...)

case commandExists("google-chrome-stable"):

openCmd = exec.Command("google-chrome-stable", chromeOptions(url)...)

case commandExists("chromium"):

openCmd = exec.Command("chromium", chromeOptions(url)...)

case commandExists("chromium-browser"):

openCmd = exec.Command("chromium-browser", chromeOptions(url)...)

case pathExists(macPath):

openCmd = exec.Command(macPath, chromeOptions(url)...)

case pathExists(wslPath):

openCmd = exec.Command(wslPath, chromeOptions(url)...)

default:

err := browser.OpenURL(url)

if err != nil {

flog.Error("failed to open browser: %v", err)

}

return

}

// We do not use CombinedOutput because if there is no chrome instance, this will block

// and become the parent process instead of using an existing chrome instance.

err := openCmd.Start()

if err != nil {

flog.Error("failed to open browser: %v", err)

}

func chromeOptions(url string) []string {

return []string{"--app=" + url, "--disable-extensions", "--disable-plugins", "--incognito"}

}

// Checks if a command exists locally.

func commandExists(name string) bool {

_, err := exec.LookPath(name)

return err == nil

}

func pathExists(name string) bool {

_, err := os.Stat(name)

return err == nil

}

// randomPort picks a random port to start code-server on.

func randomPort() (string, error) {

const (

minPort = 1024

maxPort = 65535

maxTries = 10

)

for i := 0; i < maxTries; i++ {

port := rand.Intn(maxPort-minPort+1) + minPort

l, err := net.Listen("tcp", fmt.Sprintf(":%d", port))

if err == nil {

_ = l.Close()

return strconv.Itoa(port), nil

}

flog.Info("port taken: %d", port)

}

return "", xerrors.Errorf("max number of tries exceeded: %d", maxTries)

}

func syncUserSettings(sshFlags string, host string, back bool) error {

localConfDir, err := configDir()

if err != nil {

return err

}

err = ensureDir(localConfDir)

if err != nil {

return err

}

const remoteSettingsDir = "~/.local/share/code-server/User/"

var (

src = localConfDir + "/"

dest = host + ":" + remoteSettingsDir

)

if back {

dest, src = src, dest

}

// Append "/" to have rsync copy the contents of the dir.

return rsync(src, dest, sshFlags, "workspaceStorage", "logs", "CachedData")

}

func syncExtensions(sshFlags string, host string, back bool) error {

localExtensionsDir, err := extensionsDir()

if err != nil {

return err

}

err = ensureDir(localExtensionsDir)

if err != nil {

return err

}

const remoteExtensionsDir = "~/.local/share/code-server/extensions/"

var (

src = localExtensionsDir + "/"

dest = host + ":" + remoteExtensionsDir

)

if back {

dest, src = src, dest

}

return rsync(src, dest, sshFlags)

}

func rsync(src string, dest string, sshFlags string, excludePaths ...string) error {

excludeFlags := make([]string, len(excludePaths))

for i, path := range excludePaths {

excludeFlags[i] = "--exclude=" + path

}

cmd := exec.Command("rsync", append(excludeFlags, "-azvr",

"-e", "ssh "+sshFlags,

// Only update newer directories, and sync times

// to keep things simple.

"-u", "--times",

// This is more unsafe, but it's obnoxious having to enter VS Code

// locally in order to properly delete an extension.

"--delete",

"--copy-unsafe-links",

src, dest,

)...,

)

cmd.Stdout = os.Stdout

cmd.Stderr = os.Stderr

err := cmd.Run()

if err != nil {

return xerrors.Errorf("failed to rsync '%s' to '%s': %w", src, dest, err)

}

return nil

}

func downloadScript(codeServerPath string) string {

return fmt.Sprintf(

`set -euxo pipefail || exit 1

pkill -f %v || true

mkdir -p ~/.local/share/code-server %v

cd %v

wget -N https://codesrv-ci.cdr.sh/latest-linux

[ -f %v ] && rm %v

ln latest-linux %v

chmod +x %v`,

codeServerPath,

filepath.Dir(codeServerPath),

codeServerPath,

)

}

// ensureDir creates a directory if it does not exist.

func ensureDir(path string) error {

_, err := os.Stat(path)

if os.IsNotExist(err) {

err = os.MkdirAll(path, 0750)

}

if err != nil {

return err

}

return nil

}

// parseHost parses the host argument. If 'gcp:' is prefixed to the

// host then a lookup is done using gcloud to determine the external IP and any

// additional SSH arguments that should be used for ssh commands. Otherwise, host

// is returned.

func parseHost(host string) (parsedHost string, additionalFlags string, err error) {

host = strings.TrimSpace(host)

switch {

case strings.HasPrefix(host, "gcp:"):

instance := strings.TrimPrefix(host, "gcp:")

return parseGCPSSHCmd(instance)

default:

return host, "", nil

}

// parseGCPSSHCmd parses the IP address and flags used by 'gcloud' when

// ssh'ing to an instance.

func parseGCPSSHCmd(instance string) (ip, sshFlags string, err error) {

dryRunCmd := fmt.Sprintf("gcloud compute ssh --dry-run %v", instance)

out, err := exec.Command("sh", "-c", dryRunCmd).CombinedOutput()

if err != nil {

return "", "", xerrors.Errorf("%s: %w", out, err)

}

toks := strings.Split(string(out), " ")

if len(toks) < 2 {

return "", "", xerrors.Errorf("unexpected output for '%v' command, %s", dryRunCmd, out)

}

// Slice off the '/usr/bin/ssh' prefix and the '<user>@<ip>' suffix.

sshFlags = strings.Join(toks[1:len(toks)-1], " ")

// E.g. foo@1.2.3.4.

userIP := toks[len(toks)-1]

toks = strings.Split(userIP, "@")

// Assume the '<user>@' is missing.

if len(toks) < 2 {

ip = strings.TrimSpace(toks[0])

} else {

ip = strings.TrimSpace(toks[1])

}

if net.ParseIP(ip) == nil {

return "", "", xerrors.Errorf("parsed invalid ip address %v", ip)

}

return ip, sshFlags, nil

}

sshcode/sshcode.go at master · AlexSJ/sshcode · GitHub

Repository navigation

Expand file tree

Breadcrumbs

sshcode.go

Latest commit

History

Breadcrumbs

sshcode.go

File metadata and controls