2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 * This file contains functions for generic socket connection forwarding.
6 * There is also code for initiating connection forwarding for X11 connections,
7 * arbitrary tcp/ip connections, and the authentication agent connection.
9 * As far as I am concerned, the code I have written for this software
10 * can be used freely for any purpose. Any derived versions of this
11 * software must be clearly marked as such, and if the derived work is
12 * incompatible with the protocol description in the RFC file, it must be
13 * called by a name other than "ssh" or "Secure Shell".
16 * SSH2 support added by Markus Friedl.
17 * Copyright (c) 1999,2000 Markus Friedl. All rights reserved.
18 * Copyright (c) 1999 Dug Song. All rights reserved.
19 * Copyright (c) 1999 Theo de Raadt. All rights reserved.
21 * Redistribution and use in source and binary forms, with or without
22 * modification, are permitted provided that the following conditions
24 * 1. Redistributions of source code must retain the above copyright
25 * notice, this list of conditions and the following disclaimer.
26 * 2. Redistributions in binary form must reproduce the above copyright
27 * notice, this list of conditions and the following disclaimer in the
28 * documentation and/or other materials provided with the distribution.
30 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
31 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
33 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
34 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
35 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
39 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 RCSID("$OpenBSD: channels.c,v 1.83 2001/01/24 21:03:50 stevesk Exp $");
45 #include <openssl/rsa.h>
46 #include <openssl/dsa.h>
64 /* Maximum number of fake X11 displays to try. */
65 #define MAX_DISPLAYS 1000
67 /* Max len of agent socket */
68 #define MAX_SOCKET_NAME 100
71 * Pointer to an array containing all allocated channels. The array is
72 * dynamically extended as needed.
74 static Channel *channels = NULL;
77 * Size of the channel array. All slots of the array must always be
78 * initialized (at least the type field); unused slots are marked with type
81 static int channels_alloc = 0;
84 * Maximum file descriptor value used in any of the channels. This is
85 * updated in channel_allocate.
87 static int channel_max_fd_value = 0;
89 /* Name and directory of socket for authentication agent forwarding. */
90 static char *channel_forwarded_auth_socket_name = NULL;
91 static char *channel_forwarded_auth_socket_dir = NULL;
93 /* Saved X11 authentication protocol name. */
94 char *x11_saved_proto = NULL;
96 /* Saved X11 authentication data. This is the real data. */
97 char *x11_saved_data = NULL;
98 u_int x11_saved_data_len = 0;
101 * Fake X11 authentication data. This is what the server will be sending us;
102 * we should replace any occurrences of this by the real data.
104 char *x11_fake_data = NULL;
105 u_int x11_fake_data_len;
108 * Data structure for storing which hosts are permitted for forward requests.
109 * The local sides of any remote forwards are stored in this array to prevent
110 * a corrupt remote server from accessing arbitrary TCP/IP ports on our local
111 * network (which might be behind a firewall).
114 char *host_to_connect; /* Connect to 'host'. */
115 u_short port_to_connect; /* Connect to 'port'. */
116 u_short listen_port; /* Remote side should listen port number. */
119 /* List of all permitted host/port pairs to connect. */
120 static ForwardPermission permitted_opens[SSH_MAX_FORWARDS_PER_DIRECTION];
121 /* Number of permitted host/port pairs in the array. */
122 static int num_permitted_opens = 0;
124 * If this is true, all opens are permitted. This is the case on the server
125 * on which we have to trust the client anyway, and the user could do
126 * anything after logging in anyway.
128 static int all_opens_permitted = 0;
130 /* This is set to true if both sides support SSH_PROTOFLAG_HOST_IN_FWD_OPEN. */
131 static int have_hostname_in_open = 0;
133 /* AF_UNSPEC or AF_INET or AF_INET6 */
136 /* Sets specific protocol options. */
139 channel_set_options(int hostname_in_open)
141 have_hostname_in_open = hostname_in_open;
145 * Permits opening to any host/port in SSH_MSG_PORT_OPEN. This is usually
146 * called by the server, because the user could connect to any port anyway,
147 * and the server has no way to know but to trust the client anyway.
151 channel_permit_all_opens()
153 all_opens_permitted = 1;
156 /* lookup channel by id */
159 channel_lookup(int id)
162 if (id < 0 || id > channels_alloc) {
163 log("channel_lookup: %d: bad id", id);
167 if (c->type == SSH_CHANNEL_FREE) {
168 log("channel_lookup: %d: bad id: channel free", id);
175 * Register filedescriptors for a channel, used when allocating a channel or
176 * when the channel consumer/producer is ready, e.g. shell exec'd
180 channel_register_fds(Channel *c, int rfd, int wfd, int efd,
181 int extusage, int nonblock)
183 /* Update the maximum file descriptor value. */
184 if (rfd > channel_max_fd_value)
185 channel_max_fd_value = rfd;
186 if (wfd > channel_max_fd_value)
187 channel_max_fd_value = wfd;
188 if (efd > channel_max_fd_value)
189 channel_max_fd_value = efd;
190 /* XXX set close-on-exec -markus */
194 c->sock = (rfd == wfd) ? rfd : -1;
196 c->extended_usage = extusage;
198 /* enable nonblocking mode */
210 * Allocate a new channel object and set its type and socket. This will cause
211 * remote_name to be freed.
215 channel_new(char *ctype, int type, int rfd, int wfd, int efd,
216 int window, int maxpack, int extusage, char *remote_name, int nonblock)
221 /* Do initial allocation if this is the first call. */
222 if (channels_alloc == 0) {
225 channels = xmalloc(channels_alloc * sizeof(Channel));
226 for (i = 0; i < channels_alloc; i++)
227 channels[i].type = SSH_CHANNEL_FREE;
229 * Kludge: arrange a call to channel_stop_listening if we
230 * terminate with fatal().
232 fatal_add_cleanup((void (*) (void *)) channel_stop_listening, NULL);
234 /* Try to find a free slot where to put the new channel. */
235 for (found = -1, i = 0; i < channels_alloc; i++)
236 if (channels[i].type == SSH_CHANNEL_FREE) {
237 /* Found a free slot. */
242 /* There are no free slots. Take last+1 slot and expand the array. */
243 found = channels_alloc;
244 channels_alloc += 10;
245 debug2("channel: expanding %d", channels_alloc);
246 channels = xrealloc(channels, channels_alloc * sizeof(Channel));
247 for (i = found; i < channels_alloc; i++)
248 channels[i].type = SSH_CHANNEL_FREE;
250 /* Initialize and return new channel number. */
251 c = &channels[found];
252 buffer_init(&c->input);
253 buffer_init(&c->output);
254 buffer_init(&c->extended);
255 chan_init_iostates(c);
256 channel_register_fds(c, rfd, wfd, efd, extusage, nonblock);
260 c->local_window = window;
261 c->local_window_max = window;
262 c->local_consumed = 0;
263 c->local_maxpacket = maxpack;
265 c->remote_name = remote_name;
266 c->remote_window = 0;
267 c->remote_maxpacket = 0;
271 c->dettach_user = NULL;
272 c->input_filter = NULL;
273 debug("channel %d: new [%s]", found, remote_name);
276 /* old interface XXX */
278 channel_allocate(int type, int sock, char *remote_name)
280 return channel_new("", type, sock, sock, -1, 0, 0, 0, remote_name, 1);
284 /* Close all channel fd/socket. */
287 channel_close_fds(Channel *c)
307 /* Free the channel and close its fd/socket. */
312 Channel *c = channel_lookup(id);
313 char *s = channel_open_message();
316 packet_disconnect("channel free: bad local channel %d", id);
317 debug("channel_free: channel %d: status: %s", id, s);
320 if (c->dettach_user != NULL) {
321 debug("channel_free: channel %d: dettaching channel user", id);
322 c->dettach_user(c->self, NULL);
325 shutdown(c->sock, SHUT_RDWR);
326 channel_close_fds(c);
327 buffer_free(&c->input);
328 buffer_free(&c->output);
329 buffer_free(&c->extended);
330 c->type = SSH_CHANNEL_FREE;
331 if (c->remote_name) {
332 xfree(c->remote_name);
333 c->remote_name = NULL;
338 * 'channel_pre*' are called just before select() to add any bits relevant to
339 * channels in the select bitmasks.
342 * 'channel_post*': perform any appropriate operations for channels which
343 * have events pending.
345 typedef void chan_fn(Channel *c, fd_set * readset, fd_set * writeset);
346 chan_fn *channel_pre[SSH_CHANNEL_MAX_TYPE];
347 chan_fn *channel_post[SSH_CHANNEL_MAX_TYPE];
350 channel_pre_listener(Channel *c, fd_set * readset, fd_set * writeset)
352 FD_SET(c->sock, readset);
356 channel_pre_connecting(Channel *c, fd_set * readset, fd_set * writeset)
358 debug3("channel %d: waiting for connection", c->self);
359 FD_SET(c->sock, writeset);
363 channel_pre_open_13(Channel *c, fd_set * readset, fd_set * writeset)
365 if (buffer_len(&c->input) < packet_get_maxsize())
366 FD_SET(c->sock, readset);
367 if (buffer_len(&c->output) > 0)
368 FD_SET(c->sock, writeset);
372 channel_pre_open_15(Channel *c, fd_set * readset, fd_set * writeset)
374 /* test whether sockets are 'alive' for read/write */
375 if (c->istate == CHAN_INPUT_OPEN)
376 if (buffer_len(&c->input) < packet_get_maxsize())
377 FD_SET(c->sock, readset);
378 if (c->ostate == CHAN_OUTPUT_OPEN ||
379 c->ostate == CHAN_OUTPUT_WAIT_DRAIN) {
380 if (buffer_len(&c->output) > 0) {
381 FD_SET(c->sock, writeset);
382 } else if (c->ostate == CHAN_OUTPUT_WAIT_DRAIN) {
389 channel_pre_open_20(Channel *c, fd_set * readset, fd_set * writeset)
391 if (c->istate == CHAN_INPUT_OPEN &&
392 c->remote_window > 0 &&
393 buffer_len(&c->input) < c->remote_window)
394 FD_SET(c->rfd, readset);
395 if (c->ostate == CHAN_OUTPUT_OPEN ||
396 c->ostate == CHAN_OUTPUT_WAIT_DRAIN) {
397 if (buffer_len(&c->output) > 0) {
398 FD_SET(c->wfd, writeset);
399 } else if (c->ostate == CHAN_OUTPUT_WAIT_DRAIN) {
403 /** XXX check close conditions, too */
405 if (c->extended_usage == CHAN_EXTENDED_WRITE &&
406 buffer_len(&c->extended) > 0)
407 FD_SET(c->efd, writeset);
408 else if (c->extended_usage == CHAN_EXTENDED_READ &&
409 buffer_len(&c->extended) < c->remote_window)
410 FD_SET(c->efd, readset);
415 channel_pre_input_draining(Channel *c, fd_set * readset, fd_set * writeset)
417 if (buffer_len(&c->input) == 0) {
418 packet_start(SSH_MSG_CHANNEL_CLOSE);
419 packet_put_int(c->remote_id);
421 c->type = SSH_CHANNEL_CLOSED;
422 debug("Closing channel %d after input drain.", c->self);
427 channel_pre_output_draining(Channel *c, fd_set * readset, fd_set * writeset)
429 if (buffer_len(&c->output) == 0)
430 channel_free(c->self);
432 FD_SET(c->sock, writeset);
436 * This is a special state for X11 authentication spoofing. An opened X11
437 * connection (when authentication spoofing is being done) remains in this
438 * state until the first packet has been completely read. The authentication
439 * data in that packet is then substituted by the real data if it matches the
440 * fake data, and the channel is put into normal mode.
441 * XXX All this happens at the client side.
444 x11_open_helper(Channel *c)
447 u_int proto_len, data_len;
449 /* Check if the fixed size part of the packet is in buffer. */
450 if (buffer_len(&c->output) < 12)
453 /* Parse the lengths of variable-length fields. */
454 ucp = (u_char *) buffer_ptr(&c->output);
455 if (ucp[0] == 0x42) { /* Byte order MSB first. */
456 proto_len = 256 * ucp[6] + ucp[7];
457 data_len = 256 * ucp[8] + ucp[9];
458 } else if (ucp[0] == 0x6c) { /* Byte order LSB first. */
459 proto_len = ucp[6] + 256 * ucp[7];
460 data_len = ucp[8] + 256 * ucp[9];
462 debug("Initial X11 packet contains bad byte order byte: 0x%x",
467 /* Check if the whole packet is in buffer. */
468 if (buffer_len(&c->output) <
469 12 + ((proto_len + 3) & ~3) + ((data_len + 3) & ~3))
472 /* Check if authentication protocol matches. */
473 if (proto_len != strlen(x11_saved_proto) ||
474 memcmp(ucp + 12, x11_saved_proto, proto_len) != 0) {
475 debug("X11 connection uses different authentication protocol.");
478 /* Check if authentication data matches our fake data. */
479 if (data_len != x11_fake_data_len ||
480 memcmp(ucp + 12 + ((proto_len + 3) & ~3),
481 x11_fake_data, x11_fake_data_len) != 0) {
482 debug("X11 auth data does not match fake data.");
485 /* Check fake data length */
486 if (x11_fake_data_len != x11_saved_data_len) {
487 error("X11 fake_data_len %d != saved_data_len %d",
488 x11_fake_data_len, x11_saved_data_len);
492 * Received authentication protocol and data match
493 * our fake data. Substitute the fake data with real
496 memcpy(ucp + 12 + ((proto_len + 3) & ~3),
497 x11_saved_data, x11_saved_data_len);
502 channel_pre_x11_open_13(Channel *c, fd_set * readset, fd_set * writeset)
504 int ret = x11_open_helper(c);
506 /* Start normal processing for the channel. */
507 c->type = SSH_CHANNEL_OPEN;
508 channel_pre_open_13(c, readset, writeset);
509 } else if (ret == -1) {
511 * We have received an X11 connection that has bad
512 * authentication information.
514 log("X11 connection rejected because of wrong authentication.\r\n");
515 buffer_clear(&c->input);
516 buffer_clear(&c->output);
519 c->type = SSH_CHANNEL_CLOSED;
520 packet_start(SSH_MSG_CHANNEL_CLOSE);
521 packet_put_int(c->remote_id);
527 channel_pre_x11_open(Channel *c, fd_set * readset, fd_set * writeset)
529 int ret = x11_open_helper(c);
531 c->type = SSH_CHANNEL_OPEN;
533 channel_pre_open_20(c, readset, writeset);
535 channel_pre_open_15(c, readset, writeset);
536 } else if (ret == -1) {
537 debug("X11 rejected %d i%d/o%d", c->self, c->istate, c->ostate);
538 chan_read_failed(c); /** force close? */
539 chan_write_failed(c);
540 debug("X11 closed %d i%d/o%d", c->self, c->istate, c->ostate);
544 /* This is our fake X11 server socket. */
546 channel_post_x11_listener(Channel *c, fd_set * readset, fd_set * writeset)
548 struct sockaddr addr;
551 char buf[16384], *remote_hostname;
554 if (FD_ISSET(c->sock, readset)) {
555 debug("X11 connection requested.");
556 addrlen = sizeof(addr);
557 newsock = accept(c->sock, &addr, &addrlen);
559 error("accept: %.100s", strerror(errno));
562 remote_hostname = get_remote_hostname(newsock);
563 remote_port = get_peer_port(newsock);
564 snprintf(buf, sizeof buf, "X11 connection from %.200s port %d",
565 remote_hostname, remote_port);
567 newch = channel_new("x11",
568 SSH_CHANNEL_OPENING, newsock, newsock, -1,
569 c->local_window_max, c->local_maxpacket,
572 packet_start(SSH2_MSG_CHANNEL_OPEN);
573 packet_put_cstring("x11");
574 packet_put_int(newch);
575 packet_put_int(c->local_window_max);
576 packet_put_int(c->local_maxpacket);
577 /* originator host and port */
578 packet_put_cstring(remote_hostname);
579 if (datafellows & SSH_BUG_X11FWD) {
580 debug("ssh2 x11 bug compat mode");
582 packet_put_int(remote_port);
586 packet_start(SSH_SMSG_X11_OPEN);
587 packet_put_int(newch);
588 if (have_hostname_in_open)
589 packet_put_string(buf, strlen(buf));
592 xfree(remote_hostname);
597 * This socket is listening for connections to a forwarded TCP/IP port.
600 channel_post_port_listener(Channel *c, fd_set * readset, fd_set * writeset)
602 struct sockaddr addr;
605 char buf[1024], *remote_hostname, *rtype;
608 rtype = (c->type == SSH_CHANNEL_RPORT_LISTENER) ?
609 "forwarded-tcpip" : "direct-tcpip";
611 if (FD_ISSET(c->sock, readset)) {
612 debug("Connection to port %d forwarding "
613 "to %.100s port %d requested.",
614 c->listening_port, c->path, c->host_port);
615 addrlen = sizeof(addr);
616 newsock = accept(c->sock, &addr, &addrlen);
618 error("accept: %.100s", strerror(errno));
621 remote_hostname = get_remote_hostname(newsock);
622 remote_port = get_peer_port(newsock);
623 snprintf(buf, sizeof buf,
624 "listen port %d for %.100s port %d, "
625 "connect from %.200s port %d",
626 c->listening_port, c->path, c->host_port,
627 remote_hostname, remote_port);
629 newch = channel_new(rtype,
630 SSH_CHANNEL_OPENING, newsock, newsock, -1,
631 c->local_window_max, c->local_maxpacket,
634 packet_start(SSH2_MSG_CHANNEL_OPEN);
635 packet_put_cstring(rtype);
636 packet_put_int(newch);
637 packet_put_int(c->local_window_max);
638 packet_put_int(c->local_maxpacket);
639 if (c->type == SSH_CHANNEL_RPORT_LISTENER) {
640 /* listen address, port */
641 packet_put_string(c->path, strlen(c->path));
642 packet_put_int(c->listening_port);
644 /* target host, port */
645 packet_put_string(c->path, strlen(c->path));
646 packet_put_int(c->host_port);
648 /* originator host and port */
649 packet_put_cstring(remote_hostname);
650 packet_put_int(remote_port);
653 packet_start(SSH_MSG_PORT_OPEN);
654 packet_put_int(newch);
655 packet_put_string(c->path, strlen(c->path));
656 packet_put_int(c->host_port);
657 if (have_hostname_in_open) {
658 packet_put_string(buf, strlen(buf));
662 xfree(remote_hostname);
667 * This is the authentication agent socket listening for connections from
671 channel_post_auth_listener(Channel *c, fd_set * readset, fd_set * writeset)
673 struct sockaddr addr;
677 if (FD_ISSET(c->sock, readset)) {
678 addrlen = sizeof(addr);
679 newsock = accept(c->sock, &addr, &addrlen);
681 error("accept from auth socket: %.100s", strerror(errno));
684 newch = channel_new("accepted auth socket",
685 SSH_CHANNEL_OPENING, newsock, newsock, -1,
686 c->local_window_max, c->local_maxpacket,
687 0, xstrdup("accepted auth socket"), 1);
689 packet_start(SSH2_MSG_CHANNEL_OPEN);
690 packet_put_cstring("auth-agent@openssh.com");
691 packet_put_int(newch);
692 packet_put_int(c->local_window_max);
693 packet_put_int(c->local_maxpacket);
695 packet_start(SSH_SMSG_AGENT_OPEN);
696 packet_put_int(newch);
703 channel_post_connecting(Channel *c, fd_set * readset, fd_set * writeset)
705 if (FD_ISSET(c->sock, writeset)) {
707 int sz = sizeof(err);
708 c->type = SSH_CHANNEL_OPEN;
709 if (getsockopt(c->sock, SOL_SOCKET, SO_ERROR, (char *)&err, &sz) < 0) {
710 debug("getsockopt SO_ERROR failed");
713 debug("channel %d: connected)", c->self);
715 debug("channel %d: not connected: %s",
716 c->self, strerror(err));
718 chan_write_failed(c);
725 channel_handle_rfd(Channel *c, fd_set * readset, fd_set * writeset)
731 FD_ISSET(c->rfd, readset)) {
732 len = read(c->rfd, buf, sizeof(buf));
733 if (len < 0 && (errno == EINTR || errno == EAGAIN))
736 debug("channel %d: read<=0 rfd %d len %d",
737 c->self, c->rfd, len);
739 buffer_consume(&c->output, buffer_len(&c->output));
740 c->type = SSH_CHANNEL_INPUT_DRAINING;
741 debug("Channel %d status set to input draining.", c->self);
747 if(c->input_filter != NULL) {
748 if (c->input_filter(c, buf, len) == -1) {
749 debug("filter stops channel %d", c->self);
753 buffer_append(&c->input, buf, len);
759 channel_handle_wfd(Channel *c, fd_set * readset, fd_set * writeset)
763 /* Send buffered output data to the socket. */
765 FD_ISSET(c->wfd, writeset) &&
766 buffer_len(&c->output) > 0) {
767 len = write(c->wfd, buffer_ptr(&c->output),
768 buffer_len(&c->output));
769 if (len < 0 && (errno == EINTR || errno == EAGAIN))
773 buffer_consume(&c->output, buffer_len(&c->output));
774 debug("Channel %d status set to input draining.", c->self);
775 c->type = SSH_CHANNEL_INPUT_DRAINING;
777 chan_write_failed(c);
781 buffer_consume(&c->output, len);
782 if (compat20 && len > 0) {
783 c->local_consumed += len;
789 channel_handle_efd(Channel *c, fd_set * readset, fd_set * writeset)
794 /** XXX handle drain efd, too */
796 if (c->extended_usage == CHAN_EXTENDED_WRITE &&
797 FD_ISSET(c->efd, writeset) &&
798 buffer_len(&c->extended) > 0) {
799 len = write(c->efd, buffer_ptr(&c->extended),
800 buffer_len(&c->extended));
801 debug2("channel %d: written %d to efd %d",
802 c->self, len, c->efd);
804 buffer_consume(&c->extended, len);
805 c->local_consumed += len;
807 } else if (c->extended_usage == CHAN_EXTENDED_READ &&
808 FD_ISSET(c->efd, readset)) {
809 len = read(c->efd, buf, sizeof(buf));
810 debug2("channel %d: read %d from efd %d",
811 c->self, len, c->efd);
813 debug("channel %d: closing efd %d",
818 buffer_append(&c->extended, buf, len);
824 channel_check_window(Channel *c, fd_set * readset, fd_set * writeset)
826 if (!(c->flags & (CHAN_CLOSE_SENT|CHAN_CLOSE_RCVD)) &&
827 c->local_window < c->local_window_max/2 &&
828 c->local_consumed > 0) {
829 packet_start(SSH2_MSG_CHANNEL_WINDOW_ADJUST);
830 packet_put_int(c->remote_id);
831 packet_put_int(c->local_consumed);
833 debug2("channel %d: window %d sent adjust %d",
834 c->self, c->local_window,
836 c->local_window += c->local_consumed;
837 c->local_consumed = 0;
843 channel_post_open_1(Channel *c, fd_set * readset, fd_set * writeset)
845 channel_handle_rfd(c, readset, writeset);
846 channel_handle_wfd(c, readset, writeset);
850 channel_post_open_2(Channel *c, fd_set * readset, fd_set * writeset)
852 channel_handle_rfd(c, readset, writeset);
853 channel_handle_wfd(c, readset, writeset);
854 channel_handle_efd(c, readset, writeset);
855 channel_check_window(c, readset, writeset);
859 channel_post_output_drain_13(Channel *c, fd_set * readset, fd_set * writeset)
862 /* Send buffered output data to the socket. */
863 if (FD_ISSET(c->sock, writeset) && buffer_len(&c->output) > 0) {
864 len = write(c->sock, buffer_ptr(&c->output),
865 buffer_len(&c->output));
867 buffer_consume(&c->output, buffer_len(&c->output));
869 buffer_consume(&c->output, len);
874 channel_handler_init_20(void)
876 channel_pre[SSH_CHANNEL_OPEN] = &channel_pre_open_20;
877 channel_pre[SSH_CHANNEL_X11_OPEN] = &channel_pre_x11_open;
878 channel_pre[SSH_CHANNEL_PORT_LISTENER] = &channel_pre_listener;
879 channel_pre[SSH_CHANNEL_RPORT_LISTENER] = &channel_pre_listener;
880 channel_pre[SSH_CHANNEL_X11_LISTENER] = &channel_pre_listener;
881 channel_pre[SSH_CHANNEL_AUTH_SOCKET] = &channel_pre_listener;
882 channel_pre[SSH_CHANNEL_CONNECTING] = &channel_pre_connecting;
884 channel_post[SSH_CHANNEL_OPEN] = &channel_post_open_2;
885 channel_post[SSH_CHANNEL_PORT_LISTENER] = &channel_post_port_listener;
886 channel_post[SSH_CHANNEL_RPORT_LISTENER] = &channel_post_port_listener;
887 channel_post[SSH_CHANNEL_X11_LISTENER] = &channel_post_x11_listener;
888 channel_post[SSH_CHANNEL_AUTH_SOCKET] = &channel_post_auth_listener;
889 channel_post[SSH_CHANNEL_CONNECTING] = &channel_post_connecting;
893 channel_handler_init_13(void)
895 channel_pre[SSH_CHANNEL_OPEN] = &channel_pre_open_13;
896 channel_pre[SSH_CHANNEL_X11_OPEN] = &channel_pre_x11_open_13;
897 channel_pre[SSH_CHANNEL_X11_LISTENER] = &channel_pre_listener;
898 channel_pre[SSH_CHANNEL_PORT_LISTENER] = &channel_pre_listener;
899 channel_pre[SSH_CHANNEL_AUTH_SOCKET] = &channel_pre_listener;
900 channel_pre[SSH_CHANNEL_INPUT_DRAINING] = &channel_pre_input_draining;
901 channel_pre[SSH_CHANNEL_OUTPUT_DRAINING] = &channel_pre_output_draining;
902 channel_pre[SSH_CHANNEL_CONNECTING] = &channel_pre_connecting;
904 channel_post[SSH_CHANNEL_OPEN] = &channel_post_open_1;
905 channel_post[SSH_CHANNEL_X11_LISTENER] = &channel_post_x11_listener;
906 channel_post[SSH_CHANNEL_PORT_LISTENER] = &channel_post_port_listener;
907 channel_post[SSH_CHANNEL_AUTH_SOCKET] = &channel_post_auth_listener;
908 channel_post[SSH_CHANNEL_OUTPUT_DRAINING] = &channel_post_output_drain_13;
909 channel_post[SSH_CHANNEL_CONNECTING] = &channel_post_connecting;
913 channel_handler_init_15(void)
915 channel_pre[SSH_CHANNEL_OPEN] = &channel_pre_open_15;
916 channel_pre[SSH_CHANNEL_X11_OPEN] = &channel_pre_x11_open;
917 channel_pre[SSH_CHANNEL_X11_LISTENER] = &channel_pre_listener;
918 channel_pre[SSH_CHANNEL_PORT_LISTENER] = &channel_pre_listener;
919 channel_pre[SSH_CHANNEL_AUTH_SOCKET] = &channel_pre_listener;
920 channel_pre[SSH_CHANNEL_CONNECTING] = &channel_pre_connecting;
922 channel_post[SSH_CHANNEL_X11_LISTENER] = &channel_post_x11_listener;
923 channel_post[SSH_CHANNEL_PORT_LISTENER] = &channel_post_port_listener;
924 channel_post[SSH_CHANNEL_AUTH_SOCKET] = &channel_post_auth_listener;
925 channel_post[SSH_CHANNEL_OPEN] = &channel_post_open_1;
926 channel_post[SSH_CHANNEL_CONNECTING] = &channel_post_connecting;
930 channel_handler_init(void)
933 for(i = 0; i < SSH_CHANNEL_MAX_TYPE; i++) {
934 channel_pre[i] = NULL;
935 channel_post[i] = NULL;
938 channel_handler_init_20();
940 channel_handler_init_13();
942 channel_handler_init_15();
946 channel_handler(chan_fn *ftab[], fd_set * readset, fd_set * writeset)
948 static int did_init = 0;
953 channel_handler_init();
956 for (i = 0; i < channels_alloc; i++) {
958 if (c->type == SSH_CHANNEL_FREE)
960 if (ftab[c->type] == NULL)
962 (*ftab[c->type])(c, readset, writeset);
963 chan_delete_if_full_closed(c);
968 channel_prepare_select(fd_set * readset, fd_set * writeset)
970 channel_handler(channel_pre, readset, writeset);
974 channel_after_select(fd_set * readset, fd_set * writeset)
976 channel_handler(channel_post, readset, writeset);
979 /* If there is data to send to the connection, send some of it now. */
982 channel_output_poll()
987 for (i = 0; i < channels_alloc; i++) {
990 /* We are only interested in channels that can have buffered incoming data. */
992 if (c->type != SSH_CHANNEL_OPEN &&
993 c->type != SSH_CHANNEL_INPUT_DRAINING)
996 if (c->type != SSH_CHANNEL_OPEN)
998 if (c->istate != CHAN_INPUT_OPEN &&
999 c->istate != CHAN_INPUT_WAIT_DRAIN)
1003 (c->flags & (CHAN_CLOSE_SENT|CHAN_CLOSE_RCVD))) {
1004 debug("channel: %d: no data after CLOSE", c->self);
1008 /* Get the amount of buffered data for this channel. */
1009 len = buffer_len(&c->input);
1011 /* Send some data for the other side over the secure connection. */
1013 if (len > c->remote_window)
1014 len = c->remote_window;
1015 if (len > c->remote_maxpacket)
1016 len = c->remote_maxpacket;
1018 if (packet_is_interactive()) {
1022 /* Keep the packets at reasonable size. */
1023 if (len > packet_get_maxsize()/2)
1024 len = packet_get_maxsize()/2;
1028 packet_start(compat20 ?
1029 SSH2_MSG_CHANNEL_DATA : SSH_MSG_CHANNEL_DATA);
1030 packet_put_int(c->remote_id);
1031 packet_put_string(buffer_ptr(&c->input), len);
1033 buffer_consume(&c->input, len);
1034 c->remote_window -= len;
1036 } else if (c->istate == CHAN_INPUT_WAIT_DRAIN) {
1038 fatal("cannot happen: istate == INPUT_WAIT_DRAIN for proto 1.3");
1040 * input-buffer is empty and read-socket shutdown:
1041 * tell peer, that we will not send more data: send IEOF
1045 /* Send extended data, i.e. stderr */
1047 c->remote_window > 0 &&
1048 (len = buffer_len(&c->extended)) > 0 &&
1049 c->extended_usage == CHAN_EXTENDED_READ) {
1050 if (len > c->remote_window)
1051 len = c->remote_window;
1052 if (len > c->remote_maxpacket)
1053 len = c->remote_maxpacket;
1054 packet_start(SSH2_MSG_CHANNEL_EXTENDED_DATA);
1055 packet_put_int(c->remote_id);
1056 packet_put_int(SSH2_EXTENDED_DATA_STDERR);
1057 packet_put_string(buffer_ptr(&c->extended), len);
1059 buffer_consume(&c->extended, len);
1060 c->remote_window -= len;
1066 * This is called when a packet of type CHANNEL_DATA has just been received.
1067 * The message type has already been consumed, but channel number and data is
1072 channel_input_data(int type, int plen, void *ctxt)
1079 /* Get the channel number and verify it. */
1080 id = packet_get_int();
1081 c = channel_lookup(id);
1083 packet_disconnect("Received data for nonexistent channel %d.", id);
1085 /* Ignore any data for non-open channels (might happen on close) */
1086 if (c->type != SSH_CHANNEL_OPEN &&
1087 c->type != SSH_CHANNEL_X11_OPEN)
1090 /* same for protocol 1.5 if output end is no longer open */
1091 if (!compat13 && c->ostate != CHAN_OUTPUT_OPEN)
1095 data = packet_get_string(&data_len);
1099 if (data_len > c->local_maxpacket) {
1100 log("channel %d: rcvd big packet %d, maxpack %d",
1101 c->self, data_len, c->local_maxpacket);
1103 if (data_len > c->local_window) {
1104 log("channel %d: rcvd too much data %d, win %d",
1105 c->self, data_len, c->local_window);
1109 c->local_window -= data_len;
1111 packet_integrity_check(plen, 4 + 4 + data_len, type);
1113 buffer_append(&c->output, data, data_len);
1117 channel_input_extended_data(int type, int plen, void *ctxt)
1125 /* Get the channel number and verify it. */
1126 id = packet_get_int();
1127 c = channel_lookup(id);
1130 packet_disconnect("Received extended_data for bad channel %d.", id);
1131 if (c->type != SSH_CHANNEL_OPEN) {
1132 log("channel %d: ext data for non open", id);
1135 tcode = packet_get_int();
1137 c->extended_usage != CHAN_EXTENDED_WRITE ||
1138 tcode != SSH2_EXTENDED_DATA_STDERR) {
1139 log("channel %d: bad ext data", c->self);
1142 data = packet_get_string(&data_len);
1144 if (data_len > c->local_window) {
1145 log("channel %d: rcvd too much extended_data %d, win %d",
1146 c->self, data_len, c->local_window);
1150 debug2("channel %d: rcvd ext data %d", c->self, data_len);
1151 c->local_window -= data_len;
1152 buffer_append(&c->extended, data, data_len);
1158 * Returns true if no channel has too much buffered data, and false if one or
1159 * more channel is overfull.
1163 channel_not_very_much_buffered_data()
1168 for (i = 0; i < channels_alloc; i++) {
1170 if (c->type == SSH_CHANNEL_OPEN) {
1171 if (!compat20 && buffer_len(&c->input) > packet_get_maxsize()) {
1172 debug("channel %d: big input buffer %d",
1173 c->self, buffer_len(&c->input));
1176 if (buffer_len(&c->output) > packet_get_maxsize()) {
1177 debug("channel %d: big output buffer %d",
1178 c->self, buffer_len(&c->output));
1187 channel_input_ieof(int type, int plen, void *ctxt)
1192 packet_integrity_check(plen, 4, type);
1194 id = packet_get_int();
1195 c = channel_lookup(id);
1197 packet_disconnect("Received ieof for nonexistent channel %d.", id);
1202 channel_input_close(int type, int plen, void *ctxt)
1207 packet_integrity_check(plen, 4, type);
1209 id = packet_get_int();
1210 c = channel_lookup(id);
1212 packet_disconnect("Received close for nonexistent channel %d.", id);
1215 * Send a confirmation that we have closed the channel and no more
1216 * data is coming for it.
1218 packet_start(SSH_MSG_CHANNEL_CLOSE_CONFIRMATION);
1219 packet_put_int(c->remote_id);
1223 * If the channel is in closed state, we have sent a close request,
1224 * and the other side will eventually respond with a confirmation.
1225 * Thus, we cannot free the channel here, because then there would be
1226 * no-one to receive the confirmation. The channel gets freed when
1227 * the confirmation arrives.
1229 if (c->type != SSH_CHANNEL_CLOSED) {
1231 * Not a closed channel - mark it as draining, which will
1232 * cause it to be freed later.
1234 buffer_consume(&c->input, buffer_len(&c->input));
1235 c->type = SSH_CHANNEL_OUTPUT_DRAINING;
1239 /* proto version 1.5 overloads CLOSE_CONFIRMATION with OCLOSE */
1241 channel_input_oclose(int type, int plen, void *ctxt)
1243 int id = packet_get_int();
1244 Channel *c = channel_lookup(id);
1245 packet_integrity_check(plen, 4, type);
1247 packet_disconnect("Received oclose for nonexistent channel %d.", id);
1248 chan_rcvd_oclose(c);
1252 channel_input_close_confirmation(int type, int plen, void *ctxt)
1254 int id = packet_get_int();
1255 Channel *c = channel_lookup(id);
1259 packet_disconnect("Received close confirmation for "
1260 "out-of-range channel %d.", id);
1261 if (c->type != SSH_CHANNEL_CLOSED)
1262 packet_disconnect("Received close confirmation for "
1263 "non-closed channel %d (type %d).", id, c->type);
1264 channel_free(c->self);
1268 channel_input_open_confirmation(int type, int plen, void *ctxt)
1274 packet_integrity_check(plen, 4 + 4, type);
1276 id = packet_get_int();
1277 c = channel_lookup(id);
1279 if (c==NULL || c->type != SSH_CHANNEL_OPENING)
1280 packet_disconnect("Received open confirmation for "
1281 "non-opening channel %d.", id);
1282 remote_id = packet_get_int();
1283 /* Record the remote channel number and mark that the channel is now open. */
1284 c->remote_id = remote_id;
1285 c->type = SSH_CHANNEL_OPEN;
1288 c->remote_window = packet_get_int();
1289 c->remote_maxpacket = packet_get_int();
1291 if (c->cb_fn != NULL && c->cb_event == type) {
1292 debug2("callback start");
1293 c->cb_fn(c->self, c->cb_arg);
1294 debug2("callback done");
1296 debug("channel %d: open confirm rwindow %d rmax %d", c->self,
1297 c->remote_window, c->remote_maxpacket);
1302 channel_input_open_failure(int type, int plen, void *ctxt)
1308 packet_integrity_check(plen, 4, type);
1310 id = packet_get_int();
1311 c = channel_lookup(id);
1313 if (c==NULL || c->type != SSH_CHANNEL_OPENING)
1314 packet_disconnect("Received open failure for "
1315 "non-opening channel %d.", id);
1317 int reason = packet_get_int();
1318 char *msg = packet_get_string(NULL);
1319 char *lang = packet_get_string(NULL);
1320 log("channel_open_failure: %d: reason %d: %s", id, reason, msg);
1325 /* Free the channel. This will also close the socket. */
1330 channel_input_channel_request(int type, int plen, void *ctxt)
1335 id = packet_get_int();
1336 c = channel_lookup(id);
1339 (c->type != SSH_CHANNEL_OPEN && c->type != SSH_CHANNEL_LARVAL))
1340 packet_disconnect("Received request for "
1341 "non-open channel %d.", id);
1342 if (c->cb_fn != NULL && c->cb_event == type) {
1343 debug2("callback start");
1344 c->cb_fn(c->self, c->cb_arg);
1345 debug2("callback done");
1347 char *service = packet_get_string(NULL);
1348 debug("channel: %d rcvd request for %s", c->self, service);
1349 debug("cb_fn %p cb_event %d", c->cb_fn , c->cb_event);
1355 channel_input_window_adjust(int type, int plen, void *ctxt)
1363 /* Get the channel number and verify it. */
1364 id = packet_get_int();
1365 c = channel_lookup(id);
1367 if (c == NULL || c->type != SSH_CHANNEL_OPEN) {
1368 log("Received window adjust for "
1369 "non-open channel %d.", id);
1372 adjust = packet_get_int();
1374 debug2("channel %d: rcvd adjust %d", id, adjust);
1375 c->remote_window += adjust;
1379 * Stops listening for channels, and removes any unix domain sockets that we
1384 channel_stop_listening()
1387 for (i = 0; i < channels_alloc; i++) {
1388 switch (channels[i].type) {
1389 case SSH_CHANNEL_AUTH_SOCKET:
1390 close(channels[i].sock);
1391 unlink(channels[i].path);
1394 case SSH_CHANNEL_PORT_LISTENER:
1395 case SSH_CHANNEL_RPORT_LISTENER:
1396 case SSH_CHANNEL_X11_LISTENER:
1397 close(channels[i].sock);
1407 * Closes the sockets/fds of all channels. This is used to close extra file
1408 * descriptors after a fork.
1415 for (i = 0; i < channels_alloc; i++)
1416 if (channels[i].type != SSH_CHANNEL_FREE)
1417 channel_close_fds(&channels[i]);
1420 /* Returns the maximum file descriptor number used by the channels. */
1425 return channel_max_fd_value;
1428 /* Returns true if any channel is still open. */
1431 channel_still_open()
1434 for (i = 0; i < channels_alloc; i++)
1435 switch (channels[i].type) {
1436 case SSH_CHANNEL_FREE:
1437 case SSH_CHANNEL_X11_LISTENER:
1438 case SSH_CHANNEL_PORT_LISTENER:
1439 case SSH_CHANNEL_RPORT_LISTENER:
1440 case SSH_CHANNEL_CLOSED:
1441 case SSH_CHANNEL_AUTH_SOCKET:
1442 case SSH_CHANNEL_CONNECTING: /* XXX ??? */
1444 case SSH_CHANNEL_LARVAL:
1446 fatal("cannot happen: SSH_CHANNEL_LARVAL");
1448 case SSH_CHANNEL_OPENING:
1449 case SSH_CHANNEL_OPEN:
1450 case SSH_CHANNEL_X11_OPEN:
1452 case SSH_CHANNEL_INPUT_DRAINING:
1453 case SSH_CHANNEL_OUTPUT_DRAINING:
1455 fatal("cannot happen: OUT_DRAIN");
1458 fatal("channel_still_open: bad channel type %d", channels[i].type);
1465 * Returns a message describing the currently open forwarded connections,
1466 * suitable for sending to the client. The message contains crlf pairs for
1471 channel_open_message()
1477 buffer_init(&buffer);
1478 snprintf(buf, sizeof buf, "The following connections are open:\r\n");
1479 buffer_append(&buffer, buf, strlen(buf));
1480 for (i = 0; i < channels_alloc; i++) {
1481 Channel *c = &channels[i];
1483 case SSH_CHANNEL_FREE:
1484 case SSH_CHANNEL_X11_LISTENER:
1485 case SSH_CHANNEL_PORT_LISTENER:
1486 case SSH_CHANNEL_RPORT_LISTENER:
1487 case SSH_CHANNEL_CLOSED:
1488 case SSH_CHANNEL_AUTH_SOCKET:
1490 case SSH_CHANNEL_LARVAL:
1491 case SSH_CHANNEL_OPENING:
1492 case SSH_CHANNEL_CONNECTING:
1493 case SSH_CHANNEL_OPEN:
1494 case SSH_CHANNEL_X11_OPEN:
1495 case SSH_CHANNEL_INPUT_DRAINING:
1496 case SSH_CHANNEL_OUTPUT_DRAINING:
1497 snprintf(buf, sizeof buf, " #%d %.300s (t%d r%d i%d/%d o%d/%d fd %d/%d)\r\n",
1498 c->self, c->remote_name,
1499 c->type, c->remote_id,
1500 c->istate, buffer_len(&c->input),
1501 c->ostate, buffer_len(&c->output),
1503 buffer_append(&buffer, buf, strlen(buf));
1506 fatal("channel_open_message: bad channel type %d", c->type);
1510 buffer_append(&buffer, "\0", 1);
1511 cp = xstrdup(buffer_ptr(&buffer));
1512 buffer_free(&buffer);
1517 * Initiate forwarding of connections to local port "port" through the secure
1518 * channel to host:port from remote side.
1521 channel_request_local_forwarding(u_short listen_port, const char *host_to_connect,
1522 u_short port_to_connect, int gateway_ports)
1524 channel_request_forwarding(
1526 host_to_connect, port_to_connect,
1527 gateway_ports, /*remote_fwd*/ 0);
1531 * If 'remote_fwd' is true we have a '-R style' listener for protocol 2
1532 * (SSH_CHANNEL_RPORT_LISTENER).
1535 channel_request_forwarding(
1536 const char *listen_address, u_short listen_port,
1537 const char *host_to_connect, u_short port_to_connect,
1538 int gateway_ports, int remote_fwd)
1540 int success, ch, sock, on = 1, ctype;
1541 struct addrinfo hints, *ai, *aitop;
1542 char ntop[NI_MAXHOST], strport[NI_MAXSERV];
1544 struct linger linger;
1547 host = listen_address;
1548 ctype = SSH_CHANNEL_RPORT_LISTENER;
1550 host = host_to_connect;
1551 ctype =SSH_CHANNEL_PORT_LISTENER;
1554 if (strlen(host) > sizeof(channels[0].path) - 1)
1555 packet_disconnect("Forward host name too long.");
1557 /* XXX listen_address is currently ignored */
1559 * getaddrinfo returns a loopback address if the hostname is
1560 * set to NULL and hints.ai_flags is not AI_PASSIVE
1562 memset(&hints, 0, sizeof(hints));
1563 hints.ai_family = IPv4or6;
1564 hints.ai_flags = gateway_ports ? AI_PASSIVE : 0;
1565 hints.ai_socktype = SOCK_STREAM;
1566 snprintf(strport, sizeof strport, "%d", listen_port);
1567 if (getaddrinfo(NULL, strport, &hints, &aitop) != 0)
1568 packet_disconnect("getaddrinfo: fatal error");
1571 for (ai = aitop; ai; ai = ai->ai_next) {
1572 if (ai->ai_family != AF_INET && ai->ai_family != AF_INET6)
1574 if (getnameinfo(ai->ai_addr, ai->ai_addrlen, ntop, sizeof(ntop),
1575 strport, sizeof(strport), NI_NUMERICHOST|NI_NUMERICSERV) != 0) {
1576 error("channel_request_forwarding: getnameinfo failed");
1579 /* Create a port to listen for the host. */
1580 sock = socket(ai->ai_family, SOCK_STREAM, 0);
1582 /* this is no error since kernel may not support ipv6 */
1583 verbose("socket: %.100s", strerror(errno));
1587 * Set socket options. We would like the socket to disappear
1588 * as soon as it has been closed for whatever reason.
1590 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, (void *)&on, sizeof(on));
1592 linger.l_linger = 5;
1593 setsockopt(sock, SOL_SOCKET, SO_LINGER, (void *)&linger, sizeof(linger));
1594 debug("Local forwarding listening on %s port %s.", ntop, strport);
1596 /* Bind the socket to the address. */
1597 if (bind(sock, ai->ai_addr, ai->ai_addrlen) < 0) {
1598 /* address can be in use ipv6 address is already bound */
1600 error("bind: %.100s", strerror(errno));
1602 verbose("bind: %.100s", strerror(errno));
1607 /* Start listening for connections on the socket. */
1608 if (listen(sock, 5) < 0) {
1609 error("listen: %.100s", strerror(errno));
1613 /* Allocate a channel number for the socket. */
1614 ch = channel_new("port listener", ctype, sock, sock, -1,
1615 CHAN_TCP_WINDOW_DEFAULT, CHAN_TCP_PACKET_DEFAULT,
1616 0, xstrdup("port listener"), 1);
1617 strlcpy(channels[ch].path, host, sizeof(channels[ch].path));
1618 channels[ch].host_port = port_to_connect;
1619 channels[ch].listening_port = listen_port;
1623 packet_disconnect("cannot listen port: %d", listen_port); /*XXX ?disconnect? */
1624 freeaddrinfo(aitop);
1628 * Initiate forwarding of connections to port "port" on remote host through
1629 * the secure channel to host:port from local side.
1633 channel_request_remote_forwarding(u_short listen_port,
1634 const char *host_to_connect, u_short port_to_connect)
1636 int payload_len, type, success = 0;
1638 /* Record locally that connection to this host/port is permitted. */
1639 if (num_permitted_opens >= SSH_MAX_FORWARDS_PER_DIRECTION)
1640 fatal("channel_request_remote_forwarding: too many forwards");
1642 /* Send the forward request to the remote side. */
1644 const char *address_to_bind = "0.0.0.0";
1645 packet_start(SSH2_MSG_GLOBAL_REQUEST);
1646 packet_put_cstring("tcpip-forward");
1647 packet_put_char(0); /* boolean: want reply */
1648 packet_put_cstring(address_to_bind);
1649 packet_put_int(listen_port);
1651 packet_write_wait();
1652 /* Assume that server accepts the request */
1655 packet_start(SSH_CMSG_PORT_FORWARD_REQUEST);
1656 packet_put_int(listen_port);
1657 packet_put_cstring(host_to_connect);
1658 packet_put_int(port_to_connect);
1660 packet_write_wait();
1662 /* Wait for response from the remote side. */
1663 type = packet_read(&payload_len);
1665 case SSH_SMSG_SUCCESS:
1668 case SSH_SMSG_FAILURE:
1669 log("Warning: Server denied remote port forwarding.");
1672 /* Unknown packet */
1673 packet_disconnect("Protocol error for port forward request:"
1674 "received packet type %d.", type);
1678 permitted_opens[num_permitted_opens].host_to_connect = xstrdup(host_to_connect);
1679 permitted_opens[num_permitted_opens].port_to_connect = port_to_connect;
1680 permitted_opens[num_permitted_opens].listen_port = listen_port;
1681 num_permitted_opens++;
1686 * This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
1687 * listening for the port, and sends back a success reply (or disconnect
1688 * message if there was an error). This never returns if there was an error.
1692 channel_input_port_forward_request(int is_root, int gateway_ports)
1694 u_short port, host_port;
1697 /* Get arguments from the packet. */
1698 port = packet_get_int();
1699 hostname = packet_get_string(NULL);
1700 host_port = packet_get_int();
1704 * Check that an unprivileged user is not trying to forward a
1707 if (port < IPPORT_RESERVED && !is_root)
1708 packet_disconnect("Requested forwarding of port %d but user is not root.",
1711 /* Initiate forwarding */
1712 channel_request_local_forwarding(port, hostname, host_port, gateway_ports);
1714 /* Free the argument string. */
1718 /* XXX move to aux.c */
1720 channel_connect_to(const char *host, u_short host_port)
1722 struct addrinfo hints, *ai, *aitop;
1723 char ntop[NI_MAXHOST], strport[NI_MAXSERV];
1727 memset(&hints, 0, sizeof(hints));
1728 hints.ai_family = IPv4or6;
1729 hints.ai_socktype = SOCK_STREAM;
1730 snprintf(strport, sizeof strport, "%d", host_port);
1731 if ((gaierr = getaddrinfo(host, strport, &hints, &aitop)) != 0) {
1732 error("%.100s: unknown host (%s)", host, gai_strerror(gaierr));
1735 for (ai = aitop; ai; ai = ai->ai_next) {
1736 if (ai->ai_family != AF_INET && ai->ai_family != AF_INET6)
1738 if (getnameinfo(ai->ai_addr, ai->ai_addrlen, ntop, sizeof(ntop),
1739 strport, sizeof(strport), NI_NUMERICHOST|NI_NUMERICSERV) != 0) {
1740 error("channel_connect_to: getnameinfo failed");
1743 /* Create the socket. */
1744 sock = socket(ai->ai_family, SOCK_STREAM, 0);
1746 error("socket: %.100s", strerror(errno));
1749 if (fcntl(sock, F_SETFL, O_NONBLOCK) < 0)
1750 fatal("connect_to: F_SETFL: %s", strerror(errno));
1751 /* Connect to the host/port. */
1752 if (connect(sock, ai->ai_addr, ai->ai_addrlen) < 0 &&
1753 errno != EINPROGRESS) {
1754 error("connect %.100s port %s: %.100s", ntop, strport,
1757 continue; /* fail -- try next */
1759 break; /* success */
1762 freeaddrinfo(aitop);
1764 error("connect %.100s port %d: failed.", host, host_port);
1771 channel_connect_by_listen_adress(u_short listen_port)
1774 for (i = 0; i < num_permitted_opens; i++)
1775 if (permitted_opens[i].listen_port == listen_port)
1776 return channel_connect_to(
1777 permitted_opens[i].host_to_connect,
1778 permitted_opens[i].port_to_connect);
1779 error("WARNING: Server requests forwarding for unknown listen_port %d",
1785 * This is called after receiving PORT_OPEN message. This attempts to
1786 * connect to the given host:port, and sends back CHANNEL_OPEN_CONFIRMATION
1787 * or CHANNEL_OPEN_FAILURE.
1791 channel_input_port_open(int type, int plen, void *ctxt)
1794 char *host, *originator_string;
1795 int remote_channel, sock = -1, newch, i, denied;
1796 u_int host_len, originator_len;
1798 /* Get remote channel number. */
1799 remote_channel = packet_get_int();
1801 /* Get host name to connect to. */
1802 host = packet_get_string(&host_len);
1804 /* Get port to connect to. */
1805 host_port = packet_get_int();
1807 /* Get remote originator name. */
1808 if (have_hostname_in_open) {
1809 originator_string = packet_get_string(&originator_len);
1810 originator_len += 4; /* size of packet_int */
1812 originator_string = xstrdup("unknown (remote did not supply name)");
1813 originator_len = 0; /* no originator supplied */
1816 packet_integrity_check(plen,
1817 4 + 4 + host_len + 4 + originator_len, SSH_MSG_PORT_OPEN);
1819 /* Check if opening that port is permitted. */
1821 if (!all_opens_permitted) {
1822 /* Go trough all permitted ports. */
1823 for (i = 0; i < num_permitted_opens; i++)
1824 if (permitted_opens[i].port_to_connect == host_port &&
1825 strcmp(permitted_opens[i].host_to_connect, host) == 0)
1828 /* Check if we found the requested port among those permitted. */
1829 if (i >= num_permitted_opens) {
1830 /* The port is not permitted. */
1831 log("Received request to connect to %.100s:%d, but the request was denied.",
1836 sock = denied ? -1 : channel_connect_to(host, host_port);
1838 /* Allocate a channel for this connection. */
1839 newch = channel_allocate(SSH_CHANNEL_CONNECTING,
1840 sock, originator_string);
1841 /*XXX delay answer? */
1842 channels[newch].remote_id = remote_channel;
1844 packet_start(SSH_MSG_CHANNEL_OPEN_CONFIRMATION);
1845 packet_put_int(remote_channel);
1846 packet_put_int(newch);
1849 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
1850 packet_put_int(remote_channel);
1857 * Creates an internet domain socket for listening for X11 connections.
1858 * Returns a suitable value for the DISPLAY variable, or NULL if an error
1862 #define NUM_SOCKS 10
1865 x11_create_display_inet(int screen_number, int x11_display_offset)
1867 int display_number, sock;
1869 struct addrinfo hints, *ai, *aitop;
1870 char strport[NI_MAXSERV];
1871 int gaierr, n, num_socks = 0, socks[NUM_SOCKS];
1873 char hostname[MAXHOSTNAMELEN];
1875 for (display_number = x11_display_offset;
1876 display_number < MAX_DISPLAYS;
1878 port = 6000 + display_number;
1879 memset(&hints, 0, sizeof(hints));
1880 hints.ai_family = IPv4or6;
1881 hints.ai_flags = AI_PASSIVE; /* XXX loopback only ? */
1882 hints.ai_socktype = SOCK_STREAM;
1883 snprintf(strport, sizeof strport, "%d", port);
1884 if ((gaierr = getaddrinfo(NULL, strport, &hints, &aitop)) != 0) {
1885 error("getaddrinfo: %.100s", gai_strerror(gaierr));
1888 for (ai = aitop; ai; ai = ai->ai_next) {
1889 if (ai->ai_family != AF_INET && ai->ai_family != AF_INET6)
1891 sock = socket(ai->ai_family, SOCK_STREAM, 0);
1893 if ((errno != EINVAL) && (errno != EAFNOSUPPORT)) {
1894 error("socket: %.100s", strerror(errno));
1897 debug("x11_create_display_inet: Socket family %d not supported",
1902 if (bind(sock, ai->ai_addr, ai->ai_addrlen) < 0) {
1903 debug("bind port %d: %.100s", port, strerror(errno));
1904 shutdown(sock, SHUT_RDWR);
1910 for (n = 0; n < num_socks; n++) {
1911 shutdown(socks[n], SHUT_RDWR);
1917 socks[num_socks++] = sock;
1918 #ifndef DONT_TRY_OTHER_AF
1919 if (num_socks == NUM_SOCKS)
1925 freeaddrinfo(aitop);
1929 if (display_number >= MAX_DISPLAYS) {
1930 error("Failed to allocate internet-domain X11 display socket.");
1933 /* Start listening for connections on the socket. */
1934 for (n = 0; n < num_socks; n++) {
1936 if (listen(sock, 5) < 0) {
1937 error("listen: %.100s", strerror(errno));
1938 shutdown(sock, SHUT_RDWR);
1944 /* Set up a suitable value for the DISPLAY variable. */
1945 if (gethostname(hostname, sizeof(hostname)) < 0)
1946 fatal("gethostname: %.100s", strerror(errno));
1948 #ifdef IPADDR_IN_DISPLAY
1950 * HPUX detects the local hostname in the DISPLAY variable and tries
1951 * to set up a shared memory connection to the server, which it
1952 * incorrectly supposes to be local.
1954 * The workaround - as used in later $$H and other programs - is
1955 * is to set display to the host's IP address.
1959 struct in_addr my_addr;
1961 he = gethostbyname(hostname);
1963 error("[X11-broken-fwd-hostname-workaround] Could not get "
1964 "IP address for hostname %s.", hostname);
1966 packet_send_debug("[X11-broken-fwd-hostname-workaround]"
1967 "Could not get IP address for hostname %s.", hostname);
1969 shutdown(sock, SHUT_RDWR);
1975 memcpy(&my_addr, he->h_addr_list[0], sizeof(struct in_addr));
1977 /* Set DISPLAY to <ip address>:screen.display */
1978 snprintf(display, sizeof(display), "%.50s:%d.%d", inet_ntoa(my_addr),
1979 display_number, screen_number);
1981 #else /* IPADDR_IN_DISPLAY */
1982 /* Just set DISPLAY to hostname:screen.display */
1983 snprintf(display, sizeof display, "%.400s:%d.%d", hostname,
1984 display_number, screen_number);
1985 #endif /* IPADDR_IN_DISPLAY */
1987 /* Allocate a channel for each socket. */
1988 for (n = 0; n < num_socks; n++) {
1990 (void) channel_new("x11 listener",
1991 SSH_CHANNEL_X11_LISTENER, sock, sock, -1,
1992 CHAN_X11_WINDOW_DEFAULT, CHAN_X11_PACKET_DEFAULT,
1993 0, xstrdup("X11 inet listener"), 1);
1996 /* Return a suitable value for the DISPLAY environment variable. */
1997 return xstrdup(display);
2001 #define X_UNIX_PATH "/tmp/.X11-unix/X"
2006 connect_local_xsocket(u_int dnr)
2008 static const char *const x_sockets[] = {
2010 "/var/X/.X11-unix/X" "%u",
2011 "/usr/spool/sockets/X11/" "%u",
2015 struct sockaddr_un addr;
2016 const char *const * path;
2018 for (path = x_sockets; *path; ++path) {
2019 sock = socket(AF_UNIX, SOCK_STREAM, 0);
2021 error("socket: %.100s", strerror(errno));
2022 memset(&addr, 0, sizeof(addr));
2023 addr.sun_family = AF_UNIX;
2024 snprintf(addr.sun_path, sizeof addr.sun_path, *path, dnr);
2025 if (connect(sock, (struct sockaddr *) & addr, sizeof(addr)) == 0)
2029 error("connect %.100s: %.100s", addr.sun_path, strerror(errno));
2034 x11_connect_display(void)
2036 int display_number, sock = 0;
2037 const char *display;
2038 char buf[1024], *cp;
2039 struct addrinfo hints, *ai, *aitop;
2040 char strport[NI_MAXSERV];
2043 /* Try to open a socket for the local X server. */
2044 display = getenv("DISPLAY");
2046 error("DISPLAY not set.");
2050 * Now we decode the value of the DISPLAY variable and make a
2051 * connection to the real X server.
2055 * Check if it is a unix domain socket. Unix domain displays are in
2056 * one of the following formats: unix:d[.s], :d[.s], ::d[.s]
2058 if (strncmp(display, "unix:", 5) == 0 ||
2059 display[0] == ':') {
2060 /* Connect to the unix domain socket. */
2061 if (sscanf(strrchr(display, ':') + 1, "%d", &display_number) != 1) {
2062 error("Could not parse display number from DISPLAY: %.100s",
2066 /* Create a socket. */
2067 sock = connect_local_xsocket(display_number);
2071 /* OK, we now have a connection to the display. */
2075 * Connect to an inet socket. The DISPLAY value is supposedly
2076 * hostname:d[.s], where hostname may also be numeric IP address.
2078 strncpy(buf, display, sizeof(buf));
2079 buf[sizeof(buf) - 1] = 0;
2080 cp = strchr(buf, ':');
2082 error("Could not find ':' in DISPLAY: %.100s", display);
2086 /* buf now contains the host name. But first we parse the display number. */
2087 if (sscanf(cp + 1, "%d", &display_number) != 1) {
2088 error("Could not parse display number from DISPLAY: %.100s",
2093 /* Look up the host address */
2094 memset(&hints, 0, sizeof(hints));
2095 hints.ai_family = IPv4or6;
2096 hints.ai_socktype = SOCK_STREAM;
2097 snprintf(strport, sizeof strport, "%d", 6000 + display_number);
2098 if ((gaierr = getaddrinfo(buf, strport, &hints, &aitop)) != 0) {
2099 error("%.100s: unknown host. (%s)", buf, gai_strerror(gaierr));
2102 for (ai = aitop; ai; ai = ai->ai_next) {
2103 /* Create a socket. */
2104 sock = socket(ai->ai_family, SOCK_STREAM, 0);
2106 debug("socket: %.100s", strerror(errno));
2109 /* Connect it to the display. */
2110 if (connect(sock, ai->ai_addr, ai->ai_addrlen) < 0) {
2111 debug("connect %.100s port %d: %.100s", buf,
2112 6000 + display_number, strerror(errno));
2119 freeaddrinfo(aitop);
2121 error("connect %.100s port %d: %.100s", buf, 6000 + display_number,
2129 * This is called when SSH_SMSG_X11_OPEN is received. The packet contains
2130 * the remote channel number. We should do whatever we want, and respond
2131 * with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE.
2135 x11_input_open(int type, int plen, void *ctxt)
2137 int remote_channel, sock = 0, newch;
2141 /* Get remote channel number. */
2142 remote_channel = packet_get_int();
2144 /* Get remote originator name. */
2145 if (have_hostname_in_open) {
2146 remote_host = packet_get_string(&remote_len);
2149 remote_host = xstrdup("unknown (remote did not supply name)");
2153 debug("Received X11 open request.");
2154 packet_integrity_check(plen, 4 + remote_len, SSH_SMSG_X11_OPEN);
2156 /* Obtain a connection to the real X display. */
2157 sock = x11_connect_display();
2159 /* Send refusal to the remote host. */
2160 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
2161 packet_put_int(remote_channel);
2164 /* Allocate a channel for this connection. */
2165 newch = channel_allocate(
2166 (x11_saved_proto == NULL) ?
2167 SSH_CHANNEL_OPEN : SSH_CHANNEL_X11_OPEN,
2169 channels[newch].remote_id = remote_channel;
2171 /* Send a confirmation to the remote host. */
2172 packet_start(SSH_MSG_CHANNEL_OPEN_CONFIRMATION);
2173 packet_put_int(remote_channel);
2174 packet_put_int(newch);
2179 /* dummy protocol handler that denies SSH-1 requests (agent/x11) */
2181 deny_input_open(int type, int plen, void *ctxt)
2183 int rchan = packet_get_int();
2185 case SSH_SMSG_AGENT_OPEN:
2186 error("Warning: ssh server tried agent forwarding.");
2188 case SSH_SMSG_X11_OPEN:
2189 error("Warning: ssh server tried X11 forwarding.");
2192 error("deny_input_open: type %d plen %d", type, plen);
2195 error("Warning: this is probably a break in attempt by a malicious server.");
2196 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
2197 packet_put_int(rchan);
2202 * Requests forwarding of X11 connections, generates fake authentication
2203 * data, and enables authentication spoofing.
2207 x11_request_forwarding_with_spoofing(int client_session_id,
2208 const char *proto, const char *data)
2210 u_int data_len = (u_int) strlen(data) / 2;
2217 cp = getenv("DISPLAY");
2219 cp = strchr(cp, ':');
2221 cp = strchr(cp, '.');
2223 screen_number = atoi(cp + 1);
2227 /* Save protocol name. */
2228 x11_saved_proto = xstrdup(proto);
2231 * Extract real authentication data and generate fake data of the
2234 x11_saved_data = xmalloc(data_len);
2235 x11_fake_data = xmalloc(data_len);
2236 for (i = 0; i < data_len; i++) {
2237 if (sscanf(data + 2 * i, "%2x", &value) != 1)
2238 fatal("x11_request_forwarding: bad authentication data: %.100s", data);
2240 rand = arc4random();
2241 x11_saved_data[i] = value;
2242 x11_fake_data[i] = rand & 0xff;
2245 x11_saved_data_len = data_len;
2246 x11_fake_data_len = data_len;
2248 /* Convert the fake data into hex. */
2249 new_data = xmalloc(2 * data_len + 1);
2250 for (i = 0; i < data_len; i++)
2251 sprintf(new_data + 2 * i, "%02x", (u_char) x11_fake_data[i]);
2253 /* Send the request packet. */
2255 channel_request_start(client_session_id, "x11-req", 0);
2256 packet_put_char(0); /* XXX bool single connection */
2258 packet_start(SSH_CMSG_X11_REQUEST_FORWARDING);
2260 packet_put_cstring(proto);
2261 packet_put_cstring(new_data);
2262 packet_put_int(screen_number);
2264 packet_write_wait();
2268 /* Sends a message to the server to request authentication fd forwarding. */
2271 auth_request_forwarding()
2273 packet_start(SSH_CMSG_AGENT_REQUEST_FORWARDING);
2275 packet_write_wait();
2279 * Returns the name of the forwarded authentication socket. Returns NULL if
2280 * there is no forwarded authentication socket. The returned value points to
2285 auth_get_socket_name()
2287 return channel_forwarded_auth_socket_name;
2290 /* removes the agent forwarding socket */
2293 cleanup_socket(void)
2295 unlink(channel_forwarded_auth_socket_name);
2296 rmdir(channel_forwarded_auth_socket_dir);
2300 * This is called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
2301 * This starts forwarding authentication requests.
2305 auth_input_request_forwarding(struct passwd * pw)
2308 struct sockaddr_un sunaddr;
2310 if (auth_get_socket_name() != NULL)
2311 fatal("Protocol error: authentication forwarding requested twice.");
2313 /* Temporarily drop privileged uid for mkdir/bind. */
2314 temporarily_use_uid(pw->pw_uid);
2316 /* Allocate a buffer for the socket name, and format the name. */
2317 channel_forwarded_auth_socket_name = xmalloc(MAX_SOCKET_NAME);
2318 channel_forwarded_auth_socket_dir = xmalloc(MAX_SOCKET_NAME);
2319 strlcpy(channel_forwarded_auth_socket_dir, "/tmp/ssh-XXXXXXXX", MAX_SOCKET_NAME);
2321 /* Create private directory for socket */
2322 if (mkdtemp(channel_forwarded_auth_socket_dir) == NULL) {
2323 packet_send_debug("Agent forwarding disabled: mkdtemp() failed: %.100s",
2326 xfree(channel_forwarded_auth_socket_name);
2327 xfree(channel_forwarded_auth_socket_dir);
2328 channel_forwarded_auth_socket_name = NULL;
2329 channel_forwarded_auth_socket_dir = NULL;
2332 snprintf(channel_forwarded_auth_socket_name, MAX_SOCKET_NAME, "%s/agent.%d",
2333 channel_forwarded_auth_socket_dir, (int) getpid());
2335 if (atexit(cleanup_socket) < 0) {
2338 packet_disconnect("socket: %.100s", strerror(saved));
2340 /* Create the socket. */
2341 sock = socket(AF_UNIX, SOCK_STREAM, 0);
2343 packet_disconnect("socket: %.100s", strerror(errno));
2345 /* Bind it to the name. */
2346 memset(&sunaddr, 0, sizeof(sunaddr));
2347 sunaddr.sun_family = AF_UNIX;
2348 strncpy(sunaddr.sun_path, channel_forwarded_auth_socket_name,
2349 sizeof(sunaddr.sun_path));
2351 if (bind(sock, (struct sockaddr *) & sunaddr, sizeof(sunaddr)) < 0)
2352 packet_disconnect("bind: %.100s", strerror(errno));
2354 /* Restore the privileged uid. */
2357 /* Start listening on the socket. */
2358 if (listen(sock, 5) < 0)
2359 packet_disconnect("listen: %.100s", strerror(errno));
2361 /* Allocate a channel for the authentication agent socket. */
2362 newch = channel_new("auth socket",
2363 SSH_CHANNEL_AUTH_SOCKET, sock, sock, -1,
2364 CHAN_X11_WINDOW_DEFAULT, CHAN_X11_PACKET_DEFAULT,
2365 0, xstrdup("auth socket"), 1);
2367 strlcpy(channels[newch].path, channel_forwarded_auth_socket_name,
2368 sizeof(channels[newch].path));
2372 /* This is called to process an SSH_SMSG_AGENT_OPEN message. */
2375 auth_input_open_request(int type, int plen, void *ctxt)
2377 int remch, sock, newch;
2380 packet_integrity_check(plen, 4, type);
2382 /* Read the remote channel number from the message. */
2383 remch = packet_get_int();
2386 * Get a connection to the local authentication agent (this may again
2389 sock = ssh_get_authentication_socket();
2392 * If we could not connect the agent, send an error message back to
2393 * the server. This should never happen unless the agent dies,
2394 * because authentication forwarding is only enabled if we have an
2398 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
2399 packet_put_int(remch);
2403 debug("Forwarding authentication connection.");
2406 * Dummy host name. This will be freed when the channel is freed; it
2407 * will still be valid in the packet_put_string below since the
2408 * channel cannot yet be freed at that point.
2410 dummyname = xstrdup("authentication agent connection");
2412 newch = channel_allocate(SSH_CHANNEL_OPEN, sock, dummyname);
2413 channels[newch].remote_id = remch;
2415 /* Send a confirmation to the remote host. */
2416 packet_start(SSH_MSG_CHANNEL_OPEN_CONFIRMATION);
2417 packet_put_int(remch);
2418 packet_put_int(newch);
2423 channel_start_open(int id)
2425 Channel *c = channel_lookup(id);
2427 log("channel_open: %d: bad id", id);
2430 debug("send channel open %d", id);
2431 packet_start(SSH2_MSG_CHANNEL_OPEN);
2432 packet_put_cstring(c->ctype);
2433 packet_put_int(c->self);
2434 packet_put_int(c->local_window);
2435 packet_put_int(c->local_maxpacket);
2438 channel_open(int id)
2441 channel_start_open(id);
2445 channel_request(int id, char *service, int wantconfirm)
2447 channel_request_start(id, service, wantconfirm);
2449 debug("channel request %d: %s", id, service) ;
2452 channel_request_start(int id, char *service, int wantconfirm)
2454 Channel *c = channel_lookup(id);
2456 log("channel_request: %d: bad id", id);
2459 packet_start(SSH2_MSG_CHANNEL_REQUEST);
2460 packet_put_int(c->remote_id);
2461 packet_put_cstring(service);
2462 packet_put_char(wantconfirm);
2465 channel_register_callback(int id, int mtype, channel_callback_fn *fn, void *arg)
2467 Channel *c = channel_lookup(id);
2469 log("channel_register_callback: %d: bad id", id);
2472 c->cb_event = mtype;
2477 channel_register_cleanup(int id, channel_callback_fn *fn)
2479 Channel *c = channel_lookup(id);
2481 log("channel_register_cleanup: %d: bad id", id);
2484 c->dettach_user = fn;
2487 channel_cancel_cleanup(int id)
2489 Channel *c = channel_lookup(id);
2491 log("channel_cancel_cleanup: %d: bad id", id);
2494 c->dettach_user = NULL;
2497 channel_register_filter(int id, channel_filter_fn *fn)
2499 Channel *c = channel_lookup(id);
2501 log("channel_register_filter: %d: bad id", id);
2504 c->input_filter = fn;
2508 channel_set_fds(int id, int rfd, int wfd, int efd,
2509 int extusage, int nonblock)
2511 Channel *c = channel_lookup(id);
2512 if (c == NULL || c->type != SSH_CHANNEL_LARVAL)
2513 fatal("channel_activate for non-larval channel %d.", id);
2514 channel_register_fds(c, rfd, wfd, efd, extusage, nonblock);
2515 c->type = SSH_CHANNEL_OPEN;
2516 /* XXX window size? */
2517 c->local_window = c->local_window_max = c->local_maxpacket * 2;
2518 packet_start(SSH2_MSG_CHANNEL_WINDOW_ADJUST);
2519 packet_put_int(c->remote_id);
2520 packet_put_int(c->local_window);