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.119 2005/01/24 10:22:06 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);
113 waitpid(do_cmd_pid, NULL, 0);
120 * This function executes the given command as the specified user on the
121 * given host. This returns < 0 if execution fails, and >= 0 otherwise. This
122 * assigns the input and output file descriptors on success.
126 do_cmd(char *host, char *remuser, char *cmd, int *fdin, int *fdout, int argc)
128 int pin[2], pout[2], reserved[2];
132 "Executing: program %s host %s, user %s, command %s\n",
134 remuser ? remuser : "(unspecified)", cmd);
137 * Reserve two descriptors so that the real pipes won't get
138 * descriptors 0 and 1 because that will screw up dup2 below.
142 /* Create a socket pair for communicating with ssh. */
144 fatal("pipe: %s", strerror(errno));
146 fatal("pipe: %s", strerror(errno));
148 /* Free the reserved descriptors. */
152 /* Fork a child to execute the command on the remote host using ssh. */
154 if (do_cmd_pid == 0) {
163 args.list[0] = ssh_program;
165 addargs(&args, "-l%s", remuser);
166 addargs(&args, "%s", host);
167 addargs(&args, "%s", cmd);
169 execvp(ssh_program, args.list);
172 } else if (do_cmd_pid == -1) {
173 fatal("fork: %s", strerror(errno));
175 /* Parent. Close the other side, and return the local side. */
180 signal(SIGTERM, killchild);
181 signal(SIGINT, killchild);
182 signal(SIGHUP, killchild);
191 BUF *allocbuf(BUF *, int, int);
195 void run_err(const char *,...);
196 void verifydir(char *);
200 int errs, remin, remout;
201 int pflag, iamremote, iamrecursive, targetshouldbedirectory;
204 char cmd[CMDNEEDS]; /* must hold "rcp -r -p -d\0" */
207 void rsource(char *, struct stat *);
208 void sink(int, char *[]);
209 void source(int, char *[]);
210 void tolocal(int, char *[]);
211 void toremote(char *, int, char *[]);
215 main(int argc, char **argv)
217 int ch, fflag, tflag, status;
223 __progname = ssh_get_progname(argv[0]);
226 addargs(&args, "ssh"); /* overwritten with ssh_program */
227 addargs(&args, "-x");
228 addargs(&args, "-oForwardAgent no");
229 addargs(&args, "-oClearAllForwardings yes");
232 while ((ch = getopt(argc, argv, "dfl:prtvBCc:i:P:q1246S:o:F:")) != -1)
234 /* User-visible flags. */
240 addargs(&args, "-%c", ch);
246 addargs(&args, "-%c%s", ch, optarg);
249 addargs(&args, "-p%s", optarg);
252 addargs(&args, "-oBatchmode yes");
255 speed = strtod(optarg, &endp);
256 if (speed <= 0 || *endp != '\0')
258 limit_rate = speed * 1024;
267 ssh_program = xstrdup(optarg);
270 addargs(&args, "-v");
274 addargs(&args, "-q");
278 /* Server options. */
280 targetshouldbedirectory = 1;
282 case 'f': /* "from" */
290 setmode(0, O_BINARY);
299 if ((pwd = getpwuid(userid = getuid())) == NULL)
300 fatal("unknown user %u", (u_int) userid);
302 if (!isatty(STDERR_FILENO))
305 remin = STDIN_FILENO;
306 remout = STDOUT_FILENO;
309 /* Follow "protocol", send data. */
322 targetshouldbedirectory = 1;
326 /* Command to be executed on remote system using "ssh". */
327 (void) snprintf(cmd, sizeof cmd, "scp%s%s%s%s",
328 verbose_mode ? " -v" : "",
329 iamrecursive ? " -r" : "", pflag ? " -p" : "",
330 targetshouldbedirectory ? " -d" : "");
332 (void) signal(SIGPIPE, lostconn);
334 if ((targ = colon(argv[argc - 1]))) /* Dest is remote host. */
335 toremote(targ, argc, argv);
337 tolocal(argc, argv); /* Dest is local host. */
338 if (targetshouldbedirectory)
339 verifydir(argv[argc - 1]);
342 * Finally check the exit status of the ssh process, if one was forked
343 * and no error has occured yet
345 if (do_cmd_pid != -1 && errs == 0) {
349 (void) close(remout);
350 if (waitpid(do_cmd_pid, &status, 0) == -1)
353 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
361 toremote(char *targ, int argc, char **argv)
364 char *bp, *host, *src, *suser, *thost, *tuser;
370 if ((thost = strrchr(argv[argc - 1], '@'))) {
373 tuser = argv[argc - 1];
377 thost = argv[argc - 1];
381 for (i = 0; i < argc - 1; i++) {
382 src = colon(argv[i]);
383 if (src) { /* remote to remote */
384 static char *ssh_options =
385 "-x -o'ClearAllForwardings yes'";
389 host = strrchr(argv[i], '@');
390 len = strlen(ssh_program) + strlen(argv[i]) +
391 strlen(src) + (tuser ? strlen(tuser) : 0) +
392 strlen(thost) + strlen(targ) +
393 strlen(ssh_options) + CMDNEEDS + 20;
397 host = cleanhostname(host);
400 suser = pwd->pw_name;
401 else if (!okname(suser)) {
405 if (tuser && !okname(tuser)) {
411 "-l %s %s %s %s '%s%s%s:%s'",
412 ssh_program, verbose_mode ? " -v" : "",
413 ssh_options, suser, host, cmd, src,
414 tuser ? tuser : "", tuser ? "@" : "",
417 host = cleanhostname(argv[i]);
419 "exec %s%s %s -n %s "
421 ssh_program, verbose_mode ? " -v" : "",
422 ssh_options, host, cmd, src,
423 tuser ? tuser : "", tuser ? "@" : "",
427 fprintf(stderr, "Executing: %s\n", bp);
431 } else { /* local to remote */
433 len = strlen(targ) + CMDNEEDS + 20;
435 (void) snprintf(bp, len, "%s -t %s", cmd, targ);
436 host = cleanhostname(thost);
437 if (do_cmd(host, tuser, bp, &remin,
450 tolocal(int argc, char **argv)
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);
499 source(int argc, char **argv)
504 off_t i, amt, result, statbytes;
505 int fd, haderr, indx;
506 char *last, *name, buf[2048];
509 for (indx = 0; indx < argc; ++indx) {
513 while (len > 1 && name[len-1] == '/')
515 if (strchr(name, '\n') != NULL) {
516 run_err("%s: skipping, filename contains a newline",
520 if ((fd = open(name, O_RDONLY, 0)) < 0)
522 if (fstat(fd, &stb) < 0) {
523 syserr: run_err("%s: %s", name, strerror(errno));
526 switch (stb.st_mode & S_IFMT) {
536 run_err("%s: not a regular file", name);
539 if ((last = strrchr(name, '/')) == NULL)
546 * Make it compatible with possible future
547 * versions expecting microseconds.
549 (void) snprintf(buf, sizeof buf, "T%lu 0 %lu 0\n",
550 (u_long) stb.st_mtime,
551 (u_long) stb.st_atime);
552 (void) atomicio(vwrite, remout, buf, strlen(buf));
556 #define FILEMODEMASK (S_ISUID|S_ISGID|S_IRWXU|S_IRWXG|S_IRWXO)
557 snprintf(buf, sizeof buf, "C%04o %lld %s\n",
558 (u_int) (stb.st_mode & FILEMODEMASK),
559 (int64_t)stb.st_size, last);
561 fprintf(stderr, "Sending file modes: %s", buf);
563 (void) atomicio(vwrite, remout, buf, strlen(buf));
566 if ((bp = allocbuf(&buffer, fd, 2048)) == NULL) {
567 next: (void) close(fd);
571 start_progress_meter(curfile, stb.st_size, &statbytes);
572 /* Keep writing after an error so that we stay sync'd up. */
573 for (haderr = i = 0; i < stb.st_size; i += bp->cnt) {
575 if (i + amt > stb.st_size)
576 amt = stb.st_size - i;
578 result = atomicio(read, fd, bp->buf, amt);
580 haderr = result >= 0 ? EIO : errno;
583 (void) atomicio(vwrite, remout, bp->buf, amt);
585 result = atomicio(vwrite, remout, bp->buf, amt);
587 haderr = result >= 0 ? EIO : errno;
594 stop_progress_meter();
596 if (close(fd) < 0 && !haderr)
599 (void) atomicio(vwrite, remout, "", 1);
601 run_err("%s: %s", name, strerror(haderr));
607 rsource(char *name, struct stat *statp)
611 char *last, *vect[1], path[1100];
613 if (!(dirp = opendir(name))) {
614 run_err("%s: %s", name, strerror(errno));
617 last = strrchr(name, '/');
623 (void) snprintf(path, sizeof(path), "T%lu 0 %lu 0\n",
624 (u_long) statp->st_mtime,
625 (u_long) statp->st_atime);
626 (void) atomicio(vwrite, remout, path, strlen(path));
627 if (response() < 0) {
632 (void) snprintf(path, sizeof path, "D%04o %d %.1024s\n",
633 (u_int) (statp->st_mode & FILEMODEMASK), 0, last);
635 fprintf(stderr, "Entering directory: %s", path);
636 (void) atomicio(vwrite, remout, path, strlen(path));
637 if (response() < 0) {
641 while ((dp = readdir(dirp)) != NULL) {
644 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, ".."))
646 if (strlen(name) + 1 + strlen(dp->d_name) >= sizeof(path) - 1) {
647 run_err("%s/%s: name too long", name, dp->d_name);
650 (void) snprintf(path, sizeof path, "%s/%s", name, dp->d_name);
654 (void) closedir(dirp);
655 (void) atomicio(vwrite, remout, "E\n", 2);
662 static struct timeval bwstart, bwend;
663 static int lamt, thresh = 16384;
665 struct timespec ts, rm;
667 if (!timerisset(&bwstart)) {
668 gettimeofday(&bwstart, NULL);
676 gettimeofday(&bwend, NULL);
677 timersub(&bwend, &bwstart, &bwend);
678 if (!timerisset(&bwend))
682 waitlen = (double)1000000L * lamt / limit_rate;
684 bwstart.tv_sec = waitlen / 1000000L;
685 bwstart.tv_usec = waitlen % 1000000L;
687 if (timercmp(&bwstart, &bwend, >)) {
688 timersub(&bwstart, &bwend, &bwend);
690 /* Adjust the wait time */
695 } else if (bwend.tv_usec < 100) {
701 TIMEVAL_TO_TIMESPEC(&bwend, &ts);
702 while (nanosleep(&ts, &rm) == -1) {
710 gettimeofday(&bwstart, NULL);
714 sink(int argc, char **argv)
723 int amt, count, exists, first, mask, mode, ofd, omode;
724 off_t size, statbytes;
725 int setimes, targisdir, wrerrno = 0;
726 char ch, *cp, *np, *targ, *why, *vect[1], buf[2048];
727 struct timeval tv[2];
731 #define SCREWUP(str) { why = str; goto screwup; }
733 setimes = targisdir = 0;
738 run_err("ambiguous target");
742 if (targetshouldbedirectory)
745 (void) atomicio(vwrite, remout, "", 1);
746 if (stat(targ, &stb) == 0 && S_ISDIR(stb.st_mode))
748 for (first = 1;; first = 0) {
750 if (atomicio(read, remin, cp, 1) <= 0)
753 SCREWUP("unexpected <newline>");
755 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
756 SCREWUP("lost connection");
758 } while (cp < &buf[sizeof(buf) - 1] && ch != '\n');
761 fprintf(stderr, "Sink: %s", buf);
763 if (buf[0] == '\01' || buf[0] == '\02') {
765 (void) atomicio(vwrite, STDERR_FILENO,
766 buf + 1, strlen(buf + 1));
773 (void) atomicio(vwrite, remout, "", 1);
783 mtime.tv_sec = strtol(cp, &cp, 10);
784 if (!cp || *cp++ != ' ')
785 SCREWUP("mtime.sec not delimited");
786 mtime.tv_usec = strtol(cp, &cp, 10);
787 if (!cp || *cp++ != ' ')
788 SCREWUP("mtime.usec not delimited");
789 atime.tv_sec = strtol(cp, &cp, 10);
790 if (!cp || *cp++ != ' ')
791 SCREWUP("atime.sec not delimited");
792 atime.tv_usec = strtol(cp, &cp, 10);
793 if (!cp || *cp++ != '\0')
794 SCREWUP("atime.usec not delimited");
795 (void) atomicio(vwrite, remout, "", 1);
798 if (*cp != 'C' && *cp != 'D') {
800 * Check for the case "rcp remote:foo\* local:bar".
801 * In this case, the line "No match." can be returned
802 * by the shell before the rcp command on the remote is
803 * executed so the ^Aerror_message convention isn't
810 SCREWUP("expected control record");
813 for (++cp; cp < buf + 5; cp++) {
814 if (*cp < '0' || *cp > '7')
816 mode = (mode << 3) | (*cp - '0');
819 SCREWUP("mode not delimited");
821 for (size = 0; isdigit(*cp);)
822 size = size * 10 + (*cp++ - '0');
824 SCREWUP("size not delimited");
825 if ((strchr(cp, '/') != NULL) || (strcmp(cp, "..") == 0)) {
826 run_err("error: unexpected filename: %s", cp);
830 static char *namebuf;
834 need = strlen(targ) + strlen(cp) + 250;
835 if (need > cursize) {
838 namebuf = xmalloc(need);
841 (void) snprintf(namebuf, need, "%s%s%s", targ,
842 strcmp(targ, "/") ? "/" : "", cp);
847 exists = stat(np, &stb) == 0;
849 int mod_flag = pflag;
851 SCREWUP("received directory without -r");
853 if (!S_ISDIR(stb.st_mode)) {
858 (void) chmod(np, mode);
860 /* Handle copying from a read-only
863 if (mkdir(np, mode | S_IRWXU) < 0)
866 vect[0] = xstrdup(np);
870 if (utimes(vect[0], tv) < 0)
871 run_err("%s: set times: %s",
872 vect[0], strerror(errno));
875 (void) chmod(vect[0], mode);
882 if ((ofd = open(np, O_WRONLY|O_CREAT, mode)) < 0) {
883 bad: run_err("%s: %s", np, strerror(errno));
886 (void) atomicio(vwrite, remout, "", 1);
887 if ((bp = allocbuf(&buffer, ofd, 4096)) == NULL) {
896 start_progress_meter(curfile, size, &statbytes);
897 for (count = i = 0; i < size; i += 4096) {
903 j = atomicio(read, remin, cp, amt);
905 run_err("%s", j ? strerror(errno) :
906 "dropped connection");
917 if (count == bp->cnt) {
918 /* Keep reading so we stay sync'd up. */
920 j = atomicio(vwrite, ofd, bp->buf, count);
923 wrerrno = j >= 0 ? EIO : errno;
931 stop_progress_meter();
932 if (count != 0 && wrerr == NO &&
933 (j = atomicio(vwrite, ofd, bp->buf, count)) != count) {
935 wrerrno = j >= 0 ? EIO : errno;
937 if (wrerr == NO && ftruncate(ofd, size) != 0) {
938 run_err("%s: truncate: %s", np, strerror(errno));
942 if (exists || omode != mode)
944 if (fchmod(ofd, omode)) {
945 #else /* HAVE_FCHMOD */
946 if (chmod(np, omode)) {
947 #endif /* HAVE_FCHMOD */
948 run_err("%s: set mode: %s",
949 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));
964 if (close(ofd) == -1) {
969 if (setimes && wrerr == NO) {
971 if (utimes(np, tv) < 0) {
972 run_err("%s: set times: %s",
973 np, strerror(errno));
979 run_err("%s: %s", np, strerror(wrerrno));
982 (void) atomicio(vwrite, remout, "", 1);
989 run_err("protocol error: %s", why);
996 char ch, *cp, resp, rbuf[2048];
998 if (atomicio(read, remin, &resp, sizeof(resp)) != sizeof(resp))
1008 case 1: /* error, followed by error msg */
1009 case 2: /* fatal error, "" */
1011 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
1014 } while (cp < &rbuf[sizeof(rbuf) - 1] && ch != '\n');
1017 (void) atomicio(vwrite, STDERR_FILENO, rbuf, cp - rbuf);
1029 (void) fprintf(stderr,
1030 "usage: scp [-1246BCpqrv] [-c cipher] [-F ssh_config] [-i identity_file]\n"
1031 " [-l limit] [-o ssh_option] [-P port] [-S program]\n"
1032 " [[user@]host1:]file1 [...] [[user@]host2:]file2\n");
1037 run_err(const char *fmt,...)
1043 if (fp == NULL && !(fp = fdopen(remout, "w")))
1045 (void) fprintf(fp, "%c", 0x01);
1046 (void) fprintf(fp, "scp: ");
1048 (void) vfprintf(fp, fmt, ap);
1050 (void) fprintf(fp, "\n");
1055 vfprintf(stderr, fmt, ap);
1057 fprintf(stderr, "\n");
1066 if (!stat(cp, &stb)) {
1067 if (S_ISDIR(stb.st_mode))
1071 run_err("%s: %s", cp, strerror(errno));
1086 if (!isalpha(c) && !isdigit(c)) {
1101 bad: fprintf(stderr, "%s: invalid user name\n", cp0);
1106 allocbuf(BUF *bp, int fd, int blksize)
1109 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
1112 if (fstat(fd, &stb) < 0) {
1113 run_err("fstat: %s", strerror(errno));
1116 size = roundup(stb.st_blksize, blksize);
1119 #else /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1121 #endif /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1122 if (bp->cnt >= size)
1124 if (bp->buf == NULL)
1125 bp->buf = xmalloc(size);
1127 bp->buf = xrealloc(bp->buf, size);
1128 memset(bp->buf, 0, size);
1137 write(STDERR_FILENO, "lost connection\n", 16);