@@ -56,6 +56,7 @@ const (
5656
5757type Options struct {
5858 Filesystem afero.Fs
59+ TempDir string
5960 ExchangeToken func (ctx context.Context ) (string , error )
6061 Client Client
6162 ReconnectingPTYTimeout time.Duration
@@ -78,6 +79,9 @@ func New(options Options) io.Closer {
7879 if options .Filesystem == nil {
7980 options .Filesystem = afero .NewOsFs ()
8081 }
82+ if options .TempDir == "" {
83+ options .TempDir = os .TempDir ()
84+ }
8185 if options .ExchangeToken == nil {
8286 options .ExchangeToken = func (ctx context.Context ) (string , error ) {
8387 return "" , nil
@@ -93,6 +97,7 @@ func New(options Options) io.Closer {
9397 client : options .Client ,
9498 exchangeToken : options .ExchangeToken ,
9599 filesystem : options .Filesystem ,
100+ tempDir : options .TempDir ,
96101 stats : & Stats {},
97102 }
98103 server .init (ctx )
@@ -104,6 +109,7 @@ type agent struct {
104109 client Client
105110 exchangeToken func (ctx context.Context ) (string , error )
106111 filesystem afero.Fs
112+ tempDir string
107113
108114 reconnectingPTYs sync.Map
109115 reconnectingPTYTimeout time.Duration
@@ -168,7 +174,7 @@ func (a *agent) run(ctx context.Context) error {
168174 if err != nil {
169175 return xerrors .Errorf ("fetch metadata: %w" , err )
170176 }
171- a .logger .Info (context . Background () , "fetched metadata" )
177+ a .logger .Info (ctx , "fetched metadata" )
172178 oldMetadata := a .metadata .Swap (metadata )
173179
174180 // The startup script should only execute on the first run!
@@ -202,7 +208,7 @@ func (a *agent) run(ctx context.Context) error {
202208 a .closeMutex .Lock ()
203209 network := a .network
204210 a .closeMutex .Unlock ()
205- if a . network == nil {
211+ if network == nil {
206212 a .logger .Debug (ctx , "creating tailnet" )
207213 network , err = a .createTailnet (ctx , metadata .DERPMap )
208214 if err != nil {
@@ -359,7 +365,7 @@ func (a *agent) runCoordinator(ctx context.Context, network *tailnet.Conn) error
359365 return err
360366 }
361367 defer coordinator .Close ()
362- a .logger .Info (context . Background () , "connected to coordination server" )
368+ a .logger .Info (ctx , "connected to coordination server" )
363369 sendNodes , errChan := tailnet .ServeCoordinator (coordinator , network .UpdateNodes )
364370 network .SetNodeCallback (sendNodes )
365371 select {
@@ -375,14 +381,14 @@ func (a *agent) runStartupScript(ctx context.Context, script string) error {
375381 return nil
376382 }
377383
378- writer , err := os .OpenFile (filepath .Join (os .TempDir (), "coder-startup-script.log" ), os .O_CREATE | os .O_RDWR , 0o600 )
384+ a .logger .Info (ctx , "running startup script" , slog .F ("script" , script ))
385+ writer , err := a .filesystem .OpenFile (filepath .Join (a .tempDir , "coder-startup-script.log" ), os .O_CREATE | os .O_RDWR , 0o600 )
379386 if err != nil {
380387 return xerrors .Errorf ("open startup script log file: %w" , err )
381388 }
382389 defer func () {
383390 _ = writer .Close ()
384391 }()
385-
386392 cmd , err := a .createCommand (ctx , script , nil )
387393 if err != nil {
388394 return xerrors .Errorf ("create command: %w" , err )
@@ -470,6 +476,12 @@ func (a *agent) init(ctx context.Context) {
470476 },
471477 SubsystemHandlers : map [string ]ssh.SubsystemHandler {
472478 "sftp" : func (session ssh.Session ) {
479+ ctx := session .Context ()
480+
481+ // Typically sftp sessions don't request a TTY, but if they do,
482+ // we must ensure the gliderlabs/ssh CRLF emulation is disabled.
483+ // Otherwise sftp will be broken. This can happen if a user sets
484+ // `RequestTTY force` in their SSH config.
473485 session .DisablePTYEmulation ()
474486
475487 var opts []sftp.ServerOption
@@ -478,22 +490,33 @@ func (a *agent) init(ctx context.Context) {
478490 // https://github.com/coder/coder/issues/3620
479491 u , err := user .Current ()
480492 if err != nil {
481- a . logger .Warn (ctx , "get sftp working directory failed, unable to get current user" , slog .Error (err ))
493+ sshLogger .Warn (ctx , "get sftp working directory failed, unable to get current user" , slog .Error (err ))
482494 } else {
483495 opts = append (opts , sftp .WithServerWorkingDirectory (u .HomeDir ))
484496 }
485497
486498 server , err := sftp .NewServer (session , opts ... )
487499 if err != nil {
488- a . logger . Debug (session . Context () , "initialize sftp server" , slog .Error (err ))
500+ sshLogger . Debug (ctx , "initialize sftp server" , slog .Error (err ))
489501 return
490502 }
491503 defer server .Close ()
504+
492505 err = server .Serve ()
493506 if errors .Is (err , io .EOF ) {
507+ // Unless we call `session.Exit(0)` here, the client won't
508+ // receive `exit-status` because `(*sftp.Server).Close()`
509+ // calls `Close()` on the underlying connection (session),
510+ // which actually calls `channel.Close()` because it isn't
511+ // wrapped. This causes sftp clients to receive a non-zero
512+ // exit code. Typically sftp clients don't echo this exit
513+ // code but `scp` on macOS does (when using the default
514+ // SFTP backend).
515+ _ = session .Exit (0 )
494516 return
495517 }
496- a .logger .Debug (session .Context (), "sftp server exited with error" , slog .Error (err ))
518+ sshLogger .Warn (ctx , "sftp server closed with error" , slog .Error (err ))
519+ _ = session .Exit (1 )
497520 },
498521 },
499522 }
@@ -538,25 +561,26 @@ func (a *agent) createCommand(ctx context.Context, rawCommand string, env []stri
538561 return nil , xerrors .Errorf ("metadata is the wrong type: %T" , metadata )
539562 }
540563
564+ // OpenSSH executes all commands with the users current shell.
565+ // We replicate that behavior for IDE support.
566+ caller := "-c"
567+ if runtime .GOOS == "windows" {
568+ caller = "/c"
569+ }
570+ args := []string {caller , rawCommand }
571+
541572 // gliderlabs/ssh returns a command slice of zero
542573 // when a shell is requested.
543- command := rawCommand
544- if len (command ) == 0 {
545- command = shell
574+ if len (rawCommand ) == 0 {
575+ args = []string {}
546576 if runtime .GOOS != "windows" {
547577 // On Linux and macOS, we should start a login
548578 // shell to consume juicy environment variables!
549- command += " -l"
579+ args = append ( args , " -l")
550580 }
551581 }
552582
553- // OpenSSH executes all commands with the users current shell.
554- // We replicate that behavior for IDE support.
555- caller := "-c"
556- if runtime .GOOS == "windows" {
557- caller = "/c"
558- }
559- cmd := exec .CommandContext (ctx , shell , caller , command )
583+ cmd := exec .CommandContext (ctx , shell , args ... )
560584 cmd .Dir = metadata .Directory
561585 if cmd .Dir == "" {
562586 // Default to $HOME if a directory is not set!
0 commit comments