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. Neither the name of the University nor the names of its contributors
56 * may be used to endorse or promote products derived from this software
57 * without specific prior written permission.
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
74 RCSID("$OpenBSD: scp.c,v 1.117 2004/08/11 21:44:32 avsm Exp $");
78 #include "pathnames.h"
81 #include "progressmeter.h"
83 extern char *__progname;
87 /* Struct for addargs */
93 /* Name of current file being transferred. */
96 /* This is set to non-zero to enable verbose mode. */
99 /* This is set to zero if the progressmeter is not desired. */
100 int showprogress = 1;
102 /* This is the program to execute for the secured connection. ("ssh" or -S) */
103 char *ssh_program = _PATH_SSH_PROGRAM;
105 /* This is used to store the pid of ssh_program */
106 pid_t do_cmd_pid = -1;
112 kill(do_cmd_pid, signo);
118 * This function executes the given command as the specified user on the
119 * given host. This returns < 0 if execution fails, and >= 0 otherwise. This
120 * assigns the input and output file descriptors on success.
124 do_cmd(char *host, char *remuser, char *cmd, int *fdin, int *fdout, int argc)
126 int pin[2], pout[2], reserved[2];
130 "Executing: program %s host %s, user %s, command %s\n",
132 remuser ? remuser : "(unspecified)", cmd);
135 * Reserve two descriptors so that the real pipes won't get
136 * descriptors 0 and 1 because that will screw up dup2 below.
140 /* Create a socket pair for communicating with ssh. */
142 fatal("pipe: %s", strerror(errno));
144 fatal("pipe: %s", strerror(errno));
146 /* Free the reserved descriptors. */
150 /* Fork a child to execute the command on the remote host using ssh. */
152 if (do_cmd_pid == 0) {
161 args.list[0] = ssh_program;
163 addargs(&args, "-l%s", remuser);
164 addargs(&args, "%s", host);
165 addargs(&args, "%s", cmd);
167 execvp(ssh_program, args.list);
170 } else if (do_cmd_pid == -1) {
171 fatal("fork: %s", strerror(errno));
173 /* Parent. Close the other side, and return the local side. */
178 signal(SIGTERM, killchild);
179 signal(SIGINT, killchild);
180 signal(SIGHUP, killchild);
189 BUF *allocbuf(BUF *, int, int);
193 void run_err(const char *,...);
194 void verifydir(char *);
198 int errs, remin, remout;
199 int pflag, iamremote, iamrecursive, targetshouldbedirectory;
202 char cmd[CMDNEEDS]; /* must hold "rcp -r -p -d\0" */
205 void rsource(char *, struct stat *);
206 void sink(int, char *[]);
207 void source(int, char *[]);
208 void tolocal(int, char *[]);
209 void toremote(char *, int, char *[]);
213 main(int argc, char **argv)
215 int ch, fflag, tflag, status;
221 __progname = ssh_get_progname(argv[0]);
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 limit_rate = speed * 1024;
265 ssh_program = xstrdup(optarg);
268 addargs(&args, "-v");
272 addargs(&args, "-q");
276 /* Server options. */
278 targetshouldbedirectory = 1;
280 case 'f': /* "from" */
288 setmode(0, O_BINARY);
297 if ((pwd = getpwuid(userid = getuid())) == NULL)
298 fatal("unknown user %u", (u_int) userid);
300 if (!isatty(STDERR_FILENO))
303 remin = STDIN_FILENO;
304 remout = STDOUT_FILENO;
307 /* Follow "protocol", send data. */
320 targetshouldbedirectory = 1;
324 /* Command to be executed on remote system using "ssh". */
325 (void) snprintf(cmd, sizeof cmd, "scp%s%s%s%s",
326 verbose_mode ? " -v" : "",
327 iamrecursive ? " -r" : "", pflag ? " -p" : "",
328 targetshouldbedirectory ? " -d" : "");
330 (void) signal(SIGPIPE, lostconn);
332 if ((targ = colon(argv[argc - 1]))) /* Dest is remote host. */
333 toremote(targ, argc, argv);
335 tolocal(argc, argv); /* Dest is local host. */
336 if (targetshouldbedirectory)
337 verifydir(argv[argc - 1]);
340 * Finally check the exit status of the ssh process, if one was forked
341 * and no error has occured yet
343 if (do_cmd_pid != -1 && errs == 0) {
347 (void) close(remout);
348 if (waitpid(do_cmd_pid, &status, 0) == -1)
351 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
359 toremote(char *targ, int argc, char **argv)
362 char *bp, *host, *src, *suser, *thost, *tuser;
368 if ((thost = strrchr(argv[argc - 1], '@'))) {
371 tuser = argv[argc - 1];
375 thost = argv[argc - 1];
379 for (i = 0; i < argc - 1; i++) {
380 src = colon(argv[i]);
381 if (src) { /* remote to remote */
382 static char *ssh_options =
383 "-x -o'ClearAllForwardings yes'";
387 host = strrchr(argv[i], '@');
388 len = strlen(ssh_program) + strlen(argv[i]) +
389 strlen(src) + (tuser ? strlen(tuser) : 0) +
390 strlen(thost) + strlen(targ) +
391 strlen(ssh_options) + CMDNEEDS + 20;
395 host = cleanhostname(host);
398 suser = pwd->pw_name;
399 else if (!okname(suser)) {
403 if (tuser && !okname(tuser)) {
409 "-l %s %s %s %s '%s%s%s:%s'",
410 ssh_program, verbose_mode ? " -v" : "",
411 ssh_options, suser, host, cmd, src,
412 tuser ? tuser : "", tuser ? "@" : "",
415 host = cleanhostname(argv[i]);
417 "exec %s%s %s -n %s "
419 ssh_program, verbose_mode ? " -v" : "",
420 ssh_options, host, cmd, src,
421 tuser ? tuser : "", tuser ? "@" : "",
425 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,
448 tolocal(int argc, char **argv)
451 char *bp, *host, *src, *suser;
453 for (i = 0; i < argc - 1; i++) {
454 if (!(src = colon(argv[i]))) { /* Local to local. */
455 len = strlen(_PATH_CP) + strlen(argv[i]) +
456 strlen(argv[argc - 1]) + 20;
458 (void) snprintf(bp, len, "exec %s%s%s %s %s", _PATH_CP,
459 iamrecursive ? " -r" : "", pflag ? " -p" : "",
460 argv[i], argv[argc - 1]);
462 fprintf(stderr, "Executing: %s\n", bp);
471 if ((host = strrchr(argv[i], '@')) == NULL) {
478 suser = pwd->pw_name;
480 host = cleanhostname(host);
481 len = strlen(src) + CMDNEEDS + 20;
483 (void) snprintf(bp, len, "%s -f %s", cmd, src);
484 if (do_cmd(host, suser, bp, &remin, &remout, argc) < 0) {
490 sink(1, argv + argc - 1);
497 source(int argc, char **argv)
502 off_t i, amt, result, statbytes;
503 int fd, haderr, indx;
504 char *last, *name, buf[2048];
507 for (indx = 0; indx < argc; ++indx) {
511 while (len > 1 && name[len-1] == '/')
513 if (strchr(name, '\n') != NULL) {
514 run_err("%s: skipping, filename contains a newline",
518 if ((fd = open(name, O_RDONLY, 0)) < 0)
520 if (fstat(fd, &stb) < 0) {
521 syserr: run_err("%s: %s", name, strerror(errno));
524 switch (stb.st_mode & S_IFMT) {
534 run_err("%s: not a regular file", name);
537 if ((last = strrchr(name, '/')) == NULL)
544 * Make it compatible with possible future
545 * versions expecting microseconds.
547 (void) snprintf(buf, sizeof buf, "T%lu 0 %lu 0\n",
548 (u_long) stb.st_mtime,
549 (u_long) stb.st_atime);
550 (void) atomicio(vwrite, remout, buf, strlen(buf));
554 #define FILEMODEMASK (S_ISUID|S_ISGID|S_IRWXU|S_IRWXG|S_IRWXO)
555 snprintf(buf, sizeof buf, "C%04o %lld %s\n",
556 (u_int) (stb.st_mode & FILEMODEMASK),
557 (int64_t)stb.st_size, last);
559 fprintf(stderr, "Sending file modes: %s", buf);
561 (void) atomicio(vwrite, remout, buf, strlen(buf));
564 if ((bp = allocbuf(&buffer, fd, 2048)) == NULL) {
565 next: (void) close(fd);
569 start_progress_meter(curfile, stb.st_size, &statbytes);
570 /* Keep writing after an error so that we stay sync'd up. */
571 for (haderr = i = 0; i < stb.st_size; i += bp->cnt) {
573 if (i + amt > stb.st_size)
574 amt = stb.st_size - i;
576 result = atomicio(read, fd, bp->buf, amt);
578 haderr = result >= 0 ? EIO : errno;
581 (void) atomicio(vwrite, remout, bp->buf, amt);
583 result = atomicio(vwrite, remout, bp->buf, amt);
585 haderr = result >= 0 ? EIO : errno;
592 stop_progress_meter();
594 if (close(fd) < 0 && !haderr)
597 (void) atomicio(vwrite, remout, "", 1);
599 run_err("%s: %s", name, strerror(haderr));
605 rsource(char *name, struct stat *statp)
609 char *last, *vect[1], path[1100];
611 if (!(dirp = opendir(name))) {
612 run_err("%s: %s", name, strerror(errno));
615 last = strrchr(name, '/');
621 (void) snprintf(path, sizeof(path), "T%lu 0 %lu 0\n",
622 (u_long) statp->st_mtime,
623 (u_long) statp->st_atime);
624 (void) atomicio(vwrite, remout, path, strlen(path));
625 if (response() < 0) {
630 (void) snprintf(path, sizeof path, "D%04o %d %.1024s\n",
631 (u_int) (statp->st_mode & FILEMODEMASK), 0, last);
633 fprintf(stderr, "Entering directory: %s", path);
634 (void) atomicio(vwrite, remout, path, strlen(path));
635 if (response() < 0) {
639 while ((dp = readdir(dirp)) != NULL) {
642 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, ".."))
644 if (strlen(name) + 1 + strlen(dp->d_name) >= sizeof(path) - 1) {
645 run_err("%s/%s: name too long", name, dp->d_name);
648 (void) snprintf(path, sizeof path, "%s/%s", name, dp->d_name);
652 (void) closedir(dirp);
653 (void) atomicio(vwrite, remout, "E\n", 2);
660 static struct timeval bwstart, bwend;
661 static int lamt, thresh = 16384;
663 struct timespec ts, rm;
665 if (!timerisset(&bwstart)) {
666 gettimeofday(&bwstart, NULL);
674 gettimeofday(&bwend, NULL);
675 timersub(&bwend, &bwstart, &bwend);
676 if (!timerisset(&bwend))
680 waitlen = (double)1000000L * lamt / limit_rate;
682 bwstart.tv_sec = waitlen / 1000000L;
683 bwstart.tv_usec = waitlen % 1000000L;
685 if (timercmp(&bwstart, &bwend, >)) {
686 timersub(&bwstart, &bwend, &bwend);
688 /* Adjust the wait time */
693 } else if (bwend.tv_usec < 100) {
699 TIMEVAL_TO_TIMESPEC(&bwend, &ts);
700 while (nanosleep(&ts, &rm) == -1) {
708 gettimeofday(&bwstart, NULL);
712 sink(int argc, char **argv)
721 int amt, count, exists, first, mask, mode, ofd, omode;
722 off_t size, statbytes;
723 int setimes, targisdir, wrerrno = 0;
724 char ch, *cp, *np, *targ, *why, *vect[1], buf[2048];
725 struct timeval tv[2];
729 #define SCREWUP(str) do { why = str; goto screwup; } while (0)
731 setimes = targisdir = 0;
736 run_err("ambiguous target");
740 if (targetshouldbedirectory)
743 (void) atomicio(vwrite, remout, "", 1);
744 if (stat(targ, &stb) == 0 && S_ISDIR(stb.st_mode))
746 for (first = 1;; first = 0) {
748 if (atomicio(read, remin, cp, 1) <= 0)
751 SCREWUP("unexpected <newline>");
753 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
754 SCREWUP("lost connection");
756 } while (cp < &buf[sizeof(buf) - 1] && ch != '\n');
759 fprintf(stderr, "Sink: %s", buf);
761 if (buf[0] == '\01' || buf[0] == '\02') {
763 (void) atomicio(vwrite, STDERR_FILENO,
764 buf + 1, strlen(buf + 1));
771 (void) atomicio(vwrite, remout, "", 1);
781 mtime.tv_sec = strtol(cp, &cp, 10);
782 if (!cp || *cp++ != ' ')
783 SCREWUP("mtime.sec not delimited");
784 mtime.tv_usec = strtol(cp, &cp, 10);
785 if (!cp || *cp++ != ' ')
786 SCREWUP("mtime.usec not delimited");
787 atime.tv_sec = strtol(cp, &cp, 10);
788 if (!cp || *cp++ != ' ')
789 SCREWUP("atime.sec not delimited");
790 atime.tv_usec = strtol(cp, &cp, 10);
791 if (!cp || *cp++ != '\0')
792 SCREWUP("atime.usec not delimited");
793 (void) atomicio(vwrite, remout, "", 1);
796 if (*cp != 'C' && *cp != 'D') {
798 * Check for the case "rcp remote:foo\* local:bar".
799 * In this case, the line "No match." can be returned
800 * by the shell before the rcp command on the remote is
801 * executed so the ^Aerror_message convention isn't
808 SCREWUP("expected control record");
811 for (++cp; cp < buf + 5; cp++) {
812 if (*cp < '0' || *cp > '7')
814 mode = (mode << 3) | (*cp - '0');
817 SCREWUP("mode not delimited");
819 for (size = 0; isdigit(*cp);)
820 size = size * 10 + (*cp++ - '0');
822 SCREWUP("size not delimited");
823 if ((strchr(cp, '/') != NULL) || (strcmp(cp, "..") == 0)) {
824 run_err("error: unexpected filename: %s", cp);
828 static char *namebuf;
832 need = strlen(targ) + strlen(cp) + 250;
833 if (need > cursize) {
836 namebuf = xmalloc(need);
839 (void) snprintf(namebuf, need, "%s%s%s", targ,
840 strcmp(targ, "/") ? "/" : "", cp);
845 exists = stat(np, &stb) == 0;
847 int mod_flag = pflag;
849 SCREWUP("received directory without -r");
851 if (!S_ISDIR(stb.st_mode)) {
856 (void) chmod(np, mode);
858 /* Handle copying from a read-only
861 if (mkdir(np, mode | S_IRWXU) < 0)
864 vect[0] = xstrdup(np);
868 if (utimes(vect[0], tv) < 0)
869 run_err("%s: set times: %s",
870 vect[0], strerror(errno));
873 (void) chmod(vect[0], mode);
880 if ((ofd = open(np, O_WRONLY|O_CREAT, mode)) < 0) {
881 bad: run_err("%s: %s", np, strerror(errno));
884 (void) atomicio(vwrite, remout, "", 1);
885 if ((bp = allocbuf(&buffer, ofd, 4096)) == NULL) {
894 start_progress_meter(curfile, size, &statbytes);
895 for (count = i = 0; i < size; i += 4096) {
901 j = atomicio(read, remin, cp, amt);
903 run_err("%s", j ? strerror(errno) :
904 "dropped connection");
915 if (count == bp->cnt) {
916 /* Keep reading so we stay sync'd up. */
918 j = atomicio(vwrite, ofd, bp->buf, count);
921 wrerrno = j >= 0 ? EIO : errno;
929 stop_progress_meter();
930 if (count != 0 && wrerr == NO &&
931 (j = atomicio(vwrite, ofd, bp->buf, count)) != count) {
933 wrerrno = j >= 0 ? EIO : errno;
935 if (wrerr == NO && ftruncate(ofd, size) != 0) {
936 run_err("%s: truncate: %s", np, strerror(errno));
940 if (exists || omode != mode)
942 if (fchmod(ofd, omode)) {
943 #else /* HAVE_FCHMOD */
944 if (chmod(np, omode)) {
945 #endif /* HAVE_FCHMOD */
946 run_err("%s: set mode: %s",
947 np, strerror(errno));
951 if (!exists && omode != mode)
953 if (fchmod(ofd, omode & ~mask)) {
954 #else /* HAVE_FCHMOD */
955 if (chmod(np, omode & ~mask)) {
956 #endif /* HAVE_FCHMOD */
957 run_err("%s: set mode: %s",
958 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(vwrite, 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(vwrite, STDERR_FILENO, rbuf, cp - rbuf);
1027 (void) fprintf(stderr,
1028 "usage: scp [-1246BCpqrv] [-c cipher] [-F ssh_config] [-i identity_file]\n"
1029 " [-l limit] [-o ssh_option] [-P port] [-S program]\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");
1064 if (!stat(cp, &stb)) {
1065 if (S_ISDIR(stb.st_mode))
1069 run_err("%s: %s", cp, strerror(errno));
1084 if (!isalpha(c) && !isdigit(c)) {
1099 bad: fprintf(stderr, "%s: invalid user name\n", cp0);
1104 allocbuf(BUF *bp, int fd, int blksize)
1107 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
1110 if (fstat(fd, &stb) < 0) {
1111 run_err("fstat: %s", strerror(errno));
1114 size = roundup(stb.st_blksize, blksize);
1117 #else /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1119 #endif /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1120 if (bp->cnt >= size)
1122 if (bp->buf == NULL)
1123 bp->buf = xmalloc(size);
1125 bp->buf = xrealloc(bp->buf, size);
1126 memset(bp->buf, 0, size);
1135 write(STDERR_FILENO, "lost connection\n", 16);