2 * scp - secure remote copy. This is basically patched BSD rcp which
3 * uses ssh to do the data transfer (instead of using rcmd).
5 * NOTE: This version should NOT be suid root. (This uses ssh to
6 * do the transfer and ssh has the necessary privileges.)
8 * 1995 Timo Rinne <tri@iki.fi>, Tatu Ylonen <ylo@cs.hut.fi>
10 * As far as I am concerned, the code I have written for this software
11 * can be used freely for any purpose. Any derived versions of this
12 * software must be clearly marked as such, and if the derived work is
13 * incompatible with the protocol description in the RFC file, it must be
14 * called by a name other than "ssh" or "Secure Shell".
17 * Copyright (c) 1999 Theo de Raadt. All rights reserved.
18 * Copyright (c) 1999 Aaron Campbell. All rights reserved.
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
23 * 1. Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
25 * 2. Redistributions in binary form must reproduce the above copyright
26 * notice, this list of conditions and the following disclaimer in the
27 * documentation and/or other materials provided with the distribution.
29 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
30 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
31 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
32 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
33 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
34 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
38 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 * Copyright (c) 1983, 1990, 1992, 1993, 1995
45 * The Regents of the University of California. All rights reserved.
47 * Redistribution and use in source and binary forms, with or without
48 * modification, are permitted provided that the following conditions
50 * 1. Redistributions of source code must retain the above copyright
51 * notice, this list of conditions and the following disclaimer.
52 * 2. Redistributions in binary form must reproduce the above copyright
53 * notice, this list of conditions and the following disclaimer in the
54 * documentation and/or other materials provided with the distribution.
55 * 3. All advertising materials mentioning features or use of this software
56 * must display the following acknowledgement:
57 * This product includes software developed by the University of
58 * California, Berkeley and its contributors.
59 * 4. Neither the name of the University nor the names of its contributors
60 * may be used to endorse or promote products derived from this software
61 * without specific prior written permission.
63 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
64 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
65 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
66 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
67 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
68 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
69 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
70 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
71 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
72 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
78 RCSID("$OpenBSD: scp.c,v 1.102 2003/03/05 22:33:43 markus Exp $");
82 #include "pathnames.h"
85 #include "progressmeter.h"
87 #ifdef HAVE___PROGNAME
88 extern char *__progname;
95 /* Struct for addargs */
101 /* Name of current file being transferred. */
104 /* This is set to non-zero to enable verbose mode. */
105 int verbose_mode = 0;
107 /* This is set to zero if the progressmeter is not desired. */
108 int showprogress = 1;
110 /* This is the program to execute for the secured connection. ("ssh" or -S) */
113 /* This is used to store the pid of ssh_program */
117 * This function executes the given command as the specified user on the
118 * given host. This returns < 0 if execution fails, and >= 0 otherwise. This
119 * assigns the input and output file descriptors on success.
123 do_cmd(char *host, char *remuser, char *cmd, int *fdin, int *fdout, int argc)
125 int pin[2], pout[2], reserved[2];
129 "Executing: program %s host %s, user %s, command %s\n",
131 remuser ? remuser : "(unspecified)", cmd);
134 * Reserve two descriptors so that the real pipes won't get
135 * descriptors 0 and 1 because that will screw up dup2 below.
139 /* Create a socket pair for communicating with ssh. */
141 fatal("pipe: %s", strerror(errno));
143 fatal("pipe: %s", strerror(errno));
145 /* Free the reserved descriptors. */
149 /* For a child to execute the command on the remote host using ssh. */
151 if (do_cmd_pid == 0) {
160 args.list[0] = ssh_program;
162 addargs(&args, "-l%s", remuser);
163 addargs(&args, "%s", host);
164 addargs(&args, "%s", cmd);
166 execvp(ssh_program, args.list);
169 } else if (do_cmd_pid == -1) {
170 fatal("fork: %s", strerror(errno));
172 /* Parent. Close the other side, and return the local side. */
185 BUF *allocbuf(BUF *, int, int);
189 void run_err(const char *,...);
190 void verifydir(char *);
194 int errs, remin, remout;
195 int pflag, iamremote, iamrecursive, targetshouldbedirectory;
198 char cmd[CMDNEEDS]; /* must hold "rcp -r -p -d\0" */
201 void rsource(char *, struct stat *);
202 void sink(int, char *[]);
203 void source(int, char *[]);
204 void tolocal(int, char *[]);
205 void toremote(char *, int, char *[]);
213 int ch, fflag, tflag, status;
219 __progname = get_progname(argv[0]);
221 ssh_program = _PATH_SSH_PROGRAM;
224 addargs(&args, "ssh"); /* overwritten with ssh_program */
225 addargs(&args, "-x");
226 addargs(&args, "-oForwardAgent no");
227 addargs(&args, "-oClearAllForwardings yes");
230 while ((ch = getopt(argc, argv, "dfl:prtvBCc:i:P:q1246S:o:F:")) != -1)
232 /* User-visible flags. */
238 addargs(&args, "-%c", ch);
244 addargs(&args, "-%c%s", ch, optarg);
247 addargs(&args, "-p%s", optarg);
250 addargs(&args, "-oBatchmode yes");
253 speed = strtod(optarg, &endp);
254 if (speed <= 0 || *endp != '\0')
256 limitbw = speed * 1024;
265 ssh_program = xstrdup(optarg);
268 addargs(&args, "-v");
275 /* Server options. */
277 targetshouldbedirectory = 1;
279 case 'f': /* "from" */
287 setmode(0, O_BINARY);
296 if ((pwd = getpwuid(userid = getuid())) == NULL)
297 fatal("unknown user %d", (int) userid);
299 if (!isatty(STDERR_FILENO))
302 remin = STDIN_FILENO;
303 remout = STDOUT_FILENO;
306 /* Follow "protocol", send data. */
319 targetshouldbedirectory = 1;
323 /* Command to be executed on remote system using "ssh". */
324 (void) snprintf(cmd, sizeof cmd, "scp%s%s%s%s",
325 verbose_mode ? " -v" : "",
326 iamrecursive ? " -r" : "", pflag ? " -p" : "",
327 targetshouldbedirectory ? " -d" : "");
329 (void) signal(SIGPIPE, lostconn);
331 if ((targ = colon(argv[argc - 1]))) /* Dest is remote host. */
332 toremote(targ, argc, argv);
334 tolocal(argc, argv); /* Dest is local host. */
335 if (targetshouldbedirectory)
336 verifydir(argv[argc - 1]);
339 * Finally check the exit status of the ssh process, if one was forked
340 * and no error has occured yet
342 if (do_cmd_pid != -1 && errs == 0) {
346 (void) close(remout);
347 if (waitpid(do_cmd_pid, &status, 0) == -1)
350 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
358 toremote(targ, argc, argv)
363 char *bp, *host, *src, *suser, *thost, *tuser;
369 if ((thost = strrchr(argv[argc - 1], '@'))) {
372 tuser = argv[argc - 1];
376 thost = argv[argc - 1];
380 for (i = 0; i < argc - 1; i++) {
381 src = colon(argv[i]);
382 if (src) { /* remote to remote */
383 static char *ssh_options =
384 "-x -o'ClearAllForwardings yes'";
388 host = strrchr(argv[i], '@');
389 len = strlen(ssh_program) + strlen(argv[i]) +
390 strlen(src) + (tuser ? strlen(tuser) : 0) +
391 strlen(thost) + strlen(targ) +
392 strlen(ssh_options) + CMDNEEDS + 20;
396 host = cleanhostname(host);
399 suser = pwd->pw_name;
400 else if (!okname(suser)) {
404 if (tuser && !okname(tuser)) {
410 "-l %s %s %s %s '%s%s%s:%s'",
411 ssh_program, verbose_mode ? " -v" : "",
412 ssh_options, suser, host, cmd, src,
413 tuser ? tuser : "", tuser ? "@" : "",
416 host = cleanhostname(argv[i]);
418 "exec %s%s %s -n %s "
420 ssh_program, verbose_mode ? " -v" : "",
421 ssh_options, host, cmd, src,
422 tuser ? tuser : "", tuser ? "@" : "",
426 fprintf(stderr, "Executing: %s\n", bp);
429 } else { /* local to remote */
431 len = strlen(targ) + CMDNEEDS + 20;
433 (void) snprintf(bp, len, "%s -t %s", cmd, targ);
434 host = cleanhostname(thost);
435 if (do_cmd(host, tuser, bp, &remin,
453 char *bp, *host, *src, *suser;
455 for (i = 0; i < argc - 1; i++) {
456 if (!(src = colon(argv[i]))) { /* Local to local. */
457 len = strlen(_PATH_CP) + strlen(argv[i]) +
458 strlen(argv[argc - 1]) + 20;
460 (void) snprintf(bp, len, "exec %s%s%s %s %s", _PATH_CP,
461 iamrecursive ? " -r" : "", pflag ? " -p" : "",
462 argv[i], argv[argc - 1]);
464 fprintf(stderr, "Executing: %s\n", bp);
473 if ((host = strrchr(argv[i], '@')) == NULL) {
480 suser = pwd->pw_name;
482 host = cleanhostname(host);
483 len = strlen(src) + CMDNEEDS + 20;
485 (void) snprintf(bp, len, "%s -f %s", cmd, src);
486 if (do_cmd(host, suser, bp, &remin, &remout, argc) < 0) {
492 sink(1, argv + argc - 1);
506 off_t i, amt, result, statbytes;
507 int fd, haderr, indx;
508 char *last, *name, buf[2048];
511 for (indx = 0; indx < argc; ++indx) {
515 while (len > 1 && name[len-1] == '/')
517 if (strchr(name, '\n') != NULL) {
518 run_err("%s: skipping, filename contains a newline",
522 if ((fd = open(name, O_RDONLY, 0)) < 0)
524 if (fstat(fd, &stb) < 0) {
525 syserr: run_err("%s: %s", name, strerror(errno));
528 switch (stb.st_mode & S_IFMT) {
538 run_err("%s: not a regular file", name);
541 if ((last = strrchr(name, '/')) == NULL)
548 * Make it compatible with possible future
549 * versions expecting microseconds.
551 (void) snprintf(buf, sizeof buf, "T%lu 0 %lu 0\n",
552 (u_long) stb.st_mtime,
553 (u_long) stb.st_atime);
554 (void) atomicio(write, remout, buf, strlen(buf));
558 #define FILEMODEMASK (S_ISUID|S_ISGID|S_IRWXU|S_IRWXG|S_IRWXO)
559 #ifdef HAVE_LONG_LONG_INT
560 snprintf(buf, sizeof buf, "C%04o %lld %s\n",
561 (u_int) (stb.st_mode & FILEMODEMASK),
562 (long long)stb.st_size, last);
564 /* XXX: Handle integer overflow? */
565 snprintf(buf, sizeof buf, "C%04o %lu %s\n",
566 (u_int) (stb.st_mode & FILEMODEMASK),
567 (u_long) stb.st_size, last);
570 fprintf(stderr, "Sending file modes: %s", buf);
572 (void) atomicio(write, remout, buf, strlen(buf));
575 if ((bp = allocbuf(&buffer, fd, 2048)) == NULL) {
576 next: (void) close(fd);
580 start_progress_meter(curfile, stb.st_size, &statbytes);
581 /* Keep writing after an error so that we stay sync'd up. */
582 for (haderr = i = 0; i < stb.st_size; i += bp->cnt) {
584 if (i + amt > stb.st_size)
585 amt = stb.st_size - i;
587 result = atomicio(read, fd, bp->buf, amt);
589 haderr = result >= 0 ? EIO : errno;
592 (void) atomicio(write, remout, bp->buf, amt);
594 result = atomicio(write, remout, bp->buf, amt);
596 haderr = result >= 0 ? EIO : errno;
603 stop_progress_meter();
605 if (close(fd) < 0 && !haderr)
608 (void) atomicio(write, remout, "", 1);
610 run_err("%s: %s", name, strerror(haderr));
622 char *last, *vect[1], path[1100];
624 if (!(dirp = opendir(name))) {
625 run_err("%s: %s", name, strerror(errno));
628 last = strrchr(name, '/');
634 (void) snprintf(path, sizeof(path), "T%lu 0 %lu 0\n",
635 (u_long) statp->st_mtime,
636 (u_long) statp->st_atime);
637 (void) atomicio(write, remout, path, strlen(path));
638 if (response() < 0) {
643 (void) snprintf(path, sizeof path, "D%04o %d %.1024s\n",
644 (u_int) (statp->st_mode & FILEMODEMASK), 0, last);
646 fprintf(stderr, "Entering directory: %s", path);
647 (void) atomicio(write, remout, path, strlen(path));
648 if (response() < 0) {
652 while ((dp = readdir(dirp)) != NULL) {
655 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, ".."))
657 if (strlen(name) + 1 + strlen(dp->d_name) >= sizeof(path) - 1) {
658 run_err("%s/%s: name too long", name, dp->d_name);
661 (void) snprintf(path, sizeof path, "%s/%s", name, dp->d_name);
665 (void) closedir(dirp);
666 (void) atomicio(write, remout, "E\n", 2);
673 static struct timeval bwstart, bwend;
674 static int lamt, thresh = 16384;
676 struct timespec ts, rm;
678 if (!timerisset(&bwstart)) {
679 gettimeofday(&bwstart, NULL);
687 gettimeofday(&bwend, NULL);
688 timersub(&bwend, &bwstart, &bwend);
689 if (!timerisset(&bwend))
693 wait = (double)1000000L * lamt / limitbw;
695 bwstart.tv_sec = wait / 1000000L;
696 bwstart.tv_usec = wait % 1000000L;
698 if (timercmp(&bwstart, &bwend, >)) {
699 timersub(&bwstart, &bwend, &bwend);
701 /* Adjust the wait time */
706 } else if (bwend.tv_usec < 100) {
712 TIMEVAL_TO_TIMESPEC(&bwend, &ts);
713 while (nanosleep(&ts, &rm) == -1) {
721 gettimeofday(&bwstart, NULL);
736 int amt, count, exists, first, mask, mode, ofd, omode;
737 off_t size, statbytes;
738 int setimes, targisdir, wrerrno = 0;
739 char ch, *cp, *np, *targ, *why, *vect[1], buf[2048];
740 struct timeval tv[2];
744 #define SCREWUP(str) do { why = str; goto screwup; } while (0)
746 setimes = targisdir = 0;
751 run_err("ambiguous target");
755 if (targetshouldbedirectory)
758 (void) atomicio(write, remout, "", 1);
759 if (stat(targ, &stb) == 0 && S_ISDIR(stb.st_mode))
761 for (first = 1;; first = 0) {
763 if (atomicio(read, remin, cp, 1) <= 0)
766 SCREWUP("unexpected <newline>");
768 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
769 SCREWUP("lost connection");
771 } while (cp < &buf[sizeof(buf) - 1] && ch != '\n');
774 if (buf[0] == '\01' || buf[0] == '\02') {
776 (void) atomicio(write, STDERR_FILENO,
777 buf + 1, strlen(buf + 1));
784 (void) atomicio(write, remout, "", 1);
794 mtime.tv_sec = strtol(cp, &cp, 10);
795 if (!cp || *cp++ != ' ')
796 SCREWUP("mtime.sec not delimited");
797 mtime.tv_usec = strtol(cp, &cp, 10);
798 if (!cp || *cp++ != ' ')
799 SCREWUP("mtime.usec not delimited");
800 atime.tv_sec = strtol(cp, &cp, 10);
801 if (!cp || *cp++ != ' ')
802 SCREWUP("atime.sec not delimited");
803 atime.tv_usec = strtol(cp, &cp, 10);
804 if (!cp || *cp++ != '\0')
805 SCREWUP("atime.usec not delimited");
806 (void) atomicio(write, remout, "", 1);
809 if (*cp != 'C' && *cp != 'D') {
811 * Check for the case "rcp remote:foo\* local:bar".
812 * In this case, the line "No match." can be returned
813 * by the shell before the rcp command on the remote is
814 * executed so the ^Aerror_message convention isn't
821 SCREWUP("expected control record");
824 for (++cp; cp < buf + 5; cp++) {
825 if (*cp < '0' || *cp > '7')
827 mode = (mode << 3) | (*cp - '0');
830 SCREWUP("mode not delimited");
832 for (size = 0; isdigit(*cp);)
833 size = size * 10 + (*cp++ - '0');
835 SCREWUP("size not delimited");
837 static char *namebuf;
841 need = strlen(targ) + strlen(cp) + 250;
842 if (need > cursize) {
845 namebuf = xmalloc(need);
848 (void) snprintf(namebuf, need, "%s%s%s", targ,
849 strcmp(targ, "/") ? "/" : "", cp);
854 exists = stat(np, &stb) == 0;
856 int mod_flag = pflag;
858 if (!S_ISDIR(stb.st_mode)) {
863 (void) chmod(np, mode);
865 /* Handle copying from a read-only
868 if (mkdir(np, mode | S_IRWXU) < 0)
871 vect[0] = xstrdup(np);
875 if (utimes(vect[0], tv) < 0)
876 run_err("%s: set times: %s",
877 vect[0], strerror(errno));
880 (void) chmod(vect[0], mode);
887 if ((ofd = open(np, O_WRONLY|O_CREAT, mode)) < 0) {
888 bad: run_err("%s: %s", np, strerror(errno));
891 (void) atomicio(write, remout, "", 1);
892 if ((bp = allocbuf(&buffer, ofd, 4096)) == NULL) {
901 start_progress_meter(curfile, size, &statbytes);
902 for (count = i = 0; i < size; i += 4096) {
908 j = read(remin, cp, amt);
909 if (j == -1 && (errno == EINTR ||
913 run_err("%s", j ? strerror(errno) :
914 "dropped connection");
925 if (count == bp->cnt) {
926 /* Keep reading so we stay sync'd up. */
928 j = atomicio(write, ofd, bp->buf, count);
931 wrerrno = j >= 0 ? EIO : errno;
939 stop_progress_meter();
940 if (count != 0 && wrerr == NO &&
941 (j = atomicio(write, ofd, bp->buf, count)) != count) {
943 wrerrno = j >= 0 ? EIO : errno;
945 if (wrerr == NO && ftruncate(ofd, size) != 0) {
946 run_err("%s: truncate: %s", np, strerror(errno));
950 if (exists || omode != mode)
952 if (fchmod(ofd, omode))
953 #else /* HAVE_FCHMOD */
954 if (chmod(np, omode))
955 #endif /* HAVE_FCHMOD */
956 run_err("%s: set mode: %s",
957 np, strerror(errno));
959 if (!exists && omode != mode)
961 if (fchmod(ofd, omode & ~mask))
962 #else /* HAVE_FCHMOD */
963 if (chmod(np, omode & ~mask))
964 #endif /* HAVE_FCHMOD */
965 run_err("%s: set mode: %s",
966 np, strerror(errno));
968 if (close(ofd) == -1) {
973 if (setimes && wrerr == NO) {
975 if (utimes(np, tv) < 0) {
976 run_err("%s: set times: %s",
977 np, strerror(errno));
983 run_err("%s: %s", np, strerror(wrerrno));
986 (void) atomicio(write, remout, "", 1);
993 run_err("protocol error: %s", why);
1000 char ch, *cp, resp, rbuf[2048];
1002 if (atomicio(read, remin, &resp, sizeof(resp)) != sizeof(resp))
1012 case 1: /* error, followed by error msg */
1013 case 2: /* fatal error, "" */
1015 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
1018 } while (cp < &rbuf[sizeof(rbuf) - 1] && ch != '\n');
1021 (void) atomicio(write, STDERR_FILENO, rbuf, cp - rbuf);
1033 (void) fprintf(stderr,
1034 "usage: scp [-pqrvBC1246] [-F config] [-S program] [-P port]\n"
1035 " [-c cipher] [-i identity] [-l limit] [-o option]\n"
1036 " [[user@]host1:]file1 [...] [[user@]host2:]file2\n");
1041 run_err(const char *fmt,...)
1047 if (fp == NULL && !(fp = fdopen(remout, "w")))
1049 (void) fprintf(fp, "%c", 0x01);
1050 (void) fprintf(fp, "scp: ");
1052 (void) vfprintf(fp, fmt, ap);
1054 (void) fprintf(fp, "\n");
1059 vfprintf(stderr, fmt, ap);
1061 fprintf(stderr, "\n");
1071 if (!stat(cp, &stb)) {
1072 if (S_ISDIR(stb.st_mode))
1076 run_err("%s: %s", cp, strerror(errno));
1092 if (!isalpha(c) && !isdigit(c)) {
1107 bad: fprintf(stderr, "%s: invalid user name\n", cp0);
1112 allocbuf(bp, fd, blksize)
1117 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
1120 if (fstat(fd, &stb) < 0) {
1121 run_err("fstat: %s", strerror(errno));
1124 size = roundup(stb.st_blksize, blksize);
1127 #else /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1129 #endif /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1130 if (bp->cnt >= size)
1132 if (bp->buf == NULL)
1133 bp->buf = xmalloc(size);
1135 bp->buf = xrealloc(bp->buf, size);
1136 memset(bp->buf, 0, size);
1146 write(STDERR_FILENO, "lost connection\n", 16);