channel.c 56 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/* channel.c
 *
 * $Id$
 */

/* lsh, an implementation of the ssh protocol
 *
 * Copyright (C) 1998 Niels Mller
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
J.H.M. Dassen's avatar
J.H.M. Dassen committed
22
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
Niels Möller's avatar
Niels Möller committed
23
24
25
26
27
 */

#include "channel.h"

#include "format.h"
28
#include "io.h"
Niels Möller's avatar
Niels Möller committed
29
#include "read_data.h"
Niels Möller's avatar
Niels Möller committed
30
31
32
33
34
#include "ssh.h"
#include "werror.h"
#include "xalloc.h"

#include <assert.h>
35
#include <string.h>
Niels Möller's avatar
Niels Möller committed
36

37
#define GABA_DEFINE
38
#include "channel.h.x"
39
#undef GABA_DEFINE
40

41
42
#include "channel.c.x"

43
44
struct exception *
make_channel_open_exception(UINT32 error_code, const char *msg)
Niels Möller's avatar
Niels Möller committed
45
46
{
  NEW(channel_open_exception, self);
Niels Möller's avatar
Niels Möller committed
47
48
49
50
51
52
53
54
55
56
57
58
59
60

#define MAX_ERROR 4
  static const char *msgs[MAX_ERROR + 1] = {
    "",
    "Administratively prohibited",
    "Connect failed",
    "Unknown channel type",
    "Resource shortage"
  };

  assert(error_code > 0);
  assert(error_code <= MAX_ERROR);
#undef MAX_ERROR
  
Niels Möller's avatar
Niels Möller committed
61
  self->super.type = EXC_CHANNEL_OPEN;
Niels Möller's avatar
Niels Möller committed
62
  self->super.msg = msg ? msg : msgs[error_code];
Niels Möller's avatar
Niels Möller committed
63
64
65
66
67
  self->error_code = error_code;

  return &self->super;
}

68
/* GABA:
69
70
   (class
     (name connection_service)
71
     (super command)
72
73
74
75
     (vars
       ; Supported global requests 
       (global_requests object alist)

76
       (channel_types object alist) ))
77
78
79
80

       ; Initialize connection (for instance, request channels to be 
       ; opened or services to be forwarded).

81
       ; (start object connection_startup)))
82
83
*/

84

85
86
struct lsh_string *
format_global_failure(void)
Niels Möller's avatar
Niels Möller committed
87
88
89
90
{
  return ssh_format("%c", SSH_MSG_REQUEST_FAILURE);
}

91
92
struct lsh_string *
format_global_success(void)
93
94
95
96
{
  return ssh_format("%c", SSH_MSG_REQUEST_SUCCESS);
}

97
98
99
100
struct lsh_string *
format_open_confirmation(struct ssh_channel *channel,
			 UINT32 channel_number,
			 const char *format, ...)
101
102
103
104
105
106
{
  va_list args;
  UINT32 l1, l2;
  struct lsh_string *packet;

#define CONFIRM_FORMAT "%c%i%i%i%i"
107
108
#define CONFIRM_ARGS \
  SSH_MSG_CHANNEL_OPEN_CONFIRMATION, channel->channel_number, \
109
110
  channel_number, channel->rec_window_size, channel->rec_max_packet
    
111
  debug("format_open_confirmation: rec_window_size = %i,\n"
112
	"                          rec_max_packet = %i,\n",
113
       channel->rec_window_size,
114
       channel->rec_max_packet);
115
116
117
118
119
120
121
122
123
124
125
  l1 = ssh_format_length(CONFIRM_FORMAT, CONFIRM_ARGS);

  va_start(args, format);
  l2 = ssh_vformat_length(format, args);
  va_end(args);

  packet = lsh_string_alloc(l1 + l2);

  ssh_format_write(CONFIRM_FORMAT, l1, packet->data, CONFIRM_ARGS);

  va_start(args, format);
126
  ssh_vformat_write(format, l2, packet->data+l1, args);
127
128
129
130
131
132
133
  va_end(args);

  return packet;
#undef CONFIRM_FORMAT
#undef CONFIRM_ARGS
}

134
135
136
struct lsh_string *
format_open_failure(UINT32 channel, UINT32 reason,
		    const char *msg, const char *language)
Niels Möller's avatar
Niels Möller committed
137
138
139
140
141
{
  return ssh_format("%c%i%i%z%z", SSH_MSG_CHANNEL_OPEN_FAILURE,
		    channel, reason, msg, language);
}

142
143
struct lsh_string *
format_channel_success(UINT32 channel)
144
145
146
147
{
  return ssh_format("%c%i", SSH_MSG_CHANNEL_SUCCESS, channel);
}

148
149
struct lsh_string *
format_channel_failure(UINT32 channel)
Niels Möller's avatar
Niels Möller committed
150
151
152
153
{
  return ssh_format("%c%i", SSH_MSG_CHANNEL_FAILURE, channel);
}

154
155
156
struct lsh_string *
prepare_window_adjust(struct ssh_channel *channel,
		      UINT32 add)
157
158
159
160
161
162
163
164
{
  channel->rec_window_size += add;
  
  return ssh_format("%c%i%i",
		    SSH_MSG_CHANNEL_WINDOW_ADJUST,
		    channel->channel_number, add);
}

Niels Möller's avatar
Niels Möller committed
165
166
167
168
169
/* GABA:
   (class
     (name exc_finish_channel_handler)
     (super exception_handler)
     (vars
170
       (connection object ssh_connection)
171
172
       ; Non-zero if the channel has already been deallocated.
       (dead . int)
Niels Möller's avatar
Niels Möller committed
173
174
175
176
       ; Local channel number 
       (channel_number . UINT32)))
*/

177
178
179
static void
do_exc_finish_channel_handler(struct exception_handler *s,
			      const struct exception *e)
Niels Möller's avatar
Niels Möller committed
180
181
182
183
184
{
  CAST(exc_finish_channel_handler, self, s);

  switch (e->type)
    {
Niels Möller's avatar
Niels Möller committed
185
    case EXC_FINISH_PENDING:
186
187
      if (self->dead)
	werror("channel.c: EXC_FINISH_PENDING on dead channel.\n");
Niels Möller's avatar
Niels Möller committed
188

189
      self->connection->table->pending_close = 1;
190
      
191
192
      if (!self->connection->table->next_channel)
	EXCEPTION_RAISE(self->connection->e, &finish_read_exception);
Niels Möller's avatar
Niels Möller committed
193
194
      break;
      
Niels Möller's avatar
Niels Möller committed
195
196
    case EXC_FINISH_CHANNEL:
      /* NOTE: This type of exception must be handled only once.
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
       * However, there is at least one case where it is difficult to
       * ensure that the exception is raised only once.
       *
       * For instance, in do_channel_close, the CHANNEL_EOF callback
       * can decide to call close_channel, which might raise this
       * exception. When control gets back to do_channel_close, and
       * CHANNEL_SENT_CLOSE is true, it raises the exception again.
       *
       * To get this right, we set a flag when the channel is
       * deallocated. */
      if (self->dead)
	debug("EXC_FINISH_CHANNEL on dead channel.\n");
      else
	{
	  struct ssh_channel *channel
212
	    = self->connection->table->channels[self->channel_number];
213
214
215
216
217
218
219
220

	  assert(channel);
	  assert(channel->resources->super.alive);

	  if (channel->close)
	    CHANNEL_CLOSE(channel);
	
	  KILL_RESOURCE_LIST(channel->resources);
Niels Möller's avatar
Niels Möller committed
221
	
222
	  dealloc_channel(self->connection->table, self->channel_number);
223
224
	  self->dead = 1;

225
226
	  if (self->connection->table->pending_close &&
	      !self->connection->table->next_channel)
227
228
	    {
	      /* FIXME: Send a SSH_DISCONNECT_BY_APPLICATION message? */
229
	      EXCEPTION_RAISE(self->connection->e, &finish_read_exception);
230
231
	    }
	}
Niels Möller's avatar
Niels Möller committed
232
233
234
235
236
237
238
      break;
    default:
      EXCEPTION_RAISE(self->super.parent, e);
    }
}

static struct exception_handler *
239
make_exc_finish_channel_handler(struct ssh_connection *connection,
Niels Möller's avatar
Niels Möller committed
240
				UINT32 channel_number,
241
242
				struct exception_handler *e,
				const char *context)
Niels Möller's avatar
Niels Möller committed
243
244
245
246
{
  NEW(exc_finish_channel_handler, self);
  self->super.parent = e;
  self->super.raise = do_exc_finish_channel_handler;
247
  self->super.context = context;
Niels Möller's avatar
Niels Möller committed
248

249
  self->connection = connection;
250
  self->channel_number = channel_number;
251
  self->dead = 0;
252
  
Niels Möller's avatar
Niels Möller committed
253
  return &self->super;
Niels Möller's avatar
Niels Möller committed
254
255
256
}
				

257
/* Channel objects */
Niels Möller's avatar
Niels Möller committed
258
259
260
261
262

#define INITIAL_CHANNELS 32
/* Arbitrary limit */
#define MAX_CHANNELS (1L<<17)

263
264
struct channel_table *
make_channel_table(void)
Niels Möller's avatar
Niels Möller committed
265
{
266
  NEW(channel_table, table);
Niels Möller's avatar
Niels Möller committed
267

268
  table->channels = lsh_space_alloc(sizeof(struct ssh_channel *)
269
				      * INITIAL_CHANNELS);
Niels Möller's avatar
Niels Möller committed
270
271
  table->in_use = lsh_space_alloc(INITIAL_CHANNELS);
  
272
273
274
275
  table->allocated_channels = INITIAL_CHANNELS;
  table->next_channel = 0;
  table->used_channels = 0;
  table->max_channels = MAX_CHANNELS;
Niels Möller's avatar
Niels Möller committed
276

Niels Möller's avatar
Niels Möller committed
277
  table->pending_close = 0;
278

279
280
  table->global_requests = make_alist(0, -1);
  table->channel_types = make_alist(0, -1);
281
  table->open_fallback = NULL;
282
  
283
284
285
  object_queue_init(&table->local_ports);
  object_queue_init(&table->remote_ports);
  
286
287
  object_queue_init(&table->active_global_requests);
  object_queue_init(&table->pending_global_requests);
Niels Möller's avatar
Niels Möller committed
288
  
289
  return table;
290
}
Niels Möller's avatar
Niels Möller committed
291
292

/* Returns -1 if allocation fails */
293
294
295
/* NOTE: This function returns locally chosen channel numbers, which
 * are always small integers. So there's no problem fitting them in
 * a signed int. */
296
297
int
alloc_channel(struct channel_table *table)
Niels Möller's avatar
Niels Möller committed
298
{
299
  UINT32 i;
300
  
301
  for(i = table->next_channel; i < table->used_channels; i++)
Niels Möller's avatar
Niels Möller committed
302
    {
303
      if (table->in_use[i] == CHANNEL_FREE)
Niels Möller's avatar
Niels Möller committed
304
	{
Niels Möller's avatar
Niels Möller committed
305
	  assert(!table->channels[i]);
306
	  table->in_use[i] = CHANNEL_RESERVED;
307
	  table->next_channel = i+1;
308

309
	  verbose("Allocated local channel number %i\n", i);
Niels Möller's avatar
Niels Möller committed
310
311
312
	  return i;
	}
    }
313
  if (i == table->max_channels)
Niels Möller's avatar
Niels Möller committed
314
    return -1;
315

316
  if (i == table->allocated_channels) 
Niels Möller's avatar
Niels Möller committed
317
    {
318
      UINT32 new_size = table->allocated_channels * 2;
Niels Möller's avatar
Niels Möller committed
319
      struct ssh_channel **new_channels;
Niels Möller's avatar
Niels Möller committed
320
      UINT8 *new_in_use;
Niels Möller's avatar
Niels Möller committed
321

Niels Möller's avatar
Niels Möller committed
322
323
324
      new_channels = lsh_space_alloc(sizeof(struct ssh_channel *)
				     * new_size);
      memcpy(new_channels, table->channels,
325
	     sizeof(struct ssh_channel *) * table->used_channels);
Niels Möller's avatar
Niels Möller committed
326
327
328
      lsh_space_free(table->channels);
      table->channels = new_channels;

329
      /* FIXME: Use realloc(). */
Niels Möller's avatar
Niels Möller committed
330
331
332
333
334
      new_in_use = lsh_space_alloc(new_size);
      memcpy(new_in_use, table->in_use, table->used_channels);
      lsh_space_free(table->in_use);
      table->in_use = new_in_use;

335
      table->allocated_channels = new_size;
Niels Möller's avatar
Niels Möller committed
336
337
    }

338
  table->next_channel = table->used_channels = i+1;
Niels Möller's avatar
Niels Möller committed
339

340
  table->in_use[i] = CHANNEL_RESERVED;
341
  verbose("Allocated local channel number %i\n", i);
342

Niels Möller's avatar
Niels Möller committed
343
344
345
  return i;
}

346
347
void
dealloc_channel(struct channel_table *table, int i)
Niels Möller's avatar
Niels Möller committed
348
349
{
  assert(i >= 0);
350
  assert( (unsigned) i < table->used_channels);
351

352
  verbose("Deallocating local channel %i\n", i);
353
  table->channels[i] = NULL;
354
  table->in_use[i] = CHANNEL_FREE;
Niels Möller's avatar
Niels Möller committed
355
  
356
  if ( (unsigned) i < table->next_channel)
357
358
359
    table->next_channel = i;
}

360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
void
use_channel(struct ssh_connection *connection,
	    UINT32 local_channel_number)
{
  struct channel_table *table = connection->table;
  struct ssh_channel *channel = table->channels[local_channel_number];

  assert(channel);
  assert(table->in_use[local_channel_number] == CHANNEL_RESERVED);
  
  table->in_use[local_channel_number] = CHANNEL_IN_USE;
  verbose("Taking channel %i in use, (local %i).\n",
	  channel->channel_number, local_channel_number);
}
	    
375
376
377
void
register_channel(struct ssh_connection *connection,
		 UINT32 local_channel_number,
378
379
		 struct ssh_channel *channel,
		 int take_into_use)
380
{
381
382
  struct channel_table *table = connection->table;
  
383
  assert(table->in_use[local_channel_number] == CHANNEL_RESERVED);
Niels Möller's avatar
Niels Möller committed
384
  assert(!table->channels[local_channel_number]);
385

386
387
388
  verbose("Registering local channel %i.\n",
	  local_channel_number);
  
389
  /* NOTE: Is this the right place to install this exception handler? */
390
391
392
393
394
395
396
  channel->e =
    make_exc_finish_channel_handler(connection,
				    local_channel_number,
				    channel->e ? channel->e : connection->e,
				    HANDLER_CONTEXT);

  table->channels[local_channel_number] = channel;
397

398
399
400
  if (take_into_use)
    use_channel(connection, local_channel_number);
  
401
  REMEMBER_RESOURCE(connection->resources, &channel->resources->super);
Niels Möller's avatar
Niels Möller committed
402
403
}

404
405
406
407
408
409
410
411
412
413
struct ssh_channel *
lookup_channel(struct channel_table *table, UINT32 i)
{
  return ( (i < table->used_channels)
	   && (table->in_use[i] == CHANNEL_IN_USE))
    ? table->channels[i] : NULL;
}

struct ssh_channel *
lookup_channel_reserved(struct channel_table *table, UINT32 i)
Niels Möller's avatar
Niels Möller committed
414
{
415
416
  return ( (i < table->used_channels)
	   && (table->in_use[i] == CHANNEL_RESERVED))
417
    ? table->channels[i] : NULL;
Niels Möller's avatar
Niels Möller committed
418
419
}

420

421
422
/* FIXME: It seems suboptimal to send a window adjust message for
 * *every* write that we do. A better scheme might be as follows:
423
424
425
426
427
428
429
 *
 * Delay window adjust messages, keeping track of both the locally
 * maintained window size, which is updated after each write, and the
 * size that has been reported to the remote end. When the difference
 * between these two values gets large enough (say, larger than one
 * half or one third of the maximum window size), we send a
 * window_adjust message to sync them. */
430
431
static void
adjust_rec_window(struct flow_controlled *f, UINT32 written)
432
{
433
434
  CAST_SUBTYPE(ssh_channel, channel, f);

435
436
437
438
439
440
  /* NOTE: The channel object (referenced as a flow-control callback)
   * may live longer than the actual channel. */
  if (! (channel->flags & (CHANNEL_RECEIVED_EOF | CHANNEL_RECEIVED_CLOSE
			   | CHANNEL_SENT_CLOSE)))
    A_WRITE(channel->write,
	    prepare_window_adjust(channel, written));
441
442
}

443
444
445
void
channel_start_receive(struct ssh_channel *channel,
		      UINT32 initial_window_size)
446
{
447
448
449
450
  if (channel->rec_window_size < initial_window_size)
    A_WRITE(channel->write,
	    prepare_window_adjust
	    (channel, initial_window_size - channel->rec_window_size));
451
452
}

Niels Möller's avatar
Niels Möller committed
453

454
455
456
/* Ugly macros to make it a little simpler to free the input packet at
 * the right time. */

Niels Möller's avatar
Niels Möller committed
457
458
459
460
461
#define RETURN goto foo_finish
#define END(s) do { foo_finish: \
                    lsh_string_free((s)); \
                    return; } while(0)

462

Niels Möller's avatar
Niels Möller committed
463
/* Channel related messages */
464
465
466

/* GABA:
   (class
467
     (name request_status)
468
469
470
471
472
473
474
     (vars
       ; -1 for still active requests,
       ; 0 for failure,
       ; 1 for success
       (status . int)))
*/

475
476
static struct request_status *
make_request_status(void)
477
{
478
  NEW(request_status, self);
479
480
481
482
483
484
485
  self->status = -1;

  return self;
}

/* GABA:
   (class
486
487
     (name global_request_continuation)
     (super command_continuation)
488
     (vars
489
490
       (connection object ssh_connection)
       (active object request_status)))
491
492
*/

493
494
495
static void 
send_global_request_responses(struct ssh_connection *connection, 
			      struct object_queue *q)
496
{
497
498
499
500
501
502
   for (;;)
     {
       CAST(request_status, n, object_queue_peek_head(q));
       if (!n || (n->status < 0))
	 break;
 
503
      object_queue_remove_head(q);
Niels Möller's avatar
Niels Möller committed
504

505
      C_WRITE(connection,
Niels Möller's avatar
Niels Möller committed
506
507
	      (n->status
	       ? format_global_success()
508
	       : format_global_failure()));
509
510
511
    }
}

512
513
514
static void
do_global_request_response(struct command_continuation *s,
			   struct lsh_object *x UNUSED)
515
{
516
517
  CAST(global_request_continuation, self, s);
  struct object_queue *q = &self->connection->table->active_global_requests;
518

519
520
521
522
  assert(self->active->status == -1);
  assert(!object_queue_is_empty(q));
	  
  self->active->status = 1;
523

524
525
  send_global_request_responses(self->connection, q);
}
526

527
528
529
530
531
532
533
534
535
536
static struct command_continuation *
make_global_request_response(struct ssh_connection *connection,
			     struct request_status *active)
{
  NEW(global_request_continuation, self);

  self->super.c = do_global_request_response;
  self->connection = connection;
  self->active = active;
   
537
538
  return &self->super;
}
539
540
541
542
543
544
545
546
547
548
549
550
551


/* GABA:
   (class
     (name global_request_exception_handler)
     (super exception_handler)
     (vars
       (connection object ssh_connection)
       (active object request_status)))
*/

/* NOTE: We handle *only* EXC_GLOBAL_REQUEST */
static void 
552
do_exc_global_request_handler(struct exception_handler *c,
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
			  const struct exception *e)
{
  CAST(global_request_exception_handler, self, c);
  if (e->type == EXC_GLOBAL_REQUEST)
    {
      struct object_queue *q = &self->connection->table->active_global_requests;
      
      assert(self->active->status == -1);
      assert(!object_queue_is_empty(q));

      self->active->status = 0;
  
      send_global_request_responses(self->connection, q);
    }
  else
    EXCEPTION_RAISE(c->parent, e);
}

static struct exception_handler *
make_global_request_exception_handler(struct ssh_connection *connection,
				      struct request_status *active,
				      struct exception_handler *h,
				      const char *context)
Niels Möller's avatar
Niels Möller committed
576
{
577
578
  NEW(global_request_exception_handler, self);

579
  self->super.raise = do_exc_global_request_handler;
580
581
582
583
584
585
  self->super.context = context;
  self->super.parent = h;
  self->active = active;
  self->connection = connection;
  return &self->super;
}
Niels Möller's avatar
Niels Möller committed
586

587
DEFINE_PACKET_HANDLER(static, global_request_handler, connection, packet)
588
{
Niels Möller's avatar
Niels Möller committed
589
  struct simple_buffer buffer;
590
  unsigned msg_number;
Niels Möller's avatar
Niels Möller committed
591
592
593
594
595
596
597
598
599
600
  int name;
  int want_reply;
  
  simple_buffer_init(&buffer, packet->length, packet->data);

  if (parse_uint8(&buffer, &msg_number)
      && (msg_number == SSH_MSG_GLOBAL_REQUEST)
      && parse_atom(&buffer, &name)
      && parse_boolean(&buffer, &want_reply))
    {
601
      struct global_request *req = NULL;
602
603
      struct command_continuation *c = &discard_continuation;
      struct exception_handler *e = connection->e;
604
605
606
607
608
609
610
611
612

      if (name && connection->table->global_requests)
	{
	  CAST_SUBTYPE(global_request, r,
		       ALIST_GET(connection->table->global_requests,
				 name));
	  req = r;
	}
      if (!req)
613
	{
Niels Möller's avatar
Niels Möller committed
614
	  lsh_string_free(packet);
615

Niels Möller's avatar
Niels Möller committed
616
617
	  C_WRITE(connection, format_global_failure());
	  return;
Niels Möller's avatar
Niels Möller committed
618
619
620
621
622
	}
      else
	{
	  if (want_reply)
	    {
623
	      struct request_status *a = make_request_status();
Niels Möller's avatar
Niels Möller committed
624
	      
Niels Möller's avatar
Niels Möller committed
625
	      object_queue_add_tail(&connection->table->active_global_requests,
Niels Möller's avatar
Niels Möller committed
626
627
628
				    &a->super);
	      
	      c = make_global_request_response(connection, a);
629
630
631
632
633
634
635
636
637
638
639
	      e = make_global_request_exception_handler(connection, a, e, HANDLER_CONTEXT);
	    }
	  else
	    {
	      /* We should ignore failures. */
	      static struct report_exception_info global_req_ignore =
		STATIC_REPORT_EXCEPTION_INFO(EXC_ALL, EXC_GLOBAL_REQUEST,
					     "Ignored:");
	      
	      e = make_report_exception_handler(&global_req_ignore,
						e, HANDLER_CONTEXT);
Niels Möller's avatar
Niels Möller committed
640
	    }
641
	  GLOBAL_REQUEST(req, connection, name, want_reply, &buffer, c, e);
642
	}
Niels Möller's avatar
Niels Möller committed
643
    }
Niels Möller's avatar
Niels Möller committed
644
645
  else
    {
646
      PROTOCOL_ERROR(connection->e, "Invalid SSH_MSG_GLOBAL_REQUEST message.");
Niels Möller's avatar
Niels Möller committed
647
648
    }
  lsh_string_free(packet);
Niels Möller's avatar
Niels Möller committed
649
650
}

651
652
DEFINE_PACKET_HANDLER(static, global_success_handler,
		      connection, packet)
653
654
{
  if (packet->length != 1)
Niels Möller's avatar
Niels Möller committed
655
    {
656
      PROTOCOL_ERROR(connection->e, "Invalid GLOBAL_REQUEST_SUCCESS message.");
Niels Möller's avatar
Niels Möller committed
657
658
      RETURN;
    }
659
660
661

  assert(packet->data[0] == SSH_MSG_REQUEST_SUCCESS);

Niels Möller's avatar
Niels Möller committed
662
  if (object_queue_is_empty(&connection->table->pending_global_requests))
663
664
    {
      werror("do_global_request_success: Unexpected message, ignoring.\n");
Niels Möller's avatar
Niels Möller committed
665
      return;
666
667
    }
  {
668
    CAST_SUBTYPE(command_context, ctx,
Niels Möller's avatar
Niels Möller committed
669
670
		 object_queue_remove_head(&connection->table->pending_global_requests));
    COMMAND_RETURN(ctx->c, connection);
671
  }
Niels Möller's avatar
Niels Möller committed
672
  END(packet);
673
674
}

675
676
677
struct exception global_request_exception =
STATIC_EXCEPTION(EXC_GLOBAL_REQUEST, "Global request failed");

678
679
DEFINE_PACKET_HANDLER(static, global_failure_handler,
		      connection, packet)
680
681
{
  if (packet->length != 1)
Niels Möller's avatar
Niels Möller committed
682
    {
683
      PROTOCOL_ERROR(connection->e, "Invalid GLOBAL_REQUEST_FAILURE message.");
Niels Möller's avatar
Niels Möller committed
684
685
      RETURN;
    }
686
687
688

  assert(packet->data[0] == SSH_MSG_REQUEST_FAILURE);

Niels Möller's avatar
Niels Möller committed
689
  if (object_queue_is_empty(&connection->table->pending_global_requests))
690
691
692
    {
      werror("do_global_request_failure: Unexpected message, ignoring.\n");
    }
Niels Möller's avatar
Niels Möller committed
693
694
695
696
697
698
699
  else
    {
      CAST_SUBTYPE(command_context, ctx,
		   object_queue_remove_head(&connection->table->pending_global_requests));
      EXCEPTION_RAISE(ctx->e, &global_request_exception);
    }
  END(packet);
700
701
}

702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
/* FIXME: Don't store the channel here, instead have it passed as the
 * argument of the continuation. This might also allow some
 * unification with the handling of global_requests. */

/* GABA:
   (class
     (name channel_request_continuation)
     (super command_continuation)
     (vars
       (connection object ssh_connection)
       (channel object ssh_channel)
       (active object request_status)))
*/

static void
send_channel_request_responses(struct ssh_connection *connection,
			       struct ssh_channel *channel,
			       struct object_queue *q)
{
  for (;;)
    {
      CAST(request_status, n, object_queue_peek_head(q));
      if (!n || (n->status < 0))
	break;

      object_queue_remove_head(q);

      C_WRITE(connection,
	      (n->status
	       ? format_channel_success(channel->channel_number)
	       : format_channel_failure(channel->channel_number)));
    }
}

static void
do_channel_request_response(struct command_continuation *s,
			    struct lsh_object *x UNUSED)
{
  CAST(channel_request_continuation, self, s);
  struct object_queue *q = &self->channel->active_requests;

  assert(self->active->status == -1);
  assert(!object_queue_is_empty(q));
	  
  self->active->status = 1;

  send_channel_request_responses(self->connection, self->channel, q);
}

static struct command_continuation *
make_channel_request_response(struct ssh_connection *connection,
			      struct ssh_channel *channel,
			      struct request_status *active)
{
  NEW(channel_request_continuation, self);

  self->super.c = do_channel_request_response;
  self->connection = connection;
  self->channel = channel;
  self->active = active;

  return &self->super;
}

/* GABA:
   (class
     (name channel_request_exception_handler)
     (super exception_handler)
     (vars
       (connection object ssh_connection)
       (channel object ssh_channel)
       (active object request_status)))
*/

/* NOTE: We handle *only* EXC_CHANNEL_REQUEST */
static void 
778
779
do_exc_channel_request_handler(struct exception_handler *c,
			       const struct exception *e)
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
{
  CAST(channel_request_exception_handler, self, c);
  if (e->type == EXC_CHANNEL_REQUEST)
    {
      struct object_queue *q = &self->channel->active_requests;

      assert(self->active->status == -1);
      assert(!object_queue_is_empty(q));
      
      self->active->status = 0;
      
      send_channel_request_responses(self->connection, self->channel, q);
    }
  else
    EXCEPTION_RAISE(c->parent, e);
}

static struct exception_handler *
make_channel_request_exception_handler(struct ssh_connection *connection,
				       struct ssh_channel *channel,
				       struct request_status *active,
				       struct exception_handler *h,
				       const char *context)
{
  NEW(channel_request_exception_handler, self);

806
  self->super.raise = do_exc_channel_request_handler;
807
808
809
810
811
812
813
814
815
  self->super.parent = h;
  self->super.context = context;
  self->connection = connection;
  self->channel = channel;
  self->active = active;

  return &self->super;
}

816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
static int
parse_channel_request(struct simple_buffer *buffer,
		      UINT32 *channel_number,
		      struct channel_request_info *info)
{
  unsigned msg_number;

  if (parse_uint8(buffer, &msg_number)
      && (msg_number == SSH_MSG_CHANNEL_REQUEST)
      && parse_uint32(buffer, channel_number)
      && parse_string(buffer,
		      &info->type_length, &info->type_data)
      && parse_boolean(buffer, &info->want_reply))
    {
      info->type = lookup_atom(info->type_length, info->type_data);
      return 1;
    }
  else
    return 0;
}

837
838
DEFINE_PACKET_HANDLER(static, channel_request_handler,
		      connection, packet)
839
840
{
  struct simple_buffer buffer;
841
  struct channel_request_info info;
842
843
844
845
  UINT32 channel_number;
  
  simple_buffer_init(&buffer, packet->length, packet->data);

846
  if (parse_channel_request(&buffer, &channel_number, &info))
847
848
849
850
851
852
853
854
855
856
    {
      struct ssh_channel *channel = lookup_channel(connection->table,
						   channel_number);

      /* NOTE: We can't free packet yet, because it is not yet fully
       * parsed. There may be some more arguments, which are parsed by
       * the CHANNEL_REQUEST method below. */

      if (channel)
	{
857
	  struct channel_request *req = NULL;
858
859
860
	  struct command_continuation *c = &discard_continuation;
	  struct exception_handler *e = channel->e;

861
	  if (info.type && channel->request_types)
862
863
	    {
	      CAST_SUBTYPE(channel_request, r,
864
			   ALIST_GET(channel->request_types, info.type));
865
866
	      req = r;
	    }
867
868
869
	  if (!req)
	    req = channel->request_fallback;
	  
870
	  if (req)
871
	    {
872
	      if (info.want_reply)
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
		{
		  struct request_status *a = make_request_status();
		  
		  object_queue_add_tail(&channel->active_requests,
					&a->super);
		  
		  c = make_channel_request_response(connection, channel, a);
		  e = make_channel_request_exception_handler(connection, channel, a, e, HANDLER_CONTEXT);
		}
	      else
		{
		  /* We should ignore failures. */
		  static struct report_exception_info channel_req_ignore =
		    STATIC_REPORT_EXCEPTION_INFO(EXC_ALL, EXC_CHANNEL_REQUEST,
						 "Ignored:");
		  
		  e = make_report_exception_handler(&channel_req_ignore,
						    e, HANDLER_CONTEXT);
		}
	      
893
	      CHANNEL_REQUEST(req, channel, connection, &info, &buffer, c, e);
894
895
896
	    }
	  else
	    {
897
	      if (info.want_reply)
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
		C_WRITE(connection,
			format_channel_failure(channel->channel_number));
	    }
	}
      else
	{
	  werror("SSH_MSG_CHANNEL_REQUEST on nonexistant channel %i\n",
		 channel_number);
	}
    }
  else
    PROTOCOL_ERROR(connection->e, "Invalid SSH_MSG_CHANNEL_REQUEST message.");
  
  lsh_string_free(packet);
}


Niels Möller's avatar
Niels Möller committed
915
/* GABA:
916
917
918
919
920
   (class
     (name channel_open_continuation)
     (super command_continuation)
     (vars
       (connection object ssh_connection)
Niels Möller's avatar
Niels Möller committed
921
922
       (local_channel_number . UINT32)
       (remote_channel_number . UINT32)
923
924
       (send_window_size . UINT32)
       (send_max_packet . UINT32)))
925
*/
926

Niels Möller's avatar
Niels Möller committed
927
928
929
static void
do_channel_open_continue(struct command_continuation *c,
			 struct lsh_object *value)
930
931
{
  CAST(channel_open_continuation, self, c);
Niels Möller's avatar
Niels Möller committed
932
933
934
935
936
937
938
  CAST_SUBTYPE(ssh_channel, channel, value);

  assert(channel);

  /* FIXME: This copying could just as well be done by the
   * CHANNEL_OPEN handler? Then we can remove the corresponding fields
   * from the closure as well. */
939
940
  channel->send_window_size = self->send_window_size;
  channel->send_max_packet = self->send_max_packet;
Niels Möller's avatar
Niels Möller committed
941
942
943
  channel->channel_number = self->remote_channel_number;

  /* FIXME: Is the channel->write field really needed? */
Niels Möller's avatar
Niels Möller committed
944
  channel->write = self->connection->write;
Niels Möller's avatar
Niels Möller committed
945

946
  register_channel(self->connection,
947
948
		   self->local_channel_number, channel,
		   1);
Niels Möller's avatar
Niels Möller committed
949
950
951
952
953

  /* FIXME: Doesn't support sending extra arguments with the
   * confirmation message. */

  C_WRITE(self->connection,
Niels Möller's avatar
Niels Möller committed
954
	  format_open_confirmation(channel, self->local_channel_number, ""));
955
}
Niels Möller's avatar
Niels Möller committed
956

Niels Möller's avatar
Niels Möller committed
957
static struct command_continuation *
Niels Möller's avatar
Niels Möller committed
958
959
960
make_channel_open_continuation(struct ssh_connection *connection,
			       UINT32 local_channel_number,
			       UINT32 remote_channel_number,
961
962
			       UINT32 send_window_size,
			       UINT32 send_max_packet)
Niels Möller's avatar
Niels Möller committed
963
964
{
  NEW(channel_open_continuation, self);
Niels Möller's avatar
Niels Möller committed
965

Niels Möller's avatar
Niels Möller committed
966
967
968
969
  self->super.c = do_channel_open_continue;
  self->connection = connection;
  self->local_channel_number = local_channel_number;
  self->remote_channel_number = remote_channel_number;
970
971
  self->send_window_size = send_window_size;
  self->send_max_packet = send_max_packet;
Niels Möller's avatar
Niels Möller committed
972

Niels Möller's avatar
Niels Möller committed
973
  return &self->super;
Niels Möller's avatar
Niels Möller committed
974
975
976
977
978
979
980
981
982
}
			       
/* GABA:
   (class
     (name exc_channel_open_handler)
     (super exception_handler)
     (vars
       (connection object ssh_connection)
       (local_channel_number . UINT32)
Niels Möller's avatar
Niels Möller committed
983
       (remote_channel_number . UINT32)))
Niels Möller's avatar
Niels Möller committed
984
985
*/

986
987
988
static void
do_exc_channel_open_handler(struct exception_handler *s,
			    const struct exception *e)
Niels Möller's avatar
Niels Möller committed
989
990
991
992
993
994
995
996
{
  CAST(exc_channel_open_handler, self, s);

  switch (e->type)
    {
    case EXC_CHANNEL_OPEN:
      {
	CAST_SUBTYPE(channel_open_exception, exc, e);
Niels Möller's avatar
Niels Möller committed
997
	struct channel_table *table = self->connection->table;
Niels Möller's avatar
Niels Möller committed
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
	
	assert(table->in_use[self->local_channel_number]);
	assert(!table->channels[self->local_channel_number]);

	dealloc_channel(table, self->local_channel_number);
	
        C_WRITE(self->connection,
		format_open_failure(self->remote_channel_number,
				    exc->error_code, e->msg, ""));
	break;
      }
    default:
      EXCEPTION_RAISE(self->super.parent, e);
    }      
}

static struct exception_handler *
make_exc_channel_open_handler(struct ssh_connection *connection,
			      UINT32 local_channel_number,
			      UINT32 remote_channel_number,
1018
1019
			      struct exception_handler *parent,
			      const char *context)
Niels Möller's avatar
Niels Möller committed
1020
{
Niels Möller's avatar
Niels Möller committed
1021
  NEW(exc_channel_open_handler, self);
Niels Möller's avatar
Niels Möller committed
1022
  self->super.parent = parent;
Niels Möller's avatar
Niels Möller committed
1023
  self->super.raise = do_exc_channel_open_handler;
1024
1025
  self->super.context = context;
  
Niels Möller's avatar
Niels Möller committed
1026
  self->connection = connection;
Niels Möller's avatar
Niels Möller committed
1027
1028
1029
1030
1031
1032
  self->local_channel_number = local_channel_number;
  self->remote_channel_number = remote_channel_number;

  return &self->super;
}

1033
1034
1035
1036
1037
1038
1039
1040
static int
parse_channel_open(struct simple_buffer *buffer,
		   struct channel_open_info *info)
{
  unsigned msg_number;

  if (parse_uint8(buffer, &msg_number)
      && (msg_number == SSH_MSG_CHANNEL_OPEN)
1041
      && parse_string(buffer, &info->type_length, &info->type_data)
1042
1043
1044
1045
      && parse_uint32(buffer, &info->remote_channel_number)
      && parse_uint32(buffer, &info->send_window_size)
      && parse_uint32(buffer, &info->send_max_packet))
    {
1046
      info->type = lookup_atom(info->type_length, info->type_data);
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067

      /* We don't support larger packets than the default,
       * SSH_MAX_PACKET. The fuzz factor is because the
       * channel's max sizes refer to the data string inside the
       * packet, while the SSH_PACKET limit refers to the complete
       * packet including some overhead (9 octets for
       * SSH_MSG_CHANNEL_DATA and 13 octets for
       * SSH_MSG_CHANNEL_EXTENDED_DATA). */
      if (info->send_max_packet > (SSH_MAX_PACKET - SSH_CHANNEL_MAX_PACKET_FUZZ))
	{
	  werror("do_channel_open: The remote end asked for really large packets.\n");
	  info->send_max_packet = SSH_MAX_PACKET - SSH_CHANNEL_MAX_PACKET_FUZZ;
	}

      return 1;
    }
  else
    return 0;
}


1068
1069
DEFINE_PACKET_HANDLER(static, channel_open_handler,
		      connection, packet)
Niels Möller's avatar
Niels Möller committed
1070
1071
{
  struct simple_buffer buffer;
1072
1073
  struct channel_open_info info;
  
Niels Möller's avatar
Niels Möller committed
1074
  simple_buffer_init(&buffer, packet->length, packet->data);
1075

1076
  if (parse_channel_open(&buffer, &info))
Niels Möller's avatar
Niels Möller committed
1077
    {
1078
      struct channel_open *open = NULL;
Niels Möller's avatar
Niels Möller committed
1079

Niels Möller's avatar
Niels Möller committed
1080
1081
1082
1083
      /* NOTE: We can't free the packet yet, as the buffer is passed
       * to the CHANNEL_OPEN method later. */

      if (connection->table->pending_close)
Niels Möller's avatar
Niels Möller committed
1084
1085
1086
1087
	{
	  /* We are waiting for channels to close. Don't open any new ones. */

	  C_WRITE(connection,
1088
		  format_open_failure(info.remote_channel_number,
Niels Möller's avatar
Niels Möller committed
1089
1090
1091
1092
1093
				      SSH_OPEN_ADMINISTRATIVELY_PROHIBITED,
				      "Waiting for channels to close.", ""));
	}
      else
	{
1094
	  if (info.type)
1095
	    {
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
	      CAST_SUBTYPE(channel_open, o,
			   ALIST_GET(connection->table->channel_types,
				     info.type));
	      open = o;
	    }

	  if (!open)
	    open = connection->table->open_fallback;
	  
	  if (!open)
	    {
	      C_WRITE(connection,
		      format_open_failure(info.remote_channel_number,
					  SSH_OPEN_UNKNOWN_CHANNEL_TYPE,
					  "Unknown channel type", ""));
	    }
	  else
	    {
	      int local_number = alloc_channel(connection->table);

	      if (local_number < 0)
		C_WRITE(connection,
			format_open_failure(info.remote_channel_number,
					    SSH_OPEN_RESOURCE_SHORTAGE,
					    "Channel limit exceeded.", ""));

	      CHANNEL_OPEN(open, connection,
			   &info,
			   &buffer,
			   make_channel_open_continuation(connection,
							  local_number,
							  info.remote_channel_number,
							  info.send_window_size,
							  info.send_max_packet),
			   make_exc_channel_open_handler(connection,
							 local_number,
							 info.remote_channel_number,
							 connection->e,
							 HANDLER_CONTEXT));

1136
	    }
Niels Möller's avatar
Niels Möller committed
1137
	}
Niels Möller's avatar
Niels Möller committed
1138
    }
Niels Möller's avatar
Niels Möller committed
1139
  else
1140
    PROTOCOL_ERROR(connection->e, "Invalid SSH_MSG_CHANNEL_OPEN message.");
Niels Möller's avatar
Niels Möller committed
1141

Niels Möller's avatar
Niels Möller committed
1142
  lsh_string_free(packet);
Niels Möller's avatar
Niels Möller committed
1143
1144
}     

1145
1146
DEFINE_PACKET_HANDLER(static, window_adjust_handler,
		      connection, packet)
Niels Möller's avatar
Niels Möller committed
1147
1148
{
  struct simple_buffer buffer;
1149
  unsigned msg_number;
Niels Möller's avatar
Niels Möller committed
1150
1151
1152
1153
1154
1155
1156
  UINT32 channel_number;
  UINT32 size;

  simple_buffer_init(&buffer, packet->length, packet->data);

  if (parse_uint8(&buffer, &msg_number)
      && (msg_number == SSH_MSG_CHANNEL_WINDOW_ADJUST)
1157
      && parse_uint32(&buffer, &channel_number)
Niels Möller's avatar
Niels Möller committed
1158
1159
1160
      && parse_uint32(&buffer, &size)
      && parse_eod(&buffer))
    {
Niels Möller's avatar
Niels Möller committed
1161
      struct ssh_channel *channel = lookup_channel(connection->table,
Niels Möller's avatar
Niels Möller committed
1162
1163
1164
1165
						   channel_number);

      lsh_string_free(packet);
      
Niels Möller's avatar
Niels Möller committed
1166
      if (channel
1167
	  && !(channel->flags & CHANNEL_RECEIVED_CLOSE))
Niels Möller's avatar
Niels Möller committed
1168
	{
1169
	  if (! (channel->flags & (CHANNEL_SENT_CLOSE | CHANNEL_SENT_EOF)))
Niels Möller's avatar
Niels Möller committed
1170
1171
	    {
	      channel->send_window_size += size;
1172
1173
1174
1175
1176
	      if (channel->send_window_size && channel->send_adjust)
		{
		  assert(channel->send_window_size);
		  CHANNEL_SEND_ADJUST(channel, size);
		}
Niels Möller's avatar
Niels Möller committed
1177
	    }
Niels Möller's avatar
Niels Möller committed
1178
	}
Niels Möller's avatar
Niels Möller committed
1179
1180
1181
1182
      else
	{
	  werror("SSH_MSG_CHANNEL_WINDOW_ADJUST on nonexistant or closed "
		 "channel %i\n", channel_number);
1183
	  PROTOCOL_ERROR(connection->e, "Unexpected CHANNEL_WINDOW_ADJUST");
Niels Möller's avatar
Niels Möller committed
1184
1185
1186
1187
1188
	}
    }
  else
    {
      lsh_string_free(packet);
1189
      PROTOCOL_ERROR(connection->e, "Invalid CHANNEL_WINDOW_ADJUST message.");
Niels Möller's avatar
Niels Möller committed
1190
1191
1192
    }
}

1193
1194
DEFINE_PACKET_HANDLER(static, channel_data_handler,
		      connection, packet)
Niels Möller's avatar
Niels Möller committed
1195
1196
{
  struct simple_buffer buffer;
1197
  unsigned msg_number;
Niels Möller's avatar
Niels Möller committed
1198
1199
1200
1201
1202
1203
1204
  UINT32 channel_number;
  struct lsh_string *data;
  
  simple_buffer_init(&buffer, packet->length, packet->data);

  if (parse_uint8(&buffer, &msg_number)
      && (msg_number == SSH_MSG_CHANNEL_DATA)
1205
      && parse_uint32(&buffer, &channel_number)
Niels Möller's avatar
Niels Möller committed
1206
1207
1208
      && ( (data = parse_string_copy(&buffer)) )
      && parse_eod(&buffer))
    {
Niels Möller's avatar
Niels Möller committed
1209
      struct ssh_channel *channel = lookup_channel(connection->table,
Niels Möller's avatar
Niels Möller committed
1210
1211
1212
1213
						   channel_number);

      lsh_string_free(packet);
      
1214
      if (channel && channel->receive
1215
1216
	  && !(channel->flags & (CHANNEL_RECEIVED_EOF
				 | CHANNEL_RECEIVED_CLOSE)))
Niels Möller's avatar
Niels Möller committed
1217
	{
Niels Möller's avatar
Niels Möller committed
1218
	  if (channel->flags & CHANNEL_SENT_CLOSE)
Niels Möller's avatar
Niels Möller committed
1219
	    {
Niels Möller's avatar
Niels Möller committed
1220
	      lsh_string_free(data);
1221
	      werror("Ignoring data on channel which is closing\n");
Niels Möller's avatar
Niels Möller committed
1222
	      return;
Niels Möller's avatar
Niels Möller committed
1223
	    }
Niels Möller's avatar
Niels Möller committed
1224
1225
	  else
	    {
1226
1227
1228
1229
1230
1231
              if (data->length > channel->rec_max_packet)
                {
                  werror("Channel data larger than rec_max_packet. Extra data ignored.\n");
                  data->length = channel->rec_max_packet;
                }

Niels Möller's avatar
Niels Möller committed
1232
1233
1234
	      if (data->length > channel->rec_window_size)
		{
		  /* Truncate data to fit window */
1235
1236
1237
1238
		  werror("Channel data overflow. Extra data ignored.\n");