2 * Copyright (c) 2001 Damien Miller. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 /* XXX: signed vs unsigned */
27 /* XXX: redesign to allow concurrent overlapped operations */
28 /* XXX: we use fatal too much, error may be more appropriate in places */
29 /* XXX: copy between two remote sites */
32 RCSID("$OpenBSD: sftp-client.c,v 1.18 2001/07/14 15:10:16 stevesk Exp $");
42 #include "sftp-common.h"
43 #include "sftp-client.h"
45 /* How much data to read/write at at time during copies */
46 /* XXX: what should this be? */
47 #define COPY_SIZE 8192
50 static u_int msg_id = 1;
53 send_msg(int fd, Buffer *m)
55 int mlen = buffer_len(m);
60 buffer_put_int(&oqueue, mlen);
61 buffer_append(&oqueue, buffer_ptr(m), mlen);
62 buffer_consume(m, mlen);
64 len = atomicio(write, fd, buffer_ptr(&oqueue), buffer_len(&oqueue));
66 fatal("Couldn't send packet: %s", strerror(errno));
72 get_msg(int fd, Buffer *m)
75 unsigned char buf[4096];
77 len = atomicio(read, fd, buf, 4);
79 fatal("Connection closed");
81 fatal("Couldn't read packet: %s", strerror(errno));
83 msg_len = GET_32BIT(buf);
84 if (msg_len > 256 * 1024)
85 fatal("Received message too long %d", msg_len);
88 len = atomicio(read, fd, buf, MIN(msg_len, sizeof(buf)));
90 fatal("Connection closed");
92 fatal("Couldn't read packet: %s", strerror(errno));
95 buffer_append(m, buf, len);
100 send_string_request(int fd, u_int id, u_int code, char *s,
106 buffer_put_char(&msg, code);
107 buffer_put_int(&msg, id);
108 buffer_put_string(&msg, s, len);
110 debug3("Sent message fd %d T:%d I:%d", fd, code, id);
115 send_string_attrs_request(int fd, u_int id, u_int code, char *s,
116 u_int len, Attrib *a)
121 buffer_put_char(&msg, code);
122 buffer_put_int(&msg, id);
123 buffer_put_string(&msg, s, len);
124 encode_attrib(&msg, a);
126 debug3("Sent message fd %d T:%d I:%d", fd, code, id);
131 get_status(int fd, int expected_id)
134 u_int type, id, status;
138 type = buffer_get_char(&msg);
139 id = buffer_get_int(&msg);
141 if (id != expected_id)
142 fatal("ID mismatch (%d != %d)", id, expected_id);
143 if (type != SSH2_FXP_STATUS)
144 fatal("Expected SSH2_FXP_STATUS(%d) packet, got %d",
145 SSH2_FXP_STATUS, type);
147 status = buffer_get_int(&msg);
150 debug3("SSH2_FXP_STATUS %d", status);
156 get_handle(int fd, u_int expected_id, u_int *len)
164 type = buffer_get_char(&msg);
165 id = buffer_get_int(&msg);
167 if (id != expected_id)
168 fatal("ID mismatch (%d != %d)", id, expected_id);
169 if (type == SSH2_FXP_STATUS) {
170 int status = buffer_get_int(&msg);
172 error("Couldn't get handle: %s", fx2txt(status));
174 } else if (type != SSH2_FXP_HANDLE)
175 fatal("Expected SSH2_FXP_HANDLE(%d) packet, got %d",
176 SSH2_FXP_HANDLE, type);
178 handle = buffer_get_string(&msg, len);
185 get_decode_stat(int fd, u_int expected_id, int quiet)
194 type = buffer_get_char(&msg);
195 id = buffer_get_int(&msg);
197 debug3("Received stat reply T:%d I:%d", type, id);
198 if (id != expected_id)
199 fatal("ID mismatch (%d != %d)", id, expected_id);
200 if (type == SSH2_FXP_STATUS) {
201 int status = buffer_get_int(&msg);
204 debug("Couldn't stat remote file: %s", fx2txt(status));
206 error("Couldn't stat remote file: %s", fx2txt(status));
208 } else if (type != SSH2_FXP_ATTRS) {
209 fatal("Expected SSH2_FXP_ATTRS(%d) packet, got %d",
210 SSH2_FXP_ATTRS, type);
212 a = decode_attrib(&msg);
219 do_init(int fd_in, int fd_out)
225 buffer_put_char(&msg, SSH2_FXP_INIT);
226 buffer_put_int(&msg, SSH2_FILEXFER_VERSION);
227 send_msg(fd_out, &msg);
231 get_msg(fd_in, &msg);
233 /* Expecting a VERSION reply */
234 if ((type = buffer_get_char(&msg)) != SSH2_FXP_VERSION) {
235 error("Invalid packet back from SSH2_FXP_INIT (type %d)",
240 version = buffer_get_int(&msg);
242 debug2("Remote version: %d", version);
244 /* Check for extensions */
245 while (buffer_len(&msg) > 0) {
246 char *name = buffer_get_string(&msg, NULL);
247 char *value = buffer_get_string(&msg, NULL);
249 debug2("Init extension: \"%s\"", name);
260 do_close(int fd_in, int fd_out, char *handle, u_int handle_len)
268 buffer_put_char(&msg, SSH2_FXP_CLOSE);
269 buffer_put_int(&msg, id);
270 buffer_put_string(&msg, handle, handle_len);
271 send_msg(fd_out, &msg);
272 debug3("Sent message SSH2_FXP_CLOSE I:%d", id);
274 status = get_status(fd_in, id);
275 if (status != SSH2_FX_OK)
276 error("Couldn't close file: %s", fx2txt(status));
285 do_lsreaddir(int fd_in, int fd_out, char *path, int printflag,
289 u_int type, id, handle_len, i, expected_id, ents = 0;
295 buffer_put_char(&msg, SSH2_FXP_OPENDIR);
296 buffer_put_int(&msg, id);
297 buffer_put_cstring(&msg, path);
298 send_msg(fd_out, &msg);
302 handle = get_handle(fd_in, id, &handle_len);
308 *dir = xmalloc(sizeof(**dir));
316 id = expected_id = msg_id++;
318 debug3("Sending SSH2_FXP_READDIR I:%d", id);
321 buffer_put_char(&msg, SSH2_FXP_READDIR);
322 buffer_put_int(&msg, id);
323 buffer_put_string(&msg, handle, handle_len);
324 send_msg(fd_out, &msg);
328 get_msg(fd_in, &msg);
330 type = buffer_get_char(&msg);
331 id = buffer_get_int(&msg);
333 debug3("Received reply T:%d I:%d", type, id);
335 if (id != expected_id)
336 fatal("ID mismatch (%d != %d)", id, expected_id);
338 if (type == SSH2_FXP_STATUS) {
339 int status = buffer_get_int(&msg);
341 debug3("Received SSH2_FXP_STATUS %d", status);
343 if (status == SSH2_FX_EOF) {
346 error("Couldn't read directory: %s",
348 do_close(fd_in, fd_out, handle, handle_len);
351 } else if (type != SSH2_FXP_NAME)
352 fatal("Expected SSH2_FXP_NAME(%d) packet, got %d",
353 SSH2_FXP_NAME, type);
355 count = buffer_get_int(&msg);
358 debug3("Received %d SSH2_FXP_NAME responses", count);
359 for(i = 0; i < count; i++) {
360 char *filename, *longname;
363 filename = buffer_get_string(&msg, NULL);
364 longname = buffer_get_string(&msg, NULL);
365 a = decode_attrib(&msg);
368 printf("%s\n", longname);
371 *dir = xrealloc(*dir, sizeof(**dir) *
373 (*dir)[ents] = xmalloc(sizeof(***dir));
374 (*dir)[ents]->filename = xstrdup(filename);
375 (*dir)[ents]->longname = xstrdup(longname);
376 memcpy(&(*dir)[ents]->a, a, sizeof(*a));
377 (*dir)[++ents] = NULL;
386 do_close(fd_in, fd_out, handle, handle_len);
393 do_ls(int fd_in, int fd_out, char *path)
395 return(do_lsreaddir(fd_in, fd_out, path, 1, NULL));
399 do_readdir(int fd_in, int fd_out, char *path, SFTP_DIRENT ***dir)
401 return(do_lsreaddir(fd_in, fd_out, path, 0, dir));
404 void free_sftp_dirents(SFTP_DIRENT **s)
408 for(i = 0; s[i]; i++) {
409 xfree(s[i]->filename);
410 xfree(s[i]->longname);
417 do_rm(int fd_in, int fd_out, char *path)
421 debug2("Sending SSH2_FXP_REMOVE \"%s\"", path);
424 send_string_request(fd_out, id, SSH2_FXP_REMOVE, path, strlen(path));
425 status = get_status(fd_in, id);
426 if (status != SSH2_FX_OK)
427 error("Couldn't delete file: %s", fx2txt(status));
432 do_mkdir(int fd_in, int fd_out, char *path, Attrib *a)
437 send_string_attrs_request(fd_out, id, SSH2_FXP_MKDIR, path,
440 status = get_status(fd_in, id);
441 if (status != SSH2_FX_OK)
442 error("Couldn't create directory: %s", fx2txt(status));
448 do_rmdir(int fd_in, int fd_out, char *path)
453 send_string_request(fd_out, id, SSH2_FXP_RMDIR, path, strlen(path));
455 status = get_status(fd_in, id);
456 if (status != SSH2_FX_OK)
457 error("Couldn't remove directory: %s", fx2txt(status));
463 do_stat(int fd_in, int fd_out, char *path, int quiet)
468 send_string_request(fd_out, id, SSH2_FXP_STAT, path, strlen(path));
469 return(get_decode_stat(fd_in, id, quiet));
473 do_lstat(int fd_in, int fd_out, char *path, int quiet)
478 send_string_request(fd_out, id, SSH2_FXP_LSTAT, path, strlen(path));
479 return(get_decode_stat(fd_in, id, quiet));
483 do_fstat(int fd_in, int fd_out, char *handle, u_int handle_len, int quiet)
488 send_string_request(fd_out, id, SSH2_FXP_FSTAT, handle, handle_len);
489 return(get_decode_stat(fd_in, id, quiet));
493 do_setstat(int fd_in, int fd_out, char *path, Attrib *a)
498 send_string_attrs_request(fd_out, id, SSH2_FXP_SETSTAT, path,
501 status = get_status(fd_in, id);
502 if (status != SSH2_FX_OK)
503 error("Couldn't setstat on \"%s\": %s", path,
510 do_fsetstat(int fd_in, int fd_out, char *handle, u_int handle_len,
516 send_string_attrs_request(fd_out, id, SSH2_FXP_FSETSTAT, handle,
519 status = get_status(fd_in, id);
520 if (status != SSH2_FX_OK)
521 error("Couldn't fsetstat: %s", fx2txt(status));
527 do_realpath(int fd_in, int fd_out, char *path)
530 u_int type, expected_id, count, id;
531 char *filename, *longname;
534 expected_id = id = msg_id++;
535 send_string_request(fd_out, id, SSH2_FXP_REALPATH, path, strlen(path));
539 get_msg(fd_in, &msg);
540 type = buffer_get_char(&msg);
541 id = buffer_get_int(&msg);
543 if (id != expected_id)
544 fatal("ID mismatch (%d != %d)", id, expected_id);
546 if (type == SSH2_FXP_STATUS) {
547 u_int status = buffer_get_int(&msg);
549 error("Couldn't canonicalise: %s", fx2txt(status));
551 } else if (type != SSH2_FXP_NAME)
552 fatal("Expected SSH2_FXP_NAME(%d) packet, got %d",
553 SSH2_FXP_NAME, type);
555 count = buffer_get_int(&msg);
557 fatal("Got multiple names (%d) from SSH_FXP_REALPATH", count);
559 filename = buffer_get_string(&msg, NULL);
560 longname = buffer_get_string(&msg, NULL);
561 a = decode_attrib(&msg);
563 debug3("SSH_FXP_REALPATH %s -> %s", path, filename);
573 do_rename(int fd_in, int fd_out, char *oldpath, char *newpath)
580 /* Send rename request */
582 buffer_put_char(&msg, SSH2_FXP_RENAME);
583 buffer_put_int(&msg, id);
584 buffer_put_cstring(&msg, oldpath);
585 buffer_put_cstring(&msg, newpath);
586 send_msg(fd_out, &msg);
587 debug3("Sent message SSH2_FXP_RENAME \"%s\" -> \"%s\"", oldpath,
591 status = get_status(fd_in, id);
592 if (status != SSH2_FX_OK)
593 error("Couldn't rename file \"%s\" to \"%s\": %s", oldpath, newpath,
600 do_symlink(int fd_in, int fd_out, char *oldpath, char *newpath)
607 /* Send rename request */
609 buffer_put_char(&msg, SSH2_FXP_SYMLINK);
610 buffer_put_int(&msg, id);
611 buffer_put_cstring(&msg, oldpath);
612 buffer_put_cstring(&msg, newpath);
613 send_msg(fd_out, &msg);
614 debug3("Sent message SSH2_FXP_SYMLINK \"%s\" -> \"%s\"", oldpath,
618 status = get_status(fd_in, id);
619 if (status != SSH2_FX_OK)
620 error("Couldn't rename file \"%s\" to \"%s\": %s", oldpath, newpath,
627 do_readlink(int fd_in, int fd_out, char *path)
630 u_int type, expected_id, count, id;
631 char *filename, *longname;
634 expected_id = id = msg_id++;
635 send_string_request(fd_out, id, SSH2_FXP_READLINK, path, strlen(path));
639 get_msg(fd_in, &msg);
640 type = buffer_get_char(&msg);
641 id = buffer_get_int(&msg);
643 if (id != expected_id)
644 fatal("ID mismatch (%d != %d)", id, expected_id);
646 if (type == SSH2_FXP_STATUS) {
647 u_int status = buffer_get_int(&msg);
649 error("Couldn't readlink: %s", fx2txt(status));
651 } else if (type != SSH2_FXP_NAME)
652 fatal("Expected SSH2_FXP_NAME(%d) packet, got %d",
653 SSH2_FXP_NAME, type);
655 count = buffer_get_int(&msg);
657 fatal("Got multiple names (%d) from SSH_FXP_READLINK", count);
659 filename = buffer_get_string(&msg, NULL);
660 longname = buffer_get_string(&msg, NULL);
661 a = decode_attrib(&msg);
663 debug3("SSH_FXP_READLINK %s -> %s", path, filename);
673 do_download(int fd_in, int fd_out, char *remote_path, char *local_path,
677 u_int expected_id, handle_len, mode, type, id;
684 a = do_stat(fd_in, fd_out, remote_path, 0);
688 /* XXX: should we preserve set[ug]id? */
689 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS)
690 mode = S_IWRITE | (a->perm & 0777);
694 if ((a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) &&
695 (a->perm & S_IFDIR)) {
696 error("Cannot download a directory: %s", remote_path);
700 local_fd = open(local_path, O_WRONLY | O_CREAT | O_TRUNC, mode);
701 if (local_fd == -1) {
702 error("Couldn't open local file \"%s\" for writing: %s",
703 local_path, strerror(errno));
709 /* Send open request */
711 buffer_put_char(&msg, SSH2_FXP_OPEN);
712 buffer_put_int(&msg, id);
713 buffer_put_cstring(&msg, remote_path);
714 buffer_put_int(&msg, SSH2_FXF_READ);
715 attrib_clear(&junk); /* Send empty attributes */
716 encode_attrib(&msg, &junk);
717 send_msg(fd_out, &msg);
718 debug3("Sent message SSH2_FXP_OPEN I:%d P:%s", id, remote_path);
720 handle = get_handle(fd_in, id, &handle_len);
721 if (handle == NULL) {
727 /* Read from remote and write to local */
733 id = expected_id = msg_id++;
736 buffer_put_char(&msg, SSH2_FXP_READ);
737 buffer_put_int(&msg, id);
738 buffer_put_string(&msg, handle, handle_len);
739 buffer_put_int64(&msg, offset);
740 buffer_put_int(&msg, COPY_SIZE);
741 send_msg(fd_out, &msg);
742 debug3("Sent message SSH2_FXP_READ I:%d O:%llu S:%u",
743 id, (u_int64_t)offset, COPY_SIZE);
747 get_msg(fd_in, &msg);
748 type = buffer_get_char(&msg);
749 id = buffer_get_int(&msg);
750 debug3("Received reply T:%d I:%d", type, id);
751 if (id != expected_id)
752 fatal("ID mismatch (%d != %d)", id, expected_id);
753 if (type == SSH2_FXP_STATUS) {
754 status = buffer_get_int(&msg);
756 if (status == SSH2_FX_EOF)
759 error("Couldn't read from remote "
760 "file \"%s\" : %s", remote_path,
762 do_close(fd_in, fd_out, handle, handle_len);
765 } else if (type != SSH2_FXP_DATA) {
766 fatal("Expected SSH2_FXP_DATA(%d) packet, got %d",
767 SSH2_FXP_DATA, type);
770 data = buffer_get_string(&msg, &len);
772 fatal("Received more data than asked for %d > %d",
775 debug3("In read loop, got %d offset %llu", len,
777 if (atomicio(write, local_fd, data, len) != len) {
778 error("Couldn't write to \"%s\": %s", local_path,
780 do_close(fd_in, fd_out, handle, handle_len);
789 status = do_close(fd_in, fd_out, handle, handle_len);
791 /* Override umask and utimes if asked */
793 if (pflag && fchmod(local_fd, mode) == -1)
795 if (pflag && chmod(local_path, mode) == -1)
796 #endif /* HAVE_FCHMOD */
797 error("Couldn't set mode on \"%s\": %s", local_path,
799 if (pflag && (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME)) {
800 struct timeval tv[2];
801 tv[0].tv_sec = a->atime;
802 tv[1].tv_sec = a->mtime;
803 tv[0].tv_usec = tv[1].tv_usec = 0;
804 if (utimes(local_path, tv) == -1)
805 error("Can't set times on \"%s\": %s", local_path,
817 do_upload(int fd_in, int fd_out, char *local_path, char *remote_path,
821 u_int handle_len, id;
829 if ((local_fd = open(local_path, O_RDONLY, 0)) == -1) {
830 error("Couldn't open local file \"%s\" for reading: %s",
831 local_path, strerror(errno));
834 if (fstat(local_fd, &sb) == -1) {
835 error("Couldn't fstat local file \"%s\": %s",
836 local_path, strerror(errno));
840 stat_to_attrib(&sb, &a);
842 a.flags &= ~SSH2_FILEXFER_ATTR_SIZE;
843 a.flags &= ~SSH2_FILEXFER_ATTR_UIDGID;
846 a.flags &= ~SSH2_FILEXFER_ATTR_ACMODTIME;
850 /* Send open request */
852 buffer_put_char(&msg, SSH2_FXP_OPEN);
853 buffer_put_int(&msg, id);
854 buffer_put_cstring(&msg, remote_path);
855 buffer_put_int(&msg, SSH2_FXF_WRITE|SSH2_FXF_CREAT|SSH2_FXF_TRUNC);
856 encode_attrib(&msg, &a);
857 send_msg(fd_out, &msg);
858 debug3("Sent message SSH2_FXP_OPEN I:%d P:%s", id, remote_path);
862 handle = get_handle(fd_in, id, &handle_len);
863 if (handle == NULL) {
869 /* Read from local and write to remote */
873 char data[COPY_SIZE];
876 * Can't use atomicio here because it returns 0 on EOF, thus losing
877 * the last block of the file
880 len = read(local_fd, data, COPY_SIZE);
881 while ((len == -1) && (errno == EINTR || errno == EAGAIN));
884 fatal("Couldn't read from \"%s\": %s", local_path,
890 buffer_put_char(&msg, SSH2_FXP_WRITE);
891 buffer_put_int(&msg, ++id);
892 buffer_put_string(&msg, handle, handle_len);
893 buffer_put_int64(&msg, offset);
894 buffer_put_string(&msg, data, len);
895 send_msg(fd_out, &msg);
896 debug3("Sent message SSH2_FXP_WRITE I:%d O:%llu S:%u",
897 id, (u_int64_t)offset, len);
899 status = get_status(fd_in, id);
900 if (status != SSH2_FX_OK) {
901 error("Couldn't write to remote file \"%s\": %s",
902 remote_path, fx2txt(status));
903 do_close(fd_in, fd_out, handle, handle_len);
907 debug3("In write loop, got %d offset %llu", len,
913 if (close(local_fd) == -1) {
914 error("Couldn't close local file \"%s\": %s", local_path,
916 do_close(fd_in, fd_out, handle, handle_len);
921 /* Override umask and utimes if asked */
923 do_fsetstat(fd_in, fd_out, handle, handle_len, &a);
925 status = do_close(fd_in, fd_out, handle, handle_len);