]> andersk Git - openssh.git/blob - packet.c
- millert@cvs.openbsd.org 2001/03/04 17:42:28
[openssh.git] / packet.c
1 /*
2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4  *                    All rights reserved
5  * This file contains code implementing the packet protocol and communication
6  * with the other side.  This same code is used both on client and server side.
7  *
8  * As far as I am concerned, the code I have written for this software
9  * can be used freely for any purpose.  Any derived versions of this
10  * software must be clearly marked as such, and if the derived work is
11  * incompatible with the protocol description in the RFC file, it must be
12  * called by a name other than "ssh" or "Secure Shell".
13  *
14  *
15  * SSH2 packet format added by Markus Friedl.
16  * Copyright (c) 2000 Markus Friedl.  All rights reserved.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions
20  * are met:
21  * 1. Redistributions of source code must retain the above copyright
22  *    notice, this list of conditions and the following disclaimer.
23  * 2. Redistributions in binary form must reproduce the above copyright
24  *    notice, this list of conditions and the following disclaimer in the
25  *    documentation and/or other materials provided with the distribution.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
28  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
29  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
31  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
36  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37  */
38
39 #include "includes.h"
40 RCSID("$OpenBSD: packet.c,v 1.56 2001/03/03 21:41:07 millert Exp $");
41
42 #include "xmalloc.h"
43 #include "buffer.h"
44 #include "packet.h"
45 #include "bufaux.h"
46 #include "crc32.h"
47 #include "getput.h"
48
49 #include "compress.h"
50 #include "deattack.h"
51 #include "channels.h"
52
53 #include "compat.h"
54 #include "ssh1.h"
55 #include "ssh2.h"
56
57 #include "cipher.h"
58 #include "kex.h"
59 #include "mac.h"
60 #include "log.h"
61 #include "canohost.h"
62
63 #ifdef PACKET_DEBUG
64 #define DBG(x) x
65 #else
66 #define DBG(x)
67 #endif
68
69 /*
70  * This variable contains the file descriptors used for communicating with
71  * the other side.  connection_in is used for reading; connection_out for
72  * writing.  These can be the same descriptor, in which case it is assumed to
73  * be a socket.
74  */
75 static int connection_in = -1;
76 static int connection_out = -1;
77
78 /*
79  * Cipher type.  This value is only used to determine whether to pad the
80  * packets with zeroes or random data.
81  */
82 static int cipher_type = SSH_CIPHER_NONE;
83
84 /* Protocol flags for the remote side. */
85 static u_int remote_protocol_flags = 0;
86
87 /* Encryption context for receiving data.  This is only used for decryption. */
88 static CipherContext receive_context;
89
90 /* Encryption context for sending data.  This is only used for encryption. */
91 static CipherContext send_context;
92
93 /* Buffer for raw input data from the socket. */
94 static Buffer input;
95
96 /* Buffer for raw output data going to the socket. */
97 static Buffer output;
98
99 /* Buffer for the partial outgoing packet being constructed. */
100 static Buffer outgoing_packet;
101
102 /* Buffer for the incoming packet currently being processed. */
103 static Buffer incoming_packet;
104
105 /* Scratch buffer for packet compression/decompression. */
106 static Buffer compression_buffer;
107
108 /* Flag indicating whether packet compression/decompression is enabled. */
109 static int packet_compression = 0;
110
111 /* default maximum packet size */
112 int max_packet_size = 32768;
113
114 /* Flag indicating whether this module has been initialized. */
115 static int initialized = 0;
116
117 /* Set to true if the connection is interactive. */
118 static int interactive_mode = 0;
119
120 /* True if SSH2 packet format is used */
121 int use_ssh2_packet_format = 0;
122
123 /* Session key information for Encryption and MAC */
124 Kex     *kex = NULL;
125
126 void
127 packet_set_kex(Kex *k)
128 {
129         if( k->mac[MODE_IN ].key == NULL ||
130             k->enc[MODE_IN ].key == NULL ||
131             k->enc[MODE_IN ].iv  == NULL ||
132             k->mac[MODE_OUT].key == NULL ||
133             k->enc[MODE_OUT].key == NULL ||
134             k->enc[MODE_OUT].iv  == NULL)
135                 fatal("bad KEX");
136         kex = k;
137 }
138 void
139 clear_enc_keys(Enc *enc, int len)
140 {
141         memset(enc->iv,  0, len);
142         memset(enc->key, 0, len);
143         xfree(enc->iv);
144         xfree(enc->key);
145         enc->iv = NULL;
146         enc->key = NULL;
147 }
148 void
149 packet_set_ssh2_format(void)
150 {
151         DBG(debug("use_ssh2_packet_format"));
152         use_ssh2_packet_format = 1;
153 }
154
155 /*
156  * Sets the descriptors used for communication.  Disables encryption until
157  * packet_set_encryption_key is called.
158  */
159 void
160 packet_set_connection(int fd_in, int fd_out)
161 {
162         Cipher *none = cipher_by_name("none");
163         if (none == NULL)
164                 fatal("packet_set_connection: cannot load cipher 'none'");
165         connection_in = fd_in;
166         connection_out = fd_out;
167         cipher_type = SSH_CIPHER_NONE;
168         cipher_init(&send_context, none, (u_char *) "", 0, NULL, 0);
169         cipher_init(&receive_context, none, (u_char *) "", 0, NULL, 0);
170         if (!initialized) {
171                 initialized = 1;
172                 buffer_init(&input);
173                 buffer_init(&output);
174                 buffer_init(&outgoing_packet);
175                 buffer_init(&incoming_packet);
176         }
177         /* Kludge: arrange the close function to be called from fatal(). */
178         fatal_add_cleanup((void (*) (void *)) packet_close, NULL);
179 }
180
181 /* Returns 1 if remote host is connected via socket, 0 if not. */
182
183 int
184 packet_connection_is_on_socket()
185 {
186         struct sockaddr_storage from, to;
187         socklen_t fromlen, tolen;
188
189         /* filedescriptors in and out are the same, so it's a socket */
190         if (connection_in == connection_out)
191                 return 1;
192         fromlen = sizeof(from);
193         memset(&from, 0, sizeof(from));
194         if (getpeername(connection_in, (struct sockaddr *)&from, &fromlen) < 0)
195                 return 0;
196         tolen = sizeof(to);
197         memset(&to, 0, sizeof(to));
198         if (getpeername(connection_out, (struct sockaddr *)&to, &tolen) < 0)
199                 return 0;
200         if (fromlen != tolen || memcmp(&from, &to, fromlen) != 0)
201                 return 0;
202         if (from.ss_family != AF_INET && from.ss_family != AF_INET6)
203                 return 0;
204         return 1;
205 }
206
207 /* returns 1 if connection is via ipv4 */
208
209 int
210 packet_connection_is_ipv4()
211 {
212         struct sockaddr_storage to;
213         socklen_t tolen = sizeof(to);
214
215         memset(&to, 0, sizeof(to));
216         if (getsockname(connection_out, (struct sockaddr *)&to, &tolen) < 0)
217                 return 0;
218         if (to.ss_family != AF_INET)
219                 return 0;
220         return 1;
221 }
222
223 /* Sets the connection into non-blocking mode. */
224
225 void
226 packet_set_nonblocking()
227 {
228         /* Set the socket into non-blocking mode. */
229         if (fcntl(connection_in, F_SETFL, O_NONBLOCK) < 0)
230                 error("fcntl O_NONBLOCK: %.100s", strerror(errno));
231
232         if (connection_out != connection_in) {
233                 if (fcntl(connection_out, F_SETFL, O_NONBLOCK) < 0)
234                         error("fcntl O_NONBLOCK: %.100s", strerror(errno));
235         }
236 }
237
238 /* Returns the socket used for reading. */
239
240 int
241 packet_get_connection_in()
242 {
243         return connection_in;
244 }
245
246 /* Returns the descriptor used for writing. */
247
248 int
249 packet_get_connection_out()
250 {
251         return connection_out;
252 }
253
254 /* Closes the connection and clears and frees internal data structures. */
255
256 void
257 packet_close()
258 {
259         if (!initialized)
260                 return;
261         initialized = 0;
262         if (connection_in == connection_out) {
263                 shutdown(connection_out, SHUT_RDWR);
264                 close(connection_out);
265         } else {
266                 close(connection_in);
267                 close(connection_out);
268         }
269         buffer_free(&input);
270         buffer_free(&output);
271         buffer_free(&outgoing_packet);
272         buffer_free(&incoming_packet);
273         if (packet_compression) {
274                 buffer_free(&compression_buffer);
275                 buffer_compress_uninit();
276         }
277 }
278
279 /* Sets remote side protocol flags. */
280
281 void
282 packet_set_protocol_flags(u_int protocol_flags)
283 {
284         remote_protocol_flags = protocol_flags;
285         channel_set_options((protocol_flags & SSH_PROTOFLAG_HOST_IN_FWD_OPEN) != 0);
286 }
287
288 /* Returns the remote protocol flags set earlier by the above function. */
289
290 u_int
291 packet_get_protocol_flags()
292 {
293         return remote_protocol_flags;
294 }
295
296 /*
297  * Starts packet compression from the next packet on in both directions.
298  * Level is compression level 1 (fastest) - 9 (slow, best) as in gzip.
299  */
300
301 /*** XXXXX todo: kex means re-init */
302 void
303 packet_start_compression(int level)
304 {
305         if (packet_compression)
306                 fatal("Compression already enabled.");
307         packet_compression = 1;
308         buffer_init(&compression_buffer);
309         buffer_compress_init(level);
310 }
311
312 /*
313  * Encrypts the given number of bytes, copying from src to dest. bytes is
314  * known to be a multiple of 8.
315  */
316
317 void
318 packet_encrypt(CipherContext * cc, void *dest, void *src,
319     u_int bytes)
320 {
321         cipher_encrypt(cc, dest, src, bytes);
322 }
323
324 /*
325  * Decrypts the given number of bytes, copying from src to dest. bytes is
326  * known to be a multiple of 8.
327  */
328
329 void
330 packet_decrypt(CipherContext *context, void *dest, void *src, u_int bytes)
331 {
332         /*
333          * Cryptographic attack detector for ssh - Modifications for packet.c
334          * (C)1998 CORE-SDI, Buenos Aires Argentina Ariel Futoransky(futo@core-sdi.com)
335          */
336         if (!compat20 &&
337             context->cipher->number != SSH_CIPHER_NONE &&
338             detect_attack(src, bytes, NULL) == DEATTACK_DETECTED)
339                 packet_disconnect("crc32 compensation attack: network attack detected");
340
341         cipher_decrypt(context, dest, src, bytes);
342 }
343
344 /*
345  * Causes any further packets to be encrypted using the given key.  The same
346  * key is used for both sending and reception.  However, both directions are
347  * encrypted independently of each other.
348  */
349
350 void
351 packet_set_encryption_key(const u_char *key, u_int keylen,
352     int number)
353 {
354         Cipher *cipher = cipher_by_number(number);
355         if (cipher == NULL)
356                 fatal("packet_set_encryption_key: unknown cipher number %d", number);
357         if (keylen < 20)
358                 fatal("packet_set_encryption_key: keylen too small: %d", keylen);
359         cipher_init(&receive_context, cipher, key, keylen, NULL, 0);
360         cipher_init(&send_context, cipher, key, keylen, NULL, 0);
361 }
362
363 /* Starts constructing a packet to send. */
364
365 void
366 packet_start1(int type)
367 {
368         char buf[9];
369
370         buffer_clear(&outgoing_packet);
371         memset(buf, 0, 8);
372         buf[8] = type;
373         buffer_append(&outgoing_packet, buf, 9);
374 }
375
376 void
377 packet_start2(int type)
378 {
379         char buf[4+1+1];
380
381         buffer_clear(&outgoing_packet);
382         memset(buf, 0, sizeof buf);
383         /* buf[0..3] = payload_len; */
384         /* buf[4] =    pad_len; */
385         buf[5] = type & 0xff;
386         buffer_append(&outgoing_packet, buf, sizeof buf);
387 }
388
389 void
390 packet_start(int type)
391 {
392         DBG(debug("packet_start[%d]", type));
393         if (use_ssh2_packet_format)
394                 packet_start2(type);
395         else
396                 packet_start1(type);
397 }
398
399 /* Appends a character to the packet data. */
400
401 void
402 packet_put_char(int value)
403 {
404         char ch = value;
405         buffer_append(&outgoing_packet, &ch, 1);
406 }
407
408 /* Appends an integer to the packet data. */
409
410 void
411 packet_put_int(u_int value)
412 {
413         buffer_put_int(&outgoing_packet, value);
414 }
415
416 /* Appends a string to packet data. */
417
418 void
419 packet_put_string(const char *buf, u_int len)
420 {
421         buffer_put_string(&outgoing_packet, buf, len);
422 }
423 void
424 packet_put_cstring(const char *str)
425 {
426         buffer_put_string(&outgoing_packet, str, strlen(str));
427 }
428
429 void
430 packet_put_raw(const char *buf, u_int len)
431 {
432         buffer_append(&outgoing_packet, buf, len);
433 }
434
435
436 /* Appends an arbitrary precision integer to packet data. */
437
438 void
439 packet_put_bignum(BIGNUM * value)
440 {
441         buffer_put_bignum(&outgoing_packet, value);
442 }
443 void
444 packet_put_bignum2(BIGNUM * value)
445 {
446         buffer_put_bignum2(&outgoing_packet, value);
447 }
448
449 /*
450  * Finalizes and sends the packet.  If the encryption key has been set,
451  * encrypts the packet before sending.
452  */
453
454 void
455 packet_send1(void)
456 {
457         char buf[8], *cp;
458         int i, padding, len;
459         u_int checksum;
460         u_int32_t rand = 0;
461
462         /*
463          * If using packet compression, compress the payload of the outgoing
464          * packet.
465          */
466         if (packet_compression) {
467                 buffer_clear(&compression_buffer);
468                 /* Skip padding. */
469                 buffer_consume(&outgoing_packet, 8);
470                 /* padding */
471                 buffer_append(&compression_buffer, "\0\0\0\0\0\0\0\0", 8);
472                 buffer_compress(&outgoing_packet, &compression_buffer);
473                 buffer_clear(&outgoing_packet);
474                 buffer_append(&outgoing_packet, buffer_ptr(&compression_buffer),
475                               buffer_len(&compression_buffer));
476         }
477         /* Compute packet length without padding (add checksum, remove padding). */
478         len = buffer_len(&outgoing_packet) + 4 - 8;
479
480         /* Insert padding. Initialized to zero in packet_start1() */
481         padding = 8 - len % 8;
482         if (cipher_type != SSH_CIPHER_NONE) {
483                 cp = buffer_ptr(&outgoing_packet);
484                 for (i = 0; i < padding; i++) {
485                         if (i % 4 == 0)
486                                 rand = arc4random();
487                         cp[7 - i] = rand & 0xff;
488                         rand >>= 8;
489                 }
490         }
491         buffer_consume(&outgoing_packet, 8 - padding);
492
493         /* Add check bytes. */
494         checksum = ssh_crc32((u_char *) buffer_ptr(&outgoing_packet),
495             buffer_len(&outgoing_packet));
496         PUT_32BIT(buf, checksum);
497         buffer_append(&outgoing_packet, buf, 4);
498
499 #ifdef PACKET_DEBUG
500         fprintf(stderr, "packet_send plain: ");
501         buffer_dump(&outgoing_packet);
502 #endif
503
504         /* Append to output. */
505         PUT_32BIT(buf, len);
506         buffer_append(&output, buf, 4);
507         buffer_append_space(&output, &cp, buffer_len(&outgoing_packet));
508         packet_encrypt(&send_context, cp, buffer_ptr(&outgoing_packet),
509                        buffer_len(&outgoing_packet));
510
511 #ifdef PACKET_DEBUG
512         fprintf(stderr, "encrypted: ");
513         buffer_dump(&output);
514 #endif
515
516         buffer_clear(&outgoing_packet);
517
518         /*
519          * Note that the packet is now only buffered in output.  It won\'t be
520          * actually sent until packet_write_wait or packet_write_poll is
521          * called.
522          */
523 }
524
525 /*
526  * Finalize packet in SSH2 format (compress, mac, encrypt, enqueue)
527  */
528 void
529 packet_send2(void)
530 {
531         static u_int32_t seqnr = 0;
532         u_char *macbuf = NULL;
533         char *cp;
534         u_int packet_length = 0;
535         u_int i, padlen, len;
536         u_int32_t rand = 0;
537         int type;
538         Enc *enc   = NULL;
539         Mac *mac   = NULL;
540         Comp *comp = NULL;
541         int block_size;
542
543         if (kex != NULL) {
544                 enc  = &kex->enc[MODE_OUT];
545                 mac  = &kex->mac[MODE_OUT];
546                 comp = &kex->comp[MODE_OUT];
547         }
548         block_size = enc ? enc->cipher->block_size : 8;
549
550         cp = buffer_ptr(&outgoing_packet);
551         type = cp[5] & 0xff;
552
553 #ifdef PACKET_DEBUG
554         fprintf(stderr, "plain:     ");
555         buffer_dump(&outgoing_packet);
556 #endif
557
558         if (comp && comp->enabled) {
559                 len = buffer_len(&outgoing_packet);
560                 /* skip header, compress only payload */
561                 buffer_consume(&outgoing_packet, 5);
562                 buffer_clear(&compression_buffer);
563                 buffer_compress(&outgoing_packet, &compression_buffer);
564                 buffer_clear(&outgoing_packet);
565                 buffer_append(&outgoing_packet, "\0\0\0\0\0", 5);
566                 buffer_append(&outgoing_packet, buffer_ptr(&compression_buffer),
567                     buffer_len(&compression_buffer));
568                 DBG(debug("compression: raw %d compressed %d", len,
569                     buffer_len(&outgoing_packet)));
570         }
571
572         /* sizeof (packet_len + pad_len + payload) */
573         len = buffer_len(&outgoing_packet);
574
575         /*
576          * calc size of padding, alloc space, get random data,
577          * minimum padding is 4 bytes
578          */
579         padlen = block_size - (len % block_size);
580         if (padlen < 4)
581                 padlen += block_size;
582         buffer_append_space(&outgoing_packet, &cp, padlen);
583         if (enc && enc->cipher->number != SSH_CIPHER_NONE) {
584                 /* random padding */
585                 for (i = 0; i < padlen; i++) {
586                         if (i % 4 == 0)
587                                 rand = arc4random();
588                         cp[i] = rand & 0xff;
589                         rand >>= 8;
590                 }
591         } else {
592                 /* clear padding */
593                 memset(cp, 0, padlen);
594         }
595         /* packet_length includes payload, padding and padding length field */
596         packet_length = buffer_len(&outgoing_packet) - 4;
597         cp = buffer_ptr(&outgoing_packet);
598         PUT_32BIT(cp, packet_length);
599         cp[4] = padlen & 0xff;
600         DBG(debug("send: len %d (includes padlen %d)", packet_length+4, padlen));
601
602         /* compute MAC over seqnr and packet(length fields, payload, padding) */
603         if (mac && mac->enabled) {
604                 macbuf = mac_compute(mac, seqnr,
605                     (u_char *) buffer_ptr(&outgoing_packet),
606                     buffer_len(&outgoing_packet));
607                 DBG(debug("done calc MAC out #%d", seqnr));
608         }
609         /* encrypt packet and append to output buffer. */
610         buffer_append_space(&output, &cp, buffer_len(&outgoing_packet));
611         packet_encrypt(&send_context, cp, buffer_ptr(&outgoing_packet),
612             buffer_len(&outgoing_packet));
613         /* append unencrypted MAC */
614         if (mac && mac->enabled)
615                 buffer_append(&output, (char *)macbuf, mac->mac_len);
616 #ifdef PACKET_DEBUG
617         fprintf(stderr, "encrypted: ");
618         buffer_dump(&output);
619 #endif
620         /* increment sequence number for outgoing packets */
621         if (++seqnr == 0)
622                 log("outgoing seqnr wraps around");
623         buffer_clear(&outgoing_packet);
624
625         if (type == SSH2_MSG_NEWKEYS) {
626                 if (kex==NULL || mac==NULL || enc==NULL || comp==NULL)
627                         fatal("packet_send2: no KEX");
628                 if (mac->md != NULL)
629                         mac->enabled = 1;
630                 DBG(debug("cipher_init send_context"));
631                 cipher_init(&send_context, enc->cipher,
632                     enc->key, enc->cipher->key_len,
633                     enc->iv, enc->cipher->block_size);
634                 clear_enc_keys(enc, kex->we_need);
635                 if (comp->type != 0 && comp->enabled == 0) {
636                         comp->enabled = 1;
637                         if (! packet_compression)
638                                 packet_start_compression(6);
639                 }
640         }
641 }
642
643 void
644 packet_send()
645 {
646         if (use_ssh2_packet_format)
647                 packet_send2();
648         else
649                 packet_send1();
650         DBG(debug("packet_send done"));
651 }
652
653 /*
654  * Waits until a packet has been received, and returns its type.  Note that
655  * no other data is processed until this returns, so this function should not
656  * be used during the interactive session.
657  */
658
659 int
660 packet_read(int *payload_len_ptr)
661 {
662         int type, len;
663         fd_set *setp;
664         char buf[8192];
665         DBG(debug("packet_read()"));
666
667         setp = (fd_set *)xmalloc(howmany(connection_in+1, NFDBITS) *
668             sizeof(fd_mask));
669
670         /* Since we are blocking, ensure that all written packets have been sent. */
671         packet_write_wait();
672
673         /* Stay in the loop until we have received a complete packet. */
674         for (;;) {
675                 /* Try to read a packet from the buffer. */
676                 type = packet_read_poll(payload_len_ptr);
677                 if (!use_ssh2_packet_format && (
678                     type == SSH_SMSG_SUCCESS
679                     || type == SSH_SMSG_FAILURE
680                     || type == SSH_CMSG_EOF
681                     || type == SSH_CMSG_EXIT_CONFIRMATION))
682                         packet_integrity_check(*payload_len_ptr, 0, type);
683                 /* If we got a packet, return it. */
684                 if (type != SSH_MSG_NONE) {
685                         xfree(setp);
686                         return type;
687                 }
688                 /*
689                  * Otherwise, wait for some data to arrive, add it to the
690                  * buffer, and try again.
691                  */
692                 memset(setp, 0, howmany(connection_in + 1, NFDBITS) *
693                     sizeof(fd_mask));
694                 FD_SET(connection_in, setp);
695
696                 /* Wait for some data to arrive. */
697                 while (select(connection_in + 1, setp, NULL, NULL, NULL) == -1 &&
698                     (errno == EAGAIN || errno == EINTR))
699                         ;
700
701                 /* Read data from the socket. */
702                 len = read(connection_in, buf, sizeof(buf));
703                 if (len == 0) {
704                         log("Connection closed by %.200s", get_remote_ipaddr());
705                         fatal_cleanup();
706                 }
707                 if (len < 0)
708                         fatal("Read from socket failed: %.100s", strerror(errno));
709                 /* Append it to the buffer. */
710                 packet_process_incoming(buf, len);
711         }
712         /* NOTREACHED */
713 }
714
715 /*
716  * Waits until a packet has been received, verifies that its type matches
717  * that given, and gives a fatal error and exits if there is a mismatch.
718  */
719
720 void
721 packet_read_expect(int *payload_len_ptr, int expected_type)
722 {
723         int type;
724
725         type = packet_read(payload_len_ptr);
726         if (type != expected_type)
727                 packet_disconnect("Protocol error: expected packet type %d, got %d",
728                     expected_type, type);
729 }
730
731 /* Checks if a full packet is available in the data received so far via
732  * packet_process_incoming.  If so, reads the packet; otherwise returns
733  * SSH_MSG_NONE.  This does not wait for data from the connection.
734  *
735  * SSH_MSG_DISCONNECT is handled specially here.  Also,
736  * SSH_MSG_IGNORE messages are skipped by this function and are never returned
737  * to higher levels.
738  *
739  * The returned payload_len does include space consumed by:
740  *      Packet length
741  *      Padding
742  *      Packet type
743  *      Check bytes
744  */
745
746 int
747 packet_read_poll1(int *payload_len_ptr)
748 {
749         u_int len, padded_len;
750         u_char *ucp;
751         char buf[8], *cp;
752         u_int checksum, stored_checksum;
753
754         /* Check if input size is less than minimum packet size. */
755         if (buffer_len(&input) < 4 + 8)
756                 return SSH_MSG_NONE;
757         /* Get length of incoming packet. */
758         ucp = (u_char *) buffer_ptr(&input);
759         len = GET_32BIT(ucp);
760         if (len < 1 + 2 + 2 || len > 256 * 1024)
761                 packet_disconnect("Bad packet length %d.", len);
762         padded_len = (len + 8) & ~7;
763
764         /* Check if the packet has been entirely received. */
765         if (buffer_len(&input) < 4 + padded_len)
766                 return SSH_MSG_NONE;
767
768         /* The entire packet is in buffer. */
769
770         /* Consume packet length. */
771         buffer_consume(&input, 4);
772
773         /* Copy data to incoming_packet. */
774         buffer_clear(&incoming_packet);
775         buffer_append_space(&incoming_packet, &cp, padded_len);
776         packet_decrypt(&receive_context, cp, buffer_ptr(&input), padded_len);
777         buffer_consume(&input, padded_len);
778
779 #ifdef PACKET_DEBUG
780         fprintf(stderr, "read_poll plain: ");
781         buffer_dump(&incoming_packet);
782 #endif
783
784         /* Compute packet checksum. */
785         checksum = ssh_crc32((u_char *) buffer_ptr(&incoming_packet),
786             buffer_len(&incoming_packet) - 4);
787
788         /* Skip padding. */
789         buffer_consume(&incoming_packet, 8 - len % 8);
790
791         /* Test check bytes. */
792
793         if (len != buffer_len(&incoming_packet))
794                 packet_disconnect("packet_read_poll: len %d != buffer_len %d.",
795                     len, buffer_len(&incoming_packet));
796
797         ucp = (u_char *) buffer_ptr(&incoming_packet) + len - 4;
798         stored_checksum = GET_32BIT(ucp);
799         if (checksum != stored_checksum)
800                 packet_disconnect("Corrupted check bytes on input.");
801         buffer_consume_end(&incoming_packet, 4);
802
803         /* If using packet compression, decompress the packet. */
804         if (packet_compression) {
805                 buffer_clear(&compression_buffer);
806                 buffer_uncompress(&incoming_packet, &compression_buffer);
807                 buffer_clear(&incoming_packet);
808                 buffer_append(&incoming_packet, buffer_ptr(&compression_buffer),
809                     buffer_len(&compression_buffer));
810         }
811         /* Get packet type. */
812         buffer_get(&incoming_packet, &buf[0], 1);
813
814         /* Return length of payload (without type field). */
815         *payload_len_ptr = buffer_len(&incoming_packet);
816
817         /* Return type. */
818         return (u_char) buf[0];
819 }
820
821 int
822 packet_read_poll2(int *payload_len_ptr)
823 {
824         static u_int32_t seqnr = 0;
825         static u_int packet_length = 0;
826         u_int padlen, need;
827         u_char buf[8], *macbuf;
828         u_char *ucp;
829         char *cp;
830         int type;
831         int maclen, block_size;
832         Enc *enc   = NULL;
833         Mac *mac   = NULL;
834         Comp *comp = NULL;
835
836         if (kex != NULL) {
837                 enc  = &kex->enc[MODE_IN];
838                 mac  = &kex->mac[MODE_IN];
839                 comp = &kex->comp[MODE_IN];
840         }
841         maclen = mac && mac->enabled ? mac->mac_len : 0;
842         block_size = enc ? enc->cipher->block_size : 8;
843
844         if (packet_length == 0) {
845                 /*
846                  * check if input size is less than the cipher block size,
847                  * decrypt first block and extract length of incoming packet
848                  */
849                 if (buffer_len(&input) < block_size)
850                         return SSH_MSG_NONE;
851                 buffer_clear(&incoming_packet);
852                 buffer_append_space(&incoming_packet, &cp, block_size);
853                 packet_decrypt(&receive_context, cp, buffer_ptr(&input),
854                     block_size);
855                 ucp = (u_char *) buffer_ptr(&incoming_packet);
856                 packet_length = GET_32BIT(ucp);
857                 if (packet_length < 1 + 4 || packet_length > 256 * 1024) {
858                         buffer_dump(&incoming_packet);
859                         packet_disconnect("Bad packet length %d.", packet_length);
860                 }
861                 DBG(debug("input: packet len %d", packet_length+4));
862                 buffer_consume(&input, block_size);
863         }
864         /* we have a partial packet of block_size bytes */
865         need = 4 + packet_length - block_size;
866         DBG(debug("partial packet %d, need %d, maclen %d", block_size,
867             need, maclen));
868         if (need % block_size != 0)
869                 fatal("padding error: need %d block %d mod %d",
870                     need, block_size, need % block_size);
871         /*
872          * check if the entire packet has been received and
873          * decrypt into incoming_packet
874          */
875         if (buffer_len(&input) < need + maclen)
876                 return SSH_MSG_NONE;
877 #ifdef PACKET_DEBUG
878         fprintf(stderr, "read_poll enc/full: ");
879         buffer_dump(&input);
880 #endif
881         buffer_append_space(&incoming_packet, &cp, need);
882         packet_decrypt(&receive_context, cp, buffer_ptr(&input), need);
883         buffer_consume(&input, need);
884         /*
885          * compute MAC over seqnr and packet,
886          * increment sequence number for incoming packet
887          */
888         if (mac && mac->enabled) {
889                 macbuf = mac_compute(mac, seqnr,
890                     (u_char *) buffer_ptr(&incoming_packet),
891                     buffer_len(&incoming_packet));
892                 if (memcmp(macbuf, buffer_ptr(&input), mac->mac_len) != 0)
893                         packet_disconnect("Corrupted MAC on input.");
894                 DBG(debug("MAC #%d ok", seqnr));
895                 buffer_consume(&input, mac->mac_len);
896         }
897         if (++seqnr == 0)
898                 log("incoming seqnr wraps around");
899
900         /* get padlen */
901         cp = buffer_ptr(&incoming_packet) + 4;
902         padlen = *cp & 0xff;
903         DBG(debug("input: padlen %d", padlen));
904         if (padlen < 4)
905                 packet_disconnect("Corrupted padlen %d on input.", padlen);
906
907         /* skip packet size + padlen, discard padding */
908         buffer_consume(&incoming_packet, 4 + 1);
909         buffer_consume_end(&incoming_packet, padlen);
910
911         DBG(debug("input: len before de-compress %d", buffer_len(&incoming_packet)));
912         if (comp && comp->enabled) {
913                 buffer_clear(&compression_buffer);
914                 buffer_uncompress(&incoming_packet, &compression_buffer);
915                 buffer_clear(&incoming_packet);
916                 buffer_append(&incoming_packet, buffer_ptr(&compression_buffer),
917                     buffer_len(&compression_buffer));
918                 DBG(debug("input: len after de-compress %d", buffer_len(&incoming_packet)));
919         }
920         /*
921          * get packet type, implies consume.
922          * return length of payload (without type field)
923          */
924         buffer_get(&incoming_packet, (char *)&buf[0], 1);
925         *payload_len_ptr = buffer_len(&incoming_packet);
926
927         /* reset for next packet */
928         packet_length = 0;
929
930         /* extract packet type */
931         type = (u_char)buf[0];
932
933         if (type == SSH2_MSG_NEWKEYS) {
934                 if (kex==NULL || mac==NULL || enc==NULL || comp==NULL)
935                         fatal("packet_read_poll2: no KEX");
936                 if (mac->md != NULL)
937                         mac->enabled = 1;
938                 DBG(debug("cipher_init receive_context"));
939                 cipher_init(&receive_context, enc->cipher,
940                     enc->key, enc->cipher->key_len,
941                     enc->iv, enc->cipher->block_size);
942                 clear_enc_keys(enc, kex->we_need);
943                 if (comp->type != 0 && comp->enabled == 0) {
944                         comp->enabled = 1;
945                         if (! packet_compression)
946                                 packet_start_compression(6);
947                 }
948         }
949
950 #ifdef PACKET_DEBUG
951         fprintf(stderr, "read/plain[%d]:\r\n", type);
952         buffer_dump(&incoming_packet);
953 #endif
954         return (u_char)type;
955 }
956
957 int
958 packet_read_poll(int *payload_len_ptr)
959 {
960         char *msg;
961         for (;;) {
962                 int type = use_ssh2_packet_format ?
963                     packet_read_poll2(payload_len_ptr):
964                     packet_read_poll1(payload_len_ptr);
965
966                 if(compat20) {
967                         int reason;
968                         if (type != 0)
969                                 DBG(debug("received packet type %d", type));
970                         switch(type) {
971                         case SSH2_MSG_IGNORE:
972                                 break;
973                         case SSH2_MSG_DEBUG:
974                                 packet_get_char();
975                                 msg = packet_get_string(NULL);
976                                 debug("Remote: %.900s", msg);
977                                 xfree(msg);
978                                 msg = packet_get_string(NULL);
979                                 xfree(msg);
980                                 break;
981                         case SSH2_MSG_DISCONNECT:
982                                 reason = packet_get_int();
983                                 msg = packet_get_string(NULL);
984                                 log("Received disconnect from %s: %d: %.400s", get_remote_ipaddr(),
985                                         reason, msg);
986                                 xfree(msg);
987                                 fatal_cleanup();
988                                 break;
989                         default:
990                                 return type;
991                                 break;
992                         }
993                 } else {
994                         switch(type) {
995                         case SSH_MSG_IGNORE:
996                                 break;
997                         case SSH_MSG_DEBUG:
998                                 msg = packet_get_string(NULL);
999                                 debug("Remote: %.900s", msg);
1000                                 xfree(msg);
1001                                 break;
1002                         case SSH_MSG_DISCONNECT:
1003                                 msg = packet_get_string(NULL);
1004                                 log("Received disconnect from %s: %.400s", get_remote_ipaddr(),
1005                                         msg);
1006                                 fatal_cleanup();
1007                                 xfree(msg);
1008                                 break;
1009                         default:
1010                                 if (type != 0)
1011                                         DBG(debug("received packet type %d", type));
1012                                 return type;
1013                                 break;
1014                         }
1015                 }
1016         }
1017 }
1018
1019 /*
1020  * Buffers the given amount of input characters.  This is intended to be used
1021  * together with packet_read_poll.
1022  */
1023
1024 void
1025 packet_process_incoming(const char *buf, u_int len)
1026 {
1027         buffer_append(&input, buf, len);
1028 }
1029
1030 /* Returns a character from the packet. */
1031
1032 u_int
1033 packet_get_char()
1034 {
1035         char ch;
1036         buffer_get(&incoming_packet, &ch, 1);
1037         return (u_char) ch;
1038 }
1039
1040 /* Returns an integer from the packet data. */
1041
1042 u_int
1043 packet_get_int()
1044 {
1045         return buffer_get_int(&incoming_packet);
1046 }
1047
1048 /*
1049  * Returns an arbitrary precision integer from the packet data.  The integer
1050  * must have been initialized before this call.
1051  */
1052
1053 void
1054 packet_get_bignum(BIGNUM * value, int *length_ptr)
1055 {
1056         *length_ptr = buffer_get_bignum(&incoming_packet, value);
1057 }
1058
1059 void
1060 packet_get_bignum2(BIGNUM * value, int *length_ptr)
1061 {
1062         *length_ptr = buffer_get_bignum2(&incoming_packet, value);
1063 }
1064
1065 char *
1066 packet_get_raw(int *length_ptr)
1067 {
1068         int bytes = buffer_len(&incoming_packet);
1069         if (length_ptr != NULL)
1070                 *length_ptr = bytes;
1071         return buffer_ptr(&incoming_packet);
1072 }
1073
1074 int
1075 packet_remaining(void)
1076 {
1077         return buffer_len(&incoming_packet);
1078 }
1079
1080 /*
1081  * Returns a string from the packet data.  The string is allocated using
1082  * xmalloc; it is the responsibility of the calling program to free it when
1083  * no longer needed.  The length_ptr argument may be NULL, or point to an
1084  * integer into which the length of the string is stored.
1085  */
1086
1087 char *
1088 packet_get_string(u_int *length_ptr)
1089 {
1090         return buffer_get_string(&incoming_packet, length_ptr);
1091 }
1092
1093 /*
1094  * Sends a diagnostic message from the server to the client.  This message
1095  * can be sent at any time (but not while constructing another message). The
1096  * message is printed immediately, but only if the client is being executed
1097  * in verbose mode.  These messages are primarily intended to ease debugging
1098  * authentication problems.   The length of the formatted message must not
1099  * exceed 1024 bytes.  This will automatically call packet_write_wait.
1100  */
1101
1102 void
1103 packet_send_debug(const char *fmt,...)
1104 {
1105         char buf[1024];
1106         va_list args;
1107
1108         if (compat20 && (datafellows & SSH_BUG_DEBUG))
1109                 return;
1110
1111         va_start(args, fmt);
1112         vsnprintf(buf, sizeof(buf), fmt, args);
1113         va_end(args);
1114
1115         if (compat20) {
1116                 packet_start(SSH2_MSG_DEBUG);
1117                 packet_put_char(0);     /* bool: always display */
1118                 packet_put_cstring(buf);
1119                 packet_put_cstring("");
1120         } else {
1121                 packet_start(SSH_MSG_DEBUG);
1122                 packet_put_cstring(buf);
1123         }
1124         packet_send();
1125         packet_write_wait();
1126 }
1127
1128 /*
1129  * Logs the error plus constructs and sends a disconnect packet, closes the
1130  * connection, and exits.  This function never returns. The error message
1131  * should not contain a newline.  The length of the formatted message must
1132  * not exceed 1024 bytes.
1133  */
1134
1135 void
1136 packet_disconnect(const char *fmt,...)
1137 {
1138         char buf[1024];
1139         va_list args;
1140         static int disconnecting = 0;
1141         if (disconnecting)      /* Guard against recursive invocations. */
1142                 fatal("packet_disconnect called recursively.");
1143         disconnecting = 1;
1144
1145         /*
1146          * Format the message.  Note that the caller must make sure the
1147          * message is of limited size.
1148          */
1149         va_start(args, fmt);
1150         vsnprintf(buf, sizeof(buf), fmt, args);
1151         va_end(args);
1152
1153         /* Send the disconnect message to the other side, and wait for it to get sent. */
1154         if (compat20) {
1155                 packet_start(SSH2_MSG_DISCONNECT);
1156                 packet_put_int(SSH2_DISCONNECT_PROTOCOL_ERROR);
1157                 packet_put_cstring(buf);
1158                 packet_put_cstring("");
1159         } else {
1160                 packet_start(SSH_MSG_DISCONNECT);
1161                 packet_put_string(buf, strlen(buf));
1162         }
1163         packet_send();
1164         packet_write_wait();
1165
1166         /* Stop listening for connections. */
1167         channel_stop_listening();
1168
1169         /* Close the connection. */
1170         packet_close();
1171
1172         /* Display the error locally and exit. */
1173         log("Disconnecting: %.100s", buf);
1174         fatal_cleanup();
1175 }
1176
1177 /* Checks if there is any buffered output, and tries to write some of the output. */
1178
1179 void
1180 packet_write_poll()
1181 {
1182         int len = buffer_len(&output);
1183         if (len > 0) {
1184                 len = write(connection_out, buffer_ptr(&output), len);
1185                 if (len <= 0) {
1186                         if (errno == EAGAIN)
1187                                 return;
1188                         else
1189                                 fatal("Write failed: %.100s", strerror(errno));
1190                 }
1191                 buffer_consume(&output, len);
1192         }
1193 }
1194
1195 /*
1196  * Calls packet_write_poll repeatedly until all pending output data has been
1197  * written.
1198  */
1199
1200 void
1201 packet_write_wait()
1202 {
1203         fd_set *setp;
1204
1205         setp = (fd_set *)xmalloc(howmany(connection_out + 1, NFDBITS) *
1206             sizeof(fd_mask));
1207         packet_write_poll();
1208         while (packet_have_data_to_write()) {
1209                 memset(setp, 0, howmany(connection_out + 1, NFDBITS) *
1210                     sizeof(fd_mask));
1211                 FD_SET(connection_out, setp);
1212                 while (select(connection_out + 1, NULL, setp, NULL, NULL) == -1 &&
1213                     (errno == EAGAIN || errno == EINTR))
1214                         ;
1215                 packet_write_poll();
1216         }
1217         xfree(setp);
1218 }
1219
1220 /* Returns true if there is buffered data to write to the connection. */
1221
1222 int
1223 packet_have_data_to_write()
1224 {
1225         return buffer_len(&output) != 0;
1226 }
1227
1228 /* Returns true if there is not too much data to write to the connection. */
1229
1230 int
1231 packet_not_very_much_data_to_write()
1232 {
1233         if (interactive_mode)
1234                 return buffer_len(&output) < 16384;
1235         else
1236                 return buffer_len(&output) < 128 * 1024;
1237 }
1238
1239 /* Informs that the current session is interactive.  Sets IP flags for that. */
1240
1241 void
1242 packet_set_interactive(int interactive)
1243 {
1244         static int called = 0;
1245 #if defined(IP_TOS) && !defined(IP_TOS_IS_BROKEN)
1246         int lowdelay = IPTOS_LOWDELAY;
1247         int throughput = IPTOS_THROUGHPUT;
1248 #endif
1249         int on = 1;
1250
1251         if (called)
1252                 return;
1253         called = 1;
1254
1255         /* Record that we are in interactive mode. */
1256         interactive_mode = interactive;
1257
1258         /* Only set socket options if using a socket.  */
1259         if (!packet_connection_is_on_socket())
1260                 return;
1261         /*
1262          * IPTOS_LOWDELAY and IPTOS_THROUGHPUT are IPv4 only
1263          */
1264         if (interactive) {
1265                 /*
1266                  * Set IP options for an interactive connection.  Use
1267                  * IPTOS_LOWDELAY and TCP_NODELAY.
1268                  */
1269 #if defined(IP_TOS) && !defined(IP_TOS_IS_BROKEN)
1270                 if (packet_connection_is_ipv4()) {
1271                         if (setsockopt(connection_in, IPPROTO_IP, IP_TOS,
1272                             (void *) &lowdelay, sizeof(lowdelay)) < 0)
1273                                 error("setsockopt IPTOS_LOWDELAY: %.100s",
1274                                     strerror(errno));
1275                 }
1276 #endif
1277                 if (setsockopt(connection_in, IPPROTO_TCP, TCP_NODELAY, (void *) &on,
1278                     sizeof(on)) < 0)
1279                         error("setsockopt TCP_NODELAY: %.100s", strerror(errno));
1280         } else if (packet_connection_is_ipv4()) {
1281                 /*
1282                  * Set IP options for a non-interactive connection.  Use
1283                  * IPTOS_THROUGHPUT.
1284                  */
1285 #if defined(IP_TOS) && !defined(IP_TOS_IS_BROKEN)
1286                 if (setsockopt(connection_in, IPPROTO_IP, IP_TOS, (void *) &throughput,
1287                     sizeof(throughput)) < 0)
1288                         error("setsockopt IPTOS_THROUGHPUT: %.100s", strerror(errno));
1289 #endif
1290         }
1291 }
1292
1293 /* Returns true if the current connection is interactive. */
1294
1295 int
1296 packet_is_interactive()
1297 {
1298         return interactive_mode;
1299 }
1300
1301 int
1302 packet_set_maxsize(int s)
1303 {
1304         static int called = 0;
1305         if (called) {
1306                 log("packet_set_maxsize: called twice: old %d new %d",
1307                     max_packet_size, s);
1308                 return -1;
1309         }
1310         if (s < 4 * 1024 || s > 1024 * 1024) {
1311                 log("packet_set_maxsize: bad size %d", s);
1312                 return -1;
1313         }
1314         log("packet_set_maxsize: setting to %d", s);
1315         max_packet_size = s;
1316         return s;
1317 }
1318
1319 /*
1320  * 9.2.  Ignored Data Message
1321  * 
1322  *   byte      SSH_MSG_IGNORE
1323  *   string    data
1324  * 
1325  * All implementations MUST understand (and ignore) this message at any
1326  * time (after receiving the protocol version). No implementation is
1327  * required to send them. This message can be used as an additional
1328  * protection measure against advanced traffic analysis techniques.
1329  */
1330 /* size of current + ignore message should be n*sumlen bytes (w/o mac) */
1331 void
1332 packet_inject_ignore(int sumlen)
1333 {
1334         int blocksize, padlen, have, need, nb, mini, nbytes;
1335         Enc *enc = NULL;
1336
1337         if (use_ssh2_packet_format == 0)
1338                 return;
1339
1340         have = buffer_len(&outgoing_packet);
1341         debug2("packet_inject_ignore: current %d", have);
1342         if (kex != NULL)
1343         enc  = &kex->enc[MODE_OUT];
1344         blocksize = enc ? enc->cipher->block_size : 8;
1345         padlen = blocksize - (have % blocksize);
1346         if (padlen < 4)
1347                 padlen += blocksize;
1348         have += padlen;
1349         have /= blocksize;      /* # of blocks for current message */
1350
1351         nb   = roundup(sumlen,  blocksize) / blocksize; /* blocks for both */
1352         mini = roundup(5+1+4+4, blocksize) / blocksize; /* minsize ignore msg */
1353         need = nb - (have % nb);                        /* blocks for ignore */
1354         if (need <= mini)
1355                 need += nb;
1356         nbytes = (need - mini) * blocksize;     /* size of ignore payload */
1357         debug2("packet_inject_ignore: block %d have %d nb %d mini %d need %d",
1358             blocksize, have, nb, mini, need);
1359
1360         /* enqueue current message and append a ignore message */
1361         packet_send();
1362         packet_send_ignore(nbytes);
1363 }
1364
1365 void
1366 packet_send_ignore(int nbytes)
1367 {
1368         u_int32_t rand = 0;
1369         int i;
1370
1371         packet_start(compat20 ? SSH2_MSG_IGNORE : SSH_MSG_IGNORE);
1372         packet_put_int(nbytes);
1373         for(i = 0; i < nbytes; i++) {
1374                 if (i % 4 == 0)
1375                         rand = arc4random();
1376                 packet_put_char(rand & 0xff);
1377                 rand >>= 8;
1378         }
1379 }
This page took 0.142494 seconds and 5 git commands to generate.