Preparatory work for allowing PSCP to work over SFTP as well as old-
[u/mdw/putty] / scp.c
diff --git a/scp.c b/scp.c
index 871d01d..2c8a46f 100644 (file)
--- a/scp.c
+++ b/scp.c
@@ -53,6 +53,7 @@ static int preserve = 0;
 static int targetshouldbedirectory = 0;
 static int statistics = 1;
 static int portnumber = 0;
+static int prev_stats_len = 0;
 static char *password = NULL;
 static int errs = 0;
 /* GUI Adaptation - Sept 2000 */
@@ -74,6 +75,12 @@ static void tell_user(FILE * stream, char *fmt, ...);
 static void gui_update_stats(char *name, unsigned long size,
                             int percentage, unsigned long elapsed);
 
+/*
+ * The maximum amount of queued data we accept before we stop and
+ * wait for the server to process some.
+ */
+#define MAX_SCP_BUFSIZE 16384
+
 void logevent(char *string)
 {
 }
@@ -93,6 +100,8 @@ void verify_ssh_host_key(char *host, int port, char *keytype,
                         char *keystr, char *fingerprint)
 {
     int ret;
+    HANDLE hin;
+    DWORD savemode, i;
 
     static const char absentmsg[] =
        "The server's host key is not cached in the registry. You\n"
@@ -102,8 +111,11 @@ void verify_ssh_host_key(char *host, int port, char *keytype,
        "%s\n"
        "If you trust this host, enter \"y\" to add the key to\n"
        "PuTTY's cache and carry on connecting.\n"
-       "If you do not trust this host, enter \"n\" to abandon the\n"
-       "connection.\n" "Continue connecting? (y/n) ";
+       "If you want to carry on connecting just once, without\n"
+       "adding the key to the cache, enter \"n\".\n"
+       "If you do not trust this host, press Return to abandon the\n"
+       "connection.\n"
+       "Store key in cache? (y/n) ";
 
     static const char wrongmsg[] =
        "WARNING - POTENTIAL SECURITY BREACH!\n"
@@ -115,9 +127,9 @@ void verify_ssh_host_key(char *host, int port, char *keytype,
        "The new key fingerprint is:\n"
        "%s\n"
        "If you were expecting this change and trust the new key,\n"
-       "enter Yes to update PuTTY's cache and continue connecting.\n"
+       "enter \"y\" to update PuTTY's cache and continue connecting.\n"
        "If you want to carry on connecting but without updating\n"
-       "the cache, enter No.\n"
+       "the cache, enter \"n\".\n"
        "If you want to abandon the connection completely, press\n"
        "Return to cancel. Pressing Return is the ONLY guaranteed\n"
        "safe choice.\n"
@@ -134,28 +146,69 @@ void verify_ssh_host_key(char *host, int port, char *keytype,
 
     if (ret == 0)                     /* success - key matched OK */
        return;
+
     if (ret == 2) {                   /* key was different */
        fprintf(stderr, wrongmsg, fingerprint);
        fflush(stderr);
-       if (fgets(line, sizeof(line), stdin) &&
-           line[0] != '\0' && line[0] != '\n') {
-           if (line[0] == 'y' || line[0] == 'Y')
-               store_host_key(host, port, keytype, keystr);
-       } else {
-           fprintf(stderr, abandoned);
-           fflush(stderr);
-           exit(0);
-       }
     }
     if (ret == 1) {                   /* key was absent */
        fprintf(stderr, absentmsg, fingerprint);
-       if (fgets(line, sizeof(line), stdin) &&
-           (line[0] == 'y' || line[0] == 'Y'))
+       fflush(stderr);
+    }
+
+    hin = GetStdHandle(STD_INPUT_HANDLE);
+    GetConsoleMode(hin, &savemode);
+    SetConsoleMode(hin, (savemode | ENABLE_ECHO_INPUT |
+                        ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT));
+    ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
+    SetConsoleMode(hin, savemode);
+
+    if (line[0] != '\0' && line[0] != '\r' && line[0] != '\n') {
+       if (line[0] == 'y' || line[0] == 'Y')
            store_host_key(host, port, keytype, keystr);
-       else {
-           fprintf(stderr, abandoned);
-           exit(0);
-       }
+    } else {
+       fprintf(stderr, abandoned);
+       exit(0);
+    }
+}
+
+/*
+ * Ask whether the selected cipher is acceptable (since it was
+ * below the configured 'warn' threshold).
+ * cs: 0 = both ways, 1 = client->server, 2 = server->client
+ */
+void askcipher(char *ciphername, int cs)
+{
+    HANDLE hin;
+    DWORD savemode, i;
+
+    static const char msg[] =
+       "The first %scipher supported by the server is\n"
+       "%s, which is below the configured warning threshold.\n"
+       "Continue with connection? (y/n) ";
+    static const char abandoned[] = "Connection abandoned.\n";
+
+    char line[32];
+
+    fprintf(stderr, msg,
+           (cs == 0) ? "" :
+           (cs == 1) ? "client-to-server " :
+                       "server-to-client ",
+           ciphername);
+    fflush(stderr);
+
+    hin = GetStdHandle(STD_INPUT_HANDLE);
+    GetConsoleMode(hin, &savemode);
+    SetConsoleMode(hin, (savemode | ENABLE_ECHO_INPUT |
+                        ENABLE_PROCESSED_INPUT | ENABLE_LINE_INPUT));
+    ReadFile(hin, line, sizeof(line) - 1, &i, NULL);
+    SetConsoleMode(hin, savemode);
+
+    if (line[0] == 'y' || line[0] == 'Y') {
+       return;
+    } else {
+       fprintf(stderr, abandoned);
+       exit(0);
     }
 }
 
@@ -233,7 +286,7 @@ void fatalbox(char *fmt, ...)
     char str[0x100];                  /* Make the size big enough */
     va_list ap;
     va_start(ap, fmt);
-    strcpy(str, "Fatal:");
+    strcpy(str, "Fatal: ");
     vsprintf(str + strlen(str), fmt, ap);
     va_end(ap);
     strcat(str, "\n");
@@ -256,7 +309,7 @@ void connection_fatal(char *fmt, ...)
     char str[0x100];                  /* Make the size big enough */
     va_list ap;
     va_start(ap, fmt);
-    strcpy(str, "Fatal:");
+    strcpy(str, "Fatal: ");
     vsprintf(str + strlen(str), fmt, ap);
     va_end(ap);
     strcat(str, "\n");
@@ -302,7 +355,7 @@ static unsigned char *outptr;              /* where to put the data */
 static unsigned outlen;                       /* how much data required */
 static unsigned char *pending = NULL;  /* any spare data */
 static unsigned pendlen = 0, pendsize = 0;     /* length and phys. size of buffer */
-void from_backend(int is_stderr, char *data, int datalen)
+int from_backend(int is_stderr, char *data, int datalen)
 {
     unsigned char *p = (unsigned char *) data;
     unsigned len = (unsigned) datalen;
@@ -313,7 +366,7 @@ void from_backend(int is_stderr, char *data, int datalen)
      */
     if (is_stderr) {
        fwrite(data, 1, len, stderr);
-       return;
+       return 0;
     }
 
     inbuf_head = 0;
@@ -322,7 +375,7 @@ void from_backend(int is_stderr, char *data, int datalen)
      * If this is before the real session begins, just return.
      */
     if (!outptr)
-       return;
+       return 0;
 
     if (outlen > 0) {
        unsigned used = outlen;
@@ -346,6 +399,19 @@ void from_backend(int is_stderr, char *data, int datalen)
        memcpy(pending + pendlen, p, len);
        pendlen += len;
     }
+
+    return 0;
+}
+static int scp_process_network_event(void)
+{
+    fd_set readfds;
+
+    FD_ZERO(&readfds);
+    FD_SET(scp_ssh_socket, &readfds);
+    if (select(1, &readfds, NULL, NULL, NULL) < 0)
+       return 0;                      /* doom */
+    select_result((WPARAM) scp_ssh_socket, (LPARAM) FD_READ);
+    return 1;
 }
 static int ssh_scp_recv(unsigned char *buf, int len)
 {
@@ -375,13 +441,8 @@ static int ssh_scp_recv(unsigned char *buf, int len)
     }
 
     while (outlen > 0) {
-       fd_set readfds;
-
-       FD_ZERO(&readfds);
-       FD_SET(scp_ssh_socket, &readfds);
-       if (select(1, &readfds, NULL, NULL, NULL) < 0)
+       if (!scp_process_network_event())
            return 0;                  /* doom */
-       select_result((WPARAM) scp_ssh_socket, (LPARAM) FD_READ);
     }
 
     return len;
@@ -412,7 +473,7 @@ static void bump(char *fmt, ...)
     char str[0x100];                  /* Make the size big enough */
     va_list ap;
     va_start(ap, fmt);
-    strcpy(str, "Fatal:");
+    strcpy(str, "Fatal: ");
     vsprintf(str + strlen(str), fmt, ap);
     va_end(ap);
     strcat(str, "\n");
@@ -560,6 +621,7 @@ static void print_stats(char *name, unsigned long size, unsigned long done,
     unsigned long eta;
     char etastr[10];
     int pct;
+    int len;
 
     /* GUI Adaptation - Sept 2000 */
     if (gui_mode)
@@ -580,8 +642,11 @@ static void print_stats(char *name, unsigned long size, unsigned long done,
 
        pct = (int) (100.0 * (float) done / size);
 
-       printf("\r%-25.25s | %10ld kB | %5.1f kB/s | ETA: %8s | %3d%%",
-              name, done / 1024, ratebs / 1024.0, etastr, pct);
+       len = printf("\r%-25.25s | %10ld kB | %5.1f kB/s | ETA: %8s | %3d%%",
+                    name, done / 1024, ratebs / 1024.0, etastr, pct);
+       if (len < prev_stats_len)
+           printf("%*s", prev_stats_len - len, "");
+       prev_stats_len = len;
 
        if (done == size)
            printf("\n");
@@ -643,7 +708,185 @@ static int response(void)
     }
 }
 
-/*
+/* ----------------------------------------------------------------------
+ * Helper routines that contain the actual SCP protocol elements,
+ * so they can be switched to use SFTP.
+ */
+
+int scp_send_errmsg(char *str)
+{
+    back->send("\001", 1);            /* scp protocol error prefix */
+    back->send(str, strlen(str));
+    return 0;                         /* can't fail */
+}
+
+int scp_send_filetimes(unsigned long mtime, unsigned long atime)
+{
+    char buf[80];
+    sprintf(buf, "T%lu 0 %lu 0\n", mtime, atime);
+    back->send(buf, strlen(buf));
+    return response();
+}
+
+int scp_send_filename(char *name, unsigned long size, int modes)
+{
+    char buf[40];
+    sprintf(buf, "C%04o %lu ", modes, size);
+    back->send(buf, strlen(buf));
+    back->send(name, strlen(name));
+    back->send("\n", 1);
+    return response();
+}
+
+int scp_send_filedata(char *data, int len)
+{
+    int bufsize = back->send(data, len);
+
+    /*
+     * If the network transfer is backing up - that is, the remote
+     * site is not accepting data as fast as we can produce it -
+     * then we must loop on network events until we have space in
+     * the buffer again.
+     */
+    while (bufsize > MAX_SCP_BUFSIZE) {
+       if (!scp_process_network_event())
+           return 1;
+       bufsize = back->sendbuffer();
+    }
+
+    return 0;
+}
+
+int scp_send_finish(void)
+{
+    back->send("", 1);
+    return response();
+}
+
+int scp_send_dirname(char *name, int modes)
+{
+    char buf[40];
+    sprintf(buf, "D%04o 0 ", modes);
+    back->send(buf, strlen(buf));
+    back->send(name, strlen(name));
+    back->send("\n", 1);
+    return response();
+}
+
+int scp_send_enddir(void)
+{
+    back->send("E\n", 2);
+    return response();
+}
+
+int scp_sink_init(void)
+{
+    back->send("", 1);
+    return 0;
+}
+
+#define SCP_SINK_FILE   1
+#define SCP_SINK_DIR    2
+#define SCP_SINK_ENDDIR 3
+struct scp_sink_action {
+    int action;                               /* FILE, DIR, ENDDIR */
+    char *buf;                        /* will need freeing after use */
+    char *name;                               /* filename or dirname (not ENDDIR) */
+    int mode;                         /* access mode (not ENDDIR) */
+    unsigned long size;                       /* file size (not ENDDIR) */
+    int settime;                      /* 1 if atime and mtime are filled */
+    unsigned long atime, mtime;               /* access times for the file */
+};
+
+int scp_get_sink_action(struct scp_sink_action *act)
+{
+    int done = 0;
+    int i, bufsize;
+    int action;
+    char ch;
+
+    act->settime = 0;
+    act->buf = NULL;
+    bufsize = 0;
+
+    while (!done) {
+       if (ssh_scp_recv(&ch, 1) <= 0)
+           return 1;
+       if (ch == '\n')
+           bump("Protocol error: Unexpected newline");
+       i = 0;
+       action = ch;
+       do {
+           if (ssh_scp_recv(&ch, 1) <= 0)
+               bump("Lost connection");
+           if (i >= bufsize) {
+               bufsize = i + 128;
+               act->buf = srealloc(act->buf, bufsize);
+           }
+           act->buf[i++] = ch;
+       } while (ch != '\n');
+       act->buf[i - 1] = '\0';
+       switch (action) {
+         case '\01':                  /* error */
+           tell_user(stderr, "%s\n", act->buf);
+           errs++;
+           continue;                  /* go round again */
+         case '\02':                  /* fatal error */
+           bump("%s", act->buf);
+         case 'E':
+           back->send("", 1);
+           act->action = SCP_SINK_ENDDIR;
+           return 0;
+         case 'T':
+           if (sscanf(act->buf, "%ld %*d %ld %*d",
+                      &act->mtime, &act->atime) == 2) {
+               act->settime = 1;
+               back->send("", 1);
+               continue;              /* go round again */
+           }
+           bump("Protocol error: Illegal time format");
+         case 'C':
+         case 'D':
+           act->action = (action == 'C' ? SCP_SINK_FILE : SCP_SINK_DIR);
+           break;
+         default:
+           bump("Protocol error: Expected control record");
+       }
+       /*
+        * We will go round this loop only once, unless we hit
+        * `continue' above.
+        */
+       done = 1;
+    }
+
+    /*
+     * If we get here, we must have seen SCP_SINK_FILE or
+     * SCP_SINK_DIR.
+     */
+    if (sscanf(act->buf, "%o %lu %n", &act->mode, &act->size, &i) != 2)
+       bump("Protocol error: Illegal file descriptor format");
+    act->name = act->buf + i;
+    return 0;
+}
+
+int scp_accept_filexfer(void)
+{
+    back->send("", 1);
+    return 0;                         /* can't fail */
+}
+
+int scp_recv_filedata(char *data, int len)
+{
+    return ssh_scp_recv(data, len);
+}
+
+int scp_finish_filerecv(void)
+{
+    back->send("", 1);
+    return response();
+}
+
+/* ----------------------------------------------------------------------
  *  Send an error message to the other side and to the screen.
  *  Increment error counter.
  */
@@ -656,8 +899,7 @@ static void run_err(const char *fmt, ...)
     strcpy(str, "scp: ");
     vsprintf(str + strlen(str), fmt, ap);
     strcat(str, "\n");
-    back->send("\001", 1);            /* scp protocol error prefix */
-    back->send(str, strlen(str));
+    scp_send_errmsg(str);
     tell_user(stderr, "%s", str);
     va_end(ap);
 }
@@ -727,18 +969,14 @@ static void source(char *src)
        GetFileTime(f, NULL, &actime, &wrtime);
        TIME_WIN_TO_POSIX(actime, atime);
        TIME_WIN_TO_POSIX(wrtime, mtime);
-       sprintf(buf, "T%lu 0 %lu 0\n", mtime, atime);
-       back->send(buf, strlen(buf));
-       if (response())
+       if (scp_send_filetimes(mtime, atime))
            return;
     }
 
     size = GetFileSize(f, NULL);
-    sprintf(buf, "C0644 %lu %s\n", size, last);
     if (verbose)
-       tell_user(stderr, "Sending file modes: %s", buf);
-    back->send(buf, strlen(buf));
-    if (response())
+       tell_user(stderr, "Sending file %s, size=%lu", last, size);
+    if (scp_send_filename(last, size, 0644))
        return;
 
     stat_bytes = 0;
@@ -748,6 +986,7 @@ static void source(char *src)
     for (i = 0; i < size; i += 4096) {
        char transbuf[4096];
        DWORD j, k = 4096;
+
        if (i + k > size)
            k = size - i;
        if (!ReadFile(f, transbuf, k, &j, NULL) || j != k) {
@@ -755,7 +994,9 @@ static void source(char *src)
                printf("\n");
            bump("%s: Read error", src);
        }
-       back->send(transbuf, k);
+       if (scp_send_filedata(transbuf, k))
+           bump("%s: Network error occurred", src);
+
        if (statistics) {
            stat_bytes += k;
            if (time(NULL) != stat_lasttime || i + k == size) {
@@ -764,11 +1005,11 @@ static void source(char *src)
                            stat_starttime, stat_lasttime);
            }
        }
+
     }
     CloseHandle(f);
 
-    back->send("", 1);
-    (void) response();
+    (void) scp_send_finish();
 }
 
 /*
@@ -793,11 +1034,9 @@ static void rsource(char *src)
 
     /* maybe send filetime */
 
-    sprintf(buf, "D0755 0 %s\n", last);
     if (verbose)
-       tell_user(stderr, "Entering directory: %s", buf);
-    back->send(buf, strlen(buf));
-    if (response())
+       tell_user(stderr, "Entering directory: %s", last);
+    if (scp_send_dirname(last, 0755))
        return;
 
     sprintf(buf, "%s/*", src);
@@ -816,9 +1055,7 @@ static void rsource(char *src)
     }
     FindClose(dir);
 
-    sprintf(buf, "E\n");
-    back->send(buf, strlen(buf));
-    (void) response();
+    (void) scp_send_enddir();
 }
 
 /*
@@ -834,9 +1071,7 @@ static void sink(char *targ, char *src)
     int exists;
     DWORD attr;
     HANDLE f;
-    unsigned long mtime, atime;
-    unsigned int mode;
-    unsigned long size, i;
+    unsigned long received;
     int wrerror = 0;
     unsigned long stat_bytes;
     time_t stat_starttime, stat_lasttime;
@@ -849,48 +1084,14 @@ static void sink(char *targ, char *src)
     if (targetshouldbedirectory && !targisdir)
        bump("%s: Not a directory", targ);
 
-    back->send("", 1);
+    scp_sink_init();
     while (1) {
-       settime = 0;
-      gottime:
-       if (ssh_scp_recv(&ch, 1) <= 0)
-           return;
-       if (ch == '\n')
-           bump("Protocol error: Unexpected newline");
-       i = 0;
-       buf[i++] = ch;
-       do {
-           if (ssh_scp_recv(&ch, 1) <= 0)
-               bump("Lost connection");
-           buf[i++] = ch;
-       } while (i < sizeof(buf) && ch != '\n');
-       buf[i - 1] = '\0';
-       switch (buf[0]) {
-         case '\01':                  /* error */
-           tell_user(stderr, "%s\n", buf + 1);
-           errs++;
-           continue;
-         case '\02':                  /* fatal error */
-           bump("%s", buf + 1);
-         case 'E':
-           back->send("", 1);
+       struct scp_sink_action act;
+       if (scp_get_sink_action(&act))
            return;
-         case 'T':
-           if (sscanf(buf, "T%ld %*d %ld %*d", &mtime, &atime) == 2) {
-               settime = 1;
-               back->send("", 1);
-               goto gottime;
-           }
-           bump("Protocol error: Illegal time format");
-         case 'C':
-         case 'D':
-           break;
-         default:
-           bump("Protocol error: Expected control record");
-       }
 
-       if (sscanf(buf + 1, "%u %lu %[^\n]", &mode, &size, namebuf) != 3)
-           bump("Protocol error: Illegal file descriptor format");
+       if (act.action == SCP_SINK_ENDDIR)
+           return;
        /* Security fix: ensure the file ends up where we asked for it. */
        if (targisdir) {
            char t[2048];
@@ -898,8 +1099,8 @@ static void sink(char *targ, char *src)
            strcpy(t, targ);
            if (targ[0] != '\0')
                strcat(t, "/");
-           p = namebuf + strlen(namebuf);
-           while (p > namebuf && p[-1] != '/' && p[-1] != '\\')
+           p = act.name + strlen(act.name);
+           while (p > act.name && p[-1] != '/' && p[-1] != '\\')
                p--;
            strcat(t, p);
            strcpy(namebuf, t);
@@ -909,7 +1110,7 @@ static void sink(char *targ, char *src)
        attr = GetFileAttributes(namebuf);
        exists = (attr != (DWORD) - 1);
 
-       if (buf[0] == 'D') {
+       if (act.action == SCP_SINK_DIR) {
            if (exists && (attr & FILE_ATTRIBUTE_DIRECTORY) == 0) {
                run_err("%s: Not a directory", namebuf);
                continue;
@@ -932,7 +1133,8 @@ static void sink(char *targ, char *src)
            continue;
        }
 
-       back->send("", 1);
+       if (scp_accept_filexfer())
+           return;
 
        stat_bytes = 0;
        stat_starttime = time(NULL);
@@ -944,17 +1146,22 @@ static void sink(char *targ, char *src)
        if (strrchr(stat_name, '\\') != NULL)
            stat_name = strrchr(stat_name, '\\') + 1;
 
-       for (i = 0; i < size; i += 4096) {
+       received = 0;
+       while (received < act.size) {
            char transbuf[4096];
-           DWORD j, k = 4096;
-           if (i + k > size)
-               k = size - i;
-           if (ssh_scp_recv(transbuf, k) == 0)
+           DWORD blksize, read, written;
+           blksize = 4096;
+           if (blksize > act.size - received)
+               blksize = act.size - received;
+           read = scp_recv_filedata(transbuf, blksize);
+           if (read <= 0)
                bump("Lost connection");
            if (wrerror)
                continue;
-           if (!WriteFile(f, transbuf, k, &j, NULL) || j != k) {
+           if (!WriteFile(f, transbuf, read, &written, NULL) ||
+               written != read) {
                wrerror = 1;
+               /* FIXME: in sftp we can actually abort the transfer */
                if (statistics)
                    printf("\r%-25.25s | %50s\n",
                           stat_name,
@@ -962,20 +1169,20 @@ static void sink(char *targ, char *src)
                continue;
            }
            if (statistics) {
-               stat_bytes += k;
-               if (time(NULL) > stat_lasttime || i + k == size) {
+               stat_bytes += read;
+               if (time(NULL) > stat_lasttime ||
+                   received + read == act.size) {
                    stat_lasttime = time(NULL);
-                   print_stats(stat_name, size, stat_bytes,
+                   print_stats(stat_name, act.size, stat_bytes,
                                stat_starttime, stat_lasttime);
                }
            }
+           received += read;
        }
-       (void) response();
-
-       if (settime) {
+       if (act.settime) {
            FILETIME actime, wrtime;
-           TIME_POSIX_TO_WIN(atime, actime);
-           TIME_POSIX_TO_WIN(mtime, wrtime);
+           TIME_POSIX_TO_WIN(act.atime, actime);
+           TIME_POSIX_TO_WIN(act.mtime, wrtime);
            SetFileTime(f, NULL, &actime, &wrtime);
        }
 
@@ -984,12 +1191,12 @@ static void sink(char *targ, char *src)
            run_err("%s: Write error", namebuf);
            continue;
        }
-       back->send("", 1);
+       (void) scp_finish_filerecv();
     }
 }
 
 /*
- *  We will copy local files to a remote server.
+ * We will copy local files to a remote server.
  */
 static void toremote(int argc, char *argv[])
 {