2 * Copyright (c) 2000, 2001, 2002 Markus Friedl. 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.
25 RCSID("$OpenBSD: sftp-server.c,v 1.38 2002/09/11 22:41:50 djm Exp $");
34 #include "sftp-common.h"
37 #define get_int64() buffer_get_int64(&iqueue);
38 #define get_int() buffer_get_int(&iqueue);
39 #define get_string(lenp) buffer_get_string(&iqueue, lenp);
42 #ifdef HAVE___PROGNAME
43 extern char *__progname;
48 /* input and output queue */
52 /* Version of client */
55 /* portable attibutes, etc. */
57 typedef struct Stat Stat;
66 errno_to_portable(int unixerrno)
78 ret = SSH2_FX_NO_SUCH_FILE;
83 ret = SSH2_FX_PERMISSION_DENIED;
87 ret = SSH2_FX_BAD_MESSAGE;
90 ret = SSH2_FX_FAILURE;
97 flags_from_portable(int pflags)
101 if ((pflags & SSH2_FXF_READ) &&
102 (pflags & SSH2_FXF_WRITE)) {
104 } else if (pflags & SSH2_FXF_READ) {
106 } else if (pflags & SSH2_FXF_WRITE) {
109 if (pflags & SSH2_FXF_CREAT)
111 if (pflags & SSH2_FXF_TRUNC)
113 if (pflags & SSH2_FXF_EXCL)
121 return decode_attrib(&iqueue);
126 typedef struct Handle Handle;
147 for (i = 0; i < sizeof(handles)/sizeof(Handle); i++)
148 handles[i].use = HANDLE_UNUSED;
152 handle_new(int use, char *name, int fd, DIR *dirp)
156 for (i = 0; i < sizeof(handles)/sizeof(Handle); i++) {
157 if (handles[i].use == HANDLE_UNUSED) {
158 handles[i].use = use;
159 handles[i].dirp = dirp;
161 handles[i].name = name;
169 handle_is_ok(int i, int type)
171 return i >= 0 && i < sizeof(handles)/sizeof(Handle) &&
172 handles[i].use == type;
176 handle_to_string(int handle, char **stringp, int *hlenp)
178 if (stringp == NULL || hlenp == NULL)
180 *stringp = xmalloc(sizeof(int32_t));
181 PUT_32BIT(*stringp, handle);
182 *hlenp = sizeof(int32_t);
187 handle_from_string(char *handle, u_int hlen)
191 if (hlen != sizeof(int32_t))
193 val = GET_32BIT(handle);
194 if (handle_is_ok(val, HANDLE_FILE) ||
195 handle_is_ok(val, HANDLE_DIR))
201 handle_to_name(int handle)
203 if (handle_is_ok(handle, HANDLE_DIR)||
204 handle_is_ok(handle, HANDLE_FILE))
205 return handles[handle].name;
210 handle_to_dir(int handle)
212 if (handle_is_ok(handle, HANDLE_DIR))
213 return handles[handle].dirp;
218 handle_to_fd(int handle)
220 if (handle_is_ok(handle, HANDLE_FILE))
221 return handles[handle].fd;
226 handle_close(int handle)
230 if (handle_is_ok(handle, HANDLE_FILE)) {
231 ret = close(handles[handle].fd);
232 handles[handle].use = HANDLE_UNUSED;
233 } else if (handle_is_ok(handle, HANDLE_DIR)) {
234 ret = closedir(handles[handle].dirp);
235 handles[handle].use = HANDLE_UNUSED;
249 handle = get_string(&hlen);
251 val = handle_from_string(handle, hlen);
261 int mlen = buffer_len(m);
263 buffer_put_int(&oqueue, mlen);
264 buffer_append(&oqueue, buffer_ptr(m), mlen);
265 buffer_consume(m, mlen);
269 send_status(u_int32_t id, u_int32_t error)
272 const char *status_messages[] = {
273 "Success", /* SSH_FX_OK */
274 "End of file", /* SSH_FX_EOF */
275 "No such file", /* SSH_FX_NO_SUCH_FILE */
276 "Permission denied", /* SSH_FX_PERMISSION_DENIED */
277 "Failure", /* SSH_FX_FAILURE */
278 "Bad message", /* SSH_FX_BAD_MESSAGE */
279 "No connection", /* SSH_FX_NO_CONNECTION */
280 "Connection lost", /* SSH_FX_CONNECTION_LOST */
281 "Operation unsupported", /* SSH_FX_OP_UNSUPPORTED */
282 "Unknown error" /* Others */
285 TRACE("sent status id %u error %u", id, error);
287 buffer_put_char(&msg, SSH2_FXP_STATUS);
288 buffer_put_int(&msg, id);
289 buffer_put_int(&msg, error);
291 buffer_put_cstring(&msg,
292 status_messages[MIN(error,SSH2_FX_MAX)]);
293 buffer_put_cstring(&msg, "");
299 send_data_or_handle(char type, u_int32_t id, char *data, int dlen)
304 buffer_put_char(&msg, type);
305 buffer_put_int(&msg, id);
306 buffer_put_string(&msg, data, dlen);
312 send_data(u_int32_t id, char *data, int dlen)
314 TRACE("sent data id %u len %d", id, dlen);
315 send_data_or_handle(SSH2_FXP_DATA, id, data, dlen);
319 send_handle(u_int32_t id, int handle)
324 handle_to_string(handle, &string, &hlen);
325 TRACE("sent handle id %u handle %d", id, handle);
326 send_data_or_handle(SSH2_FXP_HANDLE, id, string, hlen);
331 send_names(u_int32_t id, int count, Stat *stats)
337 buffer_put_char(&msg, SSH2_FXP_NAME);
338 buffer_put_int(&msg, id);
339 buffer_put_int(&msg, count);
340 TRACE("sent names id %u count %d", id, count);
341 for (i = 0; i < count; i++) {
342 buffer_put_cstring(&msg, stats[i].name);
343 buffer_put_cstring(&msg, stats[i].long_name);
344 encode_attrib(&msg, &stats[i].attrib);
351 send_attrib(u_int32_t id, Attrib *a)
355 TRACE("sent attrib id %u have 0x%x", id, a->flags);
357 buffer_put_char(&msg, SSH2_FXP_ATTRS);
358 buffer_put_int(&msg, id);
359 encode_attrib(&msg, a);
372 TRACE("client version %d", version);
374 buffer_put_char(&msg, SSH2_FXP_VERSION);
375 buffer_put_int(&msg, SSH2_FILEXFER_VERSION);
383 u_int32_t id, pflags;
386 int handle, fd, flags, mode, status = SSH2_FX_FAILURE;
389 name = get_string(NULL);
390 pflags = get_int(); /* portable flags */
392 flags = flags_from_portable(pflags);
393 mode = (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) ? a->perm : 0666;
394 TRACE("open id %u name %s flags %d mode 0%o", id, name, pflags, mode);
395 fd = open(name, flags, mode);
397 status = errno_to_portable(errno);
399 handle = handle_new(HANDLE_FILE, xstrdup(name), fd, NULL);
403 send_handle(id, handle);
407 if (status != SSH2_FX_OK)
408 send_status(id, status);
416 int handle, ret, status = SSH2_FX_FAILURE;
419 handle = get_handle();
420 TRACE("close id %u handle %d", id, handle);
421 ret = handle_close(handle);
422 status = (ret == -1) ? errno_to_portable(errno) : SSH2_FX_OK;
423 send_status(id, status);
431 int handle, fd, ret, status = SSH2_FX_FAILURE;
435 handle = get_handle();
439 TRACE("read id %u handle %d off %llu len %d", id, handle,
440 (u_int64_t)off, len);
441 if (len > sizeof buf) {
443 log("read change len %d", len);
445 fd = handle_to_fd(handle);
447 if (lseek(fd, off, SEEK_SET) < 0) {
448 error("process_read: seek failed");
449 status = errno_to_portable(errno);
451 ret = read(fd, buf, len);
453 status = errno_to_portable(errno);
454 } else if (ret == 0) {
455 status = SSH2_FX_EOF;
457 send_data(id, buf, ret);
462 if (status != SSH2_FX_OK)
463 send_status(id, status);
472 int handle, fd, ret, status = SSH2_FX_FAILURE;
476 handle = get_handle();
478 data = get_string(&len);
480 TRACE("write id %u handle %d off %llu len %d", id, handle,
481 (u_int64_t)off, len);
482 fd = handle_to_fd(handle);
484 if (lseek(fd, off, SEEK_SET) < 0) {
485 status = errno_to_portable(errno);
486 error("process_write: seek failed");
489 ret = write(fd, data, len);
491 error("process_write: write failed");
492 status = errno_to_portable(errno);
493 } else if (ret == len) {
496 log("nothing at all written");
500 send_status(id, status);
505 process_do_stat(int do_lstat)
511 int ret, status = SSH2_FX_FAILURE;
514 name = get_string(NULL);
515 TRACE("%sstat id %u name %s", do_lstat ? "l" : "", id, name);
516 ret = do_lstat ? lstat(name, &st) : stat(name, &st);
518 status = errno_to_portable(errno);
520 stat_to_attrib(&st, &a);
524 if (status != SSH2_FX_OK)
525 send_status(id, status);
547 int fd, ret, handle, status = SSH2_FX_FAILURE;
550 handle = get_handle();
551 TRACE("fstat id %u handle %d", id, handle);
552 fd = handle_to_fd(handle);
554 ret = fstat(fd, &st);
556 status = errno_to_portable(errno);
558 stat_to_attrib(&st, &a);
563 if (status != SSH2_FX_OK)
564 send_status(id, status);
567 static struct timeval *
568 attrib_to_tv(Attrib *a)
570 static struct timeval tv[2];
572 tv[0].tv_sec = a->atime;
574 tv[1].tv_sec = a->mtime;
580 process_setstat(void)
585 int status = SSH2_FX_OK, ret;
588 name = get_string(NULL);
590 TRACE("setstat id %u name %s", id, name);
591 if (a->flags & SSH2_FILEXFER_ATTR_SIZE) {
592 ret = truncate(name, a->size);
594 status = errno_to_portable(errno);
596 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) {
597 ret = chmod(name, a->perm & 0777);
599 status = errno_to_portable(errno);
601 if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
602 ret = utimes(name, attrib_to_tv(a));
604 status = errno_to_portable(errno);
606 if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
607 ret = chown(name, a->uid, a->gid);
609 status = errno_to_portable(errno);
611 send_status(id, status);
616 process_fsetstat(void)
621 int status = SSH2_FX_OK;
625 handle = get_handle();
627 TRACE("fsetstat id %u handle %d", id, handle);
628 fd = handle_to_fd(handle);
629 name = handle_to_name(handle);
630 if (fd < 0 || name == NULL) {
631 status = SSH2_FX_FAILURE;
633 if (a->flags & SSH2_FILEXFER_ATTR_SIZE) {
634 ret = ftruncate(fd, a->size);
636 status = errno_to_portable(errno);
638 if (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) {
640 ret = fchmod(fd, a->perm & 0777);
642 ret = chmod(name, a->perm & 0777);
645 status = errno_to_portable(errno);
647 if (a->flags & SSH2_FILEXFER_ATTR_ACMODTIME) {
649 ret = futimes(fd, attrib_to_tv(a));
651 ret = utimes(name, attrib_to_tv(a));
654 status = errno_to_portable(errno);
656 if (a->flags & SSH2_FILEXFER_ATTR_UIDGID) {
658 ret = fchown(fd, a->uid, a->gid);
660 ret = chown(name, a->uid, a->gid);
663 status = errno_to_portable(errno);
666 send_status(id, status);
670 process_opendir(void)
674 int handle, status = SSH2_FX_FAILURE;
678 path = get_string(NULL);
679 TRACE("opendir id %u path %s", id, path);
680 dirp = opendir(path);
682 status = errno_to_portable(errno);
684 handle = handle_new(HANDLE_DIR, xstrdup(path), 0, dirp);
688 send_handle(id, handle);
693 if (status != SSH2_FX_OK)
694 send_status(id, status);
699 process_readdir(void)
708 handle = get_handle();
709 TRACE("readdir id %u handle %d", id, handle);
710 dirp = handle_to_dir(handle);
711 path = handle_to_name(handle);
712 if (dirp == NULL || path == NULL) {
713 send_status(id, SSH2_FX_FAILURE);
718 int nstats = 10, count = 0, i;
720 stats = xmalloc(nstats * sizeof(Stat));
721 while ((dp = readdir(dirp)) != NULL) {
722 if (count >= nstats) {
724 stats = xrealloc(stats, nstats * sizeof(Stat));
727 snprintf(pathname, sizeof pathname, "%s%s%s", path,
728 strcmp(path, "/") ? "/" : "", dp->d_name);
729 if (lstat(pathname, &st) < 0)
731 stat_to_attrib(&st, &(stats[count].attrib));
732 stats[count].name = xstrdup(dp->d_name);
733 stats[count].long_name = ls_file(dp->d_name, &st, 0);
735 /* send up to 100 entries in one message */
736 /* XXX check packet size instead */
741 send_names(id, count, stats);
742 for (i = 0; i < count; i++) {
743 xfree(stats[i].name);
744 xfree(stats[i].long_name);
747 send_status(id, SSH2_FX_EOF);
758 int status = SSH2_FX_FAILURE;
762 name = get_string(NULL);
763 TRACE("remove id %u name %s", id, name);
765 status = (ret == -1) ? errno_to_portable(errno) : SSH2_FX_OK;
766 send_status(id, status);
776 int ret, mode, status = SSH2_FX_FAILURE;
779 name = get_string(NULL);
781 mode = (a->flags & SSH2_FILEXFER_ATTR_PERMISSIONS) ?
782 a->perm & 0777 : 0777;
783 TRACE("mkdir id %u name %s mode 0%o", id, name, mode);
784 ret = mkdir(name, mode);
785 status = (ret == -1) ? errno_to_portable(errno) : SSH2_FX_OK;
786 send_status(id, status);
798 name = get_string(NULL);
799 TRACE("rmdir id %u name %s", id, name);
801 status = (ret == -1) ? errno_to_portable(errno) : SSH2_FX_OK;
802 send_status(id, status);
807 process_realpath(void)
809 char resolvedname[MAXPATHLEN];
814 path = get_string(NULL);
815 if (path[0] == '\0') {
819 TRACE("realpath id %u path %s", id, path);
820 if (realpath(path, resolvedname) == NULL) {
821 send_status(id, errno_to_portable(errno));
824 attrib_clear(&s.attrib);
825 s.name = s.long_name = resolvedname;
826 send_names(id, 1, &s);
836 char *oldpath, *newpath;
837 int ret, status = SSH2_FX_FAILURE;
840 oldpath = get_string(NULL);
841 newpath = get_string(NULL);
842 TRACE("rename id %u old %s new %s", id, oldpath, newpath);
843 /* fail if 'newpath' exists */
844 if (stat(newpath, &st) == -1) {
845 ret = rename(oldpath, newpath);
846 status = (ret == -1) ? errno_to_portable(errno) : SSH2_FX_OK;
848 send_status(id, status);
854 process_readlink(void)
858 char link[MAXPATHLEN];
862 path = get_string(NULL);
863 TRACE("readlink id %u path %s", id, path);
864 if ((len = readlink(path, link, sizeof(link) - 1)) == -1)
865 send_status(id, errno_to_portable(errno));
870 attrib_clear(&s.attrib);
871 s.name = s.long_name = link;
872 send_names(id, 1, &s);
878 process_symlink(void)
882 char *oldpath, *newpath;
883 int ret, status = SSH2_FX_FAILURE;
886 oldpath = get_string(NULL);
887 newpath = get_string(NULL);
888 TRACE("symlink id %u old %s new %s", id, oldpath, newpath);
889 /* fail if 'newpath' exists */
890 if (stat(newpath, &st) == -1) {
891 ret = symlink(oldpath, newpath);
892 status = (ret == -1) ? errno_to_portable(errno) : SSH2_FX_OK;
894 send_status(id, status);
900 process_extended(void)
906 request = get_string(NULL);
907 send_status(id, SSH2_FX_OP_UNSUPPORTED); /* MUST */
911 /* stolen from ssh-agent */
922 buf_len = buffer_len(&iqueue);
924 return; /* Incomplete message. */
925 cp = buffer_ptr(&iqueue);
926 msg_len = GET_32BIT(cp);
927 if (msg_len > 256 * 1024) {
928 error("bad message ");
931 if (buf_len < msg_len + 4)
933 buffer_consume(&iqueue, 4);
935 type = buffer_get_char(&iqueue);
958 case SSH2_FXP_SETSTAT:
961 case SSH2_FXP_FSETSTAT:
964 case SSH2_FXP_OPENDIR:
967 case SSH2_FXP_READDIR:
970 case SSH2_FXP_REMOVE:
979 case SSH2_FXP_REALPATH:
985 case SSH2_FXP_RENAME:
988 case SSH2_FXP_READLINK:
991 case SSH2_FXP_SYMLINK:
994 case SSH2_FXP_EXTENDED:
998 error("Unknown message %d", type);
1001 /* discard the remaining bytes from the current packet */
1002 if (buf_len < buffer_len(&iqueue))
1003 fatal("iqueue grows");
1004 consumed = buf_len - buffer_len(&iqueue);
1005 if (msg_len < consumed)
1006 fatal("msg_len %d < consumed %d", msg_len, consumed);
1007 if (msg_len > consumed)
1008 buffer_consume(&iqueue, msg_len - consumed);
1012 main(int ac, char **av)
1014 fd_set *rset, *wset;
1016 ssize_t len, olen, set_size;
1018 /* XXX should use getopt */
1020 __progname = get_progname(av[0]);
1023 #ifdef DEBUG_SFTP_SERVER
1024 log_init("sftp-server", SYSLOG_LEVEL_DEBUG1, SYSLOG_FACILITY_AUTH, 0);
1027 in = dup(STDIN_FILENO);
1028 out = dup(STDOUT_FILENO);
1031 setmode(in, O_BINARY);
1032 setmode(out, O_BINARY);
1041 buffer_init(&iqueue);
1042 buffer_init(&oqueue);
1044 set_size = howmany(max + 1, NFDBITS) * sizeof(fd_mask);
1045 rset = (fd_set *)xmalloc(set_size);
1046 wset = (fd_set *)xmalloc(set_size);
1049 memset(rset, 0, set_size);
1050 memset(wset, 0, set_size);
1053 olen = buffer_len(&oqueue);
1057 if (select(max+1, rset, wset, NULL, NULL) < 0) {
1063 /* copy stdin to iqueue */
1064 if (FD_ISSET(in, rset)) {
1066 len = read(in, buf, sizeof buf);
1070 } else if (len < 0) {
1071 error("read error");
1074 buffer_append(&iqueue, buf, len);
1077 /* send oqueue to stdout */
1078 if (FD_ISSET(out, wset)) {
1079 len = write(out, buffer_ptr(&oqueue), olen);
1081 error("write error");
1084 buffer_consume(&oqueue, len);
1087 /* process requests from client */