-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
scp.go
647 lines (567 loc) · 15 KB
/
scp.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
/*
Copyright 2015 Gravitational, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// Package scp handles file uploads and downloads via scp command
package scp
import (
"bufio"
"fmt"
"io"
"os"
"path/filepath"
"strconv"
"strings"
"time"
"github.com/gravitational/teleport/lib/events"
"github.com/gravitational/trace"
log "github.com/sirupsen/logrus"
)
const (
// OKByte is scp OK message bytes
OKByte = 0x0
// WarnByte tells that next goes a warning string
WarnByte = 0x1
// ErrByte tells that next goes an error string
ErrByte = 0x2
)
// Flags describes SCP command line flags
type Flags struct {
// Source indicates upload mode
Source bool
// Sink indicates receive mode
Sink bool
// Verbose sets a logging mode
Verbose bool
// Target sets targeted files to be transfered
Target []string
// Recursive indicates recursive file transfer
Recursive bool
// RemoteAddr is a remote host address
RemoteAddr string
// LocalAddr is a local host address
LocalAddr string
}
// Config describes Command configuration settings
type Config struct {
// Flags is a set of SCP command line flags
Flags Flags
// User is a user who runs SCP command
User string
// AuditLog is AuditLog log
AuditLog events.IAuditLog
// ProgressWriter is a writer for printing the progress
// (used only on the client)
ProgressWriter io.Writer
// FileSystem is a source file system abstraction for the SCP command
FileSystem FileSystem
// RemoteLocation is a destination location of the file
RemoteLocation string
// RunOnServer is low level API flag that indicates that
// this command will be run on the server
RunOnServer bool
}
// Command is an API that describes command operations
type Command interface {
// Execute processes SCP traffic
Execute(ch io.ReadWriter) error
// GetRemoteShellCmd returns a remote shell command that
// has to be executed on the remove server (handled by Teleport)
GetRemoteShellCmd() (string, error)
}
// FileSystem is an interface that abstracts file system methods used in SCP command functions
type FileSystem interface {
// IsDir returns true if a given file path is a directory
IsDir(path string) bool
// GetFileInfo returns FileInfo for a given file path
GetFileInfo(filePath string) (FileInfo, error)
// MkDir creates a directory
MkDir(path string, mode int) error
// OpenFile opens a file and returns its Reader
OpenFile(filePath string) (io.ReadCloser, error)
// CreateFile creates a new file
CreateFile(filePath string, length uint64) (io.WriteCloser, error)
// SetChmod sets file permissions
SetChmod(path string, mode int) error
}
// FileInfo is an API that describes methods that provide file information
type FileInfo interface {
// IsDir returns true if a file is a directory
IsDir() bool
// ReadDir returns information of directory files
ReadDir() ([]FileInfo, error)
// GetName returns a file name
GetName() string
// GetPath returns a file path
GetPath() string
// GetModePerm returns file permissions
GetModePerm() os.FileMode
// GetSize returns file size
GetSize() int64
}
// CreateDownloadCommand configures and returns a command used
// to download a file
func CreateDownloadCommand(cfg Config) (Command, error) {
cfg.Flags.Sink = true
cfg.Flags.Source = false
cmd, err := CreateCommand(cfg)
if err != nil {
return nil, trace.Wrap(err)
}
return cmd, nil
}
// CreateUploadCommand configures and returns a command used
// to upload a file
func CreateUploadCommand(cfg Config) (Command, error) {
cfg.Flags.Sink = false
cfg.Flags.Source = true
cmd, err := CreateCommand(cfg)
if err != nil {
return nil, trace.Wrap(err)
}
return cmd, nil
}
// CheckAndSetDefaults checks and sets default values
func (c *Config) CheckAndSetDefaults() error {
if c.FileSystem == nil {
c.FileSystem = &localFileSystem{}
}
if c.User == "" {
return trace.BadParameter("missing User parameter")
}
return nil
}
// CreateCommand creates and returns a new Command
func CreateCommand(cfg Config) (Command, error) {
err := cfg.CheckAndSetDefaults()
if err != nil {
return nil, trace.Wrap(err)
}
cmd := command{
Config: cfg,
}
cmd.log = log.WithFields(log.Fields{
trace.Component: "SCP",
trace.ComponentFields: log.Fields{
"LocalAddr": cfg.Flags.LocalAddr,
"RemoteAddr": cfg.Flags.RemoteAddr,
"Target": cfg.Flags.Target,
"User": cfg.User,
"RunOnServer": cfg.RunOnServer,
"RemoteLocation": cfg.RemoteLocation,
},
})
return &cmd, nil
}
// Command mimics behavior of SCP command line tool
// to teleport can pretend it launches real scp behind the scenes
type command struct {
Config
log *log.Entry
}
// Execute() implements SSH file copy (SCP). It is called on both tsh (client)
// and teleport (server) side.
func (cmd *command) Execute(ch io.ReadWriter) (err error) {
if cmd.Flags.Source {
err = cmd.serveSource(ch)
} else {
err = cmd.serveSink(ch)
}
if err != nil {
if cmd.Config.RunOnServer == false {
return trace.Wrap(err)
} else {
// when 'teleport scp' encounters an error, it SHOULD NOT be logged
// to stderr (i.e. we should not return an error here) and instead
// it should be sent back to scp client using scp protocol
cmd.sendError(ch, err)
}
}
return nil
}
func (cmd *command) GetRemoteShellCmd() (string, error) {
if cmd.RemoteLocation == "" {
return "", trace.BadParameter("missing remote file location")
}
// "impersonate" scp to a server
shellCmd := "/usr/bin/scp -t"
if cmd.Flags.Source == true {
shellCmd = "/usr/bin/scp -t"
} else {
shellCmd = "/usr/bin/scp -f"
}
if cmd.Flags.Recursive {
shellCmd += " -r"
}
shellCmd += (" " + cmd.RemoteLocation)
return shellCmd, nil
}
func (cmd *command) serveSource(ch io.ReadWriter) error {
fileInfos := make([]FileInfo, len(cmd.Flags.Target))
for i := range cmd.Flags.Target {
fileInfo, err := cmd.FileSystem.GetFileInfo(cmd.Flags.Target[i])
if err != nil {
return trace.Wrap(err)
}
if fileInfo.IsDir() && !cmd.Flags.Recursive {
err := trace.Errorf("%v is a directory, perhaps try -r flag?", fileInfo.GetName())
return trace.Wrap(err)
}
fileInfos[i] = fileInfo
}
r := newReader(ch)
if err := r.read(); err != nil {
return trace.Wrap(err)
}
for i := range fileInfos {
info := fileInfos[i]
if info.IsDir() {
if err := cmd.sendDir(r, ch, info); err != nil {
return trace.Wrap(err)
}
} else {
if err := cmd.sendFile(r, ch, info); err != nil {
return trace.Wrap(err)
}
}
}
cmd.log.Debugf("send completed")
return nil
}
func (cmd *command) sendDir(r *reader, ch io.ReadWriter, fileInfo FileInfo) error {
out := fmt.Sprintf("D%04o 0 %s\n", fileInfo.GetModePerm(), fileInfo.GetName())
cmd.log.Debugf("sendDir: %v", out)
_, err := io.WriteString(ch, out)
if err != nil {
return trace.Wrap(err)
}
if err := r.read(); err != nil {
return trace.Wrap(err)
}
cmd.log.Debug("sendDir got OK")
fileInfos, err := fileInfo.ReadDir()
if err != nil {
return trace.Wrap(err)
}
for i := range fileInfos {
info := fileInfos[i]
if info.IsDir() {
err := cmd.sendDir(r, ch, info)
if err != nil {
return trace.Wrap(err)
}
} else {
err := cmd.sendFile(r, ch, info)
if err != nil {
return trace.Wrap(err)
}
}
}
if _, err = fmt.Fprintf(ch, "E\n"); err != nil {
return trace.Wrap(err)
}
return r.read()
}
func (cmd *command) sendFile(r *reader, ch io.ReadWriter, fileInfo FileInfo) error {
reader, err := cmd.FileSystem.OpenFile(fileInfo.GetPath())
if err != nil {
return trace.Wrap(err)
}
defer reader.Close()
out := fmt.Sprintf("C%04o %d %s\n", fileInfo.GetModePerm(), fileInfo.GetSize(), fileInfo.GetName())
// report progress:
if cmd.ProgressWriter != nil {
defer fmt.Fprintf(cmd.ProgressWriter, "-> %s (%d)\n", fileInfo.GetPath(), fileInfo.GetSize())
}
_, err = io.WriteString(ch, out)
if err != nil {
return trace.Wrap(err)
}
if err := r.read(); err != nil {
return trace.Wrap(err)
}
n, err := io.Copy(ch, reader)
if err != nil {
return trace.Wrap(err)
}
if n != fileInfo.GetSize() {
err := fmt.Errorf("short write: %v %v", n, fileInfo.GetSize())
return trace.Wrap(err)
}
if err := sendOK(ch); err != nil {
return trace.Wrap(err)
}
return trace.Wrap(r.read())
}
// serveSink executes file uploading, when a remote server sends file(s)
// via scp
func (cmd *command) serveSink(ch io.ReadWriter) error {
if err := sendOK(ch); err != nil {
return trace.Wrap(err)
}
var st state
st.path = []string{"."}
var b = make([]byte, 1)
scanner := bufio.NewScanner(ch)
for {
n, err := ch.Read(b)
if err != nil {
if err == io.EOF {
return nil
}
return trace.Wrap(err)
}
if n < 1 {
return trace.Errorf("unexpected error, read 0 bytes")
}
if b[0] == OKByte {
continue
}
scanner.Scan()
if err := scanner.Err(); err != nil {
return trace.Wrap(err)
}
if err := cmd.processCommand(ch, &st, b[0], scanner.Text()); err != nil {
return trace.Wrap(err)
}
if err := sendOK(ch); err != nil {
return trace.Wrap(err)
}
}
}
func (cmd *command) processCommand(ch io.ReadWriter, st *state, b byte, line string) error {
cmd.log.Debugf("[SCP] <- %v %v", string(b), line)
switch b {
case WarnByte:
return trace.Errorf(line)
case ErrByte:
return trace.Errorf(line)
case 'C':
f, err := parseNewFile(line)
if err != nil {
return trace.Wrap(err)
}
err = cmd.receiveFile(st, *f, ch)
if err != nil {
return trace.Wrap(err)
}
return nil
case 'D':
d, err := parseNewFile(line)
if err != nil {
return trace.Wrap(err)
}
if err := cmd.receiveDir(st, *d, ch); err != nil {
return trace.Wrap(err)
}
return nil
case 'E':
return st.pop()
case 'T':
_, err := parseMtime(line)
if err != nil {
return trace.Wrap(err)
}
}
return trace.Errorf("got unrecognized command: %v", string(b))
}
func (cmd *command) receiveFile(st *state, fc newFileCmd, ch io.ReadWriter) error {
cmd.log.Debugf("scp.receiveFile(%v)", cmd.Flags.Target)
// if the dest path is a folder, we should save the file to that folder, but
// only if is 'recursive' is set
path := cmd.Flags.Target[0]
if cmd.Flags.Recursive || cmd.FileSystem.IsDir(path) {
path = st.makePath(path, fc.Name)
}
writer, err := cmd.FileSystem.CreateFile(path, fc.Length)
if err != nil {
return trace.Wrap(err)
}
// report progress:
if cmd.ProgressWriter != nil {
defer fmt.Fprintf(cmd.ProgressWriter, "<- %s (%d)\n", path, fc.Length)
}
defer writer.Close()
if err = sendOK(ch); err != nil {
return trace.Wrap(err)
}
n, err := io.CopyN(writer, ch, int64(fc.Length))
if err != nil {
cmd.log.Error(err)
return trace.Wrap(err)
}
if n != int64(fc.Length) {
return trace.Errorf("unexpected file copy length: %v", n)
}
if err := cmd.FileSystem.SetChmod(path, int(fc.Mode)); err != nil {
return trace.Wrap(err)
}
cmd.log.Debugf("file %v(%v) copied to %v", fc.Name, fc.Length, path)
return nil
}
func (cmd *command) receiveDir(st *state, fc newFileCmd, ch io.ReadWriter) error {
targetDir := cmd.Flags.Target[0]
// copying into an existing directory? append to it:
if cmd.FileSystem.IsDir(targetDir) {
targetDir = st.makePath(targetDir, fc.Name)
st.push(fc.Name)
}
err := cmd.FileSystem.MkDir(targetDir, int(fc.Mode))
if err != nil {
return trace.Wrap(err)
}
return nil
}
// sendError gets called during all errors during SCP transmission.
// It writes it back to the SCP client
func (cmd *command) sendError(ch io.ReadWriter, err error) error {
if err == nil {
return nil
}
cmd.log.Error(err)
message := err.Error()
bytes := make([]byte, 0, len(message)+2)
bytes = append(bytes, ErrByte)
bytes = append(bytes, message...)
bytes = append(bytes, []byte{'\n'}...)
_, writeErr := ch.Write(bytes)
if writeErr != nil {
cmd.log.Error(writeErr)
}
return trace.Wrap(err)
}
type newFileCmd struct {
Mode int64
Length uint64
Name string
}
func parseNewFile(line string) (*newFileCmd, error) {
parts := strings.SplitN(line, " ", 3)
if len(parts) != 3 {
return nil, trace.Errorf("broken command")
}
c := newFileCmd{}
var err error
if c.Mode, err = strconv.ParseInt(parts[0], 8, 32); err != nil {
return nil, trace.Wrap(err)
}
if c.Length, err = strconv.ParseUint(parts[1], 10, 64); err != nil {
return nil, trace.Wrap(err)
}
c.Name = parts[2]
return &c, nil
}
type mtimeCmd struct {
Mtime time.Time
Atime time.Time
}
func parseMtime(line string) (*mtimeCmd, error) {
parts := strings.SplitN(line, " ", 4)
if len(parts) != 4 {
return nil, trace.Errorf("broken mtime command")
}
var err error
vars := make([]int64, 4)
for i := range vars {
if vars[i], err = strconv.ParseInt(parts[i], 10, 64); err != nil {
return nil, trace.Wrap(err)
}
}
return &mtimeCmd{
Mtime: time.Unix(vars[0], vars[1]),
Atime: time.Unix(vars[2], vars[3]),
}, nil
}
func sendOK(ch io.ReadWriter) error {
_, err := ch.Write([]byte{OKByte})
if err != nil {
return trace.Wrap(err)
} else {
return nil
}
}
type state struct {
path []string
finished bool
}
func (st *state) push(dir string) {
st.path = append(st.path, dir)
}
func (st *state) pop() error {
if st.finished {
return trace.Errorf("empty path")
}
if len(st.path) == 0 {
st.finished = true // allow extra 'E' command in the end
return nil
}
st.path = st.path[:len(st.path)-1]
return nil
}
func (st *state) makePath(target, filename string) string {
return filepath.Join(target, filepath.Join(st.path...), filename)
}
func newReader(r io.Reader) *reader {
return &reader{
b: make([]byte, 1),
s: bufio.NewScanner(r),
r: r,
}
}
type reader struct {
b []byte
s *bufio.Scanner
r io.Reader
}
// read is used to "ask" for response messages after each SCP transmission
// it only reads text data until a newline and returns 'nil' for "OK" responses
// and errors for everything else
func (r *reader) read() error {
n, err := r.r.Read(r.b)
if err != nil {
return trace.Wrap(err)
}
if n < 1 {
return trace.Errorf("unexpected error, read 0 bytes")
}
switch r.b[0] {
case OKByte:
return nil
case WarnByte, ErrByte:
r.s.Scan()
if err := r.s.Err(); err != nil {
return trace.Wrap(err)
}
return trace.Errorf(r.s.Text())
}
return trace.Errorf("unrecognized command: %#v", r.b)
}
// ParseSCPDestination takes a string representing a remote resource for SCP
// to download/upload, like "user@host:/path/to/resource.txt" and returns
// 3 components of it
func ParseSCPDestination(s string) (login, host, dest string) {
parts := strings.SplitN(s, "@", 2)
if len(parts) > 1 {
login = parts[0]
host = parts[1]
} else {
host = parts[0]
}
parts = strings.SplitN(host, ":", 2)
if len(parts) > 1 {
host = parts[0]
dest = parts[1]
}
if len(dest) == 0 {
dest = "."
}
return login, host, dest
}