Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 1 | /* |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 2 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 3 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 4 | * All rights reserved |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 5 | * Interface to packet compression for ssh. |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 6 | * |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 7 | * As far as I am concerned, the code I have written for this software |
| 8 | * can be used freely for any purpose. Any derived versions of this |
| 9 | * software must be clearly marked as such, and if the derived work is |
| 10 | * incompatible with the protocol description in the RFC file, it must be |
| 11 | * called by a name other than "ssh" or "Secure Shell". |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 12 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 13 | |
| 14 | #include "includes.h" |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 15 | |
Ben Lindstrom | 226cfa0 | 2001-01-22 05:34:40 +0000 | [diff] [blame] | 16 | #include "log.h" |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 17 | #include "buffer.h" |
| 18 | #include "zlib.h" |
Ben Lindstrom | 31ca54a | 2001-02-09 02:11:24 +0000 | [diff] [blame] | 19 | #include "compress.h" |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 20 | |
Ben Lindstrom | 0f345f5 | 2002-03-22 01:51:24 +0000 | [diff] [blame] | 21 | z_stream incoming_stream; |
| 22 | z_stream outgoing_stream; |
Ben Lindstrom | fb50cdf | 2001-04-05 23:20:46 +0000 | [diff] [blame] | 23 | static int compress_init_send_called = 0; |
| 24 | static int compress_init_recv_called = 0; |
Ben Lindstrom | ce398b2 | 2002-03-22 01:17:52 +0000 | [diff] [blame] | 25 | static int inflate_failed = 0; |
| 26 | static int deflate_failed = 0; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 27 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 28 | /* |
| 29 | * Initializes compression; level is compression level from 1 to 9 |
| 30 | * (as in gzip). |
| 31 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 32 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 33 | void |
Ben Lindstrom | fb50cdf | 2001-04-05 23:20:46 +0000 | [diff] [blame] | 34 | buffer_compress_init_send(int level) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 35 | { |
Ben Lindstrom | fb50cdf | 2001-04-05 23:20:46 +0000 | [diff] [blame] | 36 | if (compress_init_send_called == 1) |
Ben Lindstrom | 96f8d14 | 2001-10-03 17:07:47 +0000 | [diff] [blame] | 37 | deflateEnd(&outgoing_stream); |
Ben Lindstrom | fb50cdf | 2001-04-05 23:20:46 +0000 | [diff] [blame] | 38 | compress_init_send_called = 1; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 39 | debug("Enabling compression at level %d.", level); |
| 40 | if (level < 1 || level > 9) |
| 41 | fatal("Bad compression level %d.", level); |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 42 | deflateInit(&outgoing_stream, level); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 43 | } |
Ben Lindstrom | fb50cdf | 2001-04-05 23:20:46 +0000 | [diff] [blame] | 44 | void |
| 45 | buffer_compress_init_recv(void) |
| 46 | { |
| 47 | if (compress_init_recv_called == 1) |
| 48 | inflateEnd(&incoming_stream); |
| 49 | compress_init_recv_called = 1; |
| 50 | inflateInit(&incoming_stream); |
| 51 | } |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 52 | |
| 53 | /* Frees any data structures allocated for compression. */ |
| 54 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 55 | void |
Kevin Steves | e765240 | 2000-12-28 22:16:00 +0000 | [diff] [blame] | 56 | buffer_compress_uninit(void) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 57 | { |
Damien Miller | 8f341f8 | 2004-01-21 11:00:46 +1100 | [diff] [blame] | 58 | debug("compress outgoing: raw data %llu, compressed %llu, factor %.2f", |
Damien Miller | f84fed6 | 2004-01-21 11:01:23 +1100 | [diff] [blame] | 59 | (unsigned long long)outgoing_stream.total_in, |
| 60 | (unsigned long long)outgoing_stream.total_out, |
Damien Miller | 9f0f5c6 | 2001-12-21 14:45:46 +1100 | [diff] [blame] | 61 | outgoing_stream.total_in == 0 ? 0.0 : |
| 62 | (double) outgoing_stream.total_out / outgoing_stream.total_in); |
Damien Miller | 8f341f8 | 2004-01-21 11:00:46 +1100 | [diff] [blame] | 63 | debug("compress incoming: raw data %llu, compressed %llu, factor %.2f", |
Damien Miller | f84fed6 | 2004-01-21 11:01:23 +1100 | [diff] [blame] | 64 | (unsigned long long)incoming_stream.total_out, |
| 65 | (unsigned long long)incoming_stream.total_in, |
Damien Miller | 9f0f5c6 | 2001-12-21 14:45:46 +1100 | [diff] [blame] | 66 | incoming_stream.total_out == 0 ? 0.0 : |
| 67 | (double) incoming_stream.total_in / incoming_stream.total_out); |
Ben Lindstrom | ce398b2 | 2002-03-22 01:17:52 +0000 | [diff] [blame] | 68 | if (compress_init_recv_called == 1 && inflate_failed == 0) |
Ben Lindstrom | fb50cdf | 2001-04-05 23:20:46 +0000 | [diff] [blame] | 69 | inflateEnd(&incoming_stream); |
Ben Lindstrom | ce398b2 | 2002-03-22 01:17:52 +0000 | [diff] [blame] | 70 | if (compress_init_send_called == 1 && deflate_failed == 0) |
Ben Lindstrom | fb50cdf | 2001-04-05 23:20:46 +0000 | [diff] [blame] | 71 | deflateEnd(&outgoing_stream); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 72 | } |
| 73 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 74 | /* |
| 75 | * Compresses the contents of input_buffer into output_buffer. All packets |
| 76 | * compressed using this function will form a single compressed data stream; |
| 77 | * however, data will be flushed at the end of every call so that each |
| 78 | * output_buffer can be decompressed independently (but in the appropriate |
| 79 | * order since they together form a single compression stream) by the |
| 80 | * receiver. This appends the compressed data to the output buffer. |
| 81 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 82 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 83 | void |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 84 | buffer_compress(Buffer * input_buffer, Buffer * output_buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 85 | { |
Damien Miller | 708d21c | 2002-01-22 23:18:15 +1100 | [diff] [blame] | 86 | u_char buf[4096]; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 87 | int status; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 88 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 89 | /* This case is not handled below. */ |
| 90 | if (buffer_len(input_buffer) == 0) |
| 91 | return; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 92 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 93 | /* Input is the contents of the input buffer. */ |
Damien Miller | 708d21c | 2002-01-22 23:18:15 +1100 | [diff] [blame] | 94 | outgoing_stream.next_in = buffer_ptr(input_buffer); |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 95 | outgoing_stream.avail_in = buffer_len(input_buffer); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 96 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 97 | /* Loop compressing until deflate() returns with avail_out != 0. */ |
| 98 | do { |
| 99 | /* Set up fixed-size output buffer. */ |
Damien Miller | 708d21c | 2002-01-22 23:18:15 +1100 | [diff] [blame] | 100 | outgoing_stream.next_out = buf; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 101 | outgoing_stream.avail_out = sizeof(buf); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 102 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 103 | /* Compress as much data into the buffer as possible. */ |
| 104 | status = deflate(&outgoing_stream, Z_PARTIAL_FLUSH); |
| 105 | switch (status) { |
| 106 | case Z_OK: |
| 107 | /* Append compressed data to output_buffer. */ |
| 108 | buffer_append(output_buffer, buf, |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 109 | sizeof(buf) - outgoing_stream.avail_out); |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 110 | break; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 111 | default: |
Ben Lindstrom | ce398b2 | 2002-03-22 01:17:52 +0000 | [diff] [blame] | 112 | deflate_failed = 1; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 113 | fatal("buffer_compress: deflate returned %d", status); |
| 114 | /* NOTREACHED */ |
| 115 | } |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 116 | } while (outgoing_stream.avail_out == 0); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 117 | } |
| 118 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 119 | /* |
| 120 | * Uncompresses the contents of input_buffer into output_buffer. All packets |
| 121 | * uncompressed using this function will form a single compressed data |
| 122 | * stream; however, data will be flushed at the end of every call so that |
| 123 | * each output_buffer. This must be called for the same size units that the |
| 124 | * buffer_compress was called, and in the same order that buffers compressed |
| 125 | * with that. This appends the uncompressed data to the output buffer. |
| 126 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 127 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 128 | void |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 129 | buffer_uncompress(Buffer * input_buffer, Buffer * output_buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 130 | { |
Damien Miller | 708d21c | 2002-01-22 23:18:15 +1100 | [diff] [blame] | 131 | u_char buf[4096]; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 132 | int status; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 133 | |
Damien Miller | 708d21c | 2002-01-22 23:18:15 +1100 | [diff] [blame] | 134 | incoming_stream.next_in = buffer_ptr(input_buffer); |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 135 | incoming_stream.avail_in = buffer_len(input_buffer); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 136 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 137 | for (;;) { |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 138 | /* Set up fixed-size output buffer. */ |
Damien Miller | 708d21c | 2002-01-22 23:18:15 +1100 | [diff] [blame] | 139 | incoming_stream.next_out = buf; |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 140 | incoming_stream.avail_out = sizeof(buf); |
| 141 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 142 | status = inflate(&incoming_stream, Z_PARTIAL_FLUSH); |
| 143 | switch (status) { |
| 144 | case Z_OK: |
| 145 | buffer_append(output_buffer, buf, |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 146 | sizeof(buf) - incoming_stream.avail_out); |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 147 | break; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 148 | case Z_BUF_ERROR: |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 149 | /* |
| 150 | * Comments in zlib.h say that we should keep calling |
| 151 | * inflate() until we get an error. This appears to |
| 152 | * be the error that we get. |
| 153 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 154 | return; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 155 | default: |
Ben Lindstrom | ce398b2 | 2002-03-22 01:17:52 +0000 | [diff] [blame] | 156 | inflate_failed = 1; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 157 | fatal("buffer_uncompress: inflate returned %d", status); |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 158 | /* NOTREACHED */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 159 | } |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 160 | } |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 161 | } |