]> andersk Git - openssh.git/blame - channels.c
- stevesk@cvs.openbsd.org 2001/12/06 18:20:32
[openssh.git] / channels.c
CommitLineData
8efc0c15 1/*
5260325f 2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
5260325f 3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
5260325f 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.
6ae2364d 8 *
bcbf86ec 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".
14 *
7e7327a1 15 * SSH2 support added by Markus Friedl.
a96070d4 16 * Copyright (c) 1999, 2000, 2001 Markus Friedl. All rights reserved.
bcbf86ec 17 * Copyright (c) 1999 Dug Song. All rights reserved.
18 * Copyright (c) 1999 Theo de Raadt. All rights reserved.
19 *
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
22 * are met:
23 * 1. Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
25 * 2. Redistributions in binary form must reproduce the above copyright
26 * notice, this list of conditions and the following disclaimer in the
27 * documentation and/or other materials provided with the distribution.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
30 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
31 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
32 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
33 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
34 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
38 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
5260325f 39 */
8efc0c15 40
41#include "includes.h"
d24631c9 42RCSID("$OpenBSD: channels.c,v 1.146 2001/12/06 18:20:32 stevesk Exp $");
8efc0c15 43
44#include "ssh.h"
42f11eb2 45#include "ssh1.h"
46#include "ssh2.h"
8efc0c15 47#include "packet.h"
48#include "xmalloc.h"
8efc0c15 49#include "uidswap.h"
42f11eb2 50#include "log.h"
51#include "misc.h"
8efc0c15 52#include "channels.h"
8efc0c15 53#include "compat.h"
42f11eb2 54#include "canohost.h"
4c8722d9 55#include "key.h"
56#include "authfd.h"
7e7327a1 57
8efc0c15 58
8e7895b8 59/* -- channel core */
8efc0c15 60
aa3378df 61/*
62 * Pointer to an array containing all allocated channels. The array is
63 * dynamically extended as needed.
64 */
719fc62f 65static Channel **channels = NULL;
8efc0c15 66
aa3378df 67/*
68 * Size of the channel array. All slots of the array must always be
719fc62f 69 * initialized (at least the type field); unused slots set to NULL
aa3378df 70 */
8efc0c15 71static int channels_alloc = 0;
72
aa3378df 73/*
74 * Maximum file descriptor value used in any of the channels. This is
719fc62f 75 * updated in channel_new.
aa3378df 76 */
39929cdb 77static int channel_max_fd = 0;
8efc0c15 78
8efc0c15 79
8e7895b8 80/* -- tcp forwarding */
8efc0c15 81
aa3378df 82/*
83 * Data structure for storing which hosts are permitted for forward requests.
84 * The local sides of any remote forwards are stored in this array to prevent
85 * a corrupt remote server from accessing arbitrary TCP/IP ports on our local
86 * network (which might be behind a firewall).
87 */
5260325f 88typedef struct {
7368a6c8 89 char *host_to_connect; /* Connect to 'host'. */
90 u_short port_to_connect; /* Connect to 'port'. */
91 u_short listen_port; /* Remote side should listen port number. */
8efc0c15 92} ForwardPermission;
93
94/* List of all permitted host/port pairs to connect. */
95static ForwardPermission permitted_opens[SSH_MAX_FORWARDS_PER_DIRECTION];
8e7895b8 96
8efc0c15 97/* Number of permitted host/port pairs in the array. */
98static int num_permitted_opens = 0;
aa3378df 99/*
100 * If this is true, all opens are permitted. This is the case on the server
101 * on which we have to trust the client anyway, and the user could do
102 * anything after logging in anyway.
103 */
8efc0c15 104static int all_opens_permitted = 0;
105
8efc0c15 106
8e7895b8 107/* -- X11 forwarding */
42f11eb2 108
8e7895b8 109/* Maximum number of fake X11 displays to try. */
110#define MAX_DISPLAYS 1000
0490e609 111
8e7895b8 112/* Saved X11 authentication protocol name. */
113static char *x11_saved_proto = NULL;
8efc0c15 114
8e7895b8 115/* Saved X11 authentication data. This is the real data. */
116static char *x11_saved_data = NULL;
117static u_int x11_saved_data_len = 0;
118
119/*
120 * Fake X11 authentication data. This is what the server will be sending us;
121 * we should replace any occurrences of this by the real data.
122 */
123static char *x11_fake_data = NULL;
124static u_int x11_fake_data_len;
125
126
127/* -- agent forwarding */
8efc0c15 128
8e7895b8 129#define NUM_SOCKS 10
130
131/* Name and directory of socket for authentication agent forwarding. */
132static char *auth_sock_name = NULL;
133static char *auth_sock_dir = NULL;
134
8e7895b8 135/* AF_UNSPEC or AF_INET or AF_INET6 */
5e4a7219 136static int IPv4or6 = AF_UNSPEC;
8e7895b8 137
138/* helper */
396c147e 139static void port_open_helper(Channel *c, char *rtype);
8e7895b8 140
141/* -- channel core */
7368a6c8 142
143Channel *
144channel_lookup(int id)
145{
146 Channel *c;
719fc62f 147
3e98362e 148 if (id < 0 || id > channels_alloc) {
7368a6c8 149 log("channel_lookup: %d: bad id", id);
150 return NULL;
151 }
719fc62f 152 c = channels[id];
153 if (c == NULL) {
7368a6c8 154 log("channel_lookup: %d: bad id: channel free", id);
155 return NULL;
156 }
157 return c;
158}
159
aa3378df 160/*
1d1ffb87 161 * Register filedescriptors for a channel, used when allocating a channel or
0fbe8c74 162 * when the channel consumer/producer is ready, e.g. shell exec'd
aa3378df 163 */
8efc0c15 164
396c147e 165static void
a22aff1f 166channel_register_fds(Channel *c, int rfd, int wfd, int efd,
167 int extusage, int nonblock)
8efc0c15 168{
5260325f 169 /* Update the maximum file descriptor value. */
39929cdb 170 channel_max_fd = MAX(channel_max_fd, rfd);
171 channel_max_fd = MAX(channel_max_fd, wfd);
172 channel_max_fd = MAX(channel_max_fd, efd);
173
aa3378df 174 /* XXX set close-on-exec -markus */
1d1ffb87 175
0fbe8c74 176 c->rfd = rfd;
177 c->wfd = wfd;
178 c->sock = (rfd == wfd) ? rfd : -1;
179 c->efd = efd;
180 c->extended_usage = extusage;
a22aff1f 181
0ae4fe1d 182 /* XXX ugly hack: nonblock is only set by the server */
183 if (nonblock && isatty(c->rfd)) {
94dfb550 184 debug("channel %d: rfd %d isatty", c->self, c->rfd);
0ae4fe1d 185 c->isatty = 1;
186 if (!isatty(c->wfd)) {
94dfb550 187 error("channel %d: wfd %d is not a tty?",
0ae4fe1d 188 c->self, c->wfd);
189 }
190 } else {
191 c->isatty = 0;
192 }
193
a22aff1f 194 /* enable nonblocking mode */
195 if (nonblock) {
196 if (rfd != -1)
197 set_nonblock(rfd);
198 if (wfd != -1)
199 set_nonblock(wfd);
200 if (efd != -1)
201 set_nonblock(efd);
202 }
0fbe8c74 203}
204
205/*
206 * Allocate a new channel object and set its type and socket. This will cause
207 * remote_name to be freed.
208 */
209
719fc62f 210Channel *
0fbe8c74 211channel_new(char *ctype, int type, int rfd, int wfd, int efd,
a22aff1f 212 int window, int maxpack, int extusage, char *remote_name, int nonblock)
0fbe8c74 213{
214 int i, found;
215 Channel *c;
5260325f 216
217 /* Do initial allocation if this is the first call. */
218 if (channels_alloc == 0) {
7e7327a1 219 chan_init();
5260325f 220 channels_alloc = 10;
719fc62f 221 channels = xmalloc(channels_alloc * sizeof(Channel *));
5260325f 222 for (i = 0; i < channels_alloc; i++)
719fc62f 223 channels[i] = NULL;
d6746a0b 224 fatal_add_cleanup((void (*) (void *)) channel_free_all, NULL);
5260325f 225 }
226 /* Try to find a free slot where to put the new channel. */
227 for (found = -1, i = 0; i < channels_alloc; i++)
719fc62f 228 if (channels[i] == NULL) {
5260325f 229 /* Found a free slot. */
230 found = i;
231 break;
232 }
233 if (found == -1) {
aa3378df 234 /* There are no free slots. Take last+1 slot and expand the array. */
5260325f 235 found = channels_alloc;
236 channels_alloc += 10;
de273eef 237 debug2("channel: expanding %d", channels_alloc);
719fc62f 238 channels = xrealloc(channels, channels_alloc * sizeof(Channel *));
5260325f 239 for (i = found; i < channels_alloc; i++)
719fc62f 240 channels[i] = NULL;
5260325f 241 }
719fc62f 242 /* Initialize and return new channel. */
243 c = channels[found] = xmalloc(sizeof(Channel));
639cb8ab 244 memset(c, 0, sizeof(Channel));
5260325f 245 buffer_init(&c->input);
246 buffer_init(&c->output);
7368a6c8 247 buffer_init(&c->extended);
5260325f 248 chan_init_iostates(c);
a22aff1f 249 channel_register_fds(c, rfd, wfd, efd, extusage, nonblock);
5260325f 250 c->self = found;
251 c->type = type;
7368a6c8 252 c->ctype = ctype;
0b242b12 253 c->local_window = window;
254 c->local_window_max = window;
255 c->local_consumed = 0;
256 c->local_maxpacket = maxpack;
5260325f 257 c->remote_id = -1;
258 c->remote_name = remote_name;
7368a6c8 259 c->remote_window = 0;
260 c->remote_maxpacket = 0;
261 c->cb_fn = NULL;
262 c->cb_arg = NULL;
263 c->cb_event = 0;
a5f82435 264 c->force_drain = 0;
3cf2be58 265 c->detach_user = NULL;
2e73a022 266 c->input_filter = NULL;
5260325f 267 debug("channel %d: new [%s]", found, remote_name);
719fc62f 268 return c;
7368a6c8 269}
8efc0c15 270
489aa2e9 271static int
272channel_find_maxfd(void)
273{
274 int i, max = 0;
275 Channel *c;
276
277 for (i = 0; i < channels_alloc; i++) {
278 c = channels[i];
279 if (c != NULL) {
280 max = MAX(max, c->rfd);
281 max = MAX(max, c->wfd);
282 max = MAX(max, c->efd);
283 }
284 }
285 return max;
286}
287
288int
289channel_close_fd(int *fdp)
290{
291 int ret = 0, fd = *fdp;
292
293 if (fd != -1) {
294 ret = close(fd);
295 *fdp = -1;
296 if (fd == channel_max_fd)
297 channel_max_fd = channel_find_maxfd();
298 }
299 return ret;
300}
301
0fbe8c74 302/* Close all channel fd/socket. */
303
396c147e 304static void
0fbe8c74 305channel_close_fds(Channel *c)
306{
6fd8622b 307 debug3("channel_close_fds: channel %d: r %d w %d e %d",
308 c->self, c->rfd, c->wfd, c->efd);
309
489aa2e9 310 channel_close_fd(&c->sock);
311 channel_close_fd(&c->rfd);
312 channel_close_fd(&c->wfd);
313 channel_close_fd(&c->efd);
0fbe8c74 314}
315
8e7895b8 316/* Free the channel and close its fd/socket. */
317
318void
319channel_free(Channel *c)
320{
321 char *s;
322 int i, n;
323
324 for (n = 0, i = 0; i < channels_alloc; i++)
325 if (channels[i])
326 n++;
327 debug("channel_free: channel %d: %s, nchannels %d", c->self,
328 c->remote_name ? c->remote_name : "???", n);
329
330 s = channel_open_message();
331 debug3("channel_free: status: %s", s);
332 xfree(s);
333
8e7895b8 334 if (c->sock != -1)
335 shutdown(c->sock, SHUT_RDWR);
336 channel_close_fds(c);
337 buffer_free(&c->input);
338 buffer_free(&c->output);
339 buffer_free(&c->extended);
340 if (c->remote_name) {
341 xfree(c->remote_name);
342 c->remote_name = NULL;
343 }
344 channels[c->self] = NULL;
345 xfree(c);
346}
347
8e7895b8 348void
d6746a0b 349channel_free_all(void)
8e7895b8 350{
351 int i;
8e7895b8 352
d6746a0b 353 for (i = 0; i < channels_alloc; i++)
354 if (channels[i] != NULL)
355 channel_free(channels[i]);
8e7895b8 356}
357
358/*
359 * Closes the sockets/fds of all channels. This is used to close extra file
360 * descriptors after a fork.
361 */
362
363void
d5bb9418 364channel_close_all(void)
8e7895b8 365{
366 int i;
367
368 for (i = 0; i < channels_alloc; i++)
369 if (channels[i] != NULL)
370 channel_close_fds(channels[i]);
371}
372
3cf2be58 373/*
374 * Stop listening to channels.
375 */
376
377void
378channel_stop_listening(void)
379{
380 int i;
381 Channel *c;
382
383 for (i = 0; i < channels_alloc; i++) {
384 c = channels[i];
385 if (c != NULL) {
386 switch (c->type) {
387 case SSH_CHANNEL_AUTH_SOCKET:
388 case SSH_CHANNEL_PORT_LISTENER:
389 case SSH_CHANNEL_RPORT_LISTENER:
390 case SSH_CHANNEL_X11_LISTENER:
489aa2e9 391 channel_close_fd(&c->sock);
3cf2be58 392 channel_free(c);
393 break;
394 }
395 }
396 }
397}
398
8e7895b8 399/*
400 * Returns true if no channel has too much buffered data, and false if one or
401 * more channel is overfull.
402 */
403
404int
d5bb9418 405channel_not_very_much_buffered_data(void)
8e7895b8 406{
407 u_int i;
408 Channel *c;
409
410 for (i = 0; i < channels_alloc; i++) {
411 c = channels[i];
412 if (c != NULL && c->type == SSH_CHANNEL_OPEN) {
0c139bd1 413#if 0
414 if (!compat20 &&
415 buffer_len(&c->input) > packet_get_maxsize()) {
8e7895b8 416 debug("channel %d: big input buffer %d",
417 c->self, buffer_len(&c->input));
418 return 0;
419 }
0c139bd1 420#endif
8e7895b8 421 if (buffer_len(&c->output) > packet_get_maxsize()) {
0c139bd1 422 debug("channel %d: big output buffer %d > %d",
423 c->self, buffer_len(&c->output),
424 packet_get_maxsize());
8e7895b8 425 return 0;
426 }
427 }
428 }
429 return 1;
430}
431
432/* Returns true if any channel is still open. */
433
434int
d5bb9418 435channel_still_open(void)
8e7895b8 436{
437 int i;
438 Channel *c;
439
440 for (i = 0; i < channels_alloc; i++) {
441 c = channels[i];
442 if (c == NULL)
443 continue;
444 switch (c->type) {
445 case SSH_CHANNEL_X11_LISTENER:
446 case SSH_CHANNEL_PORT_LISTENER:
447 case SSH_CHANNEL_RPORT_LISTENER:
448 case SSH_CHANNEL_CLOSED:
449 case SSH_CHANNEL_AUTH_SOCKET:
450 case SSH_CHANNEL_DYNAMIC:
451 case SSH_CHANNEL_CONNECTING:
452 case SSH_CHANNEL_ZOMBIE:
453 continue;
454 case SSH_CHANNEL_LARVAL:
455 if (!compat20)
456 fatal("cannot happen: SSH_CHANNEL_LARVAL");
457 continue;
458 case SSH_CHANNEL_OPENING:
459 case SSH_CHANNEL_OPEN:
460 case SSH_CHANNEL_X11_OPEN:
461 return 1;
462 case SSH_CHANNEL_INPUT_DRAINING:
463 case SSH_CHANNEL_OUTPUT_DRAINING:
464 if (!compat13)
465 fatal("cannot happen: OUT_DRAIN");
466 return 1;
467 default:
468 fatal("channel_still_open: bad channel type %d", c->type);
469 /* NOTREACHED */
470 }
471 }
472 return 0;
473}
474
475/* Returns the id of an open channel suitable for keepaliving */
476
477int
d5bb9418 478channel_find_open(void)
8e7895b8 479{
480 int i;
481 Channel *c;
482
483 for (i = 0; i < channels_alloc; i++) {
484 c = channels[i];
485 if (c == NULL)
486 continue;
487 switch (c->type) {
488 case SSH_CHANNEL_CLOSED:
489 case SSH_CHANNEL_DYNAMIC:
490 case SSH_CHANNEL_X11_LISTENER:
491 case SSH_CHANNEL_PORT_LISTENER:
492 case SSH_CHANNEL_RPORT_LISTENER:
493 case SSH_CHANNEL_OPENING:
494 case SSH_CHANNEL_CONNECTING:
495 case SSH_CHANNEL_ZOMBIE:
496 continue;
497 case SSH_CHANNEL_LARVAL:
498 case SSH_CHANNEL_AUTH_SOCKET:
499 case SSH_CHANNEL_OPEN:
500 case SSH_CHANNEL_X11_OPEN:
501 return i;
502 case SSH_CHANNEL_INPUT_DRAINING:
503 case SSH_CHANNEL_OUTPUT_DRAINING:
504 if (!compat13)
505 fatal("cannot happen: OUT_DRAIN");
506 return i;
507 default:
508 fatal("channel_find_open: bad channel type %d", c->type);
509 /* NOTREACHED */
510 }
511 }
512 return -1;
513}
514
515
516/*
517 * Returns a message describing the currently open forwarded connections,
518 * suitable for sending to the client. The message contains crlf pairs for
519 * newlines.
520 */
521
522char *
d5bb9418 523channel_open_message(void)
8e7895b8 524{
525 Buffer buffer;
526 Channel *c;
527 char buf[1024], *cp;
528 int i;
529
530 buffer_init(&buffer);
531 snprintf(buf, sizeof buf, "The following connections are open:\r\n");
532 buffer_append(&buffer, buf, strlen(buf));
533 for (i = 0; i < channels_alloc; i++) {
534 c = channels[i];
535 if (c == NULL)
536 continue;
537 switch (c->type) {
538 case SSH_CHANNEL_X11_LISTENER:
539 case SSH_CHANNEL_PORT_LISTENER:
540 case SSH_CHANNEL_RPORT_LISTENER:
541 case SSH_CHANNEL_CLOSED:
542 case SSH_CHANNEL_AUTH_SOCKET:
543 case SSH_CHANNEL_ZOMBIE:
544 continue;
545 case SSH_CHANNEL_LARVAL:
546 case SSH_CHANNEL_OPENING:
547 case SSH_CHANNEL_CONNECTING:
548 case SSH_CHANNEL_DYNAMIC:
549 case SSH_CHANNEL_OPEN:
550 case SSH_CHANNEL_X11_OPEN:
551 case SSH_CHANNEL_INPUT_DRAINING:
552 case SSH_CHANNEL_OUTPUT_DRAINING:
553 snprintf(buf, sizeof buf, " #%d %.300s (t%d r%d i%d/%d o%d/%d fd %d/%d)\r\n",
554 c->self, c->remote_name,
555 c->type, c->remote_id,
556 c->istate, buffer_len(&c->input),
557 c->ostate, buffer_len(&c->output),
558 c->rfd, c->wfd);
559 buffer_append(&buffer, buf, strlen(buf));
560 continue;
561 default:
562 fatal("channel_open_message: bad channel type %d", c->type);
563 /* NOTREACHED */
564 }
565 }
566 buffer_append(&buffer, "\0", 1);
567 cp = xstrdup(buffer_ptr(&buffer));
568 buffer_free(&buffer);
569 return cp;
570}
571
572void
573channel_send_open(int id)
574{
575 Channel *c = channel_lookup(id);
576 if (c == NULL) {
577 log("channel_send_open: %d: bad id", id);
578 return;
579 }
580 debug("send channel open %d", id);
581 packet_start(SSH2_MSG_CHANNEL_OPEN);
582 packet_put_cstring(c->ctype);
583 packet_put_int(c->self);
584 packet_put_int(c->local_window);
585 packet_put_int(c->local_maxpacket);
586 packet_send();
587}
588
589void
590channel_request(int id, char *service, int wantconfirm)
591{
592 channel_request_start(id, service, wantconfirm);
593 packet_send();
594 debug("channel request %d: %s", id, service) ;
595}
596void
597channel_request_start(int id, char *service, int wantconfirm)
598{
599 Channel *c = channel_lookup(id);
600 if (c == NULL) {
601 log("channel_request: %d: bad id", id);
602 return;
603 }
604 packet_start(SSH2_MSG_CHANNEL_REQUEST);
605 packet_put_int(c->remote_id);
606 packet_put_cstring(service);
607 packet_put_char(wantconfirm);
608}
609void
610channel_register_callback(int id, int mtype, channel_callback_fn *fn, void *arg)
611{
612 Channel *c = channel_lookup(id);
613 if (c == NULL) {
614 log("channel_register_callback: %d: bad id", id);
615 return;
616 }
617 c->cb_event = mtype;
618 c->cb_fn = fn;
619 c->cb_arg = arg;
620}
621void
622channel_register_cleanup(int id, channel_callback_fn *fn)
623{
624 Channel *c = channel_lookup(id);
625 if (c == NULL) {
626 log("channel_register_cleanup: %d: bad id", id);
627 return;
628 }
3cf2be58 629 c->detach_user = fn;
8e7895b8 630}
631void
632channel_cancel_cleanup(int id)
633{
634 Channel *c = channel_lookup(id);
635 if (c == NULL) {
636 log("channel_cancel_cleanup: %d: bad id", id);
637 return;
638 }
3cf2be58 639 c->detach_user = NULL;
8e7895b8 640}
641void
642channel_register_filter(int id, channel_filter_fn *fn)
643{
644 Channel *c = channel_lookup(id);
645 if (c == NULL) {
646 log("channel_register_filter: %d: bad id", id);
647 return;
648 }
649 c->input_filter = fn;
650}
651
6ae2364d 652void
8e7895b8 653channel_set_fds(int id, int rfd, int wfd, int efd,
654 int extusage, int nonblock)
8efc0c15 655{
8e7895b8 656 Channel *c = channel_lookup(id);
657 if (c == NULL || c->type != SSH_CHANNEL_LARVAL)
658 fatal("channel_activate for non-larval channel %d.", id);
659 channel_register_fds(c, rfd, wfd, efd, extusage, nonblock);
660 c->type = SSH_CHANNEL_OPEN;
661 /* XXX window size? */
662 c->local_window = c->local_window_max = c->local_maxpacket * 2;
663 packet_start(SSH2_MSG_CHANNEL_WINDOW_ADJUST);
664 packet_put_int(c->remote_id);
665 packet_put_int(c->local_window);
666 packet_send();
8efc0c15 667}
668
aa3378df 669/*
7368a6c8 670 * 'channel_pre*' are called just before select() to add any bits relevant to
671 * channels in the select bitmasks.
aa3378df 672 */
7368a6c8 673/*
674 * 'channel_post*': perform any appropriate operations for channels which
675 * have events pending.
676 */
677typedef void chan_fn(Channel *c, fd_set * readset, fd_set * writeset);
678chan_fn *channel_pre[SSH_CHANNEL_MAX_TYPE];
679chan_fn *channel_post[SSH_CHANNEL_MAX_TYPE];
8efc0c15 680
396c147e 681static void
7368a6c8 682channel_pre_listener(Channel *c, fd_set * readset, fd_set * writeset)
8efc0c15 683{
7368a6c8 684 FD_SET(c->sock, readset);
685}
5260325f 686
396c147e 687static void
97fb6912 688channel_pre_connecting(Channel *c, fd_set * readset, fd_set * writeset)
689{
690 debug3("channel %d: waiting for connection", c->self);
691 FD_SET(c->sock, writeset);
692}
693
396c147e 694static void
7368a6c8 695channel_pre_open_13(Channel *c, fd_set * readset, fd_set * writeset)
696{
697 if (buffer_len(&c->input) < packet_get_maxsize())
698 FD_SET(c->sock, readset);
699 if (buffer_len(&c->output) > 0)
700 FD_SET(c->sock, writeset);
701}
5260325f 702
396c147e 703static void
7368a6c8 704channel_pre_open_15(Channel *c, fd_set * readset, fd_set * writeset)
705{
706 /* test whether sockets are 'alive' for read/write */
707 if (c->istate == CHAN_INPUT_OPEN)
708 if (buffer_len(&c->input) < packet_get_maxsize())
709 FD_SET(c->sock, readset);
710 if (c->ostate == CHAN_OUTPUT_OPEN ||
711 c->ostate == CHAN_OUTPUT_WAIT_DRAIN) {
712 if (buffer_len(&c->output) > 0) {
713 FD_SET(c->sock, writeset);
714 } else if (c->ostate == CHAN_OUTPUT_WAIT_DRAIN) {
715 chan_obuf_empty(c);
716 }
717 }
718}
5260325f 719
396c147e 720static void
7e7327a1 721channel_pre_open_20(Channel *c, fd_set * readset, fd_set * writeset)
722{
723 if (c->istate == CHAN_INPUT_OPEN &&
724 c->remote_window > 0 &&
725 buffer_len(&c->input) < c->remote_window)
726 FD_SET(c->rfd, readset);
727 if (c->ostate == CHAN_OUTPUT_OPEN ||
728 c->ostate == CHAN_OUTPUT_WAIT_DRAIN) {
729 if (buffer_len(&c->output) > 0) {
730 FD_SET(c->wfd, writeset);
731 } else if (c->ostate == CHAN_OUTPUT_WAIT_DRAIN) {
732 chan_obuf_empty(c);
733 }
734 }
735 /** XXX check close conditions, too */
736 if (c->efd != -1) {
737 if (c->extended_usage == CHAN_EXTENDED_WRITE &&
738 buffer_len(&c->extended) > 0)
739 FD_SET(c->efd, writeset);
740 else if (c->extended_usage == CHAN_EXTENDED_READ &&
741 buffer_len(&c->extended) < c->remote_window)
742 FD_SET(c->efd, readset);
743 }
744}
745
396c147e 746static void
7368a6c8 747channel_pre_input_draining(Channel *c, fd_set * readset, fd_set * writeset)
748{
749 if (buffer_len(&c->input) == 0) {
750 packet_start(SSH_MSG_CHANNEL_CLOSE);
751 packet_put_int(c->remote_id);
752 packet_send();
753 c->type = SSH_CHANNEL_CLOSED;
070adba2 754 debug("channel %d: closing after input drain.", c->self);
7368a6c8 755 }
756}
5260325f 757
396c147e 758static void
7368a6c8 759channel_pre_output_draining(Channel *c, fd_set * readset, fd_set * writeset)
760{
761 if (buffer_len(&c->output) == 0)
719fc62f 762 chan_mark_dead(c);
6ae2364d 763 else
7368a6c8 764 FD_SET(c->sock, writeset);
765}
5260325f 766
7368a6c8 767/*
768 * This is a special state for X11 authentication spoofing. An opened X11
769 * connection (when authentication spoofing is being done) remains in this
770 * state until the first packet has been completely read. The authentication
771 * data in that packet is then substituted by the real data if it matches the
772 * fake data, and the channel is put into normal mode.
0b242b12 773 * XXX All this happens at the client side.
8e7895b8 774 * Returns: 0 = need more data, -1 = wrong cookie, 1 = ok
7368a6c8 775 */
396c147e 776static int
8e7895b8 777x11_open_helper(Buffer *b)
7368a6c8 778{
1e3b8b07 779 u_char *ucp;
780 u_int proto_len, data_len;
5260325f 781
7368a6c8 782 /* Check if the fixed size part of the packet is in buffer. */
8e7895b8 783 if (buffer_len(b) < 12)
7368a6c8 784 return 0;
785
786 /* Parse the lengths of variable-length fields. */
8e7895b8 787 ucp = (u_char *) buffer_ptr(b);
7368a6c8 788 if (ucp[0] == 0x42) { /* Byte order MSB first. */
789 proto_len = 256 * ucp[6] + ucp[7];
790 data_len = 256 * ucp[8] + ucp[9];
791 } else if (ucp[0] == 0x6c) { /* Byte order LSB first. */
792 proto_len = ucp[6] + 256 * ucp[7];
793 data_len = ucp[8] + 256 * ucp[9];
794 } else {
795 debug("Initial X11 packet contains bad byte order byte: 0x%x",
796 ucp[0]);
797 return -1;
798 }
5260325f 799
7368a6c8 800 /* Check if the whole packet is in buffer. */
8e7895b8 801 if (buffer_len(b) <
7368a6c8 802 12 + ((proto_len + 3) & ~3) + ((data_len + 3) & ~3))
803 return 0;
5260325f 804
7368a6c8 805 /* Check if authentication protocol matches. */
806 if (proto_len != strlen(x11_saved_proto) ||
807 memcmp(ucp + 12, x11_saved_proto, proto_len) != 0) {
808 debug("X11 connection uses different authentication protocol.");
809 return -1;
810 }
811 /* Check if authentication data matches our fake data. */
812 if (data_len != x11_fake_data_len ||
813 memcmp(ucp + 12 + ((proto_len + 3) & ~3),
814 x11_fake_data, x11_fake_data_len) != 0) {
815 debug("X11 auth data does not match fake data.");
816 return -1;
817 }
818 /* Check fake data length */
819 if (x11_fake_data_len != x11_saved_data_len) {
820 error("X11 fake_data_len %d != saved_data_len %d",
821 x11_fake_data_len, x11_saved_data_len);
822 return -1;
823 }
824 /*
825 * Received authentication protocol and data match
826 * our fake data. Substitute the fake data with real
827 * data.
828 */
829 memcpy(ucp + 12 + ((proto_len + 3) & ~3),
830 x11_saved_data, x11_saved_data_len);
831 return 1;
832}
5260325f 833
396c147e 834static void
7368a6c8 835channel_pre_x11_open_13(Channel *c, fd_set * readset, fd_set * writeset)
836{
8e7895b8 837 int ret = x11_open_helper(&c->output);
7368a6c8 838 if (ret == 1) {
839 /* Start normal processing for the channel. */
840 c->type = SSH_CHANNEL_OPEN;
a8be9f80 841 channel_pre_open_13(c, readset, writeset);
7368a6c8 842 } else if (ret == -1) {
843 /*
844 * We have received an X11 connection that has bad
845 * authentication information.
846 */
54b974dc 847 log("X11 connection rejected because of wrong authentication.");
7368a6c8 848 buffer_clear(&c->input);
849 buffer_clear(&c->output);
489aa2e9 850 channel_close_fd(&c->sock);
7368a6c8 851 c->sock = -1;
852 c->type = SSH_CHANNEL_CLOSED;
853 packet_start(SSH_MSG_CHANNEL_CLOSE);
854 packet_put_int(c->remote_id);
855 packet_send();
856 }
857}
5260325f 858
396c147e 859static void
0b242b12 860channel_pre_x11_open(Channel *c, fd_set * readset, fd_set * writeset)
7368a6c8 861{
8e7895b8 862 int ret = x11_open_helper(&c->output);
a5f82435 863
864 /* c->force_drain = 1; */
865
7368a6c8 866 if (ret == 1) {
867 c->type = SSH_CHANNEL_OPEN;
d0c832f3 868 if (compat20)
869 channel_pre_open_20(c, readset, writeset);
870 else
871 channel_pre_open_15(c, readset, writeset);
7368a6c8 872 } else if (ret == -1) {
873 debug("X11 rejected %d i%d/o%d", c->self, c->istate, c->ostate);
0b242b12 874 chan_read_failed(c); /** force close? */
7368a6c8 875 chan_write_failed(c);
876 debug("X11 closed %d i%d/o%d", c->self, c->istate, c->ostate);
877 }
878}
5260325f 879
28b9cb4d 880/* try to decode a socks4 header */
396c147e 881static int
28b9cb4d 882channel_decode_socks4(Channel *c, fd_set * readset, fd_set * writeset)
0490e609 883{
884 u_char *p, *host;
53b8fe68 885 int len, have, i, found;
28b9cb4d 886 char username[256];
0490e609 887 struct {
888 u_int8_t version;
889 u_int8_t command;
890 u_int16_t dest_port;
28b9cb4d 891 struct in_addr dest_addr;
0490e609 892 } s4_req, s4_rsp;
893
28b9cb4d 894 debug2("channel %d: decode socks4", c->self);
53b8fe68 895
896 have = buffer_len(&c->input);
897 len = sizeof(s4_req);
898 if (have < len)
899 return 0;
900 p = buffer_ptr(&c->input);
901 for (found = 0, i = len; i < have; i++) {
902 if (p[i] == '\0') {
903 found = 1;
904 break;
905 }
906 if (i > 1024) {
907 /* the peer is probably sending garbage */
908 debug("channel %d: decode socks4: too long",
909 c->self);
910 return -1;
911 }
912 }
913 if (!found)
914 return 0;
0490e609 915 buffer_get(&c->input, (char *)&s4_req.version, 1);
916 buffer_get(&c->input, (char *)&s4_req.command, 1);
917 buffer_get(&c->input, (char *)&s4_req.dest_port, 2);
28b9cb4d 918 buffer_get(&c->input, (char *)&s4_req.dest_addr, 4);
53b8fe68 919 have = buffer_len(&c->input);
0490e609 920 p = buffer_ptr(&c->input);
921 len = strlen(p);
6683b40f 922 debug2("channel %d: decode socks4: user %s/%d", c->self, p, len);
0490e609 923 if (len > have)
28b9cb4d 924 fatal("channel %d: decode socks4: len %d > have %d",
0490e609 925 c->self, len, have);
926 strlcpy(username, p, sizeof(username));
927 buffer_consume(&c->input, len);
928 buffer_consume(&c->input, 1); /* trailing '\0' */
929
28b9cb4d 930 host = inet_ntoa(s4_req.dest_addr);
0490e609 931 strlcpy(c->path, host, sizeof(c->path));
932 c->host_port = ntohs(s4_req.dest_port);
933
6683b40f 934 debug("channel %d: dynamic request: socks4 host %s port %u command %u",
935 c->self, host, c->host_port, s4_req.command);
0490e609 936
28b9cb4d 937 if (s4_req.command != 1) {
938 debug("channel %d: cannot handle: socks4 cn %d",
939 c->self, s4_req.command);
940 return -1;
0490e609 941 }
28b9cb4d 942 s4_rsp.version = 0; /* vn: 0 for reply */
943 s4_rsp.command = 90; /* cd: req granted */
0490e609 944 s4_rsp.dest_port = 0; /* ignored */
28b9cb4d 945 s4_rsp.dest_addr.s_addr = INADDR_ANY; /* ignored */
0490e609 946 buffer_append(&c->output, (char *)&s4_rsp, sizeof(s4_rsp));
28b9cb4d 947 return 1;
0490e609 948}
949
28b9cb4d 950/* dynamic port forwarding */
396c147e 951static void
28b9cb4d 952channel_pre_dynamic(Channel *c, fd_set * readset, fd_set * writeset)
953{
954 u_char *p;
955 int have, ret;
956
957 have = buffer_len(&c->input);
639cb8ab 958 c->delayed = 0;
28b9cb4d 959 debug2("channel %d: pre_dynamic: have %d", c->self, have);
070adba2 960 /* buffer_dump(&c->input); */
28b9cb4d 961 /* check if the fixed size part of the packet is in buffer. */
962 if (have < 4) {
963 /* need more */
964 FD_SET(c->sock, readset);
965 return;
966 }
967 /* try to guess the protocol */
968 p = buffer_ptr(&c->input);
969 switch (p[0]) {
6683b40f 970 case 0x04:
971 ret = channel_decode_socks4(c, readset, writeset);
972 break;
28b9cb4d 973 default:
974 ret = -1;
975 break;
976 }
977 if (ret < 0) {
719fc62f 978 chan_mark_dead(c);
28b9cb4d 979 } else if (ret == 0) {
980 debug2("channel %d: pre_dynamic: need more", c->self);
981 /* need more */
982 FD_SET(c->sock, readset);
983 } else {
984 /* switch to the next state */
985 c->type = SSH_CHANNEL_OPENING;
986 port_open_helper(c, "direct-tcpip");
987 }
988}
0490e609 989
7368a6c8 990/* This is our fake X11 server socket. */
396c147e 991static void
7368a6c8 992channel_post_x11_listener(Channel *c, fd_set * readset, fd_set * writeset)
993{
719fc62f 994 Channel *nc;
7368a6c8 995 struct sockaddr addr;
d24631c9 996 int newsock, on = 1;
7368a6c8 997 socklen_t addrlen;
865ac82e 998 char buf[16384], *remote_ipaddr;
0b242b12 999 int remote_port;
7368a6c8 1000
1001 if (FD_ISSET(c->sock, readset)) {
1002 debug("X11 connection requested.");
1003 addrlen = sizeof(addr);
1004 newsock = accept(c->sock, &addr, &addrlen);
1005 if (newsock < 0) {
1006 error("accept: %.100s", strerror(errno));
1007 return;
5260325f 1008 }
d24631c9 1009 if (setsockopt(newsock, IPPROTO_TCP, TCP_NODELAY, &on,
1010 sizeof on) == -1)
1011 error("setsockopt TCP_NODELAY: %.100s",
1012 strerror(errno));
865ac82e 1013 remote_ipaddr = get_peer_ipaddr(newsock);
0b242b12 1014 remote_port = get_peer_port(newsock);
7368a6c8 1015 snprintf(buf, sizeof buf, "X11 connection from %.200s port %d",
865ac82e 1016 remote_ipaddr, remote_port);
0b242b12 1017
719fc62f 1018 nc = channel_new("accepted x11 socket",
0b242b12 1019 SSH_CHANNEL_OPENING, newsock, newsock, -1,
1020 c->local_window_max, c->local_maxpacket,
a22aff1f 1021 0, xstrdup(buf), 1);
719fc62f 1022 if (nc == NULL) {
1023 close(newsock);
1024 xfree(remote_ipaddr);
1025 return;
1026 }
0b242b12 1027 if (compat20) {
1028 packet_start(SSH2_MSG_CHANNEL_OPEN);
1029 packet_put_cstring("x11");
719fc62f 1030 packet_put_int(nc->self);
0b242b12 1031 packet_put_int(c->local_window_max);
1032 packet_put_int(c->local_maxpacket);
865ac82e 1033 /* originator ipaddr and port */
1034 packet_put_cstring(remote_ipaddr);
d0c832f3 1035 if (datafellows & SSH_BUG_X11FWD) {
1036 debug("ssh2 x11 bug compat mode");
1037 } else {
1038 packet_put_int(remote_port);
1039 }
0b242b12 1040 packet_send();
1041 } else {
1042 packet_start(SSH_SMSG_X11_OPEN);
719fc62f 1043 packet_put_int(nc->self);
8e7895b8 1044 if (packet_get_protocol_flags() &
1045 SSH_PROTOFLAG_HOST_IN_FWD_OPEN)
449c5ba5 1046 packet_put_cstring(buf);
0b242b12 1047 packet_send();
1048 }
865ac82e 1049 xfree(remote_ipaddr);
8efc0c15 1050 }
8efc0c15 1051}
1052
396c147e 1053static void
0490e609 1054port_open_helper(Channel *c, char *rtype)
1055{
1056 int direct;
1057 char buf[1024];
1058 char *remote_ipaddr = get_peer_ipaddr(c->sock);
1059 u_short remote_port = get_peer_port(c->sock);
1060
1061 direct = (strcmp(rtype, "direct-tcpip") == 0);
1062
1063 snprintf(buf, sizeof buf,
1064 "%s: listening port %d for %.100s port %d, "
1065 "connect from %.200s port %d",
1066 rtype, c->listening_port, c->path, c->host_port,
1067 remote_ipaddr, remote_port);
1068
1069 xfree(c->remote_name);
1070 c->remote_name = xstrdup(buf);
1071
1072 if (compat20) {
1073 packet_start(SSH2_MSG_CHANNEL_OPEN);
1074 packet_put_cstring(rtype);
1075 packet_put_int(c->self);
1076 packet_put_int(c->local_window_max);
1077 packet_put_int(c->local_maxpacket);
1078 if (direct) {
1079 /* target host, port */
1080 packet_put_cstring(c->path);
1081 packet_put_int(c->host_port);
1082 } else {
1083 /* listen address, port */
1084 packet_put_cstring(c->path);
1085 packet_put_int(c->listening_port);
1086 }
1087 /* originator host and port */
1088 packet_put_cstring(remote_ipaddr);
1089 packet_put_int(remote_port);
1090 packet_send();
1091 } else {
1092 packet_start(SSH_MSG_PORT_OPEN);
1093 packet_put_int(c->self);
1094 packet_put_cstring(c->path);
1095 packet_put_int(c->host_port);
8e7895b8 1096 if (packet_get_protocol_flags() &
1097 SSH_PROTOFLAG_HOST_IN_FWD_OPEN)
0490e609 1098 packet_put_cstring(c->remote_name);
1099 packet_send();
1100 }
1101 xfree(remote_ipaddr);
1102}
1103
aa3378df 1104/*
7368a6c8 1105 * This socket is listening for connections to a forwarded TCP/IP port.
aa3378df 1106 */
396c147e 1107static void
7368a6c8 1108channel_post_port_listener(Channel *c, fd_set * readset, fd_set * writeset)
1109{
0490e609 1110 Channel *nc;
7368a6c8 1111 struct sockaddr addr;
719fc62f 1112 int newsock, nextstate;
7368a6c8 1113 socklen_t addrlen;
0490e609 1114 char *rtype;
fa08c86b 1115
7368a6c8 1116 if (FD_ISSET(c->sock, readset)) {
1117 debug("Connection to port %d forwarding "
1118 "to %.100s port %d requested.",
1119 c->listening_port, c->path, c->host_port);
0490e609 1120
639cb8ab 1121 if (c->type == SSH_CHANNEL_RPORT_LISTENER) {
1122 nextstate = SSH_CHANNEL_OPENING;
1123 rtype = "forwarded-tcpip";
1124 } else {
1125 if (c->host_port == 0) {
1126 nextstate = SSH_CHANNEL_DYNAMIC;
f3964cb9 1127 rtype = "dynamic-tcpip";
639cb8ab 1128 } else {
1129 nextstate = SSH_CHANNEL_OPENING;
1130 rtype = "direct-tcpip";
1131 }
1132 }
0490e609 1133
7368a6c8 1134 addrlen = sizeof(addr);
1135 newsock = accept(c->sock, &addr, &addrlen);
1136 if (newsock < 0) {
1137 error("accept: %.100s", strerror(errno));
1138 return;
1139 }
719fc62f 1140 nc = channel_new(rtype,
0490e609 1141 nextstate, newsock, newsock, -1,
7368a6c8 1142 c->local_window_max, c->local_maxpacket,
0490e609 1143 0, xstrdup(rtype), 1);
0490e609 1144 if (nc == NULL) {
719fc62f 1145 error("channel_post_port_listener: no new channel:");
1146 close(newsock);
0490e609 1147 return;
7368a6c8 1148 }
0490e609 1149 nc->listening_port = c->listening_port;
1150 nc->host_port = c->host_port;
1151 strlcpy(nc->path, c->path, sizeof(nc->path));
1152
639cb8ab 1153 if (nextstate == SSH_CHANNEL_DYNAMIC) {
1154 /*
1155 * do not call the channel_post handler until
1156 * this flag has been reset by a pre-handler.
1157 * otherwise the FD_ISSET calls might overflow
1158 */
1159 nc->delayed = 1;
1160 } else {
0490e609 1161 port_open_helper(nc, rtype);
639cb8ab 1162 }
7368a6c8 1163 }
1164}
8efc0c15 1165
7368a6c8 1166/*
1167 * This is the authentication agent socket listening for connections from
1168 * clients.
1169 */
396c147e 1170static void
7368a6c8 1171channel_post_auth_listener(Channel *c, fd_set * readset, fd_set * writeset)
8efc0c15 1172{
719fc62f 1173 Channel *nc;
8e7895b8 1174 char *name;
719fc62f 1175 int newsock;
5260325f 1176 struct sockaddr addr;
48e671d5 1177 socklen_t addrlen;
5260325f 1178
7368a6c8 1179 if (FD_ISSET(c->sock, readset)) {
1180 addrlen = sizeof(addr);
1181 newsock = accept(c->sock, &addr, &addrlen);
1182 if (newsock < 0) {
1183 error("accept from auth socket: %.100s", strerror(errno));
1184 return;
1185 }
8e7895b8 1186 name = xstrdup("accepted auth socket");
719fc62f 1187 nc = channel_new("accepted auth socket",
fa08c86b 1188 SSH_CHANNEL_OPENING, newsock, newsock, -1,
1189 c->local_window_max, c->local_maxpacket,
8e7895b8 1190 0, name, 1);
719fc62f 1191 if (nc == NULL) {
1192 error("channel_post_auth_listener: channel_new failed");
8e7895b8 1193 xfree(name);
719fc62f 1194 close(newsock);
1195 }
fa08c86b 1196 if (compat20) {
1197 packet_start(SSH2_MSG_CHANNEL_OPEN);
1198 packet_put_cstring("auth-agent@openssh.com");
719fc62f 1199 packet_put_int(nc->self);
fa08c86b 1200 packet_put_int(c->local_window_max);
1201 packet_put_int(c->local_maxpacket);
1202 } else {
1203 packet_start(SSH_SMSG_AGENT_OPEN);
719fc62f 1204 packet_put_int(nc->self);
fa08c86b 1205 }
7368a6c8 1206 packet_send();
1207 }
1208}
5260325f 1209
396c147e 1210static void
97fb6912 1211channel_post_connecting(Channel *c, fd_set * readset, fd_set * writeset)
1212{
d18e0850 1213 int err = 0;
8ab2cb35 1214 socklen_t sz = sizeof(err);
d18e0850 1215
97fb6912 1216 if (FD_ISSET(c->sock, writeset)) {
d18e0850 1217 if (getsockopt(c->sock, SOL_SOCKET, SO_ERROR, (char *)&err,
1218 &sz) < 0) {
1219 err = errno;
1220 error("getsockopt SO_ERROR failed");
1221 }
1222 if (err == 0) {
1223 debug("channel %d: connected", c->self);
1224 c->type = SSH_CHANNEL_OPEN;
1225 if (compat20) {
1226 packet_start(SSH2_MSG_CHANNEL_OPEN_CONFIRMATION);
1227 packet_put_int(c->remote_id);
1228 packet_put_int(c->self);
1229 packet_put_int(c->local_window);
1230 packet_put_int(c->local_maxpacket);
1231 } else {
1232 packet_start(SSH_MSG_CHANNEL_OPEN_CONFIRMATION);
1233 packet_put_int(c->remote_id);
1234 packet_put_int(c->self);
1235 }
97fb6912 1236 } else {
d18e0850 1237 debug("channel %d: not connected: %s",
1238 c->self, strerror(err));
1239 if (compat20) {
1240 packet_start(SSH2_MSG_CHANNEL_OPEN_FAILURE);
1241 packet_put_int(c->remote_id);
1242 packet_put_int(SSH2_OPEN_CONNECT_FAILED);
1243 if (!(datafellows & SSH_BUG_OPENFAILURE)) {
1244 packet_put_cstring(strerror(err));
1245 packet_put_cstring("");
1246 }
97fb6912 1247 } else {
d18e0850 1248 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
1249 packet_put_int(c->remote_id);
97fb6912 1250 }
d18e0850 1251 chan_mark_dead(c);
97fb6912 1252 }
d18e0850 1253 packet_send();
97fb6912 1254 }
1255}
1256
396c147e 1257static int
7368a6c8 1258channel_handle_rfd(Channel *c, fd_set * readset, fd_set * writeset)
1259{
1260 char buf[16*1024];
1261 int len;
1262
6fd8622b 1263 if (c->rfd != -1 &&
7368a6c8 1264 FD_ISSET(c->rfd, readset)) {
1265 len = read(c->rfd, buf, sizeof(buf));
0fbe8c74 1266 if (len < 0 && (errno == EINTR || errno == EAGAIN))
1267 return 1;
7368a6c8 1268 if (len <= 0) {
0b242b12 1269 debug("channel %d: read<=0 rfd %d len %d",
7368a6c8 1270 c->self, c->rfd, len);
28b9cb4d 1271 if (c->type != SSH_CHANNEL_OPEN) {
1272 debug("channel %d: not open", c->self);
719fc62f 1273 chan_mark_dead(c);
0490e609 1274 return -1;
28b9cb4d 1275 } else if (compat13) {
7368a6c8 1276 buffer_consume(&c->output, buffer_len(&c->output));
1277 c->type = SSH_CHANNEL_INPUT_DRAINING;
8e7895b8 1278 debug("channel %d: input draining.", c->self);
7368a6c8 1279 } else {
1280 chan_read_failed(c);
5260325f 1281 }
7368a6c8 1282 return -1;
1283 }
6aacefa7 1284 if (c->input_filter != NULL) {
2e73a022 1285 if (c->input_filter(c, buf, len) == -1) {
070adba2 1286 debug("channel %d: filter stops", c->self);
2e73a022 1287 chan_read_failed(c);
1288 }
1289 } else {
1290 buffer_append(&c->input, buf, len);
1291 }
7368a6c8 1292 }
1293 return 1;
1294}
396c147e 1295static int
7368a6c8 1296channel_handle_wfd(Channel *c, fd_set * readset, fd_set * writeset)
1297{
95ce5599 1298 struct termios tio;
780a9951 1299 u_char *data;
1300 u_int dlen;
7368a6c8 1301 int len;
1302
1303 /* Send buffered output data to the socket. */
6fd8622b 1304 if (c->wfd != -1 &&
7368a6c8 1305 FD_ISSET(c->wfd, writeset) &&
1306 buffer_len(&c->output) > 0) {
780a9951 1307 data = buffer_ptr(&c->output);
1308 dlen = buffer_len(&c->output);
1309 len = write(c->wfd, data, dlen);
0fbe8c74 1310 if (len < 0 && (errno == EINTR || errno == EAGAIN))
1311 return 1;
7368a6c8 1312 if (len <= 0) {
28b9cb4d 1313 if (c->type != SSH_CHANNEL_OPEN) {
1314 debug("channel %d: not open", c->self);
719fc62f 1315 chan_mark_dead(c);
28b9cb4d 1316 return -1;
1317 } else if (compat13) {
7368a6c8 1318 buffer_consume(&c->output, buffer_len(&c->output));
8e7895b8 1319 debug("channel %d: input draining.", c->self);
7368a6c8 1320 c->type = SSH_CHANNEL_INPUT_DRAINING;
1321 } else {
1322 chan_write_failed(c);
5260325f 1323 }
7368a6c8 1324 return -1;
1325 }
780a9951 1326 if (compat20 && c->isatty && dlen >= 1 && data[0] != '\r') {
0ae4fe1d 1327 if (tcgetattr(c->wfd, &tio) == 0 &&
1328 !(tio.c_lflag & ECHO) && (tio.c_lflag & ICANON)) {
1329 /*
1330 * Simulate echo to reduce the impact of
355724fc 1331 * traffic analysis. We need to match the
95ce5599 1332 * size of a SSH2_MSG_CHANNEL_DATA message
1333 * (4 byte channel id + data)
0ae4fe1d 1334 */
95ce5599 1335 packet_send_ignore(4 + len);
0ae4fe1d 1336 packet_send();
0ae4fe1d 1337 }
1338 }
7368a6c8 1339 buffer_consume(&c->output, len);
7e7327a1 1340 if (compat20 && len > 0) {
1341 c->local_consumed += len;
1342 }
1343 }
1344 return 1;
1345}
396c147e 1346static int
7e7327a1 1347channel_handle_efd(Channel *c, fd_set * readset, fd_set * writeset)
1348{
1349 char buf[16*1024];
1350 int len;
1351
8ce64345 1352/** XXX handle drain efd, too */
7e7327a1 1353 if (c->efd != -1) {
1354 if (c->extended_usage == CHAN_EXTENDED_WRITE &&
1355 FD_ISSET(c->efd, writeset) &&
1356 buffer_len(&c->extended) > 0) {
1357 len = write(c->efd, buffer_ptr(&c->extended),
1358 buffer_len(&c->extended));
de273eef 1359 debug2("channel %d: written %d to efd %d",
7e7327a1 1360 c->self, len, c->efd);
ee55dacf 1361 if (len < 0 && (errno == EINTR || errno == EAGAIN))
1362 return 1;
1363 if (len <= 0) {
1364 debug2("channel %d: closing write-efd %d",
1365 c->self, c->efd);
489aa2e9 1366 channel_close_fd(&c->efd);
ee55dacf 1367 } else {
7e7327a1 1368 buffer_consume(&c->extended, len);
1369 c->local_consumed += len;
1370 }
1371 } else if (c->extended_usage == CHAN_EXTENDED_READ &&
1372 FD_ISSET(c->efd, readset)) {
1373 len = read(c->efd, buf, sizeof(buf));
de273eef 1374 debug2("channel %d: read %d from efd %d",
7e7327a1 1375 c->self, len, c->efd);
ee55dacf 1376 if (len < 0 && (errno == EINTR || errno == EAGAIN))
1377 return 1;
1378 if (len <= 0) {
1379 debug2("channel %d: closing read-efd %d",
8ce64345 1380 c->self, c->efd);
489aa2e9 1381 channel_close_fd(&c->efd);
ee55dacf 1382 } else {
7e7327a1 1383 buffer_append(&c->extended, buf, len);
ee55dacf 1384 }
7e7327a1 1385 }
1386 }
1387 return 1;
1388}
396c147e 1389static int
ee55dacf 1390channel_check_window(Channel *c)
7e7327a1 1391{
28b9cb4d 1392 if (c->type == SSH_CHANNEL_OPEN &&
1393 !(c->flags & (CHAN_CLOSE_SENT|CHAN_CLOSE_RCVD)) &&
7e7327a1 1394 c->local_window < c->local_window_max/2 &&
1395 c->local_consumed > 0) {
1396 packet_start(SSH2_MSG_CHANNEL_WINDOW_ADJUST);
1397 packet_put_int(c->remote_id);
1398 packet_put_int(c->local_consumed);
1399 packet_send();
de273eef 1400 debug2("channel %d: window %d sent adjust %d",
7e7327a1 1401 c->self, c->local_window,
1402 c->local_consumed);
1403 c->local_window += c->local_consumed;
1404 c->local_consumed = 0;
7368a6c8 1405 }
1406 return 1;
1407}
5260325f 1408
396c147e 1409static void
7368a6c8 1410channel_post_open_1(Channel *c, fd_set * readset, fd_set * writeset)
1411{
639cb8ab 1412 if (c->delayed)
1413 return;
7368a6c8 1414 channel_handle_rfd(c, readset, writeset);
1415 channel_handle_wfd(c, readset, writeset);
1416}
aa3378df 1417
396c147e 1418static void
7e7327a1 1419channel_post_open_2(Channel *c, fd_set * readset, fd_set * writeset)
1420{
639cb8ab 1421 if (c->delayed)
1422 return;
7e7327a1 1423 channel_handle_rfd(c, readset, writeset);
1424 channel_handle_wfd(c, readset, writeset);
1425 channel_handle_efd(c, readset, writeset);
ee55dacf 1426
1427 channel_check_window(c);
7e7327a1 1428}
1429
396c147e 1430static void
7368a6c8 1431channel_post_output_drain_13(Channel *c, fd_set * readset, fd_set * writeset)
1432{
1433 int len;
1434 /* Send buffered output data to the socket. */
1435 if (FD_ISSET(c->sock, writeset) && buffer_len(&c->output) > 0) {
1436 len = write(c->sock, buffer_ptr(&c->output),
1437 buffer_len(&c->output));
1438 if (len <= 0)
1439 buffer_consume(&c->output, buffer_len(&c->output));
1440 else
1441 buffer_consume(&c->output, len);
1442 }
1443}
5260325f 1444
396c147e 1445static void
7e7327a1 1446channel_handler_init_20(void)
1447{
1448 channel_pre[SSH_CHANNEL_OPEN] = &channel_pre_open_20;
0b242b12 1449 channel_pre[SSH_CHANNEL_X11_OPEN] = &channel_pre_x11_open;
7e7327a1 1450 channel_pre[SSH_CHANNEL_PORT_LISTENER] = &channel_pre_listener;
fa08c86b 1451 channel_pre[SSH_CHANNEL_RPORT_LISTENER] = &channel_pre_listener;
0b242b12 1452 channel_pre[SSH_CHANNEL_X11_LISTENER] = &channel_pre_listener;
fa08c86b 1453 channel_pre[SSH_CHANNEL_AUTH_SOCKET] = &channel_pre_listener;
97fb6912 1454 channel_pre[SSH_CHANNEL_CONNECTING] = &channel_pre_connecting;
0490e609 1455 channel_pre[SSH_CHANNEL_DYNAMIC] = &channel_pre_dynamic;
7e7327a1 1456
1457 channel_post[SSH_CHANNEL_OPEN] = &channel_post_open_2;
1458 channel_post[SSH_CHANNEL_PORT_LISTENER] = &channel_post_port_listener;
fa08c86b 1459 channel_post[SSH_CHANNEL_RPORT_LISTENER] = &channel_post_port_listener;
0b242b12 1460 channel_post[SSH_CHANNEL_X11_LISTENER] = &channel_post_x11_listener;
fa08c86b 1461 channel_post[SSH_CHANNEL_AUTH_SOCKET] = &channel_post_auth_listener;
97fb6912 1462 channel_post[SSH_CHANNEL_CONNECTING] = &channel_post_connecting;
28b9cb4d 1463 channel_post[SSH_CHANNEL_DYNAMIC] = &channel_post_open_2;
7e7327a1 1464}
1465
396c147e 1466static void
7368a6c8 1467channel_handler_init_13(void)
1468{
1469 channel_pre[SSH_CHANNEL_OPEN] = &channel_pre_open_13;
1470 channel_pre[SSH_CHANNEL_X11_OPEN] = &channel_pre_x11_open_13;
1471 channel_pre[SSH_CHANNEL_X11_LISTENER] = &channel_pre_listener;
1472 channel_pre[SSH_CHANNEL_PORT_LISTENER] = &channel_pre_listener;
1473 channel_pre[SSH_CHANNEL_AUTH_SOCKET] = &channel_pre_listener;
1474 channel_pre[SSH_CHANNEL_INPUT_DRAINING] = &channel_pre_input_draining;
1475 channel_pre[SSH_CHANNEL_OUTPUT_DRAINING] = &channel_pre_output_draining;
97fb6912 1476 channel_pre[SSH_CHANNEL_CONNECTING] = &channel_pre_connecting;
0490e609 1477 channel_pre[SSH_CHANNEL_DYNAMIC] = &channel_pre_dynamic;
7368a6c8 1478
1479 channel_post[SSH_CHANNEL_OPEN] = &channel_post_open_1;
1480 channel_post[SSH_CHANNEL_X11_LISTENER] = &channel_post_x11_listener;
1481 channel_post[SSH_CHANNEL_PORT_LISTENER] = &channel_post_port_listener;
1482 channel_post[SSH_CHANNEL_AUTH_SOCKET] = &channel_post_auth_listener;
1483 channel_post[SSH_CHANNEL_OUTPUT_DRAINING] = &channel_post_output_drain_13;
97fb6912 1484 channel_post[SSH_CHANNEL_CONNECTING] = &channel_post_connecting;
28b9cb4d 1485 channel_post[SSH_CHANNEL_DYNAMIC] = &channel_post_open_1;
7368a6c8 1486}
5260325f 1487
396c147e 1488static void
7368a6c8 1489channel_handler_init_15(void)
1490{
1491 channel_pre[SSH_CHANNEL_OPEN] = &channel_pre_open_15;
0b242b12 1492 channel_pre[SSH_CHANNEL_X11_OPEN] = &channel_pre_x11_open;
7368a6c8 1493 channel_pre[SSH_CHANNEL_X11_LISTENER] = &channel_pre_listener;
1494 channel_pre[SSH_CHANNEL_PORT_LISTENER] = &channel_pre_listener;
1495 channel_pre[SSH_CHANNEL_AUTH_SOCKET] = &channel_pre_listener;
97fb6912 1496 channel_pre[SSH_CHANNEL_CONNECTING] = &channel_pre_connecting;
0490e609 1497 channel_pre[SSH_CHANNEL_DYNAMIC] = &channel_pre_dynamic;
7368a6c8 1498
1499 channel_post[SSH_CHANNEL_X11_LISTENER] = &channel_post_x11_listener;
1500 channel_post[SSH_CHANNEL_PORT_LISTENER] = &channel_post_port_listener;
1501 channel_post[SSH_CHANNEL_AUTH_SOCKET] = &channel_post_auth_listener;
1502 channel_post[SSH_CHANNEL_OPEN] = &channel_post_open_1;
97fb6912 1503 channel_post[SSH_CHANNEL_CONNECTING] = &channel_post_connecting;
28b9cb4d 1504 channel_post[SSH_CHANNEL_DYNAMIC] = &channel_post_open_1;
7368a6c8 1505}
1506
396c147e 1507static void
7368a6c8 1508channel_handler_init(void)
1509{
1510 int i;
1511 for(i = 0; i < SSH_CHANNEL_MAX_TYPE; i++) {
1512 channel_pre[i] = NULL;
1513 channel_post[i] = NULL;
1514 }
7e7327a1 1515 if (compat20)
1516 channel_handler_init_20();
1517 else if (compat13)
7368a6c8 1518 channel_handler_init_13();
1519 else
1520 channel_handler_init_15();
1521}
1522
418e724c 1523/* gc dead channels */
1524static void
1525channel_garbage_collect(Channel *c)
1526{
1527 if (c == NULL)
1528 return;
1529 if (c->detach_user != NULL) {
1530 if (!chan_is_dead(c, 0))
1531 return;
1532 debug("channel %d: gc: notify user", c->self);
1533 c->detach_user(c->self, NULL);
1534 /* if we still have a callback */
1535 if (c->detach_user != NULL)
1536 return;
1537 debug("channel %d: gc: user detached", c->self);
1538 }
1539 if (!chan_is_dead(c, 1))
1540 return;
1541 debug("channel %d: garbage collecting", c->self);
1542 channel_free(c);
1543}
1544
396c147e 1545static void
7368a6c8 1546channel_handler(chan_fn *ftab[], fd_set * readset, fd_set * writeset)
1547{
1548 static int did_init = 0;
1549 int i;
1550 Channel *c;
1551
1552 if (!did_init) {
1553 channel_handler_init();
1554 did_init = 1;
1555 }
1556 for (i = 0; i < channels_alloc; i++) {
719fc62f 1557 c = channels[i];
1558 if (c == NULL)
5260325f 1559 continue;
6fd8622b 1560 if (ftab[c->type] != NULL)
1561 (*ftab[c->type])(c, readset, writeset);
418e724c 1562 channel_garbage_collect(c);
8efc0c15 1563 }
8efc0c15 1564}
1565
8e7895b8 1566/*
1567 * Allocate/update select bitmasks and add any bits relevant to channels in
1568 * select bitmasks.
1569 */
6ae2364d 1570void
c422989b 1571channel_prepare_select(fd_set **readsetp, fd_set **writesetp, int *maxfdp,
489aa2e9 1572 int *nallocp, int rekeying)
7368a6c8 1573{
39929cdb 1574 int n;
1575 u_int sz;
1576
1577 n = MAX(*maxfdp, channel_max_fd);
1578
1579 sz = howmany(n+1, NFDBITS) * sizeof(fd_mask);
489aa2e9 1580 /* perhaps check sz < nalloc/2 and shrink? */
1581 if (*readsetp == NULL || sz > *nallocp) {
1582 *readsetp = xrealloc(*readsetp, sz);
1583 *writesetp = xrealloc(*writesetp, sz);
1584 *nallocp = sz;
39929cdb 1585 }
489aa2e9 1586 *maxfdp = n;
39929cdb 1587 memset(*readsetp, 0, sz);
1588 memset(*writesetp, 0, sz);
1589
c422989b 1590 if (!rekeying)
1591 channel_handler(channel_pre, *readsetp, *writesetp);
7368a6c8 1592}
1593
8e7895b8 1594/*
1595 * After select, perform any appropriate operations for channels which have
1596 * events pending.
1597 */
6ae2364d 1598void
7368a6c8 1599channel_after_select(fd_set * readset, fd_set * writeset)
1600{
1601 channel_handler(channel_post, readset, writeset);
1602}
1603
8e7895b8 1604
39929cdb 1605/* If there is data to send to the connection, enqueue some of it now. */
8efc0c15 1606
6ae2364d 1607void
d5bb9418 1608channel_output_poll(void)
8efc0c15 1609{
5260325f 1610 int len, i;
7368a6c8 1611 Channel *c;
5260325f 1612
1613 for (i = 0; i < channels_alloc; i++) {
719fc62f 1614 c = channels[i];
1615 if (c == NULL)
1616 continue;
48e671d5 1617
8e7895b8 1618 /*
1619 * We are only interested in channels that can have buffered
1620 * incoming data.
1621 */
48e671d5 1622 if (compat13) {
7368a6c8 1623 if (c->type != SSH_CHANNEL_OPEN &&
1624 c->type != SSH_CHANNEL_INPUT_DRAINING)
48e671d5 1625 continue;
1626 } else {
7368a6c8 1627 if (c->type != SSH_CHANNEL_OPEN)
48e671d5 1628 continue;
48e671d5 1629 }
e78a59f5 1630 if (compat20 &&
1631 (c->flags & (CHAN_CLOSE_SENT|CHAN_CLOSE_RCVD))) {
ee55dacf 1632 /* XXX is this true? */
418e724c 1633 debug3("channel %d: will not send data after close", c->self);
7e7327a1 1634 continue;
1635 }
5260325f 1636
1637 /* Get the amount of buffered data for this channel. */
ee55dacf 1638 if ((c->istate == CHAN_INPUT_OPEN ||
1639 c->istate == CHAN_INPUT_WAIT_DRAIN) &&
1640 (len = buffer_len(&c->input)) > 0) {
8e7895b8 1641 /*
1642 * Send some data for the other side over the secure
1643 * connection.
1644 */
7e7327a1 1645 if (compat20) {
1646 if (len > c->remote_window)
1647 len = c->remote_window;
1648 if (len > c->remote_maxpacket)
1649 len = c->remote_maxpacket;
5260325f 1650 } else {
7e7327a1 1651 if (packet_is_interactive()) {
1652 if (len > 1024)
1653 len = 512;
1654 } else {
1655 /* Keep the packets at reasonable size. */
1656 if (len > packet_get_maxsize()/2)
1657 len = packet_get_maxsize()/2;
1658 }
5260325f 1659 }
7368a6c8 1660 if (len > 0) {
7e7327a1 1661 packet_start(compat20 ?
1662 SSH2_MSG_CHANNEL_DATA : SSH_MSG_CHANNEL_DATA);
7368a6c8 1663 packet_put_int(c->remote_id);
1664 packet_put_string(buffer_ptr(&c->input), len);
1665 packet_send();
1666 buffer_consume(&c->input, len);
1667 c->remote_window -= len;
7368a6c8 1668 }
1669 } else if (c->istate == CHAN_INPUT_WAIT_DRAIN) {
5260325f 1670 if (compat13)
1671 fatal("cannot happen: istate == INPUT_WAIT_DRAIN for proto 1.3");
aa3378df 1672 /*
1673 * input-buffer is empty and read-socket shutdown:
1674 * tell peer, that we will not send more data: send IEOF
1675 */
7368a6c8 1676 chan_ibuf_empty(c);
5260325f 1677 }
7e7327a1 1678 /* Send extended data, i.e. stderr */
1679 if (compat20 &&
1680 c->remote_window > 0 &&
1681 (len = buffer_len(&c->extended)) > 0 &&
1682 c->extended_usage == CHAN_EXTENDED_READ) {
ee55dacf 1683 debug2("channel %d: rwin %d elen %d euse %d",
1684 c->self, c->remote_window, buffer_len(&c->extended),
1685 c->extended_usage);
7e7327a1 1686 if (len > c->remote_window)
1687 len = c->remote_window;
1688 if (len > c->remote_maxpacket)
1689 len = c->remote_maxpacket;
1690 packet_start(SSH2_MSG_CHANNEL_EXTENDED_DATA);
1691 packet_put_int(c->remote_id);
1692 packet_put_int(SSH2_EXTENDED_DATA_STDERR);
1693 packet_put_string(buffer_ptr(&c->extended), len);
1694 packet_send();
1695 buffer_consume(&c->extended, len);
1696 c->remote_window -= len;
ee55dacf 1697 debug2("channel %d: sent ext data %d", c->self, len);
7e7327a1 1698 }
8efc0c15 1699 }
8efc0c15 1700}
1701
8e7895b8 1702
1703/* -- protocol input */
8efc0c15 1704
6ae2364d 1705void
188adeb2 1706channel_input_data(int type, int plen, void *ctxt)
8efc0c15 1707{
48e671d5 1708 int id;
5260325f 1709 char *data;
1e3b8b07 1710 u_int data_len;
7368a6c8 1711 Channel *c;
5260325f 1712
1713 /* Get the channel number and verify it. */
48e671d5 1714 id = packet_get_int();
7368a6c8 1715 c = channel_lookup(id);
1716 if (c == NULL)
48e671d5 1717 packet_disconnect("Received data for nonexistent channel %d.", id);
5260325f 1718
1719 /* Ignore any data for non-open channels (might happen on close) */
7368a6c8 1720 if (c->type != SSH_CHANNEL_OPEN &&
1721 c->type != SSH_CHANNEL_X11_OPEN)
48e671d5 1722 return;
1723
1724 /* same for protocol 1.5 if output end is no longer open */
7368a6c8 1725 if (!compat13 && c->ostate != CHAN_OUTPUT_OPEN)
5260325f 1726 return;
1727
1728 /* Get the data. */
1729 data = packet_get_string(&data_len);
6ae2364d 1730 packet_done();
7368a6c8 1731
6aacefa7 1732 if (compat20) {
7e7327a1 1733 if (data_len > c->local_maxpacket) {
1734 log("channel %d: rcvd big packet %d, maxpack %d",
1735 c->self, data_len, c->local_maxpacket);
1736 }
1737 if (data_len > c->local_window) {
1738 log("channel %d: rcvd too much data %d, win %d",
1739 c->self, data_len, c->local_window);
1740 xfree(data);
1741 return;
1742 }
1743 c->local_window -= data_len;
1744 }else{
1745 packet_integrity_check(plen, 4 + 4 + data_len, type);
1746 }
7368a6c8 1747 buffer_append(&c->output, data, data_len);
5260325f 1748 xfree(data);
8efc0c15 1749}
8e7895b8 1750
6ae2364d 1751void
188adeb2 1752channel_input_extended_data(int type, int plen, void *ctxt)
7e7327a1 1753{
1754 int id;
1755 int tcode;
1756 char *data;
1e3b8b07 1757 u_int data_len;
7e7327a1 1758 Channel *c;
1759
1760 /* Get the channel number and verify it. */
1761 id = packet_get_int();
1762 c = channel_lookup(id);
1763
1764 if (c == NULL)
1765 packet_disconnect("Received extended_data for bad channel %d.", id);
1766 if (c->type != SSH_CHANNEL_OPEN) {
1767 log("channel %d: ext data for non open", id);
1768 return;
1769 }
1770 tcode = packet_get_int();
1771 if (c->efd == -1 ||
1772 c->extended_usage != CHAN_EXTENDED_WRITE ||
1773 tcode != SSH2_EXTENDED_DATA_STDERR) {
1774 log("channel %d: bad ext data", c->self);
1775 return;
1776 }
1777 data = packet_get_string(&data_len);
6ae2364d 1778 packet_done();
7e7327a1 1779 if (data_len > c->local_window) {
1780 log("channel %d: rcvd too much extended_data %d, win %d",
1781 c->self, data_len, c->local_window);
1782 xfree(data);
1783 return;
1784 }
de273eef 1785 debug2("channel %d: rcvd ext data %d", c->self, data_len);
7e7327a1 1786 c->local_window -= data_len;
1787 buffer_append(&c->extended, data, data_len);
1788 xfree(data);
1789}
1790
6ae2364d 1791void
188adeb2 1792channel_input_ieof(int type, int plen, void *ctxt)
7368a6c8 1793{
1794 int id;
1795 Channel *c;
1796
1797 packet_integrity_check(plen, 4, type);
1798
1799 id = packet_get_int();
1800 c = channel_lookup(id);
1801 if (c == NULL)
1802 packet_disconnect("Received ieof for nonexistent channel %d.", id);
1803 chan_rcvd_ieof(c);
a5f82435 1804
1805 /* XXX force input close */
1806 if (c->force_drain) {
1807 debug("channel %d: FORCE input drain", c->self);
1808 c->istate = CHAN_INPUT_WAIT_DRAIN;
1809 }
1810
7368a6c8 1811}
8efc0c15 1812
6ae2364d 1813void
188adeb2 1814channel_input_close(int type, int plen, void *ctxt)
8efc0c15 1815{
7368a6c8 1816 int id;
1817 Channel *c;
5260325f 1818
7368a6c8 1819 packet_integrity_check(plen, 4, type);
1820
1821 id = packet_get_int();
1822 c = channel_lookup(id);
1823 if (c == NULL)
1824 packet_disconnect("Received close for nonexistent channel %d.", id);
aa3378df 1825
1826 /*
1827 * Send a confirmation that we have closed the channel and no more
1828 * data is coming for it.
1829 */
5260325f 1830 packet_start(SSH_MSG_CHANNEL_CLOSE_CONFIRMATION);
7368a6c8 1831 packet_put_int(c->remote_id);
5260325f 1832 packet_send();
1833
aa3378df 1834 /*
1835 * If the channel is in closed state, we have sent a close request,
1836 * and the other side will eventually respond with a confirmation.
1837 * Thus, we cannot free the channel here, because then there would be
1838 * no-one to receive the confirmation. The channel gets freed when
1839 * the confirmation arrives.
1840 */
7368a6c8 1841 if (c->type != SSH_CHANNEL_CLOSED) {
aa3378df 1842 /*
1843 * Not a closed channel - mark it as draining, which will
1844 * cause it to be freed later.
1845 */
7368a6c8 1846 buffer_consume(&c->input, buffer_len(&c->input));
1847 c->type = SSH_CHANNEL_OUTPUT_DRAINING;
5260325f 1848 }
8efc0c15 1849}
1850
7368a6c8 1851/* proto version 1.5 overloads CLOSE_CONFIRMATION with OCLOSE */
6ae2364d 1852void
188adeb2 1853channel_input_oclose(int type, int plen, void *ctxt)
8efc0c15 1854{
7368a6c8 1855 int id = packet_get_int();
1856 Channel *c = channel_lookup(id);
1857 packet_integrity_check(plen, 4, type);
1858 if (c == NULL)
1859 packet_disconnect("Received oclose for nonexistent channel %d.", id);
1860 chan_rcvd_oclose(c);
8efc0c15 1861}
1862
6ae2364d 1863void
188adeb2 1864channel_input_close_confirmation(int type, int plen, void *ctxt)
7368a6c8 1865{
1866 int id = packet_get_int();
1867 Channel *c = channel_lookup(id);
1868
6ae2364d 1869 packet_done();
7368a6c8 1870 if (c == NULL)
1871 packet_disconnect("Received close confirmation for "
1872 "out-of-range channel %d.", id);
1873 if (c->type != SSH_CHANNEL_CLOSED)
1874 packet_disconnect("Received close confirmation for "
1875 "non-closed channel %d (type %d).", id, c->type);
719fc62f 1876 channel_free(c);
7368a6c8 1877}
8efc0c15 1878
6ae2364d 1879void
188adeb2 1880channel_input_open_confirmation(int type, int plen, void *ctxt)
8efc0c15 1881{
7368a6c8 1882 int id, remote_id;
1883 Channel *c;
5260325f 1884
7e7327a1 1885 if (!compat20)
1886 packet_integrity_check(plen, 4 + 4, type);
5260325f 1887
7368a6c8 1888 id = packet_get_int();
1889 c = channel_lookup(id);
5260325f 1890
7368a6c8 1891 if (c==NULL || c->type != SSH_CHANNEL_OPENING)
1892 packet_disconnect("Received open confirmation for "
1893 "non-opening channel %d.", id);
1894 remote_id = packet_get_int();
aa3378df 1895 /* Record the remote channel number and mark that the channel is now open. */
7368a6c8 1896 c->remote_id = remote_id;
1897 c->type = SSH_CHANNEL_OPEN;
7e7327a1 1898
1899 if (compat20) {
1900 c->remote_window = packet_get_int();
1901 c->remote_maxpacket = packet_get_int();
6ae2364d 1902 packet_done();
7e7327a1 1903 if (c->cb_fn != NULL && c->cb_event == type) {
de273eef 1904 debug2("callback start");
7e7327a1 1905 c->cb_fn(c->self, c->cb_arg);
de273eef 1906 debug2("callback done");
7e7327a1 1907 }
1908 debug("channel %d: open confirm rwindow %d rmax %d", c->self,
1909 c->remote_window, c->remote_maxpacket);
1910 }
8efc0c15 1911}
1912
396c147e 1913static char *
d18e0850 1914reason2txt(int reason)
1915{
6aacefa7 1916 switch (reason) {
d18e0850 1917 case SSH2_OPEN_ADMINISTRATIVELY_PROHIBITED:
1918 return "administratively prohibited";
1919 case SSH2_OPEN_CONNECT_FAILED:
1920 return "connect failed";
1921 case SSH2_OPEN_UNKNOWN_CHANNEL_TYPE:
1922 return "unknown channel type";
1923 case SSH2_OPEN_RESOURCE_SHORTAGE:
1924 return "resource shortage";
1925 }
7e8c18e9 1926 return "unknown reason";
d18e0850 1927}
1928
6ae2364d 1929void
188adeb2 1930channel_input_open_failure(int type, int plen, void *ctxt)
8efc0c15 1931{
02a024dd 1932 int id, reason;
1933 char *msg = NULL, *lang = NULL;
7368a6c8 1934 Channel *c;
5260325f 1935
7e7327a1 1936 if (!compat20)
1937 packet_integrity_check(plen, 4, type);
7368a6c8 1938
1939 id = packet_get_int();
1940 c = channel_lookup(id);
1941
1942 if (c==NULL || c->type != SSH_CHANNEL_OPENING)
1943 packet_disconnect("Received open failure for "
1944 "non-opening channel %d.", id);
7e7327a1 1945 if (compat20) {
02a024dd 1946 reason = packet_get_int();
fbe90f7b 1947 if (!(datafellows & SSH_BUG_OPENFAILURE)) {
02a024dd 1948 msg = packet_get_string(NULL);
1949 lang = packet_get_string(NULL);
1950 }
6ae2364d 1951 packet_done();
d18e0850 1952 log("channel %d: open failed: %s%s%s", id,
1953 reason2txt(reason), msg ? ": ": "", msg ? msg : "");
02a024dd 1954 if (msg != NULL)
1955 xfree(msg);
1956 if (lang != NULL)
1957 xfree(lang);
7e7327a1 1958 }
5260325f 1959 /* Free the channel. This will also close the socket. */
719fc62f 1960 channel_free(c);
8efc0c15 1961}
1962
7e7327a1 1963void
188adeb2 1964channel_input_channel_request(int type, int plen, void *ctxt)
7e7327a1 1965{
1966 int id;
1967 Channel *c;
1968
1969 id = packet_get_int();
1970 c = channel_lookup(id);
1971
1972 if (c == NULL ||
1973 (c->type != SSH_CHANNEL_OPEN && c->type != SSH_CHANNEL_LARVAL))
1974 packet_disconnect("Received request for "
1975 "non-open channel %d.", id);
1976 if (c->cb_fn != NULL && c->cb_event == type) {
de273eef 1977 debug2("callback start");
7e7327a1 1978 c->cb_fn(c->self, c->cb_arg);
de273eef 1979 debug2("callback done");
8e7895b8 1980 } else {
1981 char *service = packet_get_string(NULL);
1982 debug("channel %d: rcvd request for %s", c->self, service);
1983 debug("cb_fn %p cb_event %d", c->cb_fn , c->cb_event);
1984 xfree(service);
719fc62f 1985 }
3ffc6336 1986}
1987
8e7895b8 1988void
1989channel_input_window_adjust(int type, int plen, void *ctxt)
1990{
1991 Channel *c;
1992 int id, adjust;
3ffc6336 1993
8e7895b8 1994 if (!compat20)
1995 return;
8efc0c15 1996
8e7895b8 1997 /* Get the channel number and verify it. */
1998 id = packet_get_int();
1999 c = channel_lookup(id);
2000
2001 if (c == NULL || c->type != SSH_CHANNEL_OPEN) {
2002 log("Received window adjust for "
2003 "non-open channel %d.", id);
2004 return;
2005 }
2006 adjust = packet_get_int();
2007 packet_done();
2008 debug2("channel %d: rcvd adjust %d", id, adjust);
2009 c->remote_window += adjust;
2010}
2011
2012void
2013channel_input_port_open(int type, int plen, void *ctxt)
8efc0c15 2014{
8e7895b8 2015 Channel *c = NULL;
2016 u_short host_port;
2017 char *host, *originator_string;
2018 int remote_id, sock = -1;
5260325f 2019
8e7895b8 2020 remote_id = packet_get_int();
2021 host = packet_get_string(NULL);
2022 host_port = packet_get_int();
2023
2024 if (packet_get_protocol_flags() & SSH_PROTOFLAG_HOST_IN_FWD_OPEN) {
2025 originator_string = packet_get_string(NULL);
2026 } else {
2027 originator_string = xstrdup("unknown (remote did not supply name)");
2028 }
2029 packet_done();
2030 sock = channel_connect_to(host, host_port);
2031 if (sock != -1) {
2032 c = channel_new("connected socket",
2033 SSH_CHANNEL_CONNECTING, sock, sock, -1, 0, 0, 0,
2034 originator_string, 1);
2035 if (c == NULL) {
2036 error("channel_input_port_open: channel_new failed");
2037 close(sock);
2038 } else {
2039 c->remote_id = remote_id;
5260325f 2040 }
2041 }
8e7895b8 2042 if (c == NULL) {
2043 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
2044 packet_put_int(remote_id);
2045 packet_send();
2046 }
2047 xfree(host);
8efc0c15 2048}
2049
8e7895b8 2050
2051/* -- tcp forwarding */
2052
5e4a7219 2053void
2054channel_set_af(int af)
2055{
2056 IPv4or6 = af;
2057}
2058
aa3378df 2059/*
2060 * Initiate forwarding of connections to local port "port" through the secure
2061 * channel to host:port from remote side.
2062 */
02a024dd 2063int
fa08c86b 2064channel_request_local_forwarding(u_short listen_port, const char *host_to_connect,
2065 u_short port_to_connect, int gateway_ports)
2066{
02a024dd 2067 return channel_request_forwarding(
fa08c86b 2068 NULL, listen_port,
2069 host_to_connect, port_to_connect,
2070 gateway_ports, /*remote_fwd*/ 0);
2071}
8efc0c15 2072
fa08c86b 2073/*
2074 * If 'remote_fwd' is true we have a '-R style' listener for protocol 2
2075 * (SSH_CHANNEL_RPORT_LISTENER).
2076 */
02a024dd 2077int
fa08c86b 2078channel_request_forwarding(
2079 const char *listen_address, u_short listen_port,
2080 const char *host_to_connect, u_short port_to_connect,
2081 int gateway_ports, int remote_fwd)
8efc0c15 2082{
719fc62f 2083 Channel *c;
8e7895b8 2084 int success, sock, on = 1, type;
48e671d5 2085 struct addrinfo hints, *ai, *aitop;
2086 char ntop[NI_MAXHOST], strport[NI_MAXSERV];
fa08c86b 2087 const char *host;
aa3378df 2088 struct linger linger;
5260325f 2089
02a024dd 2090 success = 0;
2091
fa08c86b 2092 if (remote_fwd) {
2093 host = listen_address;
8e7895b8 2094 type = SSH_CHANNEL_RPORT_LISTENER;
fa08c86b 2095 } else {
2096 host = host_to_connect;
8e7895b8 2097 type = SSH_CHANNEL_PORT_LISTENER;
fa08c86b 2098 }
2099
719fc62f 2100 if (strlen(host) > SSH_CHANNEL_PATH_LEN - 1) {
02a024dd 2101 error("Forward host name too long.");
2102 return success;
2103 }
5260325f 2104
fa08c86b 2105 /* XXX listen_address is currently ignored */
aa3378df 2106 /*
48e671d5 2107 * getaddrinfo returns a loopback address if the hostname is
2108 * set to NULL and hints.ai_flags is not AI_PASSIVE
aa3378df 2109 */
48e671d5 2110 memset(&hints, 0, sizeof(hints));
2111 hints.ai_family = IPv4or6;
2112 hints.ai_flags = gateway_ports ? AI_PASSIVE : 0;
2113 hints.ai_socktype = SOCK_STREAM;
fa08c86b 2114 snprintf(strport, sizeof strport, "%d", listen_port);
48e671d5 2115 if (getaddrinfo(NULL, strport, &hints, &aitop) != 0)
2116 packet_disconnect("getaddrinfo: fatal error");
2117
48e671d5 2118 for (ai = aitop; ai; ai = ai->ai_next) {
2119 if (ai->ai_family != AF_INET && ai->ai_family != AF_INET6)
2120 continue;
2121 if (getnameinfo(ai->ai_addr, ai->ai_addrlen, ntop, sizeof(ntop),
2122 strport, sizeof(strport), NI_NUMERICHOST|NI_NUMERICSERV) != 0) {
fa08c86b 2123 error("channel_request_forwarding: getnameinfo failed");
48e671d5 2124 continue;
2125 }
2126 /* Create a port to listen for the host. */
2127 sock = socket(ai->ai_family, SOCK_STREAM, 0);
2128 if (sock < 0) {
2129 /* this is no error since kernel may not support ipv6 */
2130 verbose("socket: %.100s", strerror(errno));
2131 continue;
2132 }
2133 /*
2134 * Set socket options. We would like the socket to disappear
2135 * as soon as it has been closed for whatever reason.
2136 */
2137 setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, (void *)&on, sizeof(on));
2138 linger.l_onoff = 1;
2139 linger.l_linger = 5;
2140 setsockopt(sock, SOL_SOCKET, SO_LINGER, (void *)&linger, sizeof(linger));
2141 debug("Local forwarding listening on %s port %s.", ntop, strport);
2142
2143 /* Bind the socket to the address. */
2144 if (bind(sock, ai->ai_addr, ai->ai_addrlen) < 0) {
2145 /* address can be in use ipv6 address is already bound */
16218745 2146 if (!ai->ai_next)
2147 error("bind: %.100s", strerror(errno));
2148 else
2149 verbose("bind: %.100s", strerror(errno));
2b87da3b 2150
48e671d5 2151 close(sock);
2152 continue;
2153 }
2154 /* Start listening for connections on the socket. */
2155 if (listen(sock, 5) < 0) {
2156 error("listen: %.100s", strerror(errno));
2157 close(sock);
2158 continue;
2159 }
2160 /* Allocate a channel number for the socket. */
8e7895b8 2161 c = channel_new("port listener", type, sock, sock, -1,
0b242b12 2162 CHAN_TCP_WINDOW_DEFAULT, CHAN_TCP_PACKET_DEFAULT,
a22aff1f 2163 0, xstrdup("port listener"), 1);
719fc62f 2164 if (c == NULL) {
2165 error("channel_request_forwarding: channel_new failed");
2166 close(sock);
2167 continue;
2168 }
2169 strlcpy(c->path, host, sizeof(c->path));
2170 c->host_port = port_to_connect;
2171 c->listening_port = listen_port;
48e671d5 2172 success = 1;
2173 }
2174 if (success == 0)
02a024dd 2175 error("channel_request_forwarding: cannot listen to port: %d",
2176 listen_port);
48e671d5 2177 freeaddrinfo(aitop);
02a024dd 2178 return success;
5260325f 2179}
8efc0c15 2180
aa3378df 2181/*
2182 * Initiate forwarding of connections to port "port" on remote host through
2183 * the secure channel to host:port from local side.
2184 */
8efc0c15 2185
6ae2364d 2186void
fa08c86b 2187channel_request_remote_forwarding(u_short listen_port,
2188 const char *host_to_connect, u_short port_to_connect)
8efc0c15 2189{
fa08c86b 2190 int payload_len, type, success = 0;
2191
5260325f 2192 /* Record locally that connection to this host/port is permitted. */
2193 if (num_permitted_opens >= SSH_MAX_FORWARDS_PER_DIRECTION)
2194 fatal("channel_request_remote_forwarding: too many forwards");
2195
5260325f 2196 /* Send the forward request to the remote side. */
7e7327a1 2197 if (compat20) {
2198 const char *address_to_bind = "0.0.0.0";
2199 packet_start(SSH2_MSG_GLOBAL_REQUEST);
2200 packet_put_cstring("tcpip-forward");
2201 packet_put_char(0); /* boolean: want reply */
2202 packet_put_cstring(address_to_bind);
2203 packet_put_int(listen_port);
fa08c86b 2204 packet_send();
2205 packet_write_wait();
2206 /* Assume that server accepts the request */
2207 success = 1;
7e7327a1 2208 } else {
2209 packet_start(SSH_CMSG_PORT_FORWARD_REQUEST);
7e7327a1 2210 packet_put_int(listen_port);
d6f24e45 2211 packet_put_cstring(host_to_connect);
2212 packet_put_int(port_to_connect);
7e7327a1 2213 packet_send();
2214 packet_write_wait();
fa08c86b 2215
2216 /* Wait for response from the remote side. */
2217 type = packet_read(&payload_len);
2218 switch (type) {
2219 case SSH_SMSG_SUCCESS:
2220 success = 1;
2221 break;
2222 case SSH_SMSG_FAILURE:
2223 log("Warning: Server denied remote port forwarding.");
2224 break;
2225 default:
2226 /* Unknown packet */
2227 packet_disconnect("Protocol error for port forward request:"
2228 "received packet type %d.", type);
2229 }
2230 }
2231 if (success) {
2232 permitted_opens[num_permitted_opens].host_to_connect = xstrdup(host_to_connect);
2233 permitted_opens[num_permitted_opens].port_to_connect = port_to_connect;
2234 permitted_opens[num_permitted_opens].listen_port = listen_port;
2235 num_permitted_opens++;
7e7327a1 2236 }
8efc0c15 2237}
2238
aa3378df 2239/*
2240 * This is called after receiving CHANNEL_FORWARDING_REQUEST. This initates
2241 * listening for the port, and sends back a success reply (or disconnect
2242 * message if there was an error). This never returns if there was an error.
2243 */
8efc0c15 2244
6ae2364d 2245void
1d1ffb87 2246channel_input_port_forward_request(int is_root, int gateway_ports)
8efc0c15 2247{
57112b5a 2248 u_short port, host_port;
5260325f 2249 char *hostname;
2250
2251 /* Get arguments from the packet. */
2252 port = packet_get_int();
2253 hostname = packet_get_string(NULL);
2254 host_port = packet_get_int();
2255
3c62e7eb 2256#ifndef HAVE_CYGWIN
aa3378df 2257 /*
2258 * Check that an unprivileged user is not trying to forward a
2259 * privileged port.
2260 */
5260325f 2261 if (port < IPPORT_RESERVED && !is_root)
2262 packet_disconnect("Requested forwarding of port %d but user is not root.",
2263 port);
3c62e7eb 2264#endif
fa08c86b 2265 /* Initiate forwarding */
1d1ffb87 2266 channel_request_local_forwarding(port, hostname, host_port, gateway_ports);
5260325f 2267
2268 /* Free the argument string. */
2269 xfree(hostname);
8efc0c15 2270}
2271
01794848 2272/*
2273 * Permits opening to any host/port if permitted_opens[] is empty. This is
2274 * usually called by the server, because the user could connect to any port
2275 * anyway, and the server has no way to know but to trust the client anyway.
2276 */
2277void
d5bb9418 2278channel_permit_all_opens(void)
01794848 2279{
2280 if (num_permitted_opens == 0)
2281 all_opens_permitted = 1;
2282}
2283
cd332296 2284void
01794848 2285channel_add_permitted_opens(char *host, int port)
2286{
2287 if (num_permitted_opens >= SSH_MAX_FORWARDS_PER_DIRECTION)
2288 fatal("channel_request_remote_forwarding: too many forwards");
2289 debug("allow port forwarding to host %s port %d", host, port);
2290
2291 permitted_opens[num_permitted_opens].host_to_connect = xstrdup(host);
2292 permitted_opens[num_permitted_opens].port_to_connect = port;
2293 num_permitted_opens++;
2294
2295 all_opens_permitted = 0;
2296}
2297
cd332296 2298void
01794848 2299channel_clear_permitted_opens(void)
2300{
2301 int i;
2302
2303 for (i = 0; i < num_permitted_opens; i++)
2304 xfree(permitted_opens[i].host_to_connect);
2305 num_permitted_opens = 0;
2306
2307}
2308
2309
2310/* return socket to remote host, port */
396c147e 2311static int
01794848 2312connect_to(const char *host, u_short port)
8efc0c15 2313{
48e671d5 2314 struct addrinfo hints, *ai, *aitop;
2315 char ntop[NI_MAXHOST], strport[NI_MAXSERV];
2316 int gaierr;
7368a6c8 2317 int sock = -1;
48e671d5 2318
2319 memset(&hints, 0, sizeof(hints));
2320 hints.ai_family = IPv4or6;
2321 hints.ai_socktype = SOCK_STREAM;
01794848 2322 snprintf(strport, sizeof strport, "%d", port);
48e671d5 2323 if ((gaierr = getaddrinfo(host, strport, &hints, &aitop)) != 0) {
01794848 2324 error("connect_to %.100s: unknown host (%s)", host,
2325 gai_strerror(gaierr));
7368a6c8 2326 return -1;
48e671d5 2327 }
48e671d5 2328 for (ai = aitop; ai; ai = ai->ai_next) {
2329 if (ai->ai_family != AF_INET && ai->ai_family != AF_INET6)
2330 continue;
2331 if (getnameinfo(ai->ai_addr, ai->ai_addrlen, ntop, sizeof(ntop),
2332 strport, sizeof(strport), NI_NUMERICHOST|NI_NUMERICSERV) != 0) {
01794848 2333 error("connect_to: getnameinfo failed");
48e671d5 2334 continue;
5260325f 2335 }
48e671d5 2336 sock = socket(ai->ai_family, SOCK_STREAM, 0);
2337 if (sock < 0) {
2338 error("socket: %.100s", strerror(errno));
2339 continue;
5260325f 2340 }
eea39c02 2341 if (fcntl(sock, F_SETFL, O_NONBLOCK) < 0)
97fb6912 2342 fatal("connect_to: F_SETFL: %s", strerror(errno));
97fb6912 2343 if (connect(sock, ai->ai_addr, ai->ai_addrlen) < 0 &&
2344 errno != EINPROGRESS) {
01794848 2345 error("connect_to %.100s port %s: %.100s", ntop, strport,
48e671d5 2346 strerror(errno));
2347 close(sock);
2b87da3b 2348 continue; /* fail -- try next */
48e671d5 2349 }
2350 break; /* success */
5260325f 2351
5260325f 2352 }
48e671d5 2353 freeaddrinfo(aitop);
48e671d5 2354 if (!ai) {
01794848 2355 error("connect_to %.100s port %d: failed.", host, port);
7368a6c8 2356 return -1;
8efc0c15 2357 }
7368a6c8 2358 /* success */
2359 return sock;
2360}
01794848 2361
fa08c86b 2362int
b3f8a79c 2363channel_connect_by_listen_address(u_short listen_port)
fa08c86b 2364{
2365 int i;
01794848 2366
fa08c86b 2367 for (i = 0; i < num_permitted_opens; i++)
2368 if (permitted_opens[i].listen_port == listen_port)
01794848 2369 return connect_to(
fa08c86b 2370 permitted_opens[i].host_to_connect,
2371 permitted_opens[i].port_to_connect);
0b6fbf03 2372 error("WARNING: Server requests forwarding for unknown listen_port %d",
2373 listen_port);
fa08c86b 2374 return -1;
2375}
48e671d5 2376
01794848 2377/* Check if connecting to that port is permitted and connect. */
2378int
2379channel_connect_to(const char *host, u_short port)
2380{
2381 int i, permit;
2382
2383 permit = all_opens_permitted;
2384 if (!permit) {
2385 for (i = 0; i < num_permitted_opens; i++)
2386 if (permitted_opens[i].port_to_connect == port &&
2387 strcmp(permitted_opens[i].host_to_connect, host) == 0)
2388 permit = 1;
2389
2390 }
2391 if (!permit) {
2392 log("Received request to connect to host %.100s port %d, "
2393 "but the request was denied.", host, port);
2394 return -1;
2395 }
2396 return connect_to(host, port);
2397}
2398
8e7895b8 2399/* -- X11 forwarding */
8efc0c15 2400
aa3378df 2401/*
2402 * Creates an internet domain socket for listening for X11 connections.
2403 * Returns a suitable value for the DISPLAY variable, or NULL if an error
2404 * occurs.
2405 */
5260325f 2406char *
95f1eccc 2407x11_create_display_inet(int screen_number, int x11_display_offset)
8efc0c15 2408{
57112b5a 2409 int display_number, sock;
2410 u_short port;
48e671d5 2411 struct addrinfo hints, *ai, *aitop;
2412 char strport[NI_MAXSERV];
2413 int gaierr, n, num_socks = 0, socks[NUM_SOCKS];
2414 char display[512];
5260325f 2415 char hostname[MAXHOSTNAMELEN];
2416
95f1eccc 2417 for (display_number = x11_display_offset;
5260325f 2418 display_number < MAX_DISPLAYS;
2419 display_number++) {
2420 port = 6000 + display_number;
48e671d5 2421 memset(&hints, 0, sizeof(hints));
2422 hints.ai_family = IPv4or6;
2423 hints.ai_flags = AI_PASSIVE; /* XXX loopback only ? */
2424 hints.ai_socktype = SOCK_STREAM;
2425 snprintf(strport, sizeof strport, "%d", port);
2426 if ((gaierr = getaddrinfo(NULL, strport, &hints, &aitop)) != 0) {
2427 error("getaddrinfo: %.100s", gai_strerror(gaierr));
5260325f 2428 return NULL;
2429 }
48e671d5 2430 for (ai = aitop; ai; ai = ai->ai_next) {
2431 if (ai->ai_family != AF_INET && ai->ai_family != AF_INET6)
2432 continue;
2433 sock = socket(ai->ai_family, SOCK_STREAM, 0);
2434 if (sock < 0) {
4ee81249 2435 if ((errno != EINVAL) && (errno != EAFNOSUPPORT)) {
80a44451 2436 error("socket: %.100s", strerror(errno));
2437 return NULL;
2438 } else {
22d89d24 2439 debug("x11_create_display_inet: Socket family %d not supported",
2440 ai->ai_family);
80a44451 2441 continue;
2442 }
48e671d5 2443 }
2444 if (bind(sock, ai->ai_addr, ai->ai_addrlen) < 0) {
2445 debug("bind port %d: %.100s", port, strerror(errno));
48e671d5 2446 close(sock);
16218745 2447
2448 if (ai->ai_next)
2449 continue;
2450
48e671d5 2451 for (n = 0; n < num_socks; n++) {
48e671d5 2452 close(socks[n]);
2453 }
2454 num_socks = 0;
2455 break;
2456 }
2457 socks[num_socks++] = sock;
80faa19f 2458#ifndef DONT_TRY_OTHER_AF
48e671d5 2459 if (num_socks == NUM_SOCKS)
2460 break;
80faa19f 2461#else
2462 break;
2463#endif
5260325f 2464 }
4ccb01d6 2465 freeaddrinfo(aitop);
48e671d5 2466 if (num_socks > 0)
2467 break;
5260325f 2468 }
2469 if (display_number >= MAX_DISPLAYS) {
2470 error("Failed to allocate internet-domain X11 display socket.");
2471 return NULL;
8efc0c15 2472 }
5260325f 2473 /* Start listening for connections on the socket. */
48e671d5 2474 for (n = 0; n < num_socks; n++) {
2475 sock = socks[n];
2476 if (listen(sock, 5) < 0) {
2477 error("listen: %.100s", strerror(errno));
48e671d5 2478 close(sock);
2479 return NULL;
2480 }
8efc0c15 2481 }
48e671d5 2482
5260325f 2483 /* Set up a suitable value for the DISPLAY variable. */
2484 if (gethostname(hostname, sizeof(hostname)) < 0)
2485 fatal("gethostname: %.100s", strerror(errno));
a7effaac 2486
2487#ifdef IPADDR_IN_DISPLAY
2b87da3b 2488 /*
a7effaac 2489 * HPUX detects the local hostname in the DISPLAY variable and tries
2490 * to set up a shared memory connection to the server, which it
2491 * incorrectly supposes to be local.
2492 *
2493 * The workaround - as used in later $$H and other programs - is
2494 * is to set display to the host's IP address.
2495 */
2496 {
2497 struct hostent *he;
2498 struct in_addr my_addr;
2499
2500 he = gethostbyname(hostname);
2501 if (he == NULL) {
2502 error("[X11-broken-fwd-hostname-workaround] Could not get "
2503 "IP address for hostname %s.", hostname);
2504
2505 packet_send_debug("[X11-broken-fwd-hostname-workaround]"
2506 "Could not get IP address for hostname %s.", hostname);
2507
2508 shutdown(sock, SHUT_RDWR);
2509 close(sock);
2510
2511 return NULL;
2512 }
2513
2514 memcpy(&my_addr, he->h_addr_list[0], sizeof(struct in_addr));
2515
2516 /* Set DISPLAY to <ip address>:screen.display */
2b87da3b 2517 snprintf(display, sizeof(display), "%.50s:%d.%d", inet_ntoa(my_addr),
74141647 2518 display_number, screen_number);
a7effaac 2519 }
2520#else /* IPADDR_IN_DISPLAY */
2521 /* Just set DISPLAY to hostname:screen.display */
48e671d5 2522 snprintf(display, sizeof display, "%.400s:%d.%d", hostname,
74141647 2523 display_number, screen_number);
a7effaac 2524#endif /* IPADDR_IN_DISPLAY */
5260325f 2525
48e671d5 2526 /* Allocate a channel for each socket. */
2527 for (n = 0; n < num_socks; n++) {
2528 sock = socks[n];
0b242b12 2529 (void) channel_new("x11 listener",
2530 SSH_CHANNEL_X11_LISTENER, sock, sock, -1,
2531 CHAN_X11_WINDOW_DEFAULT, CHAN_X11_PACKET_DEFAULT,
a22aff1f 2532 0, xstrdup("X11 inet listener"), 1);
48e671d5 2533 }
5260325f 2534
2535 /* Return a suitable value for the DISPLAY environment variable. */
48e671d5 2536 return xstrdup(display);
8efc0c15 2537}
2538
2539#ifndef X_UNIX_PATH
2540#define X_UNIX_PATH "/tmp/.X11-unix/X"
2541#endif
2542
396c147e 2543static int
1e3b8b07 2544connect_local_xsocket(u_int dnr)
8efc0c15 2545{
5260325f 2546 static const char *const x_sockets[] = {
2547 X_UNIX_PATH "%u",
2548 "/var/X/.X11-unix/X" "%u",
2549 "/usr/spool/sockets/X11/" "%u",
2550 NULL
2551 };
2552 int sock;
2553 struct sockaddr_un addr;
2554 const char *const * path;
2555
2556 for (path = x_sockets; *path; ++path) {
2557 sock = socket(AF_UNIX, SOCK_STREAM, 0);
2558 if (sock < 0)
2559 error("socket: %.100s", strerror(errno));
2560 memset(&addr, 0, sizeof(addr));
2561 addr.sun_family = AF_UNIX;
2562 snprintf(addr.sun_path, sizeof addr.sun_path, *path, dnr);
2563 if (connect(sock, (struct sockaddr *) & addr, sizeof(addr)) == 0)
2564 return sock;
2565 close(sock);
2566 }
2567 error("connect %.100s: %.100s", addr.sun_path, strerror(errno));
2568 return -1;
8efc0c15 2569}
2570
0b242b12 2571int
2572x11_connect_display(void)
8efc0c15 2573{
d24631c9 2574 int display_number, sock = 0, on = 1;
5260325f 2575 const char *display;
0b242b12 2576 char buf[1024], *cp;
48e671d5 2577 struct addrinfo hints, *ai, *aitop;
2578 char strport[NI_MAXSERV];
2579 int gaierr;
5260325f 2580
5260325f 2581 /* Try to open a socket for the local X server. */
2582 display = getenv("DISPLAY");
2583 if (!display) {
2584 error("DISPLAY not set.");
0b242b12 2585 return -1;
5260325f 2586 }
aa3378df 2587 /*
2588 * Now we decode the value of the DISPLAY variable and make a
2589 * connection to the real X server.
2590 */
2591
2592 /*
2593 * Check if it is a unix domain socket. Unix domain displays are in
2594 * one of the following formats: unix:d[.s], :d[.s], ::d[.s]
2595 */
5260325f 2596 if (strncmp(display, "unix:", 5) == 0 ||
2597 display[0] == ':') {
2598 /* Connect to the unix domain socket. */
2599 if (sscanf(strrchr(display, ':') + 1, "%d", &display_number) != 1) {
2600 error("Could not parse display number from DISPLAY: %.100s",
2601 display);
0b242b12 2602 return -1;
5260325f 2603 }
2604 /* Create a socket. */
2605 sock = connect_local_xsocket(display_number);
2606 if (sock < 0)
0b242b12 2607 return -1;
5260325f 2608
2609 /* OK, we now have a connection to the display. */
0b242b12 2610 return sock;
5260325f 2611 }
aa3378df 2612 /*
2613 * Connect to an inet socket. The DISPLAY value is supposedly
2614 * hostname:d[.s], where hostname may also be numeric IP address.
2615 */
74860245 2616 strlcpy(buf, display, sizeof(buf));
5260325f 2617 cp = strchr(buf, ':');
2618 if (!cp) {
2619 error("Could not find ':' in DISPLAY: %.100s", display);
0b242b12 2620 return -1;
5260325f 2621 }
2622 *cp = 0;
aa3378df 2623 /* buf now contains the host name. But first we parse the display number. */
5260325f 2624 if (sscanf(cp + 1, "%d", &display_number) != 1) {
2625 error("Could not parse display number from DISPLAY: %.100s",
2626 display);
0b242b12 2627 return -1;
5260325f 2628 }
5260325f 2629
48e671d5 2630 /* Look up the host address */
2631 memset(&hints, 0, sizeof(hints));
2632 hints.ai_family = IPv4or6;
2633 hints.ai_socktype = SOCK_STREAM;
2634 snprintf(strport, sizeof strport, "%d", 6000 + display_number);
2635 if ((gaierr = getaddrinfo(buf, strport, &hints, &aitop)) != 0) {
2636 error("%.100s: unknown host. (%s)", buf, gai_strerror(gaierr));
0b242b12 2637 return -1;
8efc0c15 2638 }
48e671d5 2639 for (ai = aitop; ai; ai = ai->ai_next) {
2640 /* Create a socket. */
2641 sock = socket(ai->ai_family, SOCK_STREAM, 0);
2642 if (sock < 0) {
2643 debug("socket: %.100s", strerror(errno));
7368a6c8 2644 continue;
2645 }
2646 /* Connect it to the display. */
2647 if (connect(sock, ai->ai_addr, ai->ai_addrlen) < 0) {
2648 debug("connect %.100s port %d: %.100s", buf,
2649 6000 + display_number, strerror(errno));
2650 close(sock);
2651 continue;
2652 }
2653 /* Success */
2654 break;
48e671d5 2655 }
48e671d5 2656 freeaddrinfo(aitop);
2657 if (!ai) {
6ae2364d 2658 error("connect %.100s port %d: %.100s", buf, 6000 + display_number,
48e671d5 2659 strerror(errno));
0b242b12 2660 return -1;
8efc0c15 2661 }
d24631c9 2662 if (setsockopt(sock, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on) == -1)
2663 error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
0b242b12 2664 return sock;
2665}
5260325f 2666
0b242b12 2667/*
2668 * This is called when SSH_SMSG_X11_OPEN is received. The packet contains
2669 * the remote channel number. We should do whatever we want, and respond
2670 * with either SSH_MSG_OPEN_CONFIRMATION or SSH_MSG_OPEN_FAILURE.
2671 */
5260325f 2672
0b242b12 2673void
188adeb2 2674x11_input_open(int type, int plen, void *ctxt)
0b242b12 2675{
719fc62f 2676 Channel *c = NULL;
2677 int remote_id, sock = 0;
0b242b12 2678 char *remote_host;
5260325f 2679
719fc62f 2680 debug("Received X11 open request.");
5260325f 2681
719fc62f 2682 remote_id = packet_get_int();
8e7895b8 2683
2684 if (packet_get_protocol_flags() & SSH_PROTOFLAG_HOST_IN_FWD_OPEN) {
719fc62f 2685 remote_host = packet_get_string(NULL);
0b242b12 2686 } else {
2687 remote_host = xstrdup("unknown (remote did not supply name)");
0b242b12 2688 }
719fc62f 2689 packet_done();
0b242b12 2690
2691 /* Obtain a connection to the real X display. */
2692 sock = x11_connect_display();
719fc62f 2693 if (sock != -1) {
2694 /* Allocate a channel for this connection. */
2695 c = channel_new("connected x11 socket",
2696 SSH_CHANNEL_X11_OPEN, sock, sock, -1, 0, 0, 0,
2697 remote_host, 1);
2698 if (c == NULL) {
2699 error("x11_input_open: channel_new failed");
2700 close(sock);
2701 } else {
2702 c->remote_id = remote_id;
a5f82435 2703 c->force_drain = 1;
719fc62f 2704 }
2705 }
2706 if (c == NULL) {
0b242b12 2707 /* Send refusal to the remote host. */
2708 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
719fc62f 2709 packet_put_int(remote_id);
0b242b12 2710 } else {
0b242b12 2711 /* Send a confirmation to the remote host. */
2712 packet_start(SSH_MSG_CHANNEL_OPEN_CONFIRMATION);
719fc62f 2713 packet_put_int(remote_id);
2714 packet_put_int(c->self);
0b242b12 2715 }
719fc62f 2716 packet_send();
8efc0c15 2717}
2718
a22aff1f 2719/* dummy protocol handler that denies SSH-1 requests (agent/x11) */
2720void
2721deny_input_open(int type, int plen, void *ctxt)
2722{
2723 int rchan = packet_get_int();
6aacefa7 2724 switch (type) {
a22aff1f 2725 case SSH_SMSG_AGENT_OPEN:
2726 error("Warning: ssh server tried agent forwarding.");
2727 break;
2728 case SSH_SMSG_X11_OPEN:
2729 error("Warning: ssh server tried X11 forwarding.");
2730 break;
2731 default:
2732 error("deny_input_open: type %d plen %d", type, plen);
2733 break;
2734 }
2735 error("Warning: this is probably a break in attempt by a malicious server.");
2736 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
2737 packet_put_int(rchan);
2738 packet_send();
2739}
2740
aa3378df 2741/*
2742 * Requests forwarding of X11 connections, generates fake authentication
2743 * data, and enables authentication spoofing.
8e7895b8 2744 * This should be called in the client only.
aa3378df 2745 */
6ae2364d 2746void
0b242b12 2747x11_request_forwarding_with_spoofing(int client_session_id,
2748 const char *proto, const char *data)
8efc0c15 2749{
1e3b8b07 2750 u_int data_len = (u_int) strlen(data) / 2;
ca910e13 2751 u_int i, value, len;
5260325f 2752 char *new_data;
2753 int screen_number;
2754 const char *cp;
2755 u_int32_t rand = 0;
2756
2757 cp = getenv("DISPLAY");
2758 if (cp)
2759 cp = strchr(cp, ':');
2760 if (cp)
2761 cp = strchr(cp, '.');
2762 if (cp)
2763 screen_number = atoi(cp + 1);
2764 else
2765 screen_number = 0;
2766
2767 /* Save protocol name. */
2768 x11_saved_proto = xstrdup(proto);
2769
aa3378df 2770 /*
2771 * Extract real authentication data and generate fake data of the
2772 * same length.
2773 */
5260325f 2774 x11_saved_data = xmalloc(data_len);
2775 x11_fake_data = xmalloc(data_len);
2776 for (i = 0; i < data_len; i++) {
2777 if (sscanf(data + 2 * i, "%2x", &value) != 1)
2778 fatal("x11_request_forwarding: bad authentication data: %.100s", data);
2779 if (i % 4 == 0)
2780 rand = arc4random();
2781 x11_saved_data[i] = value;
2782 x11_fake_data[i] = rand & 0xff;
2783 rand >>= 8;
2784 }
2785 x11_saved_data_len = data_len;
2786 x11_fake_data_len = data_len;
2787
2788 /* Convert the fake data into hex. */
ca910e13 2789 len = 2 * data_len + 1;
2790 new_data = xmalloc(len);
5260325f 2791 for (i = 0; i < data_len; i++)
ca910e13 2792 snprintf(new_data + 2 * i, len - 2 * i,
2793 "%02x", (u_char) x11_fake_data[i]);
5260325f 2794
2795 /* Send the request packet. */
0b242b12 2796 if (compat20) {
2797 channel_request_start(client_session_id, "x11-req", 0);
2798 packet_put_char(0); /* XXX bool single connection */
2799 } else {
2800 packet_start(SSH_CMSG_X11_REQUEST_FORWARDING);
2801 }
2802 packet_put_cstring(proto);
2803 packet_put_cstring(new_data);
5260325f 2804 packet_put_int(screen_number);
2805 packet_send();
2806 packet_write_wait();
2807 xfree(new_data);
8efc0c15 2808}
2809
8e7895b8 2810
2811/* -- agent forwarding */
2812
8efc0c15 2813/* Sends a message to the server to request authentication fd forwarding. */
2814
6ae2364d 2815void
d5bb9418 2816auth_request_forwarding(void)
8efc0c15 2817{
5260325f 2818 packet_start(SSH_CMSG_AGENT_REQUEST_FORWARDING);
2819 packet_send();
2820 packet_write_wait();
8efc0c15 2821}
2822
aa3378df 2823/*
2824 * Returns the name of the forwarded authentication socket. Returns NULL if
2825 * there is no forwarded authentication socket. The returned value points to
2826 * a static buffer.
2827 */
8efc0c15 2828
5260325f 2829char *
d5bb9418 2830auth_get_socket_name(void)
8efc0c15 2831{
8e7895b8 2832 return auth_sock_name;
8efc0c15 2833}
2834
2835/* removes the agent forwarding socket */
2836
6ae2364d 2837void
f0f32b8e 2838auth_sock_cleanup_proc(void *_pw)
5260325f 2839{
f0f32b8e 2840 struct passwd *pw = _pw;
2841
e4f7282d 2842 if (auth_sock_name) {
f0f32b8e 2843 temporarily_use_uid(pw);
e4f7282d 2844 unlink(auth_sock_name);
2845 rmdir(auth_sock_dir);
2846 auth_sock_name = NULL;
f0f32b8e 2847 restore_uid();
e4f7282d 2848 }
8efc0c15 2849}
2850
aa3378df 2851/*
fa649821 2852 * This is called to process SSH_CMSG_AGENT_REQUEST_FORWARDING on the server.
aa3378df 2853 * This starts forwarding authentication requests.
2854 */
8efc0c15 2855
fa649821 2856int
5260325f 2857auth_input_request_forwarding(struct passwd * pw)
8efc0c15 2858{
719fc62f 2859 Channel *nc;
2860 int sock;
5260325f 2861 struct sockaddr_un sunaddr;
2862
8e7895b8 2863 if (auth_get_socket_name() != NULL) {
2864 error("authentication forwarding requested twice.");
2865 return 0;
2866 }
5260325f 2867
2868 /* Temporarily drop privileged uid for mkdir/bind. */
63bd8c36 2869 temporarily_use_uid(pw);
5260325f 2870
2871 /* Allocate a buffer for the socket name, and format the name. */
8e7895b8 2872 auth_sock_name = xmalloc(MAXPATHLEN);
2873 auth_sock_dir = xmalloc(MAXPATHLEN);
2874 strlcpy(auth_sock_dir, "/tmp/ssh-XXXXXXXX", MAXPATHLEN);
5260325f 2875
2876 /* Create private directory for socket */
8e7895b8 2877 if (mkdtemp(auth_sock_dir) == NULL) {
2878 packet_send_debug("Agent forwarding disabled: "
2879 "mkdtemp() failed: %.100s", strerror(errno));
fa649821 2880 restore_uid();
8e7895b8 2881 xfree(auth_sock_name);
2882 xfree(auth_sock_dir);
2883 auth_sock_name = NULL;
2884 auth_sock_dir = NULL;
fa649821 2885 return 0;
2886 }
8e7895b8 2887 snprintf(auth_sock_name, MAXPATHLEN, "%s/agent.%d",
2888 auth_sock_dir, (int) getpid());
5260325f 2889
e4f7282d 2890 /* delete agent socket on fatal() */
f0f32b8e 2891 fatal_add_cleanup(auth_sock_cleanup_proc, pw);
e4f7282d 2892
5260325f 2893 /* Create the socket. */
2894 sock = socket(AF_UNIX, SOCK_STREAM, 0);
2895 if (sock < 0)
2896 packet_disconnect("socket: %.100s", strerror(errno));
2897
2898 /* Bind it to the name. */
2899 memset(&sunaddr, 0, sizeof(sunaddr));
2900 sunaddr.sun_family = AF_UNIX;
74860245 2901 strlcpy(sunaddr.sun_path, auth_sock_name, sizeof(sunaddr.sun_path));
5260325f 2902
2903 if (bind(sock, (struct sockaddr *) & sunaddr, sizeof(sunaddr)) < 0)
2904 packet_disconnect("bind: %.100s", strerror(errno));
2905
2906 /* Restore the privileged uid. */
2907 restore_uid();
2908
2909 /* Start listening on the socket. */
2910 if (listen(sock, 5) < 0)
2911 packet_disconnect("listen: %.100s", strerror(errno));
2912
2913 /* Allocate a channel for the authentication agent socket. */
719fc62f 2914 nc = channel_new("auth socket",
fa08c86b 2915 SSH_CHANNEL_AUTH_SOCKET, sock, sock, -1,
2916 CHAN_X11_WINDOW_DEFAULT, CHAN_X11_PACKET_DEFAULT,
2917 0, xstrdup("auth socket"), 1);
719fc62f 2918 if (nc == NULL) {
2919 error("auth_input_request_forwarding: channel_new failed");
f0f32b8e 2920 auth_sock_cleanup_proc(pw);
750c256a 2921 fatal_remove_cleanup(auth_sock_cleanup_proc, pw);
719fc62f 2922 close(sock);
2923 return 0;
2924 }
8e7895b8 2925 strlcpy(nc->path, auth_sock_name, sizeof(nc->path));
fa649821 2926 return 1;
8efc0c15 2927}
2928
2929/* This is called to process an SSH_SMSG_AGENT_OPEN message. */
2930
6ae2364d 2931void
188adeb2 2932auth_input_open_request(int type, int plen, void *ctxt)
8efc0c15 2933{
719fc62f 2934 Channel *c = NULL;
2935 int remote_id, sock;
8e7895b8 2936 char *name;
5260325f 2937
7368a6c8 2938 packet_integrity_check(plen, 4, type);
2939
5260325f 2940 /* Read the remote channel number from the message. */
719fc62f 2941 remote_id = packet_get_int();
5260325f 2942
aa3378df 2943 /*
2944 * Get a connection to the local authentication agent (this may again
2945 * get forwarded).
2946 */
5260325f 2947 sock = ssh_get_authentication_socket();
2948
aa3378df 2949 /*
2950 * If we could not connect the agent, send an error message back to
2951 * the server. This should never happen unless the agent dies,
2952 * because authentication forwarding is only enabled if we have an
2953 * agent.
2954 */
719fc62f 2955 if (sock >= 0) {
8e7895b8 2956 name = xstrdup("authentication agent connection");
2957 c = channel_new("", SSH_CHANNEL_OPEN, sock, sock,
2958 -1, 0, 0, 0, name, 1);
719fc62f 2959 if (c == NULL) {
2960 error("auth_input_open_request: channel_new failed");
8e7895b8 2961 xfree(name);
719fc62f 2962 close(sock);
2963 } else {
2964 c->remote_id = remote_id;
a5f82435 2965 c->force_drain = 1;
719fc62f 2966 }
2967 }
2968 if (c == NULL) {
5260325f 2969 packet_start(SSH_MSG_CHANNEL_OPEN_FAILURE);
719fc62f 2970 packet_put_int(remote_id);
2971 } else {
2972 /* Send a confirmation to the remote host. */
2973 debug("Forwarding authentication connection.");
2974 packet_start(SSH_MSG_CHANNEL_OPEN_CONFIRMATION);
2975 packet_put_int(remote_id);
2976 packet_put_int(c->self);
5260325f 2977 }
5260325f 2978 packet_send();
8efc0c15 2979}
This page took 8.546588 seconds and 5 git commands to generate.