channel.c 55.9 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
171
       (connection object ssh_connection)
       ;; (table object channel_table)
172
173
       ; Non-zero if the channel has already been deallocated.
       (dead . int)
Niels Möller's avatar
Niels Möller committed
174
175
176
177
       ; Local channel number 
       (channel_number . UINT32)))
*/

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

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

190
      self->connection->table->pending_close = 1;
191
      
192
193
      if (!self->connection->table->next_channel)
	EXCEPTION_RAISE(self->connection->e, &finish_read_exception);
Niels Möller's avatar
Niels Möller committed
194
195
      break;
      
Niels Möller's avatar
Niels Möller committed
196
197
    case EXC_FINISH_CHANNEL:
      /* NOTE: This type of exception must be handled only once.
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
       * 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
213
	    = self->connection->table->channels[self->channel_number];
214
215
216
217
218
219
220
221

	  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
222
	
223
	  dealloc_channel(self->connection->table, self->channel_number);
224
225
	  self->dead = 1;

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

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

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

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

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

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

269
  table->channels = lsh_space_alloc(sizeof(struct ssh_channel *)
270
				      * INITIAL_CHANNELS);
Niels Möller's avatar
Niels Möller committed
271
272
  table->in_use = lsh_space_alloc(INITIAL_CHANNELS);
  
273
274
275
276
  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
277

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

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

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

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

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

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

330
      /* FIXME: Use realloc(). */
Niels Möller's avatar
Niels Möller committed
331
332
333
334
335
      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;

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

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

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

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

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

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

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

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

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

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

421

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

436
437
438
439
440
441
  /* 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));
442
443
}

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

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

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

463

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

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

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

  return self;
}

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

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

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

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

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

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

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


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

580
  self->super.raise = do_exc_global_request_handler;
581
582
583
584
585
586
  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
587

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

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

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

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

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

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

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

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

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

Niels Möller's avatar
Niels Möller committed
690
  if (object_queue_is_empty(&connection->table->pending_global_requests))
691
692
693
    {
      werror("do_global_request_failure: Unexpected message, ignoring.\n");
    }
Niels Möller's avatar
Niels Möller committed
694
695
696
697
698
699
700
  else
    {
      CAST_SUBTYPE(command_context, ctx,
		   object_queue_remove_head(&connection->table->pending_global_requests));
      EXCEPTION_RAISE(ctx->e, &global_request_exception);
    }
  END(packet);
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
778
/* 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 
779
780
do_exc_channel_request_handler(struct exception_handler *c,
			       const struct exception *e)
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
806
{
  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);

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

  return &self->super;
}

817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
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;
}

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

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

862
	  if (info.type && channel->request_types)
863
864
	    {
	      CAST_SUBTYPE(channel_request, r,
865
			   ALIST_GET(channel->request_types, info.type));
866
867
	      req = r;
	    }
868
869
870
	  if (!req)
	    req = channel->request_fallback;
	  
871
	  if (req)
872
	    {
873
	      if (info.want_reply)
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
		{
		  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);
		}
	      
894
	      CHANNEL_REQUEST(req, channel, connection, &info, &buffer, c, e);
895
896
897
	    }
	  else
	    {
898
	      if (info.want_reply)
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
		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
916
/* GABA:
917
918
919
920
921
   (class
     (name channel_open_continuation)
     (super command_continuation)
     (vars
       (connection object ssh_connection)
Niels Möller's avatar
Niels Möller committed
922
923
       (local_channel_number . UINT32)
       (remote_channel_number . UINT32)
924
925
       (send_window_size . UINT32)
       (send_max_packet . UINT32)))
926
*/
927

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

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

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

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

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

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

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

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

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

  return &self->super;
}

1034
1035
1036
1037
1038
1039
1040
1041
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)
1042
      && parse_string(buffer, &info->type_length, &info->type_data)
1043
1044
1045
1046
1047
1048
1049
#if 0
      && parse_atom(&buffer, &type)
#endif
      && parse_uint32(buffer, &info->remote_channel_number)
      && parse_uint32(buffer, &info->send_window_size)
      && parse_uint32(buffer, &info->send_max_packet))
    {
1050
      info->type = lookup_atom(info->type_length, info->type_data);
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071

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


1072
1073
DEFINE_PACKET_HANDLER(static, channel_open_handler,
		      connection, packet)
Niels Möller's avatar
Niels Möller committed
1074
1075
{
  struct simple_buffer buffer;
1076
1077
1078
  struct channel_open_info info;
  
#if 0
1079
  unsigned msg_number;
Niels Möller's avatar
Niels Möller committed
1080
  int type;
1081
1082
1083
  UINT32 remote_channel_number;
  UINT32 window_size;
  UINT32 max_packet;
1084
#endif
Niels Möller's avatar
Niels Möller committed
1085
  simple_buffer_init(&buffer, packet->length, packet->data);
1086
  if (parse_channel_open(&buffer, &info))
Niels Möller's avatar
Niels Möller committed
1087
    {
1088
      struct channel_open *open = NULL;
Niels Möller's avatar
Niels Möller committed
1089

Niels Möller's avatar
Niels Möller committed
1090
1091
1092
1093
      /* 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
1094
1095
1096
1097
	{
	  /* We are waiting for channels to close. Don't open any new ones. */

	  C_WRITE(connection,
1098
		  format_open_failure(info.remote_channel_number,
Niels Möller's avatar
Niels Möller committed
1099
1100
1101
1102
1103
				      SSH_OPEN_ADMINISTRATIVELY_PROHIBITED,
				      "Waiting for channels to close.", ""));
	}
      else
	{
1104
	  if (info.type)
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
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
	      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));

1146
	    }
Niels Möller's avatar
Niels Möller committed
1147
	}
Niels Möller's avatar
Niels Möller committed
1148
    }
Niels Möller's avatar
Niels Möller committed
1149
  else
1150
    PROTOCOL_ERROR(connection->e, "Invalid SSH_MSG_CHANNEL_OPEN message.");
Niels Möller's avatar
Niels Möller committed
1151

Niels Möller's avatar
Niels Möller committed
1152
  lsh_string_free(packet);
Niels Möller's avatar
Niels Möller committed
1153
1154
}     

1155
1156
DEFINE_PACKET_HANDLER(static, window_adjust_handler,
		      connection, packet)
Niels Möller's avatar
Niels Möller committed
1157
1158
{
  struct simple_buffer buffer;
1159
  unsigned msg_number;
Niels Möller's avatar
Niels Möller committed
1160
1161
1162
1163
1164
1165
1166
  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)
1167
      && parse_uint32(&buffer, &channel_number)
Niels Möller's avatar
Niels Möller committed
1168
1169
1170
      && parse_uint32(&buffer, &size)
      && parse_eod(&buffer))
    {
Niels Möller's avatar
Niels Möller committed
1171
      struct ssh_channel *channel = lookup_channel(connection->table,
Niels Möller's avatar
Niels Möller committed
1172
1173
1174
1175
						   channel_number);

      lsh_string_free(packet);
      
Niels Möller's avatar
Niels Möller committed
1176
      if (channel
1177
	  && !(channel->flags & CHANNEL_RECEIVED_CLOSE))
Niels Möller's avatar
Niels Möller committed
1178
	{
1179
	  if (! (channel->flags & (CHANNEL_SENT_CLOSE | CHANNEL_SENT_EOF)))
Niels Möller's avatar
Niels Möller committed
1180
1181
	    {
	      channel->send_window_size += size;
1182
1183
1184
1185
1186
	      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
1187
	    }
Niels Möller's avatar
Niels Möller committed
1188
	}
Niels Möller's avatar
Niels Möller committed
1189
1190
1191
1192
      else
	{
	  werror("SSH_MSG_CHANNEL_WINDOW_ADJUST on nonexistant or closed "
		 "channel %i\n", channel_number);
1193
	  PROTOCOL_ERROR(connection->e, "Unexpected CHANNEL_WINDOW_ADJUST");
Niels Möller's avatar
Niels Möller committed
1194
1195
1196
1197
1198
	}
    }
  else
    {
      lsh_string_free(packet);
1199
      PROTOCOL_ERROR(connection->e, "Invalid CHANNEL_WINDOW_ADJUST message.");
Niels Möller's avatar
Niels Möller committed
1200
1201
1202
    }
}

1203
1204
DEFINE_PACKET_HANDLER(static, channel_data_handler,
		      connection, packet)
Niels Möller's avatar
Niels Möller committed
1205
1206
{
  struct simple_buffer buffer;
1207
  unsigned msg_number;
Niels Möller's avatar
Niels Möller committed
1208
1209
1210
1211
1212
1213
1214
  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)
1215
      && parse_uint32(&buffer, &channel_number)
Niels Möller's avatar
Niels Möller committed
1216
1217
1218
      && ( (data = parse_string_copy(&buffer)) )
      && parse_eod(&buffer))
    {
Niels Möller's avatar
Niels Möller committed
1219
      struct ssh_channel *channel = lookup_channel(connection->table,
Niels Möller's avatar
Niels Möller committed
1220
1221
1222
1223
						   channel_number);

      lsh_string_free(packet);
      
1224
      if (channel && channel->receive
1225
1226
	  && !(channel->flags & (CHANNEL_RECEIVED_EOF
				 | CHANNEL_RECEIVED_CLOSE)))
Niels Möller's avatar
Niels Möller committed
1227
	{
Niels Möller's avatar
Niels Möller committed
1228
	  if (channel->flags & CHANNEL_SENT_CLOSE)
Niels Möller's avatar
Niels Möller committed
1229
	    {
Niels Möller's avatar
Niels Möller committed
1230
	      lsh_string_free(data);
1231
	      werror("Ignoring data on channel which is closing\n");
Niels Möller's avatar
Niels Möller committed
1232
	      return;
Niels Möller's avatar
Niels Möller committed
1233
	    }
Niels Möller's avatar
Niels Möller committed
1234
1235
	  else
	    {