channel.c 56.1 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

69
70
struct lsh_string *
format_global_failure(void)
Niels Möller's avatar
Niels Möller committed
71
72
73
74
{
  return ssh_format("%c", SSH_MSG_REQUEST_FAILURE);
}

75
76
struct lsh_string *
format_global_success(void)
77
78
79
80
{
  return ssh_format("%c", SSH_MSG_REQUEST_SUCCESS);
}

81
82
83
84
struct lsh_string *
format_open_confirmation(struct ssh_channel *channel,
			 UINT32 channel_number,
			 const char *format, ...)
85
86
87
88
89
90
{
  va_list args;
  UINT32 l1, l2;
  struct lsh_string *packet;

#define CONFIRM_FORMAT "%c%i%i%i%i"
91
92
#define CONFIRM_ARGS \
  SSH_MSG_CHANNEL_OPEN_CONFIRMATION, channel->channel_number, \
93
94
  channel_number, channel->rec_window_size, channel->rec_max_packet
    
95
  debug("format_open_confirmation: rec_window_size = %i,\n"
96
	"                          rec_max_packet = %i,\n",
97
       channel->rec_window_size,
98
       channel->rec_max_packet);
99
100
101
102
103
104
105
106
107
108
109
  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);
110
  ssh_vformat_write(format, l2, packet->data+l1, args);
111
112
113
114
115
116
117
  va_end(args);

  return packet;
#undef CONFIRM_FORMAT
#undef CONFIRM_ARGS
}

118
119
120
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
121
122
123
124
125
{
  return ssh_format("%c%i%i%z%z", SSH_MSG_CHANNEL_OPEN_FAILURE,
		    channel, reason, msg, language);
}

126
127
struct lsh_string *
format_channel_success(UINT32 channel)
128
129
130
131
{
  return ssh_format("%c%i", SSH_MSG_CHANNEL_SUCCESS, channel);
}

132
133
struct lsh_string *
format_channel_failure(UINT32 channel)
Niels Möller's avatar
Niels Möller committed
134
135
136
137
{
  return ssh_format("%c%i", SSH_MSG_CHANNEL_FAILURE, channel);
}

138
139
140
struct lsh_string *
prepare_window_adjust(struct ssh_channel *channel,
		      UINT32 add)
141
142
143
144
145
146
147
148
{
  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
149
150
151
152
153
/* GABA:
   (class
     (name exc_finish_channel_handler)
     (super exception_handler)
     (vars
154
       (connection object ssh_connection)
155
156
       ; Non-zero if the channel has already been deallocated.
       (dead . int)
Niels Möller's avatar
Niels Möller committed
157
158
159
160
       ; Local channel number 
       (channel_number . UINT32)))
*/

161
162
163
static void
do_exc_finish_channel_handler(struct exception_handler *s,
			      const struct exception *e)
Niels Möller's avatar
Niels Möller committed
164
165
166
167
168
{
  CAST(exc_finish_channel_handler, self, s);

  switch (e->type)
    {
Niels Möller's avatar
Niels Möller committed
169
    case EXC_FINISH_PENDING:
170
171
      if (self->dead)
	werror("channel.c: EXC_FINISH_PENDING on dead channel.\n");
Niels Möller's avatar
Niels Möller committed
172

173
      self->connection->table->pending_close = 1;
174
175
176
177
178
179
180

      /* NOTE: We don't need to raise a EXC_FINISH_READ here. Only
       * code in a live channel is supposed to raise
       * EXC_FINISH_PENDING. The typical caller is a channel's
       * CHANNEL_CLOSE callback that is called below. */
#if 0
      if (!self->connection->table->channel_count)
181
	EXCEPTION_RAISE(self->connection->e, &finish_read_exception);
182
#endif
Niels Möller's avatar
Niels Möller committed
183
184
      break;
      
Niels Möller's avatar
Niels Möller committed
185
186
    case EXC_FINISH_CHANNEL:
      /* NOTE: This type of exception must be handled only once.
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
       * 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
202
	    = self->connection->table->channels[self->channel_number];
203
204
205
206
207
208
209
210

	  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
211
	
212
	  dealloc_channel(self->connection->table, self->channel_number);
213
214
	  self->dead = 1;

215
	  if (self->connection->table->pending_close &&
216
	      !self->connection->table->channel_count)
217
218
	    {
	      /* FIXME: Send a SSH_DISCONNECT_BY_APPLICATION message? */
219
	      EXCEPTION_RAISE(self->connection->e, &finish_read_exception);
220
221
	    }
	}
Niels Möller's avatar
Niels Möller committed
222
223
224
225
226
227
228
      break;
    default:
      EXCEPTION_RAISE(self->super.parent, e);
    }
}

static struct exception_handler *
229
make_exc_finish_channel_handler(struct ssh_connection *connection,
Niels Möller's avatar
Niels Möller committed
230
				UINT32 channel_number,
231
232
				struct exception_handler *e,
				const char *context)
Niels Möller's avatar
Niels Möller committed
233
234
235
236
{
  NEW(exc_finish_channel_handler, self);
  self->super.parent = e;
  self->super.raise = do_exc_finish_channel_handler;
237
  self->super.context = context;
Niels Möller's avatar
Niels Möller committed
238

239
  self->connection = connection;
240
  self->channel_number = channel_number;
241
  self->dead = 0;
242
  
Niels Möller's avatar
Niels Möller committed
243
  return &self->super;
Niels Möller's avatar
Niels Möller committed
244
245
246
}
				

247
/* Channel objects */
Niels Möller's avatar
Niels Möller committed
248
249
250
251
252

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

253
254
struct channel_table *
make_channel_table(void)
Niels Möller's avatar
Niels Möller committed
255
{
256
  NEW(channel_table, table);
Niels Möller's avatar
Niels Möller committed
257

258
  table->channels = lsh_space_alloc(sizeof(struct ssh_channel *)
259
				      * INITIAL_CHANNELS);
Niels Möller's avatar
Niels Möller committed
260
261
  table->in_use = lsh_space_alloc(INITIAL_CHANNELS);
  
262
263
  table->allocated_channels = INITIAL_CHANNELS;
  table->used_channels = 0;
264
265
266
  table->next_channel = 0;
  table->channel_count = 0;
  
267
  table->max_channels = MAX_CHANNELS;
Niels Möller's avatar
Niels Möller committed
268

Niels Möller's avatar
Niels Möller committed
269
  table->pending_close = 0;
270

271
272
  table->global_requests = make_alist(0, -1);
  table->channel_types = make_alist(0, -1);
273
  table->open_fallback = NULL;
274
  
275
276
277
  object_queue_init(&table->local_ports);
  object_queue_init(&table->remote_ports);
  
278
279
  object_queue_init(&table->active_global_requests);
  object_queue_init(&table->pending_global_requests);
Niels Möller's avatar
Niels Möller committed
280
  
281
  return table;
282
}
Niels Möller's avatar
Niels Möller committed
283
284

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

301
	  goto success;
Niels Möller's avatar
Niels Möller committed
302
303
	}
    }
304
  if (i == table->max_channels)
Niels Möller's avatar
Niels Möller committed
305
    return -1;
306

307
  if (i == table->allocated_channels) 
Niels Möller's avatar
Niels Möller committed
308
    {
309
      UINT32 new_size = table->allocated_channels * 2;
Niels Möller's avatar
Niels Möller committed
310
      struct ssh_channel **new_channels;
Niels Möller's avatar
Niels Möller committed
311
      UINT8 *new_in_use;
Niels Möller's avatar
Niels Möller committed
312

Niels Möller's avatar
Niels Möller committed
313
314
315
      new_channels = lsh_space_alloc(sizeof(struct ssh_channel *)
				     * new_size);
      memcpy(new_channels, table->channels,
316
	     sizeof(struct ssh_channel *) * table->used_channels);
Niels Möller's avatar
Niels Möller committed
317
318
319
      lsh_space_free(table->channels);
      table->channels = new_channels;

320
      /* FIXME: Use realloc(). */
Niels Möller's avatar
Niels Möller committed
321
322
323
324
325
      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;

326
      table->allocated_channels = new_size;
Niels Möller's avatar
Niels Möller committed
327
328
    }

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

331
  table->in_use[i] = CHANNEL_RESERVED;
332
333
334

 success:
  table->channel_count++;
335
  verbose("Allocated local channel number %i\n", i);
336

Niels Möller's avatar
Niels Möller committed
337
338
339
  return i;
}

340
341
void
dealloc_channel(struct channel_table *table, int i)
Niels Möller's avatar
Niels Möller committed
342
343
{
  assert(i >= 0);
344
  assert( (unsigned) i < table->used_channels);
345
346
  assert(table->channel_count);
  
347
  verbose("Deallocating local channel %i\n", i);
348
  table->channels[i] = NULL;
349
  table->in_use[i] = CHANNEL_FREE;
350
351

  table->channel_count--;
Niels Möller's avatar
Niels Möller committed
352
  
353
  if ( (unsigned) i < table->next_channel)
354
355
356
    table->next_channel = i;
}

357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
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);
}
	    
372
373
374
void
register_channel(struct ssh_connection *connection,
		 UINT32 local_channel_number,
375
376
		 struct ssh_channel *channel,
		 int take_into_use)
377
{
378
379
  struct channel_table *table = connection->table;
  
380
  assert(table->in_use[local_channel_number] == CHANNEL_RESERVED);
Niels Möller's avatar
Niels Möller committed
381
  assert(!table->channels[local_channel_number]);
382

383
384
385
  verbose("Registering local channel %i.\n",
	  local_channel_number);
  
386
  /* NOTE: Is this the right place to install this exception handler? */
387
388
389
390
391
392
393
  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;
394

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

401
402
403
404
405
406
407
408
409
410
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
411
{
412
413
  return ( (i < table->used_channels)
	   && (table->in_use[i] == CHANNEL_RESERVED))
414
    ? table->channels[i] : NULL;
Niels Möller's avatar
Niels Möller committed
415
416
}

417

418
419
/* FIXME: It seems suboptimal to send a window adjust message for
 * *every* write that we do. A better scheme might be as follows:
420
421
422
423
424
425
426
 *
 * 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. */
427
428
static void
adjust_rec_window(struct flow_controlled *f, UINT32 written)
429
{
430
431
  CAST_SUBTYPE(ssh_channel, channel, f);

432
433
434
435
436
437
  /* 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));
438
439
}

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

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

451
452
453
/* 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
454
455
456
457
458
#define RETURN goto foo_finish
#define END(s) do { foo_finish: \
                    lsh_string_free((s)); \
                    return; } while(0)

459

Niels Möller's avatar
Niels Möller committed
460
/* Channel related messages */
461
462
463

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

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

  return self;
}

/* GABA:
   (class
483
484
     (name global_request_continuation)
     (super command_continuation)
485
     (vars
486
487
       (connection object ssh_connection)
       (active object request_status)))
488
489
*/

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

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

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

516
517
518
519
  assert(self->active->status == -1);
  assert(!object_queue_is_empty(q));
	  
  self->active->status = 1;
520

521
522
  send_global_request_responses(self->connection, q);
}
523

524
525
526
527
528
529
530
531
532
533
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;
   
534
535
  return &self->super;
}
536
537
538
539
540
541
542
543
544
545
546
547
548


/* 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 
549
do_exc_global_request_handler(struct exception_handler *c,
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
			  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
573
{
574
575
  NEW(global_request_exception_handler, self);

576
  self->super.raise = do_exc_global_request_handler;
577
578
579
580
581
582
  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
583

584
DEFINE_PACKET_HANDLER(static, global_request_handler, connection, packet)
585
{
Niels Möller's avatar
Niels Möller committed
586
  struct simple_buffer buffer;
587
  unsigned msg_number;
Niels Möller's avatar
Niels Möller committed
588
589
590
591
592
593
594
595
596
597
  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))
    {
598
      struct global_request *req = NULL;
599
600
      struct command_continuation *c = &discard_continuation;
      struct exception_handler *e = connection->e;
601
602
603
604
605
606
607
608
609

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

Niels Möller's avatar
Niels Möller committed
613
614
	  C_WRITE(connection, format_global_failure());
	  return;
Niels Möller's avatar
Niels Möller committed
615
616
617
618
619
	}
      else
	{
	  if (want_reply)
	    {
620
	      struct request_status *a = make_request_status();
Niels Möller's avatar
Niels Möller committed
621
	      
Niels Möller's avatar
Niels Möller committed
622
	      object_queue_add_tail(&connection->table->active_global_requests,
Niels Möller's avatar
Niels Möller committed
623
624
625
				    &a->super);
	      
	      c = make_global_request_response(connection, a);
626
627
628
629
630
631
632
633
634
635
636
	      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
637
	    }
638
	  GLOBAL_REQUEST(req, connection, name, want_reply, &buffer, c, e);
639
	}
Niels Möller's avatar
Niels Möller committed
640
    }
Niels Möller's avatar
Niels Möller committed
641
642
  else
    {
643
      PROTOCOL_ERROR(connection->e, "Invalid SSH_MSG_GLOBAL_REQUEST message.");
Niels Möller's avatar
Niels Möller committed
644
645
    }
  lsh_string_free(packet);
Niels Möller's avatar
Niels Möller committed
646
647
}

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

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

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

672
673
674
struct exception global_request_exception =
STATIC_EXCEPTION(EXC_GLOBAL_REQUEST, "Global request failed");

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

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

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

699
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
/* 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 
775
776
do_exc_channel_request_handler(struct exception_handler *c,
			       const struct exception *e)
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
{
  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);

803
  self->super.raise = do_exc_channel_request_handler;
804
805
806
807
808
809
810
811
812
  self->super.parent = h;
  self->super.context = context;
  self->connection = connection;
  self->channel = channel;
  self->active = active;

  return &self->super;
}

813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
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;
}

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

843
  if (parse_channel_request(&buffer, &channel_number, &info))
844
845
846
847
848
849
850
851
852
853
    {
      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)
	{
854
	  struct channel_request *req = NULL;
855
856
857
	  struct command_continuation *c = &discard_continuation;
	  struct exception_handler *e = channel->e;

858
	  if (info.type && channel->request_types)
859
860
	    {
	      CAST_SUBTYPE(channel_request, r,
861
			   ALIST_GET(channel->request_types, info.type));
862
863
	      req = r;
	    }
864
865
866
	  if (!req)
	    req = channel->request_fallback;
	  
867
	  if (req)
868
	    {
869
	      if (info.want_reply)
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
		{
		  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);
		}
	      
890
	      CHANNEL_REQUEST(req, channel, connection, &info, &buffer, c, e);
891
892
893
	    }
	  else
	    {
894
	      if (info.want_reply)
895
896
897
898
899
900
		C_WRITE(connection,
			format_channel_failure(channel->channel_number));
	    }
	}
      else
	{
901
902
	  werror("SSH_MSG_CHANNEL_REQUEST on nonexistant channel %i: %xS\n",
		 channel_number, packet);
903
904
905
906
907
908
909
910
911
	}
    }
  else
    PROTOCOL_ERROR(connection->e, "Invalid SSH_MSG_CHANNEL_REQUEST message.");
  
  lsh_string_free(packet);
}


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

Niels Möller's avatar
Niels Möller committed
924
925
926
static void
do_channel_open_continue(struct command_continuation *c,
			 struct lsh_object *value)
927
928
{
  CAST(channel_open_continuation, self, c);
Niels Möller's avatar
Niels Möller committed
929
930
931
932
933
934
935
  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. */
936
937
  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
938
939
940
  channel->channel_number = self->remote_channel_number;

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

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

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

  C_WRITE(self->connection,
Niels Möller's avatar
Niels Möller committed
951
	  format_open_confirmation(channel, self->local_channel_number, ""));
952
}
Niels Möller's avatar
Niels Möller committed
953

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

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

Niels Möller's avatar
Niels Möller committed
970
  return &self->super;
Niels Möller's avatar
Niels Möller committed
971
972
973
974
975
976
977
978
979
}
			       
/* 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
980
       (remote_channel_number . UINT32)))
Niels Möller's avatar
Niels Möller committed
981
982
*/

983
984
985
static void
do_exc_channel_open_handler(struct exception_handler *s,
			    const struct exception *e)
Niels Möller's avatar
Niels Möller committed
986
987
988
989
990
991
992
993
{
  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
994
	struct channel_table *table = self->connection->table;
Niels Möller's avatar
Niels Möller committed
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
	
	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,
1015
1016
			      struct exception_handler *parent,
			      const char *context)
Niels Möller's avatar
Niels Möller committed
1017
{
Niels Möller's avatar
Niels Möller committed
1018
  NEW(exc_channel_open_handler, self);
Niels Möller's avatar
Niels Möller committed
1019
  self->super.parent = parent;
Niels Möller's avatar
Niels Möller committed
1020
  self->super.raise = do_exc_channel_open_handler;
1021
1022
  self->super.context = context;
  
Niels Möller's avatar
Niels Möller committed
1023
  self->connection = connection;
Niels Möller's avatar
Niels Möller committed
1024
1025
1026
1027
1028
1029
  self->local_channel_number = local_channel_number;
  self->remote_channel_number = remote_channel_number;

  return &self->super;
}

1030
1031
1032
1033
1034
1035
1036
1037
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)
1038
      && parse_string(buffer, &info->type_length, &info->type_data)
1039
1040
1041
1042
      && parse_uint32(buffer, &info->remote_channel_number)
      && parse_uint32(buffer, &info->send_window_size)
      && parse_uint32(buffer, &info->send_max_packet))
    {
1043
      info->type = lookup_atom(info->type_length, info->type_data);
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064

      /* 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;
}


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

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

Niels Möller's avatar
Niels Möller committed
1077
1078
1079
1080
      /* 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
1081
1082
1083
1084
	{
	  /* We are waiting for channels to close. Don't open any new ones. */

	  C_WRITE(connection,
1085
		  format_open_failure(info.remote_channel_number,
Niels Möller's avatar
Niels Möller committed
1086
1087
1088
1089
1090
				      SSH_OPEN_ADMINISTRATIVELY_PROHIBITED,
				      "Waiting for channels to close.", ""));
	}
      else
	{
1091
	  if (info.type)
1092
	    {
1093
1094
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
	      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));

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

Niels Möller's avatar
Niels Möller committed
1139
  lsh_string_free(packet);
Niels Möller's avatar
Niels Möller committed
1140
1141
}     

1142
1143
DEFINE_PACKET_HANDLER(static, window_adjust_handler,
		      connection, packet)
Niels Möller's avatar
Niels Möller committed
1144
1145
{
  struct simple_buffer buffer;
1146
  unsigned msg_number;
Niels Möller's avatar
Niels Möller committed
1147
1148
1149
1150
1151
1152
1153
  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)
1154
      && parse_uint32(&buffer, &channel_number)
Niels Möller's avatar
Niels Möller committed
1155
1156
1157
      && parse_uint32(&buffer, &size)
      && parse_eod(&buffer))
    {
Niels Möller's avatar
Niels Möller committed
1158
      struct ssh_channel *channel = lookup_channel(connection->table,
Niels Möller's avatar
Niels Möller committed
1159
1160
1161
1162
						   channel_number);

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

1190
1191
DEFINE_PACKET_HANDLER(static, channel_data_handler,
		      connection, packet)
Niels Möller's avatar
Niels Möller committed
1192
1193
{
  struct simple_buffer buffer;
1194
  unsigned msg_number;
Niels Möller's avatar
Niels Möller committed
1195
1196
1197
1198
1199
1200
1201
  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)
1202
      && parse_uint32(&buffer, &channel_number)
Niels Möller's avatar
Niels Möller committed
1203
1204
1205
      && ( (data = parse_string_copy(&buffer)) )
      && parse_eod(&buffer))
    {
Niels Möller's avatar
Niels Möller committed
1206
      struct ssh_channel *channel = lookup_channel(connection->table,
Niels Möller's avatar
Niels Möller committed
1207
1208
1209
1210
						   channel_number);

      lsh_string_free(packet);
      
1211
      if (channel && channel->receive
1212
1213
	  && !(channel->flags & (CHANNEL_RECEIVED_EOF
				 | CHANNEL_RECEIVED_CLOSE)))
Niels Möller's avatar
Niels Möller committed
1214
	{
Niels Möller's avatar
Niels Möller committed
1215
	  if (channel->flags & CHANNEL_SENT_CLOSE)
Niels Möller's avatar
Niels Möller committed
1216
	    {
Niels Möller's avatar
Niels Möller committed
1217
	      lsh_string_free(data);
1218
	      werror("Ignoring data on channel which is closing\n");
Niels Möller's avatar
Niels Möller committed
1219
	      return;
Niels Möller's avatar
Niels Möller committed
1220
	    }
Niels Möller's avatar
Niels Möller committed
1221
1222
	  else
	    {
1223
1224
1225
1226
1227
1228
              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
1229
1230
1231
	      if (data->length > channel->rec_window_size)
		{
		  /* Truncate data to fit window */
1232
1233
1234
1235
		  werror("Channel data overflow. Extra data ignored.\n");
		  debug("   (data->length=%i, rec_window_size=%i).\n", 
			data->length, channel->rec_window_size);
		  
Niels Möller's avatar