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.124 2004/06/14 01:44:38 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;
151 void ssh_process_session2_setup(int, int, int, Buffer *);
153 /* Restores stdin to blocking mode. */
156 leave_non_blocking(void)
158 if (in_non_blocking_mode) {
159 (void) fcntl(fileno(stdin), F_SETFL, 0);
160 in_non_blocking_mode = 0;
164 /* Puts stdin terminal in non-blocking mode. */
167 enter_non_blocking(void)
169 in_non_blocking_mode = 1;
170 set_nonblock(fileno(stdin));
174 * Signal handler for the window change signal (SIGWINCH). This just sets a
175 * flag indicating that the window has changed.
179 window_change_handler(int sig)
181 received_window_change_signal = 1;
182 signal(SIGWINCH, window_change_handler);
186 * Signal handler for signals that cause the program to terminate. These
187 * signals must be trapped to restore terminal modes.
191 signal_handler(int sig)
193 received_signal = sig;
198 * Returns current time in seconds from Jan 1, 1970 with the maximum
199 * available resolution.
203 get_current_time(void)
206 gettimeofday(&tv, NULL);
207 return (double) tv.tv_sec + (double) tv.tv_usec / 1000000.0;
211 * This is called when the interactive is entered. This checks if there is
212 * an EOF coming on stdin. We must check this explicitly, as select() does
213 * not appear to wake up when redirecting from /dev/null.
217 client_check_initial_eof_on_stdin(void)
223 * If standard input is to be "redirected from /dev/null", we simply
224 * mark that we have seen an EOF and send an EOF message to the
225 * server. Otherwise, we try to read a single character; it appears
226 * that for some files, such /dev/null, select() never wakes up for
227 * read for this descriptor, which means that we never get EOF. This
228 * way we will get the EOF if stdin comes from /dev/null or similar.
230 if (stdin_null_flag) {
231 /* Fake EOF on stdin. */
232 debug("Sending eof.");
234 packet_start(SSH_CMSG_EOF);
237 enter_non_blocking();
239 /* Check for immediate EOF on stdin. */
240 len = read(fileno(stdin), buf, 1);
242 /* EOF. Record that we have seen it and send EOF to server. */
243 debug("Sending eof.");
245 packet_start(SSH_CMSG_EOF);
247 } else if (len > 0) {
249 * Got data. We must store the data in the buffer,
250 * and also process it as an escape character if
253 if ((u_char) buf[0] == escape_char)
256 buffer_append(&stdin_buffer, buf, 1);
258 leave_non_blocking();
264 * Make packets from buffered stdin data, and buffer them for sending to the
269 client_make_packets_from_stdin_data(void)
273 /* Send buffered stdin data to the server. */
274 while (buffer_len(&stdin_buffer) > 0 &&
275 packet_not_very_much_data_to_write()) {
276 len = buffer_len(&stdin_buffer);
277 /* Keep the packets at reasonable size. */
278 if (len > packet_get_maxsize())
279 len = packet_get_maxsize();
280 packet_start(SSH_CMSG_STDIN_DATA);
281 packet_put_string(buffer_ptr(&stdin_buffer), len);
283 buffer_consume(&stdin_buffer, len);
285 /* If we have a pending EOF, send it now. */
286 if (stdin_eof && buffer_len(&stdin_buffer) == 0) {
287 packet_start(SSH_CMSG_EOF);
294 * Checks if the client window has changed, and sends a packet about it to
295 * the server if so. The actual change is detected elsewhere (by a software
296 * interrupt on Unix); this just checks the flag and sends a message if
301 client_check_window_change(void)
305 if (! received_window_change_signal)
308 received_window_change_signal = 0;
310 debug2("client_check_window_change: changed");
313 channel_send_window_changes();
315 if (ioctl(fileno(stdin), TIOCGWINSZ, &ws) < 0)
317 packet_start(SSH_CMSG_WINDOW_SIZE);
318 packet_put_int(ws.ws_row);
319 packet_put_int(ws.ws_col);
320 packet_put_int(ws.ws_xpixel);
321 packet_put_int(ws.ws_ypixel);
327 client_global_request_reply(int type, u_int32_t seq, void *ctxt)
329 server_alive_timeouts = 0;
330 client_global_request_reply_fwd(type, seq, ctxt);
334 server_alive_check(void)
336 if (++server_alive_timeouts > options.server_alive_count_max)
337 packet_disconnect("Timeout, server not responding.");
338 packet_start(SSH2_MSG_GLOBAL_REQUEST);
339 packet_put_cstring("keepalive@openssh.com");
340 packet_put_char(1); /* boolean: want reply */
345 * Waits until the client can do something (some data becomes available on
346 * one of the file descriptors).
349 client_wait_until_can_do_something(fd_set **readsetp, fd_set **writesetp,
350 int *maxfdp, int *nallocp, int rekeying)
352 struct timeval tv, *tvp;
355 /* Add any selections by the channel mechanism. */
356 channel_prepare_select(readsetp, writesetp, maxfdp, nallocp, rekeying);
359 /* Read from the connection, unless our buffers are full. */
360 if (buffer_len(&stdout_buffer) < buffer_high &&
361 buffer_len(&stderr_buffer) < buffer_high &&
362 channel_not_very_much_buffered_data())
363 FD_SET(connection_in, *readsetp);
365 * Read from stdin, unless we have seen EOF or have very much
366 * buffered data to send to the server.
368 if (!stdin_eof && packet_not_very_much_data_to_write())
369 FD_SET(fileno(stdin), *readsetp);
371 /* Select stdout/stderr if have data in buffer. */
372 if (buffer_len(&stdout_buffer) > 0)
373 FD_SET(fileno(stdout), *writesetp);
374 if (buffer_len(&stderr_buffer) > 0)
375 FD_SET(fileno(stderr), *writesetp);
377 /* channel_prepare_select could have closed the last channel */
378 if (session_closed && !channel_still_open() &&
379 !packet_have_data_to_write()) {
380 /* clear mask since we did not call select() */
381 memset(*readsetp, 0, *nallocp);
382 memset(*writesetp, 0, *nallocp);
385 FD_SET(connection_in, *readsetp);
389 /* Select server connection if have data to write to the server. */
390 if (packet_have_data_to_write())
391 FD_SET(connection_out, *writesetp);
393 if (control_fd != -1)
394 FD_SET(control_fd, *readsetp);
397 * Wait for something to happen. This will suspend the process until
398 * some selected descriptor can be read, written, or has some other
402 if (options.server_alive_interval == 0 || !compat20)
405 tv.tv_sec = options.server_alive_interval;
409 ret = select((*maxfdp)+1, *readsetp, *writesetp, NULL, tvp);
414 * We have to clear the select masks, because we return.
415 * We have to return, because the mainloop checks for the flags
416 * set by the signal handlers.
418 memset(*readsetp, 0, *nallocp);
419 memset(*writesetp, 0, *nallocp);
423 /* Note: we might still have data in the buffers. */
424 snprintf(buf, sizeof buf, "select: %s\r\n", strerror(errno));
425 buffer_append(&stderr_buffer, buf, strlen(buf));
428 server_alive_check();
432 client_suspend_self(Buffer *bin, Buffer *bout, Buffer *berr)
434 struct winsize oldws, newws;
436 /* Flush stdout and stderr buffers. */
437 if (buffer_len(bout) > 0)
438 atomicio(vwrite, fileno(stdout), buffer_ptr(bout), buffer_len(bout));
439 if (buffer_len(berr) > 0)
440 atomicio(vwrite, fileno(stderr), buffer_ptr(berr), buffer_len(berr));
445 * Free (and clear) the buffer to reduce the amount of data that gets
452 /* Save old window size. */
453 ioctl(fileno(stdin), TIOCGWINSZ, &oldws);
455 /* Send the suspend signal to the program itself. */
456 kill(getpid(), SIGTSTP);
458 /* Check if the window size has changed. */
459 if (ioctl(fileno(stdin), TIOCGWINSZ, &newws) >= 0 &&
460 (oldws.ws_row != newws.ws_row ||
461 oldws.ws_col != newws.ws_col ||
462 oldws.ws_xpixel != newws.ws_xpixel ||
463 oldws.ws_ypixel != newws.ws_ypixel))
464 received_window_change_signal = 1;
466 /* OK, we have been continued by the user. Reinitialize buffers. */
475 client_process_net_input(fd_set * readset)
481 * Read input from the server, and add any such data to the buffer of
482 * the packet subsystem.
484 if (FD_ISSET(connection_in, readset)) {
485 /* Read as much as possible. */
486 len = read(connection_in, buf, sizeof(buf));
488 /* Received EOF. The remote host has closed the connection. */
489 snprintf(buf, sizeof buf, "Connection to %.300s closed by remote host.\r\n",
491 buffer_append(&stderr_buffer, buf, strlen(buf));
496 * There is a kernel bug on Solaris that causes select to
497 * sometimes wake up even though there is no data available.
499 if (len < 0 && (errno == EAGAIN || errno == EINTR))
503 /* An error has encountered. Perhaps there is a network problem. */
504 snprintf(buf, sizeof buf, "Read from remote host %.300s: %.100s\r\n",
505 host, strerror(errno));
506 buffer_append(&stderr_buffer, buf, strlen(buf));
510 packet_process_incoming(buf, len);
515 client_subsystem_reply(int type, u_int32_t seq, void *ctxt)
520 id = packet_get_int();
523 if ((c = channel_lookup(id)) == NULL) {
524 error("%s: no channel for id %d", __func__, id);
528 if (type == SSH2_MSG_CHANNEL_SUCCESS)
529 debug2("Request suceeded on channel %d", id);
530 else if (type == SSH2_MSG_CHANNEL_FAILURE) {
531 error("Request failed on channel %d", id);
537 client_extra_session2_setup(int id, void *arg)
539 struct confirm_ctx *cctx = arg;
543 fatal("%s: cctx == NULL", __func__);
544 if ((c = channel_lookup(id)) == NULL)
545 fatal("%s: no channel for id %d", __func__, id);
547 client_session2_setup(id, cctx->want_tty, cctx->want_subsys,
548 cctx->term, &cctx->tio, c->rfd, &cctx->cmd,
549 client_subsystem_reply);
551 c->confirm_ctx = NULL;
552 buffer_free(&cctx->cmd);
558 client_process_control(fd_set * readset)
562 int client_fd, new_fd[3], ver;
564 struct sockaddr_storage addr;
565 struct confirm_ctx *cctx;
572 * Accept connection on control socket
574 if (control_fd == -1 || !FD_ISSET(control_fd, readset))
577 memset(&addr, 0, sizeof(addr));
578 addrlen = sizeof(addr);
579 if ((client_fd = accept(control_fd,
580 (struct sockaddr*)&addr, &addrlen)) == -1) {
581 error("%s accept: %s", __func__, strerror(errno));
585 if (getpeereid(client_fd, &euid, &egid) < 0) {
586 error("%s getpeereid failed: %s", __func__, strerror(errno));
590 if ((euid != 0) && (getuid() != euid)) {
591 error("control mode uid mismatch: peer euid %u != uid %u",
592 (u_int) euid, (u_int) getuid());
596 /* XXX: implement use of ssh-askpass to confirm additional channels */
598 unset_nonblock(client_fd);
602 buffer_put_int(&m, getpid());
603 if (ssh_msg_send(client_fd, /* version */0, &m) == -1) {
604 error("%s: client msg_send failed", __func__);
610 if (ssh_msg_recv(client_fd, &m) == -1) {
611 error("%s: client msg_recv failed", __func__);
616 if ((ver = buffer_get_char(&m)) != 0) {
617 error("%s: wrong client version %d", __func__, ver);
623 cctx = xmalloc(sizeof(*cctx));
624 memset(cctx, 0, sizeof(*cctx));
626 cctx->want_tty = buffer_get_int(&m);
627 cctx->want_subsys = buffer_get_int(&m);
628 cctx->term = buffer_get_string(&m, &len);
630 cmd = buffer_get_string(&m, &len);
631 buffer_init(&cctx->cmd);
632 buffer_append(&cctx->cmd, cmd, strlen(cmd));
634 debug2("%s: accepted tty %d, subsys %d, cmd %s", __func__,
635 cctx->want_tty, cctx->want_subsys, cmd);
637 /* Gather fds from client */
638 new_fd[0] = mm_receive_fd(client_fd);
639 new_fd[1] = mm_receive_fd(client_fd);
640 new_fd[2] = mm_receive_fd(client_fd);
642 debug2("%s: got fds stdin %d, stdout %d, stderr %d", __func__,
643 new_fd[0], new_fd[1], new_fd[2]);
645 /* Try to pick up ttymodes from client before it goes raw */
646 if (cctx->want_tty && tcgetattr(new_fd[0], &cctx->tio) == -1)
647 error("%s: tcgetattr: %s", __func__, strerror(errno));
650 if (ssh_msg_send(client_fd, /* version */0, &m) == -1) {
651 error("%s: client msg_send failed", __func__);
660 /* enable nonblocking unless tty */
661 if (!isatty(new_fd[0]))
662 set_nonblock(new_fd[0]);
663 if (!isatty(new_fd[1]))
664 set_nonblock(new_fd[1]);
665 if (!isatty(new_fd[2]))
666 set_nonblock(new_fd[2]);
668 set_nonblock(client_fd);
670 c = channel_new("session", SSH_CHANNEL_OPENING,
671 new_fd[0], new_fd[1], new_fd[2],
672 CHAN_SES_WINDOW_DEFAULT, CHAN_SES_PACKET_DEFAULT,
673 CHAN_EXTENDED_WRITE, "client-session", /*nonblock*/0);
676 c->ctl_fd = client_fd;
678 debug3("%s: channel_new: %d", __func__, c->self);
680 channel_send_open(c->self);
681 channel_register_confirm(c->self, client_extra_session2_setup, cctx);
685 process_cmdline(void)
687 void (*handler)(int);
689 u_short fwd_port, fwd_host_port;
690 char buf[1024], sfwd_port[6], sfwd_host_port[6];
695 handler = signal(SIGINT, SIG_IGN);
696 cmd = s = read_passphrase("\r\nssh> ", RP_ECHO);
699 while (*s && isspace(*s))
702 s++; /* Skip cmdline '-', if any */
706 if (*s == 'h' || *s == 'H' || *s == '?') {
708 logit(" -Lport:host:hostport Request local forward");
709 logit(" -Rport:host:hostport Request remote forward");
710 logit(" -KRhostport Cancel remote forward");
718 if (*s != 'L' && *s != 'R') {
719 logit("Invalid command.");
724 if (local && delete) {
725 logit("Not supported.");
728 if ((!local || delete) && !compat20) {
729 logit("Not supported for SSH protocol version 1.");
734 while (*s && isspace(*s))
738 if (sscanf(s, "%5[0-9]", sfwd_host_port) != 1) {
739 logit("Bad forwarding specification.");
742 if ((fwd_host_port = a2port(sfwd_host_port)) == 0) {
743 logit("Bad forwarding port(s).");
746 channel_request_rforward_cancel(fwd_host_port);
748 if (sscanf(s, "%5[0-9]:%255[^:]:%5[0-9]",
749 sfwd_port, buf, sfwd_host_port) != 3 &&
750 sscanf(s, "%5[0-9]/%255[^/]/%5[0-9]",
751 sfwd_port, buf, sfwd_host_port) != 3) {
752 logit("Bad forwarding specification.");
755 if ((fwd_port = a2port(sfwd_port)) == 0 ||
756 (fwd_host_port = a2port(sfwd_host_port)) == 0) {
757 logit("Bad forwarding port(s).");
761 if (channel_setup_local_fwd_listener(fwd_port, buf,
762 fwd_host_port, options.gateway_ports) < 0) {
763 logit("Port forwarding failed.");
767 channel_request_remote_forwarding(fwd_port, buf,
769 logit("Forwarding port.");
773 signal(SIGINT, handler);
779 /* process the characters one by one */
781 process_escapes(Buffer *bin, Buffer *bout, Buffer *berr, char *buf, int len)
790 for (i = 0; i < len; i++) {
791 /* Get one character at a time. */
794 if (escape_pending) {
795 /* We have previously seen an escape character. */
796 /* Clear the flag now. */
799 /* Process the escaped character. */
802 /* Terminate the connection. */
803 snprintf(string, sizeof string, "%c.\r\n", escape_char);
804 buffer_append(berr, string, strlen(string));
810 /* Suspend the program. */
811 /* Print a message to that effect to the user. */
812 snprintf(string, sizeof string, "%c^Z [suspend ssh]\r\n", escape_char);
813 buffer_append(berr, string, strlen(string));
815 /* Restore terminal modes and suspend. */
816 client_suspend_self(bin, bout, berr);
818 /* We have been continued. */
823 snprintf(string, sizeof string,
824 "%cB\r\n", escape_char);
825 buffer_append(berr, string,
827 channel_request_start(session_ident,
829 packet_put_int(1000);
836 if (datafellows & SSH_BUG_NOREKEY)
837 logit("Server does not support re-keying");
845 * Detach the program (continue to serve connections,
846 * but put in background and no more new connections).
848 /* Restore tty modes. */
851 /* Stop listening for new connections. */
852 channel_stop_listening();
854 snprintf(string, sizeof string,
855 "%c& [backgrounded]\n", escape_char);
856 buffer_append(berr, string, strlen(string));
858 /* Fork into background. */
861 error("fork: %.100s", strerror(errno));
864 if (pid != 0) { /* This is the parent. */
865 /* The parent just exits. */
868 /* The child continues serving connections. */
870 buffer_append(bin, "\004", 1);
871 /* fake EOF on stdin */
873 } else if (!stdin_eof) {
875 * Sending SSH_CMSG_EOF alone does not always appear
876 * to be enough. So we try to send an EOF character
879 packet_start(SSH_CMSG_STDIN_DATA);
880 packet_put_string("\004", 1);
884 if (buffer_len(bin) == 0) {
885 packet_start(SSH_CMSG_EOF);
892 snprintf(string, sizeof string,
894 Supported escape sequences:\r\n\
895 %c. - terminate connection\r\n\
896 %cB - send a BREAK to the remote system\r\n\
897 %cC - open a command line\r\n\
898 %cR - Request rekey (SSH protocol 2 only)\r\n\
899 %c^Z - suspend ssh\r\n\
900 %c# - list forwarded connections\r\n\
901 %c& - background ssh (when waiting for connections to terminate)\r\n\
902 %c? - this message\r\n\
903 %c%c - send the escape character by typing it twice\r\n\
904 (Note that escapes are only recognized immediately after newline.)\r\n",
905 escape_char, escape_char, escape_char, escape_char,
906 escape_char, escape_char, escape_char, escape_char,
907 escape_char, escape_char, escape_char);
908 buffer_append(berr, string, strlen(string));
912 snprintf(string, sizeof string, "%c#\r\n", escape_char);
913 buffer_append(berr, string, strlen(string));
914 s = channel_open_message();
915 buffer_append(berr, s, strlen(s));
924 if (ch != escape_char) {
925 buffer_put_char(bin, escape_char);
928 /* Escaped characters fall through here */
933 * The previous character was not an escape char. Check if this
936 if (last_was_cr && ch == escape_char) {
937 /* It is. Set the flag and continue to next character. */
944 * Normal character. Record whether it was a newline,
945 * and append it to the buffer.
947 last_was_cr = (ch == '\r' || ch == '\n');
948 buffer_put_char(bin, ch);
955 client_process_input(fd_set * readset)
960 /* Read input from stdin. */
961 if (FD_ISSET(fileno(stdin), readset)) {
962 /* Read as much as possible. */
963 len = read(fileno(stdin), buf, sizeof(buf));
964 if (len < 0 && (errno == EAGAIN || errno == EINTR))
965 return; /* we'll try again later */
968 * Received EOF or error. They are treated
969 * similarly, except that an error message is printed
970 * if it was an error condition.
973 snprintf(buf, sizeof buf, "read: %.100s\r\n", strerror(errno));
974 buffer_append(&stderr_buffer, buf, strlen(buf));
976 /* Mark that we have seen EOF. */
979 * Send an EOF message to the server unless there is
980 * data in the buffer. If there is data in the
981 * buffer, no message will be sent now. Code
982 * elsewhere will send the EOF when the buffer
983 * becomes empty if stdin_eof is set.
985 if (buffer_len(&stdin_buffer) == 0) {
986 packet_start(SSH_CMSG_EOF);
989 } else if (escape_char == SSH_ESCAPECHAR_NONE) {
991 * Normal successful read, and no escape character.
992 * Just append the data to buffer.
994 buffer_append(&stdin_buffer, buf, len);
997 * Normal, successful read. But we have an escape character
998 * and have to process the characters one by one.
1000 if (process_escapes(&stdin_buffer, &stdout_buffer,
1001 &stderr_buffer, buf, len) == -1)
1008 client_process_output(fd_set * writeset)
1013 /* Write buffered output to stdout. */
1014 if (FD_ISSET(fileno(stdout), writeset)) {
1015 /* Write as much data as possible. */
1016 len = write(fileno(stdout), buffer_ptr(&stdout_buffer),
1017 buffer_len(&stdout_buffer));
1019 if (errno == EINTR || errno == EAGAIN)
1023 * An error or EOF was encountered. Put an
1024 * error message to stderr buffer.
1026 snprintf(buf, sizeof buf, "write stdout: %.50s\r\n", strerror(errno));
1027 buffer_append(&stderr_buffer, buf, strlen(buf));
1032 /* Consume printed data from the buffer. */
1033 buffer_consume(&stdout_buffer, len);
1034 stdout_bytes += len;
1036 /* Write buffered output to stderr. */
1037 if (FD_ISSET(fileno(stderr), writeset)) {
1038 /* Write as much data as possible. */
1039 len = write(fileno(stderr), buffer_ptr(&stderr_buffer),
1040 buffer_len(&stderr_buffer));
1042 if (errno == EINTR || errno == EAGAIN)
1045 /* EOF or error, but can't even print error message. */
1050 /* Consume printed characters from the buffer. */
1051 buffer_consume(&stderr_buffer, len);
1052 stderr_bytes += len;
1057 * Get packets from the connection input buffer, and process them as long as
1058 * there are packets available.
1060 * Any unknown packets received during the actual
1061 * session cause the session to terminate. This is
1062 * intended to make debugging easier since no
1063 * confirmations are sent. Any compatible protocol
1064 * extensions must be negotiated during the
1065 * preparatory phase.
1069 client_process_buffered_input_packets(void)
1071 dispatch_run(DISPATCH_NONBLOCK, &quit_pending, compat20 ? xxx_kex : NULL);
1074 /* scan buf[] for '~' before sending data to the peer */
1077 simple_escape_filter(Channel *c, char *buf, int len)
1079 /* XXX we assume c->extended is writeable */
1080 return process_escapes(&c->input, &c->output, &c->extended, buf, len);
1084 client_channel_closed(int id, void *arg)
1086 channel_cancel_cleanup(id);
1092 * Implements the interactive session with the server. This is called after
1093 * the user has been authenticated, and a command has been started on the
1094 * remote host. If escape_char != SSH_ESCAPECHAR_NONE, it is the character
1095 * used as an escape character for terminating or suspending the session.
1099 client_loop(int have_pty, int escape_char_arg, int ssh2_chan_id)
1101 fd_set *readset = NULL, *writeset = NULL;
1102 double start_time, total_time;
1103 int max_fd = 0, max_fd2 = 0, len, rekeying = 0, nalloc = 0;
1106 debug("Entering interactive session.");
1108 start_time = get_current_time();
1110 /* Initialize variables. */
1115 buffer_high = 64 * 1024;
1116 connection_in = packet_get_connection_in();
1117 connection_out = packet_get_connection_out();
1118 max_fd = MAX(connection_in, connection_out);
1119 if (control_fd != -1)
1120 max_fd = MAX(max_fd, control_fd);
1123 /* enable nonblocking unless tty */
1124 if (!isatty(fileno(stdin)))
1125 set_nonblock(fileno(stdin));
1126 if (!isatty(fileno(stdout)))
1127 set_nonblock(fileno(stdout));
1128 if (!isatty(fileno(stderr)))
1129 set_nonblock(fileno(stderr));
1130 max_fd = MAX(max_fd, fileno(stdin));
1131 max_fd = MAX(max_fd, fileno(stdout));
1132 max_fd = MAX(max_fd, fileno(stderr));
1138 escape_char = escape_char_arg;
1140 /* Initialize buffers. */
1141 buffer_init(&stdin_buffer);
1142 buffer_init(&stdout_buffer);
1143 buffer_init(&stderr_buffer);
1145 client_init_dispatch();
1148 * Set signal handlers, (e.g. to restore non-blocking mode)
1149 * but don't overwrite SIG_IGN, matches behaviour from rsh(1)
1151 if (signal(SIGINT, SIG_IGN) != SIG_IGN)
1152 signal(SIGINT, signal_handler);
1153 if (signal(SIGQUIT, SIG_IGN) != SIG_IGN)
1154 signal(SIGQUIT, signal_handler);
1155 if (signal(SIGTERM, SIG_IGN) != SIG_IGN)
1156 signal(SIGTERM, signal_handler);
1158 signal(SIGWINCH, window_change_handler);
1164 session_ident = ssh2_chan_id;
1165 if (escape_char != SSH_ESCAPECHAR_NONE)
1166 channel_register_filter(session_ident,
1167 simple_escape_filter);
1168 if (session_ident != -1)
1169 channel_register_cleanup(session_ident,
1170 client_channel_closed);
1172 /* Check if we should immediately send eof on stdin. */
1173 client_check_initial_eof_on_stdin();
1176 /* Main loop of the client for the interactive session mode. */
1177 while (!quit_pending) {
1179 /* Process buffered packets sent by the server. */
1180 client_process_buffered_input_packets();
1182 if (compat20 && session_closed && !channel_still_open())
1185 rekeying = (xxx_kex != NULL && !xxx_kex->done);
1188 debug("rekeying in progress");
1191 * Make packets of buffered stdin data, and buffer
1192 * them for sending to the server.
1195 client_make_packets_from_stdin_data();
1198 * Make packets from buffered channel data, and
1199 * enqueue them for sending to the server.
1201 if (packet_not_very_much_data_to_write())
1202 channel_output_poll();
1205 * Check if the window size has changed, and buffer a
1206 * message about it to the server if so.
1208 client_check_window_change();
1214 * Wait until we have something to do (something becomes
1215 * available on one of the descriptors).
1218 client_wait_until_can_do_something(&readset, &writeset,
1219 &max_fd2, &nalloc, rekeying);
1224 /* Do channel operations unless rekeying in progress. */
1226 channel_after_select(readset, writeset);
1227 if (need_rekeying || packet_need_rekeying()) {
1228 debug("need rekeying");
1230 kex_send_kexinit(xxx_kex);
1235 /* Buffer input from the connection. */
1236 client_process_net_input(readset);
1238 /* Accept control connections. */
1239 client_process_control(readset);
1245 /* Buffer data from stdin */
1246 client_process_input(readset);
1248 * Process output to stdout and stderr. Output to
1249 * the connection is processed elsewhere (above).
1251 client_process_output(writeset);
1254 /* Send as much buffered packet data as possible to the sender. */
1255 if (FD_ISSET(connection_out, writeset))
1256 packet_write_poll();
1263 /* Terminate the session. */
1265 /* Stop watching for window change. */
1267 signal(SIGWINCH, SIG_DFL);
1274 /* restore blocking io */
1275 if (!isatty(fileno(stdin)))
1276 unset_nonblock(fileno(stdin));
1277 if (!isatty(fileno(stdout)))
1278 unset_nonblock(fileno(stdout));
1279 if (!isatty(fileno(stderr)))
1280 unset_nonblock(fileno(stderr));
1283 * If there was no shell or command requested, there will be no remote
1284 * exit status to be returned. In that case, clear error code if the
1285 * connection was deliberately terminated at this end.
1287 if (no_shell_flag && received_signal == SIGTERM) {
1288 received_signal = 0;
1292 if (received_signal)
1293 fatal("Killed by signal %d.", (int) received_signal);
1296 * In interactive mode (with pseudo tty) display a message indicating
1297 * that the connection has been closed.
1299 if (have_pty && options.log_level != SYSLOG_LEVEL_QUIET) {
1300 snprintf(buf, sizeof buf, "Connection to %.64s closed.\r\n", host);
1301 buffer_append(&stderr_buffer, buf, strlen(buf));
1304 /* Output any buffered data for stdout. */
1305 while (buffer_len(&stdout_buffer) > 0) {
1306 len = write(fileno(stdout), buffer_ptr(&stdout_buffer),
1307 buffer_len(&stdout_buffer));
1309 error("Write failed flushing stdout buffer.");
1312 buffer_consume(&stdout_buffer, len);
1313 stdout_bytes += len;
1316 /* Output any buffered data for stderr. */
1317 while (buffer_len(&stderr_buffer) > 0) {
1318 len = write(fileno(stderr), buffer_ptr(&stderr_buffer),
1319 buffer_len(&stderr_buffer));
1321 error("Write failed flushing stderr buffer.");
1324 buffer_consume(&stderr_buffer, len);
1325 stderr_bytes += len;
1328 /* Clear and free any buffers. */
1329 memset(buf, 0, sizeof(buf));
1330 buffer_free(&stdin_buffer);
1331 buffer_free(&stdout_buffer);
1332 buffer_free(&stderr_buffer);
1334 /* Report bytes transferred, and transfer rates. */
1335 total_time = get_current_time() - start_time;
1336 debug("Transferred: stdin %lu, stdout %lu, stderr %lu bytes in %.1f seconds",
1337 stdin_bytes, stdout_bytes, stderr_bytes, total_time);
1339 debug("Bytes per second: stdin %.1f, stdout %.1f, stderr %.1f",
1340 stdin_bytes / total_time, stdout_bytes / total_time,
1341 stderr_bytes / total_time);
1343 /* Return the exit status of the program. */
1344 debug("Exit status %d", exit_status);
1351 client_input_stdout_data(int type, u_int32_t seq, void *ctxt)
1354 char *data = packet_get_string(&data_len);
1356 buffer_append(&stdout_buffer, data, data_len);
1357 memset(data, 0, data_len);
1361 client_input_stderr_data(int type, u_int32_t seq, void *ctxt)
1364 char *data = packet_get_string(&data_len);
1366 buffer_append(&stderr_buffer, data, data_len);
1367 memset(data, 0, data_len);
1371 client_input_exit_status(int type, u_int32_t seq, void *ctxt)
1373 exit_status = packet_get_int();
1375 /* Acknowledge the exit. */
1376 packet_start(SSH_CMSG_EXIT_CONFIRMATION);
1379 * Must wait for packet to be sent since we are
1382 packet_write_wait();
1383 /* Flag that we want to exit. */
1387 client_input_agent_open(int type, u_int32_t seq, void *ctxt)
1390 int remote_id, sock;
1392 /* Read the remote channel number from the message. */
1393 remote_id = packet_get_int();
1397 * Get a connection to the local authentication agent (this may again
1400 sock = ssh_get_authentication_socket();
1403 * If we could not connect the agent, send an error message back to
1404 * the server. This should never happen unless the agent dies,
1405 * because authentication forwarding is only enabled if we have an
1409 c = channel_new("", SSH_CHANNEL_OPEN, sock, sock,
1410 -1, 0, 0, 0, "authentication agent connection", 1);
1411 c->remote_id = remote_id;
1415 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
1416 packet_put_int(remote_id);
1418 /* Send a confirmation to the remote host. */
1419 debug("Forwarding authentication connection.");
1420 packet_start(SSH_MSG_CHANNEL_OPEN_CONFIRMATION);
1421 packet_put_int(remote_id);
1422 packet_put_int(c->self);
1428 client_request_forwarded_tcpip(const char *request_type, int rchan)
1431 char *listen_address, *originator_address;
1432 int listen_port, originator_port;
1435 /* Get rest of the packet */
1436 listen_address = packet_get_string(NULL);
1437 listen_port = packet_get_int();
1438 originator_address = packet_get_string(NULL);
1439 originator_port = packet_get_int();
1442 debug("client_request_forwarded_tcpip: listen %s port %d, originator %s port %d",
1443 listen_address, listen_port, originator_address, originator_port);
1445 sock = channel_connect_by_listen_address(listen_port);
1447 xfree(originator_address);
1448 xfree(listen_address);
1451 c = channel_new("forwarded-tcpip",
1452 SSH_CHANNEL_CONNECTING, sock, sock, -1,
1453 CHAN_TCP_WINDOW_DEFAULT, CHAN_TCP_WINDOW_DEFAULT, 0,
1454 originator_address, 1);
1455 xfree(originator_address);
1456 xfree(listen_address);
1461 client_request_x11(const char *request_type, int rchan)
1465 int originator_port;
1468 if (!options.forward_x11) {
1469 error("Warning: ssh server tried X11 forwarding.");
1470 error("Warning: this is probably a break in attempt by a malicious server.");
1473 originator = packet_get_string(NULL);
1474 if (datafellows & SSH_BUG_X11FWD) {
1475 debug2("buggy server: x11 request w/o originator_port");
1476 originator_port = 0;
1478 originator_port = packet_get_int();
1481 /* XXX check permission */
1482 debug("client_request_x11: request from %s %d", originator,
1485 sock = x11_connect_display();
1488 c = channel_new("x11",
1489 SSH_CHANNEL_X11_OPEN, sock, sock, -1,
1490 CHAN_TCP_WINDOW_DEFAULT, CHAN_X11_PACKET_DEFAULT, 0, "x11", 1);
1496 client_request_agent(const char *request_type, int rchan)
1501 if (!options.forward_agent) {
1502 error("Warning: ssh server tried agent forwarding.");
1503 error("Warning: this is probably a break in attempt by a malicious server.");
1506 sock = ssh_get_authentication_socket();
1509 c = channel_new("authentication agent connection",
1510 SSH_CHANNEL_OPEN, sock, sock, -1,
1511 CHAN_X11_WINDOW_DEFAULT, CHAN_TCP_WINDOW_DEFAULT, 0,
1512 "authentication agent connection", 1);
1517 /* XXXX move to generic input handler */
1519 client_input_channel_open(int type, u_int32_t seq, void *ctxt)
1524 u_int rmaxpack, rwindow, len;
1526 ctype = packet_get_string(&len);
1527 rchan = packet_get_int();
1528 rwindow = packet_get_int();
1529 rmaxpack = packet_get_int();
1531 debug("client_input_channel_open: ctype %s rchan %d win %d max %d",
1532 ctype, rchan, rwindow, rmaxpack);
1534 if (strcmp(ctype, "forwarded-tcpip") == 0) {
1535 c = client_request_forwarded_tcpip(ctype, rchan);
1536 } else if (strcmp(ctype, "x11") == 0) {
1537 c = client_request_x11(ctype, rchan);
1538 } else if (strcmp(ctype, "auth-agent@openssh.com") == 0) {
1539 c = client_request_agent(ctype, rchan);
1541 /* XXX duplicate : */
1543 debug("confirm %s", ctype);
1544 c->remote_id = rchan;
1545 c->remote_window = rwindow;
1546 c->remote_maxpacket = rmaxpack;
1547 if (c->type != SSH_CHANNEL_CONNECTING) {
1548 packet_start(SSH2_MSG_CHANNEL_OPEN_CONFIRMATION);
1549 packet_put_int(c->remote_id);
1550 packet_put_int(c->self);
1551 packet_put_int(c->local_window);
1552 packet_put_int(c->local_maxpacket);
1556 debug("failure %s", ctype);
1557 packet_start(SSH2_MSG_CHANNEL_OPEN_FAILURE);
1558 packet_put_int(rchan);
1559 packet_put_int(SSH2_OPEN_ADMINISTRATIVELY_PROHIBITED);
1560 if (!(datafellows & SSH_BUG_OPENFAILURE)) {
1561 packet_put_cstring("open failed");
1562 packet_put_cstring("");
1569 client_input_channel_req(int type, u_int32_t seq, void *ctxt)
1572 int exitval, id, reply, success = 0;
1575 id = packet_get_int();
1576 rtype = packet_get_string(NULL);
1577 reply = packet_get_char();
1579 debug("client_input_channel_req: channel %d rtype %s reply %d",
1582 c = channel_lookup(id);
1584 error("client_input_channel_req: channel %d: unknown channel", id);
1585 } else if (strcmp(rtype, "exit-status") == 0) {
1586 exitval = packet_get_int();
1587 if (id == session_ident) {
1589 exit_status = exitval;
1590 } else if (c->ctl_fd == -1) {
1591 error("client_input_channel_req: unexpected channel %d",
1594 atomicio(vwrite, c->ctl_fd, &exitval, sizeof(exitval));
1600 packet_start(success ?
1601 SSH2_MSG_CHANNEL_SUCCESS : SSH2_MSG_CHANNEL_FAILURE);
1602 packet_put_int(c->remote_id);
1608 client_input_global_request(int type, u_int32_t seq, void *ctxt)
1614 rtype = packet_get_string(NULL);
1615 want_reply = packet_get_char();
1616 debug("client_input_global_request: rtype %s want_reply %d",
1619 packet_start(success ?
1620 SSH2_MSG_REQUEST_SUCCESS : SSH2_MSG_REQUEST_FAILURE);
1622 packet_write_wait();
1628 client_session2_setup(int id, int want_tty, int want_subsystem,
1629 const char *term, struct termios *tiop, int in_fd, Buffer *cmd,
1630 dispatch_fn *subsys_repl)
1634 debug2("%s: id %d", __func__, id);
1640 /* Store window size in the packet. */
1641 if (ioctl(in_fd, TIOCGWINSZ, &ws) < 0)
1642 memset(&ws, 0, sizeof(ws));
1644 channel_request_start(id, "pty-req", 0);
1645 packet_put_cstring(term != NULL ? term : "");
1646 packet_put_int(ws.ws_col);
1647 packet_put_int(ws.ws_row);
1648 packet_put_int(ws.ws_xpixel);
1649 packet_put_int(ws.ws_ypixel);
1650 tio = get_saved_tio();
1651 tty_make_modes(-1, tiop != NULL ? tiop : &tio);
1653 /* XXX wait for reply */
1656 /* Transfer any environment variables from client to server */
1657 if (options.num_send_env != 0) {
1659 extern char **environ;
1662 debug("Sending environment.");
1663 for (i = 0; environ && environ[i] != NULL; i++) {
1665 name = xstrdup(environ[i]);
1666 if ((val = strchr(name, '=')) == NULL) {
1673 for (j = 0; j < options.num_send_env; j++) {
1674 if (match_pattern(name, options.send_env[j])) {
1680 debug3("Ignored env %s", name);
1685 debug("Sending env %s = %s", name, val);
1686 channel_request_start(id, "env", 0);
1687 packet_put_cstring(name);
1688 packet_put_cstring(val);
1694 len = buffer_len(cmd);
1698 if (want_subsystem) {
1699 debug("Sending subsystem: %.*s", len, (u_char*)buffer_ptr(cmd));
1700 channel_request_start(id, "subsystem", subsys_repl != NULL);
1701 if (subsys_repl != NULL) {
1702 /* register callback for reply */
1703 /* XXX we assume that client_loop has already been called */
1704 dispatch_set(SSH2_MSG_CHANNEL_FAILURE, subsys_repl);
1705 dispatch_set(SSH2_MSG_CHANNEL_SUCCESS, subsys_repl);
1708 debug("Sending command: %.*s", len, (u_char*)buffer_ptr(cmd));
1709 channel_request_start(id, "exec", 0);
1711 packet_put_string(buffer_ptr(cmd), buffer_len(cmd));
1714 channel_request_start(id, "shell", 0);
1720 client_init_dispatch_20(void)
1722 dispatch_init(&dispatch_protocol_error);
1724 dispatch_set(SSH2_MSG_CHANNEL_CLOSE, &channel_input_oclose);
1725 dispatch_set(SSH2_MSG_CHANNEL_DATA, &channel_input_data);
1726 dispatch_set(SSH2_MSG_CHANNEL_EOF, &channel_input_ieof);
1727 dispatch_set(SSH2_MSG_CHANNEL_EXTENDED_DATA, &channel_input_extended_data);
1728 dispatch_set(SSH2_MSG_CHANNEL_OPEN, &client_input_channel_open);
1729 dispatch_set(SSH2_MSG_CHANNEL_OPEN_CONFIRMATION, &channel_input_open_confirmation);
1730 dispatch_set(SSH2_MSG_CHANNEL_OPEN_FAILURE, &channel_input_open_failure);
1731 dispatch_set(SSH2_MSG_CHANNEL_REQUEST, &client_input_channel_req);
1732 dispatch_set(SSH2_MSG_CHANNEL_WINDOW_ADJUST, &channel_input_window_adjust);
1733 dispatch_set(SSH2_MSG_GLOBAL_REQUEST, &client_input_global_request);
1736 dispatch_set(SSH2_MSG_KEXINIT, &kex_input_kexinit);
1738 /* global request reply messages */
1739 dispatch_set(SSH2_MSG_REQUEST_FAILURE, &client_global_request_reply);
1740 dispatch_set(SSH2_MSG_REQUEST_SUCCESS, &client_global_request_reply);
1743 client_init_dispatch_13(void)
1745 dispatch_init(NULL);
1746 dispatch_set(SSH_MSG_CHANNEL_CLOSE, &channel_input_close);
1747 dispatch_set(SSH_MSG_CHANNEL_CLOSE_CONFIRMATION, &channel_input_close_confirmation);
1748 dispatch_set(SSH_MSG_CHANNEL_DATA, &channel_input_data);
1749 dispatch_set(SSH_MSG_CHANNEL_OPEN_CONFIRMATION, &channel_input_open_confirmation);
1750 dispatch_set(SSH_MSG_CHANNEL_OPEN_FAILURE, &channel_input_open_failure);
1751 dispatch_set(SSH_MSG_PORT_OPEN, &channel_input_port_open);
1752 dispatch_set(SSH_SMSG_EXITSTATUS, &client_input_exit_status);
1753 dispatch_set(SSH_SMSG_STDERR_DATA, &client_input_stderr_data);
1754 dispatch_set(SSH_SMSG_STDOUT_DATA, &client_input_stdout_data);
1756 dispatch_set(SSH_SMSG_AGENT_OPEN, options.forward_agent ?
1757 &client_input_agent_open : &deny_input_open);
1758 dispatch_set(SSH_SMSG_X11_OPEN, options.forward_x11 ?
1759 &x11_input_open : &deny_input_open);
1762 client_init_dispatch_15(void)
1764 client_init_dispatch_13();
1765 dispatch_set(SSH_MSG_CHANNEL_CLOSE, &channel_input_ieof);
1766 dispatch_set(SSH_MSG_CHANNEL_CLOSE_CONFIRMATION, & channel_input_oclose);
1769 client_init_dispatch(void)
1772 client_init_dispatch_20();
1774 client_init_dispatch_13();
1776 client_init_dispatch_15();
1779 /* client specific fatal cleanup */
1784 leave_non_blocking();
1785 if (options.control_path != NULL && control_fd != -1)
1786 unlink(options.control_path);