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.125 2005/07/27 10:39:03 dtucker 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;
111 if (do_cmd_pid > 1) {
112 kill(do_cmd_pid, signo ? signo : SIGTERM);
113 waitpid(do_cmd_pid, NULL, 0);
122 * This function executes the given command as the specified user on the
123 * given host. This returns < 0 if execution fails, and >= 0 otherwise. This
124 * assigns the input and output file descriptors on success.
128 do_cmd(char *host, char *remuser, char *cmd, int *fdin, int *fdout, int argc)
130 int pin[2], pout[2], reserved[2];
134 "Executing: program %s host %s, user %s, command %s\n",
136 remuser ? remuser : "(unspecified)", cmd);
139 * Reserve two descriptors so that the real pipes won't get
140 * descriptors 0 and 1 because that will screw up dup2 below.
144 /* Create a socket pair for communicating with ssh. */
146 fatal("pipe: %s", strerror(errno));
148 fatal("pipe: %s", strerror(errno));
150 /* Free the reserved descriptors. */
154 /* Fork a child to execute the command on the remote host using ssh. */
156 if (do_cmd_pid == 0) {
165 args.list[0] = ssh_program;
167 addargs(&args, "-l%s", remuser);
168 addargs(&args, "%s", host);
169 addargs(&args, "%s", cmd);
171 execvp(ssh_program, args.list);
174 } else if (do_cmd_pid == -1) {
175 fatal("fork: %s", strerror(errno));
177 /* Parent. Close the other side, and return the local side. */
182 signal(SIGTERM, killchild);
183 signal(SIGINT, killchild);
184 signal(SIGHUP, killchild);
193 BUF *allocbuf(BUF *, int, int);
197 void run_err(const char *,...);
198 void verifydir(char *);
202 int errs, remin, remout;
203 int pflag, iamremote, iamrecursive, targetshouldbedirectory;
206 char cmd[CMDNEEDS]; /* must hold "rcp -r -p -d\0" */
209 void rsource(char *, struct stat *);
210 void sink(int, char *[]);
211 void source(int, char *[]);
212 void tolocal(int, char *[]);
213 void toremote(char *, int, char *[]);
217 main(int argc, char **argv)
219 int ch, fflag, tflag, status;
225 __progname = ssh_get_progname(argv[0]);
228 addargs(&args, "ssh"); /* overwritten with ssh_program */
229 addargs(&args, "-x");
230 addargs(&args, "-oForwardAgent no");
231 addargs(&args, "-oClearAllForwardings yes");
234 while ((ch = getopt(argc, argv, "dfl:prtvBCc:i:P:q1246zS:o:F:w:")) != -1)
236 /* User-visible flags. */
243 addargs(&args, "-%c", ch);
249 addargs(&args, "-%c%s", ch, optarg);
252 addargs(&args, "-p%s", optarg);
255 addargs(&args, "-oBatchmode yes");
258 speed = strtod(optarg, &endp);
259 if (speed <= 0 || *endp != '\0')
261 limit_rate = speed * 1024;
270 ssh_program = xstrdup(optarg);
273 addargs(&args, "-v");
277 addargs(&args, "-q");
281 /* Server options. */
283 targetshouldbedirectory = 1;
285 case 'f': /* "from" */
293 setmode(0, O_BINARY);
297 addargs(&args, "-w%s", optarg);
305 if ((pwd = getpwuid(userid = getuid())) == NULL)
306 fatal("unknown user %u", (u_int) userid);
308 if (!isatty(STDERR_FILENO))
311 remin = STDIN_FILENO;
312 remout = STDOUT_FILENO;
315 /* Follow "protocol", send data. */
328 targetshouldbedirectory = 1;
332 /* Command to be executed on remote system using "ssh". */
333 (void) snprintf(cmd, sizeof cmd, "scp%s%s%s%s",
334 verbose_mode ? " -v" : "",
335 iamrecursive ? " -r" : "", pflag ? " -p" : "",
336 targetshouldbedirectory ? " -d" : "");
338 (void) signal(SIGPIPE, lostconn);
340 if ((targ = colon(argv[argc - 1]))) /* Dest is remote host. */
341 toremote(targ, argc, argv);
343 tolocal(argc, argv); /* Dest is local host. */
344 if (targetshouldbedirectory)
345 verifydir(argv[argc - 1]);
348 * Finally check the exit status of the ssh process, if one was forked
349 * and no error has occured yet
351 if (do_cmd_pid != -1 && errs == 0) {
355 (void) close(remout);
356 if (waitpid(do_cmd_pid, &status, 0) == -1)
359 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
367 toremote(char *targ, int argc, char **argv)
370 char *bp, *host, *src, *suser, *thost, *tuser, *arg;
376 arg = xstrdup(argv[argc - 1]);
377 if ((thost = strrchr(arg, '@'))) {
388 for (i = 0; i < argc - 1; i++) {
389 src = colon(argv[i]);
390 if (src) { /* remote to remote */
391 static char *ssh_options =
392 "-x -o'ClearAllForwardings yes'";
396 host = strrchr(argv[i], '@');
397 len = strlen(ssh_program) + strlen(argv[i]) +
398 strlen(src) + (tuser ? strlen(tuser) : 0) +
399 strlen(thost) + strlen(targ) +
400 strlen(ssh_options) + CMDNEEDS + 20;
404 host = cleanhostname(host);
407 suser = pwd->pw_name;
408 else if (!okname(suser)) {
412 if (tuser && !okname(tuser)) {
418 "-l %s %s %s %s '%s%s%s:%s'",
419 ssh_program, verbose_mode ? " -v" : "",
420 ssh_options, suser, host, cmd, src,
421 tuser ? tuser : "", tuser ? "@" : "",
424 host = cleanhostname(argv[i]);
426 "exec %s%s %s -n %s "
428 ssh_program, verbose_mode ? " -v" : "",
429 ssh_options, host, cmd, src,
430 tuser ? tuser : "", tuser ? "@" : "",
434 fprintf(stderr, "Executing: %s\n", bp);
438 } else { /* local to remote */
440 len = strlen(targ) + CMDNEEDS + 20;
442 (void) snprintf(bp, len, "%s -t %s", cmd, targ);
443 host = cleanhostname(thost);
444 if (do_cmd(host, tuser, bp, &remin,
457 tolocal(int argc, char **argv)
460 char *bp, *host, *src, *suser;
462 for (i = 0; i < argc - 1; i++) {
463 if (!(src = colon(argv[i]))) { /* Local to local. */
464 len = strlen(_PATH_CP) + strlen(argv[i]) +
465 strlen(argv[argc - 1]) + 20;
467 (void) snprintf(bp, len, "exec %s%s%s %s %s", _PATH_CP,
468 iamrecursive ? " -r" : "", pflag ? " -p" : "",
469 argv[i], argv[argc - 1]);
471 fprintf(stderr, "Executing: %s\n", bp);
480 if ((host = strrchr(argv[i], '@')) == NULL) {
487 suser = pwd->pw_name;
489 host = cleanhostname(host);
490 len = strlen(src) + CMDNEEDS + 20;
492 (void) snprintf(bp, len, "%s -f %s", cmd, src);
493 if (do_cmd(host, suser, bp, &remin, &remout, argc) < 0) {
499 sink(1, argv + argc - 1);
506 source(int argc, char **argv)
511 off_t i, amt, statbytes;
513 int fd = -1, haderr, indx;
514 char *last, *name, buf[16384];
517 for (indx = 0; indx < argc; ++indx) {
521 while (len > 1 && name[len-1] == '/')
523 if (strchr(name, '\n') != NULL) {
524 run_err("%s: skipping, filename contains a newline",
528 if ((fd = open(name, O_RDONLY, 0)) < 0)
530 if (fstat(fd, &stb) < 0) {
531 syserr: run_err("%s: %s", name, strerror(errno));
534 switch (stb.st_mode & S_IFMT) {
544 run_err("%s: not a regular file", name);
547 if ((last = strrchr(name, '/')) == NULL)
554 * Make it compatible with possible future
555 * versions expecting microseconds.
557 (void) snprintf(buf, sizeof buf, "T%lu 0 %lu 0\n",
558 (u_long) stb.st_mtime,
559 (u_long) stb.st_atime);
560 (void) atomicio(vwrite, remout, buf, strlen(buf));
564 #define FILEMODEMASK (S_ISUID|S_ISGID|S_IRWXU|S_IRWXG|S_IRWXO)
565 snprintf(buf, sizeof buf, "C%04o %lld %s\n",
566 (u_int) (stb.st_mode & FILEMODEMASK),
567 (int64_t)stb.st_size, last);
569 fprintf(stderr, "Sending file modes: %s", buf);
571 (void) atomicio(vwrite, remout, buf, strlen(buf));
574 /* this change decreases the number of read/write syscalls*/
575 /* when scp acts as data source. this is the critical change*/
576 /* buf can actually remain at 2k but increasing both to 16k*/
577 /* seemed to make sense*/
578 if ((bp = allocbuf(&buffer, fd, sizeof(buf))) == NULL) {
579 next: (void) close(fd);
583 start_progress_meter(curfile, stb.st_size, &statbytes);
584 /* Keep writing after an error so that we stay sync'd up. */
585 for (haderr = i = 0; i < stb.st_size; i += bp->cnt) {
587 if (i + amt > stb.st_size)
588 amt = stb.st_size - i;
590 result = atomicio(read, fd, bp->buf, amt);
595 (void) atomicio(vwrite, remout, bp->buf, amt);
597 result = atomicio(vwrite, remout, bp->buf, amt);
606 stop_progress_meter();
608 if (close(fd) < 0 && !haderr)
611 (void) atomicio(vwrite, remout, "", 1);
613 run_err("%s: %s", name, strerror(haderr));
619 rsource(char *name, struct stat *statp)
623 char *last, *vect[1], path[1100];
625 if (!(dirp = opendir(name))) {
626 run_err("%s: %s", name, strerror(errno));
629 last = strrchr(name, '/');
635 (void) snprintf(path, sizeof(path), "T%lu 0 %lu 0\n",
636 (u_long) statp->st_mtime,
637 (u_long) statp->st_atime);
638 (void) atomicio(vwrite, remout, path, strlen(path));
639 if (response() < 0) {
644 (void) snprintf(path, sizeof path, "D%04o %d %.1024s\n",
645 (u_int) (statp->st_mode & FILEMODEMASK), 0, last);
647 fprintf(stderr, "Entering directory: %s", path);
648 (void) atomicio(vwrite, remout, path, strlen(path));
649 if (response() < 0) {
653 while ((dp = readdir(dirp)) != NULL) {
656 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, ".."))
658 if (strlen(name) + 1 + strlen(dp->d_name) >= sizeof(path) - 1) {
659 run_err("%s/%s: name too long", name, dp->d_name);
662 (void) snprintf(path, sizeof path, "%s/%s", name, dp->d_name);
666 (void) closedir(dirp);
667 (void) atomicio(vwrite, remout, "E\n", 2);
674 static struct timeval bwstart, bwend;
675 static int lamt, thresh = 16384;
677 struct timespec ts, rm;
679 if (!timerisset(&bwstart)) {
680 gettimeofday(&bwstart, NULL);
688 gettimeofday(&bwend, NULL);
689 timersub(&bwend, &bwstart, &bwend);
690 if (!timerisset(&bwend))
694 waitlen = (double)1000000L * lamt / limit_rate;
696 bwstart.tv_sec = waitlen / 1000000L;
697 bwstart.tv_usec = waitlen % 1000000L;
699 if (timercmp(&bwstart, &bwend, >)) {
700 timersub(&bwstart, &bwend, &bwend);
702 /* Adjust the wait time */
707 } else if (bwend.tv_usec < 100) {
713 TIMEVAL_TO_TIMESPEC(&bwend, &ts);
714 while (nanosleep(&ts, &rm) == -1) {
722 gettimeofday(&bwstart, NULL);
726 sink(int argc, char **argv)
736 int amt, 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[16384];
740 struct timeval tv[2];
744 #define SCREWUP(str) { why = str; goto screwup; }
746 setimes = targisdir = 0;
751 run_err("ambiguous target");
755 if (targetshouldbedirectory)
758 (void) atomicio(vwrite, 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) != 1)
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 fprintf(stderr, "Sink: %s", buf);
776 if (buf[0] == '\01' || buf[0] == '\02') {
778 (void) atomicio(vwrite, STDERR_FILENO,
779 buf + 1, strlen(buf + 1));
786 (void) atomicio(vwrite, remout, "", 1);
796 mtime.tv_sec = strtol(cp, &cp, 10);
797 if (!cp || *cp++ != ' ')
798 SCREWUP("mtime.sec not delimited");
799 mtime.tv_usec = strtol(cp, &cp, 10);
800 if (!cp || *cp++ != ' ')
801 SCREWUP("mtime.usec not delimited");
802 atime.tv_sec = strtol(cp, &cp, 10);
803 if (!cp || *cp++ != ' ')
804 SCREWUP("atime.sec not delimited");
805 atime.tv_usec = strtol(cp, &cp, 10);
806 if (!cp || *cp++ != '\0')
807 SCREWUP("atime.usec not delimited");
808 (void) atomicio(vwrite, remout, "", 1);
811 if (*cp != 'C' && *cp != 'D') {
813 * Check for the case "rcp remote:foo\* local:bar".
814 * In this case, the line "No match." can be returned
815 * by the shell before the rcp command on the remote is
816 * executed so the ^Aerror_message convention isn't
823 SCREWUP("expected control record");
826 for (++cp; cp < buf + 5; cp++) {
827 if (*cp < '0' || *cp > '7')
829 mode = (mode << 3) | (*cp - '0');
832 SCREWUP("mode not delimited");
834 for (size = 0; isdigit(*cp);)
835 size = size * 10 + (*cp++ - '0');
837 SCREWUP("size not delimited");
838 if ((strchr(cp, '/') != NULL) || (strcmp(cp, "..") == 0)) {
839 run_err("error: unexpected filename: %s", cp);
843 static char *namebuf;
844 static size_t cursize;
847 need = strlen(targ) + strlen(cp) + 250;
848 if (need > cursize) {
851 namebuf = xmalloc(need);
854 (void) snprintf(namebuf, need, "%s%s%s", targ,
855 strcmp(targ, "/") ? "/" : "", cp);
860 exists = stat(np, &stb) == 0;
862 int mod_flag = pflag;
864 SCREWUP("received directory without -r");
866 if (!S_ISDIR(stb.st_mode)) {
871 (void) chmod(np, mode);
873 /* Handle copying from a read-only
876 if (mkdir(np, mode | S_IRWXU) < 0)
879 vect[0] = xstrdup(np);
883 if (utimes(vect[0], tv) < 0)
884 run_err("%s: set times: %s",
885 vect[0], strerror(errno));
888 (void) chmod(vect[0], mode);
895 if ((ofd = open(np, O_WRONLY|O_CREAT, mode)) < 0) {
896 bad: run_err("%s: %s", np, strerror(errno));
899 (void) atomicio(vwrite, remout, "", 1);
900 if ((bp = allocbuf(&buffer, ofd, sizeof(buf))) == NULL) {
909 start_progress_meter(curfile, size, &statbytes);
910 for (count = i = 0; i < size; i += sizeof(buf)) {
916 j = atomicio(read, remin, cp, amt);
918 run_err("%s", j ? strerror(errno) :
919 "dropped connection");
928 bwlimit(sizeof(buf));
930 if (count == bp->cnt) {
931 /* Keep reading so we stay sync'd up. */
933 if (atomicio(vwrite, ofd, bp->buf,
944 stop_progress_meter();
945 if (count != 0 && wrerr == NO &&
946 atomicio(vwrite, ofd, bp->buf, count) != count) {
950 if (wrerr == NO && ftruncate(ofd, size) != 0) {
951 run_err("%s: truncate: %s", np, strerror(errno));
955 if (exists || omode != mode)
957 if (fchmod(ofd, omode)) {
958 #else /* HAVE_FCHMOD */
959 if (chmod(np, omode)) {
960 #endif /* HAVE_FCHMOD */
961 run_err("%s: set mode: %s",
962 np, strerror(errno));
966 if (!exists && omode != mode)
968 if (fchmod(ofd, omode & ~mask)) {
969 #else /* HAVE_FCHMOD */
970 if (chmod(np, omode & ~mask)) {
971 #endif /* HAVE_FCHMOD */
972 run_err("%s: set mode: %s",
973 np, strerror(errno));
977 if (close(ofd) == -1) {
982 if (setimes && wrerr == NO) {
984 if (utimes(np, tv) < 0) {
985 run_err("%s: set times: %s",
986 np, strerror(errno));
992 run_err("%s: %s", np, strerror(wrerrno));
995 (void) atomicio(vwrite, remout, "", 1);
1002 run_err("protocol error: %s", why);
1009 char ch, *cp, resp, rbuf[2048];
1011 if (atomicio(read, remin, &resp, sizeof(resp)) != sizeof(resp))
1021 case 1: /* error, followed by error msg */
1022 case 2: /* fatal error, "" */
1024 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
1027 } while (cp < &rbuf[sizeof(rbuf) - 1] && ch != '\n');
1030 (void) atomicio(vwrite, STDERR_FILENO, rbuf, cp - rbuf);
1042 (void) fprintf(stderr,
1043 "usage: scp [-1246BCpqrv] [-c cipher] [-F ssh_config] [-i identity_file]\n"
1044 " [-l limit] [-o ssh_option] [-P port] [-w buffer size] [-S program]\n"
1045 " [[user@]host1:]file1 [...] [[user@]host2:]file2\n");
1050 run_err(const char *fmt,...)
1056 if (fp == NULL && !(fp = fdopen(remout, "w")))
1058 (void) fprintf(fp, "%c", 0x01);
1059 (void) fprintf(fp, "scp: ");
1061 (void) vfprintf(fp, fmt, ap);
1063 (void) fprintf(fp, "\n");
1068 vfprintf(stderr, fmt, ap);
1070 fprintf(stderr, "\n");
1079 if (!stat(cp, &stb)) {
1080 if (S_ISDIR(stb.st_mode))
1084 run_err("%s: %s", cp, strerror(errno));
1099 if (!isalpha(c) && !isdigit(c)) {
1114 bad: fprintf(stderr, "%s: invalid user name\n", cp0);
1119 allocbuf(BUF *bp, int fd, int blksize)
1122 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
1125 if (fstat(fd, &stb) < 0) {
1126 run_err("fstat: %s", strerror(errno));
1129 size = roundup(stb.st_blksize, blksize);
1132 #else /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1134 #endif /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1135 if (bp->cnt >= size)
1137 if (bp->buf == NULL)
1138 bp->buf = xmalloc(size);
1140 bp->buf = xrealloc(bp->buf, size);
1141 memset(bp->buf, 0, size);
1150 write(STDERR_FILENO, "lost connection\n", 16);