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.97 2003/01/10 08:19:07 fgsch Exp $");
82 #include "pathnames.h"
85 #include "progressmeter.h"
87 #ifdef HAVE___PROGNAME
88 extern char *__progname;
93 /* Struct for addargs */
96 /* Name of current file being transferred. */
99 /* This is set to non-zero to enable verbose mode. */
100 int verbose_mode = 0;
102 /* This is set to zero if the progressmeter is not desired. */
103 int showprogress = 1;
105 /* This is the program to execute for the secured connection. ("ssh" or -S) */
106 char *ssh_program = _PATH_SSH_PROGRAM;
108 /* This is used to store the pid of ssh_program */
112 * This function executes the given command as the specified user on the
113 * given host. This returns < 0 if execution fails, and >= 0 otherwise. This
114 * assigns the input and output file descriptors on success.
118 do_cmd(char *host, char *remuser, char *cmd, int *fdin, int *fdout, int argc)
120 int pin[2], pout[2], reserved[2];
124 "Executing: program %s host %s, user %s, command %s\n",
126 remuser ? remuser : "(unspecified)", cmd);
129 * Reserve two descriptors so that the real pipes won't get
130 * descriptors 0 and 1 because that will screw up dup2 below.
134 /* Create a socket pair for communicating with ssh. */
136 fatal("pipe: %s", strerror(errno));
138 fatal("pipe: %s", strerror(errno));
140 /* Free the reserved descriptors. */
144 /* For a child to execute the command on the remote host using ssh. */
146 if (do_cmd_pid == 0) {
155 args.list[0] = ssh_program;
157 addargs(&args, "-l%s", remuser);
158 addargs(&args, "%s", host);
159 addargs(&args, "%s", cmd);
161 execvp(ssh_program, args.list);
164 } else if (do_cmd_pid == -1) {
165 fatal("fork: %s", strerror(errno));
167 /* Parent. Close the other side, and return the local side. */
180 BUF *allocbuf(BUF *, int, int);
184 void run_err(const char *,...);
185 void verifydir(char *);
189 int errs, remin, remout;
190 int pflag, iamremote, iamrecursive, targetshouldbedirectory;
193 char cmd[CMDNEEDS]; /* must hold "rcp -r -p -d\0" */
196 void rsource(char *, struct stat *);
197 void sink(int, char *[]);
198 void source(int, char *[]);
199 void tolocal(int, char *[]);
200 void toremote(char *, int, char *[]);
208 int ch, fflag, tflag, status;
213 __progname = get_progname(argv[0]);
216 addargs(&args, "ssh"); /* overwritten with ssh_program */
217 addargs(&args, "-x");
218 addargs(&args, "-oForwardAgent no");
219 addargs(&args, "-oClearAllForwardings yes");
222 while ((ch = getopt(argc, argv, "dfprtvBCc:i:P:q46S:o:F:")) != -1)
224 /* User-visible flags. */
228 addargs(&args, "-%c", ch);
234 addargs(&args, "-%c%s", ch, optarg);
237 addargs(&args, "-p%s", optarg);
240 addargs(&args, "-oBatchmode yes");
249 ssh_program = xstrdup(optarg);
252 addargs(&args, "-v");
259 /* Server options. */
261 targetshouldbedirectory = 1;
263 case 'f': /* "from" */
271 setmode(0, O_BINARY);
280 if ((pwd = getpwuid(userid = getuid())) == NULL)
281 fatal("unknown user %d", (int) userid);
283 if (!isatty(STDERR_FILENO))
286 remin = STDIN_FILENO;
287 remout = STDOUT_FILENO;
290 /* Follow "protocol", send data. */
303 targetshouldbedirectory = 1;
307 /* Command to be executed on remote system using "ssh". */
308 (void) snprintf(cmd, sizeof cmd, "scp%s%s%s%s",
309 verbose_mode ? " -v" : "",
310 iamrecursive ? " -r" : "", pflag ? " -p" : "",
311 targetshouldbedirectory ? " -d" : "");
313 (void) signal(SIGPIPE, lostconn);
315 if ((targ = colon(argv[argc - 1]))) /* Dest is remote host. */
316 toremote(targ, argc, argv);
318 tolocal(argc, argv); /* Dest is local host. */
319 if (targetshouldbedirectory)
320 verifydir(argv[argc - 1]);
323 * Finally check the exit status of the ssh process, if one was forked
324 * and no error has occured yet
326 if (do_cmd_pid != -1 && errs == 0) {
330 (void) close(remout);
331 if (waitpid(do_cmd_pid, &status, 0) == -1)
334 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0)
342 toremote(targ, argc, argv)
347 char *bp, *host, *src, *suser, *thost, *tuser;
353 if ((thost = strrchr(argv[argc - 1], '@'))) {
356 tuser = argv[argc - 1];
359 else if (!okname(tuser))
362 thost = argv[argc - 1];
366 for (i = 0; i < argc - 1; i++) {
367 src = colon(argv[i]);
368 if (src) { /* remote to remote */
369 static char *ssh_options =
370 "-x -o'ClearAllForwardings yes'";
374 host = strrchr(argv[i], '@');
375 len = strlen(ssh_program) + strlen(argv[i]) +
376 strlen(src) + (tuser ? strlen(tuser) : 0) +
377 strlen(thost) + strlen(targ) +
378 strlen(ssh_options) + CMDNEEDS + 20;
382 host = cleanhostname(host);
385 suser = pwd->pw_name;
386 else if (!okname(suser))
390 "-l %s %s %s %s '%s%s%s:%s'",
391 ssh_program, verbose_mode ? " -v" : "",
392 ssh_options, suser, host, cmd, src,
393 tuser ? tuser : "", tuser ? "@" : "",
396 host = cleanhostname(argv[i]);
398 "exec %s%s %s -n %s "
400 ssh_program, verbose_mode ? " -v" : "",
401 ssh_options, host, cmd, src,
402 tuser ? tuser : "", tuser ? "@" : "",
406 fprintf(stderr, "Executing: %s\n", bp);
409 } else { /* local to remote */
411 len = strlen(targ) + CMDNEEDS + 20;
413 (void) snprintf(bp, len, "%s -t %s", cmd, targ);
414 host = cleanhostname(thost);
415 if (do_cmd(host, tuser, bp, &remin,
433 char *bp, *host, *src, *suser;
435 for (i = 0; i < argc - 1; i++) {
436 if (!(src = colon(argv[i]))) { /* Local to local. */
437 len = strlen(_PATH_CP) + strlen(argv[i]) +
438 strlen(argv[argc - 1]) + 20;
440 (void) snprintf(bp, len, "exec %s%s%s %s %s", _PATH_CP,
441 iamrecursive ? " -r" : "", pflag ? " -p" : "",
442 argv[i], argv[argc - 1]);
444 fprintf(stderr, "Executing: %s\n", bp);
453 if ((host = strrchr(argv[i], '@')) == NULL) {
460 suser = pwd->pw_name;
461 else if (!okname(suser))
464 host = cleanhostname(host);
465 len = strlen(src) + CMDNEEDS + 20;
467 (void) snprintf(bp, len, "%s -f %s", cmd, src);
468 if (do_cmd(host, suser, bp, &remin, &remout, argc) < 0) {
474 sink(1, argv + argc - 1);
488 off_t i, amt, result, statbytes;
489 int fd, haderr, indx;
490 char *last, *name, buf[2048];
493 for (indx = 0; indx < argc; ++indx) {
497 while (len > 1 && name[len-1] == '/')
499 if (strchr(name, '\n') != NULL) {
500 run_err("%s: skipping, filename contains a newline",
504 if ((fd = open(name, O_RDONLY, 0)) < 0)
506 if (fstat(fd, &stb) < 0) {
507 syserr: run_err("%s: %s", name, strerror(errno));
510 switch (stb.st_mode & S_IFMT) {
520 run_err("%s: not a regular file", name);
523 if ((last = strrchr(name, '/')) == NULL)
530 * Make it compatible with possible future
531 * versions expecting microseconds.
533 (void) snprintf(buf, sizeof buf, "T%lu 0 %lu 0\n",
534 (u_long) stb.st_mtime,
535 (u_long) stb.st_atime);
536 (void) atomicio(write, remout, buf, strlen(buf));
540 #define FILEMODEMASK (S_ISUID|S_ISGID|S_IRWXU|S_IRWXG|S_IRWXO)
541 #ifdef HAVE_LONG_LONG_INT
542 snprintf(buf, sizeof buf, "C%04o %lld %s\n",
543 (u_int) (stb.st_mode & FILEMODEMASK),
544 (long long)stb.st_size, last);
546 /* XXX: Handle integer overflow? */
547 snprintf(buf, sizeof buf, "C%04o %lu %s\n",
548 (u_int) (stb.st_mode & FILEMODEMASK),
549 (u_long) stb.st_size, last);
552 fprintf(stderr, "Sending file modes: %s", buf);
554 (void) atomicio(write, remout, buf, strlen(buf));
557 if ((bp = allocbuf(&buffer, fd, 2048)) == NULL) {
558 next: (void) close(fd);
562 start_progress_meter(curfile, stb.st_size, &statbytes);
563 /* Keep writing after an error so that we stay sync'd up. */
564 for (haderr = i = 0; i < stb.st_size; i += bp->cnt) {
566 if (i + amt > stb.st_size)
567 amt = stb.st_size - i;
569 result = atomicio(read, fd, bp->buf, amt);
571 haderr = result >= 0 ? EIO : errno;
574 (void) atomicio(write, remout, bp->buf, amt);
576 result = atomicio(write, remout, bp->buf, amt);
578 haderr = result >= 0 ? EIO : errno;
583 stop_progress_meter();
585 if (close(fd) < 0 && !haderr)
588 (void) atomicio(write, remout, "", 1);
590 run_err("%s: %s", name, strerror(haderr));
602 char *last, *vect[1], path[1100];
604 if (!(dirp = opendir(name))) {
605 run_err("%s: %s", name, strerror(errno));
608 last = strrchr(name, '/');
614 (void) snprintf(path, sizeof(path), "T%lu 0 %lu 0\n",
615 (u_long) statp->st_mtime,
616 (u_long) statp->st_atime);
617 (void) atomicio(write, remout, path, strlen(path));
618 if (response() < 0) {
623 (void) snprintf(path, sizeof path, "D%04o %d %.1024s\n",
624 (u_int) (statp->st_mode & FILEMODEMASK), 0, last);
626 fprintf(stderr, "Entering directory: %s", path);
627 (void) atomicio(write, remout, path, strlen(path));
628 if (response() < 0) {
632 while ((dp = readdir(dirp)) != NULL) {
635 if (!strcmp(dp->d_name, ".") || !strcmp(dp->d_name, ".."))
637 if (strlen(name) + 1 + strlen(dp->d_name) >= sizeof(path) - 1) {
638 run_err("%s/%s: name too long", name, dp->d_name);
641 (void) snprintf(path, sizeof path, "%s/%s", name, dp->d_name);
645 (void) closedir(dirp);
646 (void) atomicio(write, remout, "E\n", 2);
662 int amt, count, exists, first, mask, mode, ofd, omode;
663 off_t size, statbytes;
664 int setimes, targisdir, wrerrno = 0;
665 char ch, *cp, *np, *targ, *why, *vect[1], buf[2048];
666 struct timeval tv[2];
670 #define SCREWUP(str) do { why = str; goto screwup; } while (0)
672 setimes = targisdir = 0;
677 run_err("ambiguous target");
681 if (targetshouldbedirectory)
684 (void) atomicio(write, remout, "", 1);
685 if (stat(targ, &stb) == 0 && S_ISDIR(stb.st_mode))
687 for (first = 1;; first = 0) {
689 if (atomicio(read, remin, cp, 1) <= 0)
692 SCREWUP("unexpected <newline>");
694 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
695 SCREWUP("lost connection");
697 } while (cp < &buf[sizeof(buf) - 1] && ch != '\n');
700 if (buf[0] == '\01' || buf[0] == '\02') {
702 (void) atomicio(write, STDERR_FILENO,
703 buf + 1, strlen(buf + 1));
710 (void) atomicio(write, remout, "", 1);
720 mtime.tv_sec = strtol(cp, &cp, 10);
721 if (!cp || *cp++ != ' ')
722 SCREWUP("mtime.sec not delimited");
723 mtime.tv_usec = strtol(cp, &cp, 10);
724 if (!cp || *cp++ != ' ')
725 SCREWUP("mtime.usec not delimited");
726 atime.tv_sec = strtol(cp, &cp, 10);
727 if (!cp || *cp++ != ' ')
728 SCREWUP("atime.sec not delimited");
729 atime.tv_usec = strtol(cp, &cp, 10);
730 if (!cp || *cp++ != '\0')
731 SCREWUP("atime.usec not delimited");
732 (void) atomicio(write, remout, "", 1);
735 if (*cp != 'C' && *cp != 'D') {
737 * Check for the case "rcp remote:foo\* local:bar".
738 * In this case, the line "No match." can be returned
739 * by the shell before the rcp command on the remote is
740 * executed so the ^Aerror_message convention isn't
747 SCREWUP("expected control record");
750 for (++cp; cp < buf + 5; cp++) {
751 if (*cp < '0' || *cp > '7')
753 mode = (mode << 3) | (*cp - '0');
756 SCREWUP("mode not delimited");
758 for (size = 0; isdigit(*cp);)
759 size = size * 10 + (*cp++ - '0');
761 SCREWUP("size not delimited");
763 static char *namebuf;
767 need = strlen(targ) + strlen(cp) + 250;
768 if (need > cursize) {
771 namebuf = xmalloc(need);
774 (void) snprintf(namebuf, need, "%s%s%s", targ,
775 strcmp(targ, "/") ? "/" : "", cp);
780 exists = stat(np, &stb) == 0;
782 int mod_flag = pflag;
784 if (!S_ISDIR(stb.st_mode)) {
789 (void) chmod(np, mode);
791 /* Handle copying from a read-only
794 if (mkdir(np, mode | S_IRWXU) < 0)
797 vect[0] = xstrdup(np);
801 if (utimes(vect[0], tv) < 0)
802 run_err("%s: set times: %s",
803 vect[0], strerror(errno));
806 (void) chmod(vect[0], mode);
813 if ((ofd = open(np, O_WRONLY|O_CREAT, mode)) < 0) {
814 bad: run_err("%s: %s", np, strerror(errno));
817 (void) atomicio(write, remout, "", 1);
818 if ((bp = allocbuf(&buffer, ofd, 4096)) == NULL) {
827 start_progress_meter(curfile, size, &statbytes);
828 for (count = i = 0; i < size; i += 4096) {
834 j = read(remin, cp, amt);
835 if (j == -1 && (errno == EINTR ||
839 run_err("%s", j ? strerror(errno) :
840 "dropped connection");
847 if (count == bp->cnt) {
848 /* Keep reading so we stay sync'd up. */
850 j = atomicio(write, ofd, bp->buf, count);
853 wrerrno = j >= 0 ? EIO : errno;
861 stop_progress_meter();
862 if (count != 0 && wrerr == NO &&
863 (j = atomicio(write, ofd, bp->buf, count)) != count) {
865 wrerrno = j >= 0 ? EIO : errno;
867 if (ftruncate(ofd, size)) {
868 run_err("%s: truncate: %s", np, strerror(errno));
872 if (exists || omode != mode)
874 if (fchmod(ofd, omode))
875 #else /* HAVE_FCHMOD */
876 if (chmod(np, omode))
877 #endif /* HAVE_FCHMOD */
878 run_err("%s: set mode: %s",
879 np, strerror(errno));
881 if (!exists && omode != mode)
883 if (fchmod(ofd, omode & ~mask))
884 #else /* HAVE_FCHMOD */
885 if (chmod(np, omode & ~mask))
886 #endif /* HAVE_FCHMOD */
887 run_err("%s: set mode: %s",
888 np, strerror(errno));
890 if (close(ofd) == -1) {
895 if (setimes && wrerr == NO) {
897 if (utimes(np, tv) < 0) {
898 run_err("%s: set times: %s",
899 np, strerror(errno));
905 run_err("%s: %s", np, strerror(wrerrno));
908 (void) atomicio(write, remout, "", 1);
915 run_err("protocol error: %s", why);
922 char ch, *cp, resp, rbuf[2048];
924 if (atomicio(read, remin, &resp, sizeof(resp)) != sizeof(resp))
934 case 1: /* error, followed by error msg */
935 case 2: /* fatal error, "" */
937 if (atomicio(read, remin, &ch, sizeof(ch)) != sizeof(ch))
940 } while (cp < &rbuf[sizeof(rbuf) - 1] && ch != '\n');
943 (void) atomicio(write, STDERR_FILENO, rbuf, cp - rbuf);
955 (void) fprintf(stderr,
956 "usage: scp [-pqrvBC46] [-F config] [-S program] [-P port]\n"
957 " [-c cipher] [-i identity] [-o option]\n"
958 " [[user@]host1:]file1 [...] [[user@]host2:]file2\n");
963 run_err(const char *fmt,...)
969 if (fp == NULL && !(fp = fdopen(remout, "w")))
971 (void) fprintf(fp, "%c", 0x01);
972 (void) fprintf(fp, "scp: ");
974 (void) vfprintf(fp, fmt, ap);
976 (void) fprintf(fp, "\n");
981 vfprintf(stderr, fmt, ap);
983 fprintf(stderr, "\n");
993 if (!stat(cp, &stb)) {
994 if (S_ISDIR(stb.st_mode))
998 run_err("%s: %s", cp, strerror(errno));
1014 if (!isalpha(c) && !isdigit(c) &&
1015 c != '@' && c != '_' && c != '-' && c != '.' && c != '+')
1020 bad: fprintf(stderr, "%s: invalid user name\n", cp0);
1025 allocbuf(bp, fd, blksize)
1030 #ifdef HAVE_STRUCT_STAT_ST_BLKSIZE
1033 if (fstat(fd, &stb) < 0) {
1034 run_err("fstat: %s", strerror(errno));
1037 size = roundup(stb.st_blksize, blksize);
1040 #else /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1042 #endif /* HAVE_STRUCT_STAT_ST_BLKSIZE */
1043 if (bp->cnt >= size)
1045 if (bp->buf == NULL)
1046 bp->buf = xmalloc(size);
1048 bp->buf = xrealloc(bp->buf, size);
1049 memset(bp->buf, 0, size);
1059 write(STDERR_FILENO, "lost connection\n", 16);