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.99 2003/01/23 14:01:53 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) */
111 char *ssh_program = _PATH_SSH_PROGRAM;
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]);
222 addargs(&args, "ssh"); /* overwritten with ssh_program */
223 addargs(&args, "-x");
224 addargs(&args, "-oForwardAgent no");
225 addargs(&args, "-oClearAllForwardings yes");
228 while ((ch = getopt(argc, argv, "dfl:prtvBCc:i:P:q46S:o:F:")) != -1)
230 /* User-visible flags. */
234 addargs(&args, "-%c", ch);
240 addargs(&args, "-%c%s", ch, optarg);
243 addargs(&args, "-p%s", optarg);
246 addargs(&args, "-oBatchmode yes");
249 speed = strtod(optarg, &endp);
250 if (speed <= 0 || *endp != '\0')
252 limit = speed * 1024;
261 ssh_program = xstrdup(optarg);
264 addargs(&args, "-v");
271 /* Server options. */
273 targetshouldbedirectory = 1;
275 case 'f': /* "from" */
283 setmode(0, O_BINARY);
292 if ((pwd = getpwuid(userid = getuid())) == NULL)
293 fatal("unknown user %d", (int) userid);
295 if (!isatty(STDERR_FILENO))
298 remin = STDIN_FILENO;
299 remout = STDOUT_FILENO;
302 /* Follow "protocol", send data. */
315 targetshouldbedirectory = 1;
319 /* Command to be executed on remote system using "ssh". */
320 (void) snprintf(cmd, sizeof cmd, "scp%s%s%s%s",
321 verbose_mode ? " -v" : "",
322 iamrecursive ? " -r" : "", pflag ? " -p" : "",
323 targetshouldbedirectory ? " -d" : "");
325 (void) signal(SIGPIPE, lostconn);
327 if ((targ = colon(argv[argc - 1]))) /* Dest is remote host. */
328 toremote(targ, argc, argv);
330 tolocal(argc, argv); /* Dest is local host. */
331 if (targetshouldbedirectory)
332 verifydir(argv[argc - 1]);
335 * Finally check the exit status of the ssh process, if one was forked
336 * and no error has occured yet
338 if (do_cmd_pid != -1 && errs == 0) {
342 (void) close(remout);
343 if (waitpid(do_cmd_pid, &status, 0) == -1)
346 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
354 toremote(targ, argc, argv)
359 char *bp, *host, *src, *suser, *thost, *tuser;
365 if ((thost = strrchr(argv[argc - 1], '@'))) {
368 tuser = argv[argc - 1];
371 else if (!okname(tuser))
374 thost = argv[argc - 1];
378 for (i = 0; i < argc - 1; i++) {
379 src = colon(argv[i]);
380 if (src) { /* remote to remote */
381 static char *ssh_options =
382 "-x -o'ClearAllForwardings yes'";
386 host = strrchr(argv[i], '@');
387 len = strlen(ssh_program) + strlen(argv[i]) +
388 strlen(src) + (tuser ? strlen(tuser) : 0) +
389 strlen(thost) + strlen(targ) +
390 strlen(ssh_options) + CMDNEEDS + 20;
394 host = cleanhostname(host);
397 suser = pwd->pw_name;
398 else if (!okname(suser))
402 "-l %s %s %s %s '%s%s%s:%s'",
403 ssh_program, verbose_mode ? " -v" : "",
404 ssh_options, suser, host, cmd, src,
405 tuser ? tuser : "", tuser ? "@" : "",
408 host = cleanhostname(argv[i]);
410 "exec %s%s %s -n %s "
412 ssh_program, verbose_mode ? " -v" : "",
413 ssh_options, host, cmd, src,
414 tuser ? tuser : "", tuser ? "@" : "",
418 fprintf(stderr, "Executing: %s\n", bp);
421 } else { /* local to remote */
423 len = strlen(targ) + CMDNEEDS + 20;
425 (void) snprintf(bp, len, "%s -t %s", cmd, targ);
426 host = cleanhostname(thost);
427 if (do_cmd(host, tuser, bp, &remin,
445 char *bp, *host, *src, *suser;
447 for (i = 0; i < argc - 1; i++) {
448 if (!(src = colon(argv[i]))) { /* Local to local. */
449 len = strlen(_PATH_CP) + strlen(argv[i]) +
450 strlen(argv[argc - 1]) + 20;
452 (void) snprintf(bp, len, "exec %s%s%s %s %s", _PATH_CP,
453 iamrecursive ? " -r" : "", pflag ? " -p" : "",
454 argv[i], argv[argc - 1]);
456 fprintf(stderr, "Executing: %s\n", bp);
465 if ((host = strrchr(argv[i], '@')) == NULL) {
472 suser = pwd->pw_name;
473 else if (!okname(suser))
476 host = cleanhostname(host);
477 len = strlen(src) + CMDNEEDS + 20;
479 (void) snprintf(bp, len, "%s -f %s", cmd, src);
480 if (do_cmd(host, suser, bp, &remin, &remout, argc) < 0) {
486 sink(1, argv + argc - 1);
500 off_t i, amt, result, statbytes;
501 int fd, haderr, indx;
502 char *last, *name, buf[2048];
505 for (indx = 0; indx < argc; ++indx) {
509 while (len > 1 && name[len-1] == '/')
511 if (strchr(name, '\n') != NULL) {
512 run_err("%s: skipping, filename contains a newline",
516 if ((fd = open(name, O_RDONLY, 0)) < 0)
518 if (fstat(fd, &stb) < 0) {
519 syserr: run_err("%s: %s", name, strerror(errno));
522 switch (stb.st_mode & S_IFMT) {
532 run_err("%s: not a regular file", name);
535 if ((last = strrchr(name, '/')) == NULL)
542 * Make it compatible with possible future
543 * versions expecting microseconds.
545 (void) snprintf(buf, sizeof buf, "T%lu 0 %lu 0\n",
546 (u_long) stb.st_mtime,
547 (u_long) stb.st_atime);
548 (void) atomicio(write, remout, buf, strlen(buf));
552 #define FILEMODEMASK (S_ISUID|S_ISGID|S_IRWXU|S_IRWXG|S_IRWXO)
553 #ifdef HAVE_LONG_LONG_INT
554 snprintf(buf, sizeof buf, "C%04o %lld %s\n",
555 (u_int) (stb.st_mode & FILEMODEMASK),
556 (long long)stb.st_size, last);
558 /* XXX: Handle integer overflow? */
559 snprintf(buf, sizeof buf, "C%04o %lu %s\n",
560 (u_int) (stb.st_mode & FILEMODEMASK),
561 (u_long) stb.st_size, last);
564 fprintf(stderr, "Sending file modes: %s", buf);
566 (void) atomicio(write, remout, buf, strlen(buf));
569 if ((bp = allocbuf(&buffer, fd, 2048)) == NULL) {
570 next: (void) close(fd);
574 start_progress_meter(curfile, stb.st_size, &statbytes);
575 /* Keep writing after an error so that we stay sync'd up. */
576 for (haderr = i = 0; i < stb.st_size; i += bp->cnt) {
578 if (i + amt > stb.st_size)
579 amt = stb.st_size - i;
581 result = atomicio(read, fd, bp->buf, amt);
583 haderr = result >= 0 ? EIO : errno;
586 (void) atomicio(write, remout, bp->buf, amt);
588 result = atomicio(write, remout, bp->buf, amt);
590 haderr = result >= 0 ? EIO : errno;
597 stop_progress_meter();
599 if (close(fd) < 0 && !haderr)
602 (void) atomicio(write, remout, "", 1);
604 run_err("%s: %s", name, strerror(haderr));
616 char *last, *vect[1], path[1100];
618 if (!(dirp = opendir(name))) {
619 run_err("%s: %s", name, strerror(errno));
622 last = strrchr(name, '/');
628 (void) snprintf(path, sizeof(path), "T%lu 0 %lu 0\n",
629 (u_long) statp->st_mtime,
630 (u_long) statp->st_atime);
631 (void) atomicio(write, remout, path, strlen(path));
632 if (response() < 0) {
637 (void) snprintf(path, sizeof path, "D%04o %d %.1024s\n",
638 (u_int) (statp->st_mode & FILEMODEMASK), 0, last);
640 fprintf(stderr, "Entering directory: %s", path);
641 (void) atomicio(write, remout, path, strlen(path));
642 if (response() < 0) {
646 while ((dp = readdir(dirp)) != NULL) {
649 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, ".."))
651 if (strlen(name) + 1 + strlen(dp->d_name) >= sizeof(path) - 1) {
652 run_err("%s/%s: name too long", name, dp->d_name);
655 (void) snprintf(path, sizeof path, "%s/%s", name, dp->d_name);
659 (void) closedir(dirp);
660 (void) atomicio(write, remout, "E\n", 2);
667 static struct timeval bwstart, bwend;
668 static int lamt, thresh = 16384;
670 struct timespec ts, rm;
672 if (!timerisset(&bwstart)) {
673 gettimeofday(&bwstart, NULL);
681 gettimeofday(&bwend, NULL);
682 timersub(&bwend, &bwstart, &bwend);
683 if (!timerisset(&bwend))
687 wait = (double)1000000L * lamt / limit;
689 bwstart.tv_sec = wait / 1000000L;
690 bwstart.tv_usec = wait % 1000000L;
692 if (timercmp(&bwstart, &bwend, >)) {
693 timersub(&bwstart, &bwend, &bwend);
695 /* Adjust the wait time */
700 } else if (bwend.tv_usec < 100) {
706 TIMEVAL_TO_TIMESPEC(&bwend, &ts);
707 while (nanosleep(&ts, &rm) == -1) {
715 gettimeofday(&bwstart, NULL);
730 int amt, count, exists, first, mask, mode, ofd, omode;
731 off_t size, statbytes;
732 int setimes, targisdir, wrerrno = 0;
733 char ch, *cp, *np, *targ, *why, *vect[1], buf[2048];
734 struct timeval tv[2];
738 #define SCREWUP(str) do { why = str; goto screwup; } while (0)
740 setimes = targisdir = 0;
745 run_err("ambiguous target");
749 if (targetshouldbedirectory)
752 (void) atomicio(write, remout, "", 1);
753 if (stat(targ, &stb) == 0 && S_ISDIR(stb.st_mode))
755 for (first = 1;; first = 0) {
757 if (atomicio(read, remin, cp, 1) <= 0)
760 SCREWUP("unexpected <newline>");
762 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
763 SCREWUP("lost connection");
765 } while (cp < &buf[sizeof(buf) - 1] && ch != '\n');
768 if (buf[0] == '\01' || buf[0] == '\02') {
770 (void) atomicio(write, STDERR_FILENO,
771 buf + 1, strlen(buf + 1));
778 (void) atomicio(write, remout, "", 1);
788 mtime.tv_sec = strtol(cp, &cp, 10);
789 if (!cp || *cp++ != ' ')
790 SCREWUP("mtime.sec not delimited");
791 mtime.tv_usec = strtol(cp, &cp, 10);
792 if (!cp || *cp++ != ' ')
793 SCREWUP("mtime.usec not delimited");
794 atime.tv_sec = strtol(cp, &cp, 10);
795 if (!cp || *cp++ != ' ')
796 SCREWUP("atime.sec not delimited");
797 atime.tv_usec = strtol(cp, &cp, 10);
798 if (!cp || *cp++ != '\0')
799 SCREWUP("atime.usec not delimited");
800 (void) atomicio(write, remout, "", 1);
803 if (*cp != 'C' && *cp != 'D') {
805 * Check for the case "rcp remote:foo\* local:bar".
806 * In this case, the line "No match." can be returned
807 * by the shell before the rcp command on the remote is
808 * executed so the ^Aerror_message convention isn't
815 SCREWUP("expected control record");
818 for (++cp; cp < buf + 5; cp++) {
819 if (*cp < '0' || *cp > '7')
821 mode = (mode << 3) | (*cp - '0');
824 SCREWUP("mode not delimited");
826 for (size = 0; isdigit(*cp);)
827 size = size * 10 + (*cp++ - '0');
829 SCREWUP("size not delimited");
831 static char *namebuf;
835 need = strlen(targ) + strlen(cp) + 250;
836 if (need > cursize) {
839 namebuf = xmalloc(need);
842 (void) snprintf(namebuf, need, "%s%s%s", targ,
843 strcmp(targ, "/") ? "/" : "", cp);
848 exists = stat(np, &stb) == 0;
850 int mod_flag = pflag;
852 if (!S_ISDIR(stb.st_mode)) {
857 (void) chmod(np, mode);
859 /* Handle copying from a read-only
862 if (mkdir(np, mode | S_IRWXU) < 0)
865 vect[0] = xstrdup(np);
869 if (utimes(vect[0], tv) < 0)
870 run_err("%s: set times: %s",
871 vect[0], strerror(errno));
874 (void) chmod(vect[0], mode);
881 if ((ofd = open(np, O_WRONLY|O_CREAT, mode)) < 0) {
882 bad: run_err("%s: %s", np, strerror(errno));
885 (void) atomicio(write, remout, "", 1);
886 if ((bp = allocbuf(&buffer, ofd, 4096)) == NULL) {
895 start_progress_meter(curfile, size, &statbytes);
896 for (count = i = 0; i < size; i += 4096) {
902 j = read(remin, cp, amt);
903 if (j == -1 && (errno == EINTR ||
907 run_err("%s", j ? strerror(errno) :
908 "dropped connection");
919 if (count == bp->cnt) {
920 /* Keep reading so we stay sync'd up. */
922 j = atomicio(write, ofd, bp->buf, count);
925 wrerrno = j >= 0 ? EIO : errno;
933 stop_progress_meter();
934 if (count != 0 && wrerr == NO &&
935 (j = atomicio(write, ofd, bp->buf, count)) != count) {
937 wrerrno = j >= 0 ? EIO : errno;
939 if (wrerr == NO && ftruncate(ofd, size) != 0) {
940 run_err("%s: truncate: %s", np, strerror(errno));
944 if (exists || omode != mode)
946 if (fchmod(ofd, omode))
947 #else /* HAVE_FCHMOD */
948 if (chmod(np, omode))
949 #endif /* HAVE_FCHMOD */
950 run_err("%s: set mode: %s",
951 np, strerror(errno));
953 if (!exists && omode != mode)
955 if (fchmod(ofd, omode & ~mask))
956 #else /* HAVE_FCHMOD */
957 if (chmod(np, omode & ~mask))
958 #endif /* HAVE_FCHMOD */
959 run_err("%s: set mode: %s",
960 np, strerror(errno));
962 if (close(ofd) == -1) {
967 if (setimes && wrerr == NO) {
969 if (utimes(np, tv) < 0) {
970 run_err("%s: set times: %s",
971 np, strerror(errno));
977 run_err("%s: %s", np, strerror(wrerrno));
980 (void) atomicio(write, remout, "", 1);
987 run_err("protocol error: %s", why);
994 char ch, *cp, resp, rbuf[2048];
996 if (atomicio(read, remin, &resp, sizeof(resp)) != sizeof(resp))
1006 case 1: /* error, followed by error msg */
1007 case 2: /* fatal error, "" */
1009 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
1012 } while (cp < &rbuf[sizeof(rbuf) - 1] && ch != '\n');
1015 (void) atomicio(write, STDERR_FILENO, rbuf, cp - rbuf);
1027 (void) fprintf(stderr,
1028 "usage: scp [-pqrvBC46] [-F config] [-S program] [-P port]\n"
1029 " [-c cipher] [-i identity] [-l limit] [-o option]\n"
1030 " [[user@]host1:]file1 [...] [[user@]host2:]file2\n");
1035 run_err(const char *fmt,...)
1041 if (fp == NULL && !(fp = fdopen(remout, "w")))
1043 (void) fprintf(fp, "%c", 0x01);
1044 (void) fprintf(fp, "scp: ");
1046 (void) vfprintf(fp, fmt, ap);
1048 (void) fprintf(fp, "\n");
1053 vfprintf(stderr, fmt, ap);
1055 fprintf(stderr, "\n");
1065 if (!stat(cp, &stb)) {
1066 if (S_ISDIR(stb.st_mode))
1070 run_err("%s: %s", cp, strerror(errno));
1086 if (!isalpha(c) && !isdigit(c) &&
1087 c != '@' && c != '_' && c != '-' && c != '.' && c != '+')
1092 bad: fprintf(stderr, "%s: invalid user name\n", cp0);
1097 allocbuf(bp, fd, blksize)
1102 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
1105 if (fstat(fd, &stb) < 0) {
1106 run_err("fstat: %s", strerror(errno));
1109 size = roundup(stb.st_blksize, blksize);
1112 #else /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1114 #endif /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1115 if (bp->cnt >= size)
1117 if (bp->buf == NULL)
1118 bp->buf = xmalloc(size);
1120 bp->buf = xrealloc(bp->buf, size);
1121 memset(bp->buf, 0, size);
1131 write(STDERR_FILENO, "lost connection\n", 16);