2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 * The main loop for the interactive session (client side).
7 * As far as I am concerned, the code I have written for this software
8 * can be used freely for any purpose. Any derived versions of this
9 * software must be clearly marked as such, and if the derived work is
10 * incompatible with the protocol description in the RFC file, it must be
11 * called by a name other than "ssh" or "Secure Shell".
14 * Copyright (c) 1999 Theo de Raadt. All rights reserved.
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution.
25 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
26 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
27 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
28 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
30 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 * SSH2 support added by Markus Friedl.
38 * Copyright (c) 1999, 2000, 2001 Markus Friedl. All rights reserved.
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
43 * 1. Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in the
47 * documentation and/or other materials provided with the distribution.
49 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
50 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
51 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
52 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
53 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
54 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
55 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
56 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
57 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
58 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 RCSID("$OpenBSD: clientloop.c,v 1.126 2004/06/17 14:52:48 djm Exp $");
79 #include "clientloop.h"
84 #include "monitor_fdpass.h"
89 extern Options options;
91 /* Flag indicating that stdin should be redirected from /dev/null. */
92 extern int stdin_null_flag;
94 /* Flag indicating that no shell has been requested */
95 extern int no_shell_flag;
98 extern int control_fd;
101 * Name of the host we are connecting to. This is the name given on the
102 * command line, or the HostName specified for the user-supplied name in a
103 * configuration file.
108 * Flag to indicate that we have received a window change signal which has
109 * not yet been processed. This will cause a message indicating the new
110 * window size to be sent to the server a little later. This is volatile
111 * because this is updated in a signal handler.
113 static volatile sig_atomic_t received_window_change_signal = 0;
114 static volatile sig_atomic_t received_signal = 0;
116 /* Flag indicating whether the user\'s terminal is in non-blocking mode. */
117 static int in_non_blocking_mode = 0;
119 /* Common data for the client loop code. */
120 static int quit_pending; /* Set to non-zero to quit the client loop. */
121 static int escape_char; /* Escape character. */
122 static int escape_pending; /* Last character was the escape character */
123 static int last_was_cr; /* Last character was a newline. */
124 static int exit_status; /* Used to store the exit status of the command. */
125 static int stdin_eof; /* EOF has been encountered on standard error. */
126 static Buffer stdin_buffer; /* Buffer for stdin data. */
127 static Buffer stdout_buffer; /* Buffer for stdout data. */
128 static Buffer stderr_buffer; /* Buffer for stderr data. */
129 static u_long stdin_bytes, stdout_bytes, stderr_bytes;
130 static u_int buffer_high;/* Soft max buffer size. */
131 static int connection_in; /* Connection to server (input). */
132 static int connection_out; /* Connection to server (output). */
133 static int need_rekeying; /* Set to non-zero if rekeying is requested. */
134 static int session_closed = 0; /* In SSH2: login session closed. */
135 static int server_alive_timeouts = 0;
137 static void client_init_dispatch(void);
138 int session_ident = -1;
152 void ssh_process_session2_setup(int, int, int, Buffer *);
154 /* Restores stdin to blocking mode. */
157 leave_non_blocking(void)
159 if (in_non_blocking_mode) {
160 unset_nonblock(fileno(stdin));
161 in_non_blocking_mode = 0;
165 /* Puts stdin terminal in non-blocking mode. */
168 enter_non_blocking(void)
170 in_non_blocking_mode = 1;
171 set_nonblock(fileno(stdin));
175 * Signal handler for the window change signal (SIGWINCH). This just sets a
176 * flag indicating that the window has changed.
180 window_change_handler(int sig)
182 received_window_change_signal = 1;
183 signal(SIGWINCH, window_change_handler);
187 * Signal handler for signals that cause the program to terminate. These
188 * signals must be trapped to restore terminal modes.
192 signal_handler(int sig)
194 received_signal = sig;
199 * Returns current time in seconds from Jan 1, 1970 with the maximum
200 * available resolution.
204 get_current_time(void)
207 gettimeofday(&tv, NULL);
208 return (double) tv.tv_sec + (double) tv.tv_usec / 1000000.0;
212 * This is called when the interactive is entered. This checks if there is
213 * an EOF coming on stdin. We must check this explicitly, as select() does
214 * not appear to wake up when redirecting from /dev/null.
218 client_check_initial_eof_on_stdin(void)
224 * If standard input is to be "redirected from /dev/null", we simply
225 * mark that we have seen an EOF and send an EOF message to the
226 * server. Otherwise, we try to read a single character; it appears
227 * that for some files, such /dev/null, select() never wakes up for
228 * read for this descriptor, which means that we never get EOF. This
229 * way we will get the EOF if stdin comes from /dev/null or similar.
231 if (stdin_null_flag) {
232 /* Fake EOF on stdin. */
233 debug("Sending eof.");
235 packet_start(SSH_CMSG_EOF);
238 enter_non_blocking();
240 /* Check for immediate EOF on stdin. */
241 len = read(fileno(stdin), buf, 1);
243 /* EOF. Record that we have seen it and send EOF to server. */
244 debug("Sending eof.");
246 packet_start(SSH_CMSG_EOF);
248 } else if (len > 0) {
250 * Got data. We must store the data in the buffer,
251 * and also process it as an escape character if
254 if ((u_char) buf[0] == escape_char)
257 buffer_append(&stdin_buffer, buf, 1);
259 leave_non_blocking();
265 * Make packets from buffered stdin data, and buffer them for sending to the
270 client_make_packets_from_stdin_data(void)
274 /* Send buffered stdin data to the server. */
275 while (buffer_len(&stdin_buffer) > 0 &&
276 packet_not_very_much_data_to_write()) {
277 len = buffer_len(&stdin_buffer);
278 /* Keep the packets at reasonable size. */
279 if (len > packet_get_maxsize())
280 len = packet_get_maxsize();
281 packet_start(SSH_CMSG_STDIN_DATA);
282 packet_put_string(buffer_ptr(&stdin_buffer), len);
284 buffer_consume(&stdin_buffer, len);
286 /* If we have a pending EOF, send it now. */
287 if (stdin_eof && buffer_len(&stdin_buffer) == 0) {
288 packet_start(SSH_CMSG_EOF);
295 * Checks if the client window has changed, and sends a packet about it to
296 * the server if so. The actual change is detected elsewhere (by a software
297 * interrupt on Unix); this just checks the flag and sends a message if
302 client_check_window_change(void)
306 if (! received_window_change_signal)
309 received_window_change_signal = 0;
311 debug2("client_check_window_change: changed");
314 channel_send_window_changes();
316 if (ioctl(fileno(stdin), TIOCGWINSZ, &ws) < 0)
318 packet_start(SSH_CMSG_WINDOW_SIZE);
319 packet_put_int(ws.ws_row);
320 packet_put_int(ws.ws_col);
321 packet_put_int(ws.ws_xpixel);
322 packet_put_int(ws.ws_ypixel);
328 client_global_request_reply(int type, u_int32_t seq, void *ctxt)
330 server_alive_timeouts = 0;
331 client_global_request_reply_fwd(type, seq, ctxt);
335 server_alive_check(void)
337 if (++server_alive_timeouts > options.server_alive_count_max)
338 packet_disconnect("Timeout, server not responding.");
339 packet_start(SSH2_MSG_GLOBAL_REQUEST);
340 packet_put_cstring("keepalive@openssh.com");
341 packet_put_char(1); /* boolean: want reply */
346 * Waits until the client can do something (some data becomes available on
347 * one of the file descriptors).
350 client_wait_until_can_do_something(fd_set **readsetp, fd_set **writesetp,
351 int *maxfdp, int *nallocp, int rekeying)
353 struct timeval tv, *tvp;
356 /* Add any selections by the channel mechanism. */
357 channel_prepare_select(readsetp, writesetp, maxfdp, nallocp, rekeying);
360 /* Read from the connection, unless our buffers are full. */
361 if (buffer_len(&stdout_buffer) < buffer_high &&
362 buffer_len(&stderr_buffer) < buffer_high &&
363 channel_not_very_much_buffered_data())
364 FD_SET(connection_in, *readsetp);
366 * Read from stdin, unless we have seen EOF or have very much
367 * buffered data to send to the server.
369 if (!stdin_eof && packet_not_very_much_data_to_write())
370 FD_SET(fileno(stdin), *readsetp);
372 /* Select stdout/stderr if have data in buffer. */
373 if (buffer_len(&stdout_buffer) > 0)
374 FD_SET(fileno(stdout), *writesetp);
375 if (buffer_len(&stderr_buffer) > 0)
376 FD_SET(fileno(stderr), *writesetp);
378 /* channel_prepare_select could have closed the last channel */
379 if (session_closed && !channel_still_open() &&
380 !packet_have_data_to_write()) {
381 /* clear mask since we did not call select() */
382 memset(*readsetp, 0, *nallocp);
383 memset(*writesetp, 0, *nallocp);
386 FD_SET(connection_in, *readsetp);
390 /* Select server connection if have data to write to the server. */
391 if (packet_have_data_to_write())
392 FD_SET(connection_out, *writesetp);
394 if (control_fd != -1)
395 FD_SET(control_fd, *readsetp);
398 * Wait for something to happen. This will suspend the process until
399 * some selected descriptor can be read, written, or has some other
403 if (options.server_alive_interval == 0 || !compat20)
406 tv.tv_sec = options.server_alive_interval;
410 ret = select((*maxfdp)+1, *readsetp, *writesetp, NULL, tvp);
415 * We have to clear the select masks, because we return.
416 * We have to return, because the mainloop checks for the flags
417 * set by the signal handlers.
419 memset(*readsetp, 0, *nallocp);
420 memset(*writesetp, 0, *nallocp);
424 /* Note: we might still have data in the buffers. */
425 snprintf(buf, sizeof buf, "select: %s\r\n", strerror(errno));
426 buffer_append(&stderr_buffer, buf, strlen(buf));
429 server_alive_check();
433 client_suspend_self(Buffer *bin, Buffer *bout, Buffer *berr)
435 struct winsize oldws, newws;
437 /* Flush stdout and stderr buffers. */
438 if (buffer_len(bout) > 0)
439 atomicio(vwrite, fileno(stdout), buffer_ptr(bout), buffer_len(bout));
440 if (buffer_len(berr) > 0)
441 atomicio(vwrite, fileno(stderr), buffer_ptr(berr), buffer_len(berr));
446 * Free (and clear) the buffer to reduce the amount of data that gets
453 /* Save old window size. */
454 ioctl(fileno(stdin), TIOCGWINSZ, &oldws);
456 /* Send the suspend signal to the program itself. */
457 kill(getpid(), SIGTSTP);
459 /* Check if the window size has changed. */
460 if (ioctl(fileno(stdin), TIOCGWINSZ, &newws) >= 0 &&
461 (oldws.ws_row != newws.ws_row ||
462 oldws.ws_col != newws.ws_col ||
463 oldws.ws_xpixel != newws.ws_xpixel ||
464 oldws.ws_ypixel != newws.ws_ypixel))
465 received_window_change_signal = 1;
467 /* OK, we have been continued by the user. Reinitialize buffers. */
476 client_process_net_input(fd_set * readset)
482 * Read input from the server, and add any such data to the buffer of
483 * the packet subsystem.
485 if (FD_ISSET(connection_in, readset)) {
486 /* Read as much as possible. */
487 len = read(connection_in, buf, sizeof(buf));
489 /* Received EOF. The remote host has closed the connection. */
490 snprintf(buf, sizeof buf, "Connection to %.300s closed by remote host.\r\n",
492 buffer_append(&stderr_buffer, buf, strlen(buf));
497 * There is a kernel bug on Solaris that causes select to
498 * sometimes wake up even though there is no data available.
500 if (len < 0 && (errno == EAGAIN || errno == EINTR))
504 /* An error has encountered. Perhaps there is a network problem. */
505 snprintf(buf, sizeof buf, "Read from remote host %.300s: %.100s\r\n",
506 host, strerror(errno));
507 buffer_append(&stderr_buffer, buf, strlen(buf));
511 packet_process_incoming(buf, len);
516 client_subsystem_reply(int type, u_int32_t seq, void *ctxt)
521 id = packet_get_int();
524 if ((c = channel_lookup(id)) == NULL) {
525 error("%s: no channel for id %d", __func__, id);
529 if (type == SSH2_MSG_CHANNEL_SUCCESS)
530 debug2("Request suceeded on channel %d", id);
531 else if (type == SSH2_MSG_CHANNEL_FAILURE) {
532 error("Request failed on channel %d", id);
538 client_extra_session2_setup(int id, void *arg)
540 struct confirm_ctx *cctx = arg;
545 fatal("%s: cctx == NULL", __func__);
546 if ((c = channel_lookup(id)) == NULL)
547 fatal("%s: no channel for id %d", __func__, id);
549 client_session2_setup(id, cctx->want_tty, cctx->want_subsys,
550 cctx->term, &cctx->tio, c->rfd, &cctx->cmd, cctx->env,
551 client_subsystem_reply);
553 c->confirm_ctx = NULL;
554 buffer_free(&cctx->cmd);
556 if (cctx->env != NULL) {
557 for (i = 0; cctx->env[i] != NULL; i++)
565 client_process_control(fd_set * readset)
569 int client_fd, new_fd[3], ver, i;
571 struct sockaddr_storage addr;
572 struct confirm_ctx *cctx;
579 * Accept connection on control socket
581 if (control_fd == -1 || !FD_ISSET(control_fd, readset))
584 memset(&addr, 0, sizeof(addr));
585 addrlen = sizeof(addr);
586 if ((client_fd = accept(control_fd,
587 (struct sockaddr*)&addr, &addrlen)) == -1) {
588 error("%s accept: %s", __func__, strerror(errno));
592 if (getpeereid(client_fd, &euid, &egid) < 0) {
593 error("%s getpeereid failed: %s", __func__, strerror(errno));
597 if ((euid != 0) && (getuid() != euid)) {
598 error("control mode uid mismatch: peer euid %u != uid %u",
599 (u_int) euid, (u_int) getuid());
603 /* XXX: implement use of ssh-askpass to confirm additional channels */
605 unset_nonblock(client_fd);
609 buffer_put_int(&m, getpid());
610 if (ssh_msg_send(client_fd, /* version */0, &m) == -1) {
611 error("%s: client msg_send failed", __func__);
617 if (ssh_msg_recv(client_fd, &m) == -1) {
618 error("%s: client msg_recv failed", __func__);
623 if ((ver = buffer_get_char(&m)) != 0) {
624 error("%s: wrong client version %d", __func__, ver);
630 cctx = xmalloc(sizeof(*cctx));
631 memset(cctx, 0, sizeof(*cctx));
633 cctx->want_tty = buffer_get_int(&m);
634 cctx->want_subsys = buffer_get_int(&m);
635 cctx->term = buffer_get_string(&m, &len);
637 cmd = buffer_get_string(&m, &len);
638 buffer_init(&cctx->cmd);
639 buffer_append(&cctx->cmd, cmd, strlen(cmd));
641 env_len = buffer_get_int(&m);
642 env_len = MIN(env_len, 4096);
643 debug3("%s: receiving %d env vars", __func__, env_len);
645 cctx->env = xmalloc(sizeof(*cctx->env) * (env_len + 1));
646 for (i = 0; i < env_len; i++)
647 cctx->env[i] = buffer_get_string(&m, &len);
651 debug2("%s: accepted tty %d, subsys %d, cmd %s", __func__,
652 cctx->want_tty, cctx->want_subsys, cmd);
654 /* Gather fds from client */
655 new_fd[0] = mm_receive_fd(client_fd);
656 new_fd[1] = mm_receive_fd(client_fd);
657 new_fd[2] = mm_receive_fd(client_fd);
659 debug2("%s: got fds stdin %d, stdout %d, stderr %d", __func__,
660 new_fd[0], new_fd[1], new_fd[2]);
662 /* Try to pick up ttymodes from client before it goes raw */
663 if (cctx->want_tty && tcgetattr(new_fd[0], &cctx->tio) == -1)
664 error("%s: tcgetattr: %s", __func__, strerror(errno));
667 if (ssh_msg_send(client_fd, /* version */0, &m) == -1) {
668 error("%s: client msg_send failed", __func__);
677 /* enable nonblocking unless tty */
678 if (!isatty(new_fd[0]))
679 set_nonblock(new_fd[0]);
680 if (!isatty(new_fd[1]))
681 set_nonblock(new_fd[1]);
682 if (!isatty(new_fd[2]))
683 set_nonblock(new_fd[2]);
685 set_nonblock(client_fd);
687 c = channel_new("session", SSH_CHANNEL_OPENING,
688 new_fd[0], new_fd[1], new_fd[2],
689 CHAN_SES_WINDOW_DEFAULT, CHAN_SES_PACKET_DEFAULT,
690 CHAN_EXTENDED_WRITE, "client-session", /*nonblock*/0);
693 c->ctl_fd = client_fd;
695 debug3("%s: channel_new: %d", __func__, c->self);
697 channel_send_open(c->self);
698 channel_register_confirm(c->self, client_extra_session2_setup, cctx);
702 process_cmdline(void)
704 void (*handler)(int);
706 u_short fwd_port, fwd_host_port;
707 char buf[1024], sfwd_port[6], sfwd_host_port[6];
712 handler = signal(SIGINT, SIG_IGN);
713 cmd = s = read_passphrase("\r\nssh> ", RP_ECHO);
716 while (*s && isspace(*s))
719 s++; /* Skip cmdline '-', if any */
723 if (*s == 'h' || *s == 'H' || *s == '?') {
725 logit(" -Lport:host:hostport Request local forward");
726 logit(" -Rport:host:hostport Request remote forward");
727 logit(" -KRhostport Cancel remote forward");
735 if (*s != 'L' && *s != 'R') {
736 logit("Invalid command.");
741 if (local && delete) {
742 logit("Not supported.");
745 if ((!local || delete) && !compat20) {
746 logit("Not supported for SSH protocol version 1.");
751 while (*s && isspace(*s))
755 if (sscanf(s, "%5[0-9]", sfwd_host_port) != 1) {
756 logit("Bad forwarding specification.");
759 if ((fwd_host_port = a2port(sfwd_host_port)) == 0) {
760 logit("Bad forwarding port(s).");
763 channel_request_rforward_cancel(fwd_host_port);
765 if (sscanf(s, "%5[0-9]:%255[^:]:%5[0-9]",
766 sfwd_port, buf, sfwd_host_port) != 3 &&
767 sscanf(s, "%5[0-9]/%255[^/]/%5[0-9]",
768 sfwd_port, buf, sfwd_host_port) != 3) {
769 logit("Bad forwarding specification.");
772 if ((fwd_port = a2port(sfwd_port)) == 0 ||
773 (fwd_host_port = a2port(sfwd_host_port)) == 0) {
774 logit("Bad forwarding port(s).");
778 if (channel_setup_local_fwd_listener(fwd_port, buf,
779 fwd_host_port, options.gateway_ports) < 0) {
780 logit("Port forwarding failed.");
784 channel_request_remote_forwarding(fwd_port, buf,
786 logit("Forwarding port.");
790 signal(SIGINT, handler);
796 /* process the characters one by one */
798 process_escapes(Buffer *bin, Buffer *bout, Buffer *berr, char *buf, int len)
807 for (i = 0; i < len; i++) {
808 /* Get one character at a time. */
811 if (escape_pending) {
812 /* We have previously seen an escape character. */
813 /* Clear the flag now. */
816 /* Process the escaped character. */
819 /* Terminate the connection. */
820 snprintf(string, sizeof string, "%c.\r\n", escape_char);
821 buffer_append(berr, string, strlen(string));
827 /* Suspend the program. */
828 /* Print a message to that effect to the user. */
829 snprintf(string, sizeof string, "%c^Z [suspend ssh]\r\n", escape_char);
830 buffer_append(berr, string, strlen(string));
832 /* Restore terminal modes and suspend. */
833 client_suspend_self(bin, bout, berr);
835 /* We have been continued. */
840 snprintf(string, sizeof string,
841 "%cB\r\n", escape_char);
842 buffer_append(berr, string,
844 channel_request_start(session_ident,
846 packet_put_int(1000);
853 if (datafellows & SSH_BUG_NOREKEY)
854 logit("Server does not support re-keying");
862 * Detach the program (continue to serve connections,
863 * but put in background and no more new connections).
865 /* Restore tty modes. */
868 /* Stop listening for new connections. */
869 channel_stop_listening();
871 snprintf(string, sizeof string,
872 "%c& [backgrounded]\n", escape_char);
873 buffer_append(berr, string, strlen(string));
875 /* Fork into background. */
878 error("fork: %.100s", strerror(errno));
881 if (pid != 0) { /* This is the parent. */
882 /* The parent just exits. */
885 /* The child continues serving connections. */
887 buffer_append(bin, "\004", 1);
888 /* fake EOF on stdin */
890 } else if (!stdin_eof) {
892 * Sending SSH_CMSG_EOF alone does not always appear
893 * to be enough. So we try to send an EOF character
896 packet_start(SSH_CMSG_STDIN_DATA);
897 packet_put_string("\004", 1);
901 if (buffer_len(bin) == 0) {
902 packet_start(SSH_CMSG_EOF);
909 snprintf(string, sizeof string,
911 Supported escape sequences:\r\n\
912 %c. - terminate connection\r\n\
913 %cB - send a BREAK to the remote system\r\n\
914 %cC - open a command line\r\n\
915 %cR - Request rekey (SSH protocol 2 only)\r\n\
916 %c^Z - suspend ssh\r\n\
917 %c# - list forwarded connections\r\n\
918 %c& - background ssh (when waiting for connections to terminate)\r\n\
919 %c? - this message\r\n\
920 %c%c - send the escape character by typing it twice\r\n\
921 (Note that escapes are only recognized immediately after newline.)\r\n",
922 escape_char, escape_char, escape_char, escape_char,
923 escape_char, escape_char, escape_char, escape_char,
924 escape_char, escape_char, escape_char);
925 buffer_append(berr, string, strlen(string));
929 snprintf(string, sizeof string, "%c#\r\n", escape_char);
930 buffer_append(berr, string, strlen(string));
931 s = channel_open_message();
932 buffer_append(berr, s, strlen(s));
941 if (ch != escape_char) {
942 buffer_put_char(bin, escape_char);
945 /* Escaped characters fall through here */
950 * The previous character was not an escape char. Check if this
953 if (last_was_cr && ch == escape_char) {
954 /* It is. Set the flag and continue to next character. */
961 * Normal character. Record whether it was a newline,
962 * and append it to the buffer.
964 last_was_cr = (ch == '\r' || ch == '\n');
965 buffer_put_char(bin, ch);
972 client_process_input(fd_set * readset)
977 /* Read input from stdin. */
978 if (FD_ISSET(fileno(stdin), readset)) {
979 /* Read as much as possible. */
980 len = read(fileno(stdin), buf, sizeof(buf));
981 if (len < 0 && (errno == EAGAIN || errno == EINTR))
982 return; /* we'll try again later */
985 * Received EOF or error. They are treated
986 * similarly, except that an error message is printed
987 * if it was an error condition.
990 snprintf(buf, sizeof buf, "read: %.100s\r\n", strerror(errno));
991 buffer_append(&stderr_buffer, buf, strlen(buf));
993 /* Mark that we have seen EOF. */
996 * Send an EOF message to the server unless there is
997 * data in the buffer. If there is data in the
998 * buffer, no message will be sent now. Code
999 * elsewhere will send the EOF when the buffer
1000 * becomes empty if stdin_eof is set.
1002 if (buffer_len(&stdin_buffer) == 0) {
1003 packet_start(SSH_CMSG_EOF);
1006 } else if (escape_char == SSH_ESCAPECHAR_NONE) {
1008 * Normal successful read, and no escape character.
1009 * Just append the data to buffer.
1011 buffer_append(&stdin_buffer, buf, len);
1014 * Normal, successful read. But we have an escape character
1015 * and have to process the characters one by one.
1017 if (process_escapes(&stdin_buffer, &stdout_buffer,
1018 &stderr_buffer, buf, len) == -1)
1025 client_process_output(fd_set * writeset)
1030 /* Write buffered output to stdout. */
1031 if (FD_ISSET(fileno(stdout), writeset)) {
1032 /* Write as much data as possible. */
1033 len = write(fileno(stdout), buffer_ptr(&stdout_buffer),
1034 buffer_len(&stdout_buffer));
1036 if (errno == EINTR || errno == EAGAIN)
1040 * An error or EOF was encountered. Put an
1041 * error message to stderr buffer.
1043 snprintf(buf, sizeof buf, "write stdout: %.50s\r\n", strerror(errno));
1044 buffer_append(&stderr_buffer, buf, strlen(buf));
1049 /* Consume printed data from the buffer. */
1050 buffer_consume(&stdout_buffer, len);
1051 stdout_bytes += len;
1053 /* Write buffered output to stderr. */
1054 if (FD_ISSET(fileno(stderr), writeset)) {
1055 /* Write as much data as possible. */
1056 len = write(fileno(stderr), buffer_ptr(&stderr_buffer),
1057 buffer_len(&stderr_buffer));
1059 if (errno == EINTR || errno == EAGAIN)
1062 /* EOF or error, but can't even print error message. */
1067 /* Consume printed characters from the buffer. */
1068 buffer_consume(&stderr_buffer, len);
1069 stderr_bytes += len;
1074 * Get packets from the connection input buffer, and process them as long as
1075 * there are packets available.
1077 * Any unknown packets received during the actual
1078 * session cause the session to terminate. This is
1079 * intended to make debugging easier since no
1080 * confirmations are sent. Any compatible protocol
1081 * extensions must be negotiated during the
1082 * preparatory phase.
1086 client_process_buffered_input_packets(void)
1088 dispatch_run(DISPATCH_NONBLOCK, &quit_pending, compat20 ? xxx_kex : NULL);
1091 /* scan buf[] for '~' before sending data to the peer */
1094 simple_escape_filter(Channel *c, char *buf, int len)
1096 /* XXX we assume c->extended is writeable */
1097 return process_escapes(&c->input, &c->output, &c->extended, buf, len);
1101 client_channel_closed(int id, void *arg)
1103 channel_cancel_cleanup(id);
1109 * Implements the interactive session with the server. This is called after
1110 * the user has been authenticated, and a command has been started on the
1111 * remote host. If escape_char != SSH_ESCAPECHAR_NONE, it is the character
1112 * used as an escape character for terminating or suspending the session.
1116 client_loop(int have_pty, int escape_char_arg, int ssh2_chan_id)
1118 fd_set *readset = NULL, *writeset = NULL;
1119 double start_time, total_time;
1120 int max_fd = 0, max_fd2 = 0, len, rekeying = 0, nalloc = 0;
1123 debug("Entering interactive session.");
1125 start_time = get_current_time();
1127 /* Initialize variables. */
1132 buffer_high = 64 * 1024;
1133 connection_in = packet_get_connection_in();
1134 connection_out = packet_get_connection_out();
1135 max_fd = MAX(connection_in, connection_out);
1136 if (control_fd != -1)
1137 max_fd = MAX(max_fd, control_fd);
1140 /* enable nonblocking unless tty */
1141 if (!isatty(fileno(stdin)))
1142 set_nonblock(fileno(stdin));
1143 if (!isatty(fileno(stdout)))
1144 set_nonblock(fileno(stdout));
1145 if (!isatty(fileno(stderr)))
1146 set_nonblock(fileno(stderr));
1147 max_fd = MAX(max_fd, fileno(stdin));
1148 max_fd = MAX(max_fd, fileno(stdout));
1149 max_fd = MAX(max_fd, fileno(stderr));
1155 escape_char = escape_char_arg;
1157 /* Initialize buffers. */
1158 buffer_init(&stdin_buffer);
1159 buffer_init(&stdout_buffer);
1160 buffer_init(&stderr_buffer);
1162 client_init_dispatch();
1165 * Set signal handlers, (e.g. to restore non-blocking mode)
1166 * but don't overwrite SIG_IGN, matches behaviour from rsh(1)
1168 if (signal(SIGINT, SIG_IGN) != SIG_IGN)
1169 signal(SIGINT, signal_handler);
1170 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN)
1171 signal(SIGQUIT, signal_handler);
1172 if (signal(SIGTERM, SIG_IGN) != SIG_IGN)
1173 signal(SIGTERM, signal_handler);
1175 signal(SIGWINCH, window_change_handler);
1181 session_ident = ssh2_chan_id;
1182 if (escape_char != SSH_ESCAPECHAR_NONE)
1183 channel_register_filter(session_ident,
1184 simple_escape_filter);
1185 if (session_ident != -1)
1186 channel_register_cleanup(session_ident,
1187 client_channel_closed);
1189 /* Check if we should immediately send eof on stdin. */
1190 client_check_initial_eof_on_stdin();
1193 /* Main loop of the client for the interactive session mode. */
1194 while (!quit_pending) {
1196 /* Process buffered packets sent by the server. */
1197 client_process_buffered_input_packets();
1199 if (compat20 && session_closed && !channel_still_open())
1202 rekeying = (xxx_kex != NULL && !xxx_kex->done);
1205 debug("rekeying in progress");
1208 * Make packets of buffered stdin data, and buffer
1209 * them for sending to the server.
1212 client_make_packets_from_stdin_data();
1215 * Make packets from buffered channel data, and
1216 * enqueue them for sending to the server.
1218 if (packet_not_very_much_data_to_write())
1219 channel_output_poll();
1222 * Check if the window size has changed, and buffer a
1223 * message about it to the server if so.
1225 client_check_window_change();
1231 * Wait until we have something to do (something becomes
1232 * available on one of the descriptors).
1235 client_wait_until_can_do_something(&readset, &writeset,
1236 &max_fd2, &nalloc, rekeying);
1241 /* Do channel operations unless rekeying in progress. */
1243 channel_after_select(readset, writeset);
1244 if (need_rekeying || packet_need_rekeying()) {
1245 debug("need rekeying");
1247 kex_send_kexinit(xxx_kex);
1252 /* Buffer input from the connection. */
1253 client_process_net_input(readset);
1255 /* Accept control connections. */
1256 client_process_control(readset);
1262 /* Buffer data from stdin */
1263 client_process_input(readset);
1265 * Process output to stdout and stderr. Output to
1266 * the connection is processed elsewhere (above).
1268 client_process_output(writeset);
1271 /* Send as much buffered packet data as possible to the sender. */
1272 if (FD_ISSET(connection_out, writeset))
1273 packet_write_poll();
1280 /* Terminate the session. */
1282 /* Stop watching for window change. */
1284 signal(SIGWINCH, SIG_DFL);
1291 /* restore blocking io */
1292 if (!isatty(fileno(stdin)))
1293 unset_nonblock(fileno(stdin));
1294 if (!isatty(fileno(stdout)))
1295 unset_nonblock(fileno(stdout));
1296 if (!isatty(fileno(stderr)))
1297 unset_nonblock(fileno(stderr));
1300 * If there was no shell or command requested, there will be no remote
1301 * exit status to be returned. In that case, clear error code if the
1302 * connection was deliberately terminated at this end.
1304 if (no_shell_flag && received_signal == SIGTERM) {
1305 received_signal = 0;
1309 if (received_signal)
1310 fatal("Killed by signal %d.", (int) received_signal);
1313 * In interactive mode (with pseudo tty) display a message indicating
1314 * that the connection has been closed.
1316 if (have_pty && options.log_level != SYSLOG_LEVEL_QUIET) {
1317 snprintf(buf, sizeof buf, "Connection to %.64s closed.\r\n", host);
1318 buffer_append(&stderr_buffer, buf, strlen(buf));
1321 /* Output any buffered data for stdout. */
1322 while (buffer_len(&stdout_buffer) > 0) {
1323 len = write(fileno(stdout), buffer_ptr(&stdout_buffer),
1324 buffer_len(&stdout_buffer));
1326 error("Write failed flushing stdout buffer.");
1329 buffer_consume(&stdout_buffer, len);
1330 stdout_bytes += len;
1333 /* Output any buffered data for stderr. */
1334 while (buffer_len(&stderr_buffer) > 0) {
1335 len = write(fileno(stderr), buffer_ptr(&stderr_buffer),
1336 buffer_len(&stderr_buffer));
1338 error("Write failed flushing stderr buffer.");
1341 buffer_consume(&stderr_buffer, len);
1342 stderr_bytes += len;
1345 /* Clear and free any buffers. */
1346 memset(buf, 0, sizeof(buf));
1347 buffer_free(&stdin_buffer);
1348 buffer_free(&stdout_buffer);
1349 buffer_free(&stderr_buffer);
1351 /* Report bytes transferred, and transfer rates. */
1352 total_time = get_current_time() - start_time;
1353 debug("Transferred: stdin %lu, stdout %lu, stderr %lu bytes in %.1f seconds",
1354 stdin_bytes, stdout_bytes, stderr_bytes, total_time);
1356 debug("Bytes per second: stdin %.1f, stdout %.1f, stderr %.1f",
1357 stdin_bytes / total_time, stdout_bytes / total_time,
1358 stderr_bytes / total_time);
1360 /* Return the exit status of the program. */
1361 debug("Exit status %d", exit_status);
1368 client_input_stdout_data(int type, u_int32_t seq, void *ctxt)
1371 char *data = packet_get_string(&data_len);
1373 buffer_append(&stdout_buffer, data, data_len);
1374 memset(data, 0, data_len);
1378 client_input_stderr_data(int type, u_int32_t seq, void *ctxt)
1381 char *data = packet_get_string(&data_len);
1383 buffer_append(&stderr_buffer, data, data_len);
1384 memset(data, 0, data_len);
1388 client_input_exit_status(int type, u_int32_t seq, void *ctxt)
1390 exit_status = packet_get_int();
1392 /* Acknowledge the exit. */
1393 packet_start(SSH_CMSG_EXIT_CONFIRMATION);
1396 * Must wait for packet to be sent since we are
1399 packet_write_wait();
1400 /* Flag that we want to exit. */
1404 client_input_agent_open(int type, u_int32_t seq, void *ctxt)
1407 int remote_id, sock;
1409 /* Read the remote channel number from the message. */
1410 remote_id = packet_get_int();
1414 * Get a connection to the local authentication agent (this may again
1417 sock = ssh_get_authentication_socket();
1420 * If we could not connect the agent, send an error message back to
1421 * the server. This should never happen unless the agent dies,
1422 * because authentication forwarding is only enabled if we have an
1426 c = channel_new("", SSH_CHANNEL_OPEN, sock, sock,
1427 -1, 0, 0, 0, "authentication agent connection", 1);
1428 c->remote_id = remote_id;
1432 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
1433 packet_put_int(remote_id);
1435 /* Send a confirmation to the remote host. */
1436 debug("Forwarding authentication connection.");
1437 packet_start(SSH_MSG_CHANNEL_OPEN_CONFIRMATION);
1438 packet_put_int(remote_id);
1439 packet_put_int(c->self);
1445 client_request_forwarded_tcpip(const char *request_type, int rchan)
1448 char *listen_address, *originator_address;
1449 int listen_port, originator_port;
1452 /* Get rest of the packet */
1453 listen_address = packet_get_string(NULL);
1454 listen_port = packet_get_int();
1455 originator_address = packet_get_string(NULL);
1456 originator_port = packet_get_int();
1459 debug("client_request_forwarded_tcpip: listen %s port %d, originator %s port %d",
1460 listen_address, listen_port, originator_address, originator_port);
1462 sock = channel_connect_by_listen_address(listen_port);
1464 xfree(originator_address);
1465 xfree(listen_address);
1468 c = channel_new("forwarded-tcpip",
1469 SSH_CHANNEL_CONNECTING, sock, sock, -1,
1470 CHAN_TCP_WINDOW_DEFAULT, CHAN_TCP_WINDOW_DEFAULT, 0,
1471 originator_address, 1);
1472 xfree(originator_address);
1473 xfree(listen_address);
1478 client_request_x11(const char *request_type, int rchan)
1482 int originator_port;
1485 if (!options.forward_x11) {
1486 error("Warning: ssh server tried X11 forwarding.");
1487 error("Warning: this is probably a break in attempt by a malicious server.");
1490 originator = packet_get_string(NULL);
1491 if (datafellows & SSH_BUG_X11FWD) {
1492 debug2("buggy server: x11 request w/o originator_port");
1493 originator_port = 0;
1495 originator_port = packet_get_int();
1498 /* XXX check permission */
1499 debug("client_request_x11: request from %s %d", originator,
1502 sock = x11_connect_display();
1505 c = channel_new("x11",
1506 SSH_CHANNEL_X11_OPEN, sock, sock, -1,
1507 CHAN_TCP_WINDOW_DEFAULT, CHAN_X11_PACKET_DEFAULT, 0, "x11", 1);
1513 client_request_agent(const char *request_type, int rchan)
1518 if (!options.forward_agent) {
1519 error("Warning: ssh server tried agent forwarding.");
1520 error("Warning: this is probably a break in attempt by a malicious server.");
1523 sock = ssh_get_authentication_socket();
1526 c = channel_new("authentication agent connection",
1527 SSH_CHANNEL_OPEN, sock, sock, -1,
1528 CHAN_X11_WINDOW_DEFAULT, CHAN_TCP_WINDOW_DEFAULT, 0,
1529 "authentication agent connection", 1);
1534 /* XXXX move to generic input handler */
1536 client_input_channel_open(int type, u_int32_t seq, void *ctxt)
1541 u_int rmaxpack, rwindow, len;
1543 ctype = packet_get_string(&len);
1544 rchan = packet_get_int();
1545 rwindow = packet_get_int();
1546 rmaxpack = packet_get_int();
1548 debug("client_input_channel_open: ctype %s rchan %d win %d max %d",
1549 ctype, rchan, rwindow, rmaxpack);
1551 if (strcmp(ctype, "forwarded-tcpip") == 0) {
1552 c = client_request_forwarded_tcpip(ctype, rchan);
1553 } else if (strcmp(ctype, "x11") == 0) {
1554 c = client_request_x11(ctype, rchan);
1555 } else if (strcmp(ctype, "auth-agent@openssh.com") == 0) {
1556 c = client_request_agent(ctype, rchan);
1558 /* XXX duplicate : */
1560 debug("confirm %s", ctype);
1561 c->remote_id = rchan;
1562 c->remote_window = rwindow;
1563 c->remote_maxpacket = rmaxpack;
1564 if (c->type != SSH_CHANNEL_CONNECTING) {
1565 packet_start(SSH2_MSG_CHANNEL_OPEN_CONFIRMATION);
1566 packet_put_int(c->remote_id);
1567 packet_put_int(c->self);
1568 packet_put_int(c->local_window);
1569 packet_put_int(c->local_maxpacket);
1573 debug("failure %s", ctype);
1574 packet_start(SSH2_MSG_CHANNEL_OPEN_FAILURE);
1575 packet_put_int(rchan);
1576 packet_put_int(SSH2_OPEN_ADMINISTRATIVELY_PROHIBITED);
1577 if (!(datafellows & SSH_BUG_OPENFAILURE)) {
1578 packet_put_cstring("open failed");
1579 packet_put_cstring("");
1586 client_input_channel_req(int type, u_int32_t seq, void *ctxt)
1589 int exitval, id, reply, success = 0;
1592 id = packet_get_int();
1593 rtype = packet_get_string(NULL);
1594 reply = packet_get_char();
1596 debug("client_input_channel_req: channel %d rtype %s reply %d",
1599 c = channel_lookup(id);
1601 error("client_input_channel_req: channel %d: unknown channel", id);
1602 } else if (strcmp(rtype, "exit-status") == 0) {
1603 exitval = packet_get_int();
1604 if (id == session_ident) {
1606 exit_status = exitval;
1607 } else if (c->ctl_fd == -1) {
1608 error("client_input_channel_req: unexpected channel %d",
1611 atomicio(vwrite, c->ctl_fd, &exitval, sizeof(exitval));
1617 packet_start(success ?
1618 SSH2_MSG_CHANNEL_SUCCESS : SSH2_MSG_CHANNEL_FAILURE);
1619 packet_put_int(c->remote_id);
1625 client_input_global_request(int type, u_int32_t seq, void *ctxt)
1631 rtype = packet_get_string(NULL);
1632 want_reply = packet_get_char();
1633 debug("client_input_global_request: rtype %s want_reply %d",
1636 packet_start(success ?
1637 SSH2_MSG_REQUEST_SUCCESS : SSH2_MSG_REQUEST_FAILURE);
1639 packet_write_wait();
1645 client_session2_setup(int id, int want_tty, int want_subsystem,
1646 const char *term, struct termios *tiop, int in_fd, Buffer *cmd, char **env,
1647 dispatch_fn *subsys_repl)
1651 debug2("%s: id %d", __func__, id);
1657 /* Store window size in the packet. */
1658 if (ioctl(in_fd, TIOCGWINSZ, &ws) < 0)
1659 memset(&ws, 0, sizeof(ws));
1661 channel_request_start(id, "pty-req", 0);
1662 packet_put_cstring(term != NULL ? term : "");
1663 packet_put_int(ws.ws_col);
1664 packet_put_int(ws.ws_row);
1665 packet_put_int(ws.ws_xpixel);
1666 packet_put_int(ws.ws_ypixel);
1667 tio = get_saved_tio();
1668 tty_make_modes(-1, tiop != NULL ? tiop : &tio);
1670 /* XXX wait for reply */
1673 /* Transfer any environment variables from client to server */
1674 if (options.num_send_env != 0 && env != NULL) {
1678 debug("Sending environment.");
1679 for (i = 0; env[i] != NULL; i++) {
1681 name = xstrdup(env[i]);
1682 if ((val = strchr(name, '=')) == NULL) {
1689 for (j = 0; j < options.num_send_env; j++) {
1690 if (match_pattern(name, options.send_env[j])) {
1696 debug3("Ignored env %s", name);
1701 debug("Sending env %s = %s", name, val);
1702 channel_request_start(id, "env", 0);
1703 packet_put_cstring(name);
1704 packet_put_cstring(val);
1710 len = buffer_len(cmd);
1714 if (want_subsystem) {
1715 debug("Sending subsystem: %.*s", len, (u_char*)buffer_ptr(cmd));
1716 channel_request_start(id, "subsystem", subsys_repl != NULL);
1717 if (subsys_repl != NULL) {
1718 /* register callback for reply */
1719 /* XXX we assume that client_loop has already been called */
1720 dispatch_set(SSH2_MSG_CHANNEL_FAILURE, subsys_repl);
1721 dispatch_set(SSH2_MSG_CHANNEL_SUCCESS, subsys_repl);
1724 debug("Sending command: %.*s", len, (u_char*)buffer_ptr(cmd));
1725 channel_request_start(id, "exec", 0);
1727 packet_put_string(buffer_ptr(cmd), buffer_len(cmd));
1730 channel_request_start(id, "shell", 0);
1736 client_init_dispatch_20(void)
1738 dispatch_init(&dispatch_protocol_error);
1740 dispatch_set(SSH2_MSG_CHANNEL_CLOSE, &channel_input_oclose);
1741 dispatch_set(SSH2_MSG_CHANNEL_DATA, &channel_input_data);
1742 dispatch_set(SSH2_MSG_CHANNEL_EOF, &channel_input_ieof);
1743 dispatch_set(SSH2_MSG_CHANNEL_EXTENDED_DATA, &channel_input_extended_data);
1744 dispatch_set(SSH2_MSG_CHANNEL_OPEN, &client_input_channel_open);
1745 dispatch_set(SSH2_MSG_CHANNEL_OPEN_CONFIRMATION, &channel_input_open_confirmation);
1746 dispatch_set(SSH2_MSG_CHANNEL_OPEN_FAILURE, &channel_input_open_failure);
1747 dispatch_set(SSH2_MSG_CHANNEL_REQUEST, &client_input_channel_req);
1748 dispatch_set(SSH2_MSG_CHANNEL_WINDOW_ADJUST, &channel_input_window_adjust);
1749 dispatch_set(SSH2_MSG_GLOBAL_REQUEST, &client_input_global_request);
1752 dispatch_set(SSH2_MSG_KEXINIT, &kex_input_kexinit);
1754 /* global request reply messages */
1755 dispatch_set(SSH2_MSG_REQUEST_FAILURE, &client_global_request_reply);
1756 dispatch_set(SSH2_MSG_REQUEST_SUCCESS, &client_global_request_reply);
1759 client_init_dispatch_13(void)
1761 dispatch_init(NULL);
1762 dispatch_set(SSH_MSG_CHANNEL_CLOSE, &channel_input_close);
1763 dispatch_set(SSH_MSG_CHANNEL_CLOSE_CONFIRMATION, &channel_input_close_confirmation);
1764 dispatch_set(SSH_MSG_CHANNEL_DATA, &channel_input_data);
1765 dispatch_set(SSH_MSG_CHANNEL_OPEN_CONFIRMATION, &channel_input_open_confirmation);
1766 dispatch_set(SSH_MSG_CHANNEL_OPEN_FAILURE, &channel_input_open_failure);
1767 dispatch_set(SSH_MSG_PORT_OPEN, &channel_input_port_open);
1768 dispatch_set(SSH_SMSG_EXITSTATUS, &client_input_exit_status);
1769 dispatch_set(SSH_SMSG_STDERR_DATA, &client_input_stderr_data);
1770 dispatch_set(SSH_SMSG_STDOUT_DATA, &client_input_stdout_data);
1772 dispatch_set(SSH_SMSG_AGENT_OPEN, options.forward_agent ?
1773 &client_input_agent_open : &deny_input_open);
1774 dispatch_set(SSH_SMSG_X11_OPEN, options.forward_x11 ?
1775 &x11_input_open : &deny_input_open);
1778 client_init_dispatch_15(void)
1780 client_init_dispatch_13();
1781 dispatch_set(SSH_MSG_CHANNEL_CLOSE, &channel_input_ieof);
1782 dispatch_set(SSH_MSG_CHANNEL_CLOSE_CONFIRMATION, & channel_input_oclose);
1785 client_init_dispatch(void)
1788 client_init_dispatch_20();
1790 client_init_dispatch_13();
1792 client_init_dispatch_15();
1795 /* client specific fatal cleanup */
1800 leave_non_blocking();
1801 if (options.control_path != NULL && control_fd != -1)
1802 unlink(options.control_path);