Damien Miller | e3476ed | 2006-07-24 14:13:33 +1000 | [diff] [blame] | 1 | /* $OpenBSD: bufaux.c,v 1.43 2006/07/22 20:48:22 stevesk Exp $ */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 2 | /* |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 3 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 4 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 5 | * All rights reserved |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 6 | * Auxiliary functions for storing and retrieving various data types to/from |
| 7 | * Buffers. |
| 8 | * |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 9 | * As far as I am concerned, the code I have written for this software |
| 10 | * can be used freely for any purpose. Any derived versions of this |
| 11 | * software must be clearly marked as such, and if the derived work is |
| 12 | * incompatible with the protocol description in the RFC file, it must be |
| 13 | * called by a name other than "ssh" or "Secure Shell". |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 14 | * |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 15 | * |
| 16 | * SSH2 packet format added by Markus Friedl |
| 17 | * Copyright (c) 2000 Markus Friedl. All rights reserved. |
| 18 | * |
| 19 | * Redistribution and use in source and binary forms, with or without |
| 20 | * modification, are permitted provided that the following conditions |
| 21 | * are met: |
| 22 | * 1. Redistributions of source code must retain the above copyright |
| 23 | * notice, this list of conditions and the following disclaimer. |
| 24 | * 2. Redistributions in binary form must reproduce the above copyright |
| 25 | * notice, this list of conditions and the following disclaimer in the |
| 26 | * documentation and/or other materials provided with the distribution. |
| 27 | * |
| 28 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
| 29 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| 30 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| 31 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
| 32 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
| 33 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 34 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 35 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 36 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
| 37 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 38 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 39 | |
| 40 | #include "includes.h" |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 41 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 42 | #include <openssl/bn.h> |
Damien Miller | e3476ed | 2006-07-24 14:13:33 +1000 | [diff] [blame] | 43 | |
| 44 | #include <string.h> |
| 45 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 46 | #include "bufaux.h" |
| 47 | #include "xmalloc.h" |
Ben Lindstrom | 226cfa0 | 2001-01-22 05:34:40 +0000 | [diff] [blame] | 48 | #include "log.h" |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 49 | #include "misc.h" |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 50 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 51 | /* |
Damien Miller | 3b23566 | 2002-04-23 20:42:36 +1000 | [diff] [blame] | 52 | * Returns integers from the buffer (msb first). |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 53 | */ |
Damien Miller | 3b23566 | 2002-04-23 20:42:36 +1000 | [diff] [blame] | 54 | |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 55 | int |
| 56 | buffer_get_short_ret(u_short *ret, Buffer *buffer) |
Damien Miller | 3b23566 | 2002-04-23 20:42:36 +1000 | [diff] [blame] | 57 | { |
| 58 | u_char buf[2]; |
Ben Lindstrom | e135363 | 2002-06-23 21:29:23 +0000 | [diff] [blame] | 59 | |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 60 | if (buffer_get_ret(buffer, (char *) buf, 2) == -1) |
| 61 | return (-1); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 62 | *ret = get_u16(buf); |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 63 | return (0); |
| 64 | } |
| 65 | |
| 66 | u_short |
| 67 | buffer_get_short(Buffer *buffer) |
| 68 | { |
| 69 | u_short ret; |
| 70 | |
| 71 | if (buffer_get_short_ret(&ret, buffer) == -1) |
| 72 | fatal("buffer_get_short: buffer error"); |
| 73 | |
| 74 | return (ret); |
| 75 | } |
| 76 | |
| 77 | int |
| 78 | buffer_get_int_ret(u_int *ret, Buffer *buffer) |
| 79 | { |
| 80 | u_char buf[4]; |
| 81 | |
| 82 | if (buffer_get_ret(buffer, (char *) buf, 4) == -1) |
| 83 | return (-1); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 84 | *ret = get_u32(buf); |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 85 | return (0); |
Damien Miller | 3b23566 | 2002-04-23 20:42:36 +1000 | [diff] [blame] | 86 | } |
| 87 | |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 88 | u_int |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 89 | buffer_get_int(Buffer *buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 90 | { |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 91 | u_int ret; |
Ben Lindstrom | e135363 | 2002-06-23 21:29:23 +0000 | [diff] [blame] | 92 | |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 93 | if (buffer_get_int_ret(&ret, buffer) == -1) |
| 94 | fatal("buffer_get_int: buffer error"); |
| 95 | |
| 96 | return (ret); |
| 97 | } |
| 98 | |
| 99 | int |
| 100 | buffer_get_int64_ret(u_int64_t *ret, Buffer *buffer) |
| 101 | { |
| 102 | u_char buf[8]; |
| 103 | |
| 104 | if (buffer_get_ret(buffer, (char *) buf, 8) == -1) |
| 105 | return (-1); |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 106 | *ret = get_u64(buf); |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 107 | return (0); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 108 | } |
| 109 | |
Ben Lindstrom | 2f959b4 | 2001-01-11 06:20:23 +0000 | [diff] [blame] | 110 | u_int64_t |
| 111 | buffer_get_int64(Buffer *buffer) |
| 112 | { |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 113 | u_int64_t ret; |
Ben Lindstrom | e135363 | 2002-06-23 21:29:23 +0000 | [diff] [blame] | 114 | |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 115 | if (buffer_get_int64_ret(&ret, buffer) == -1) |
| 116 | fatal("buffer_get_int: buffer error"); |
| 117 | |
| 118 | return (ret); |
Ben Lindstrom | 2f959b4 | 2001-01-11 06:20:23 +0000 | [diff] [blame] | 119 | } |
| 120 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 121 | /* |
Damien Miller | 3b23566 | 2002-04-23 20:42:36 +1000 | [diff] [blame] | 122 | * Stores integers in the buffer, msb first. |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 123 | */ |
Damien Miller | 5f05637 | 2000-04-16 12:31:48 +1000 | [diff] [blame] | 124 | void |
Damien Miller | 3b23566 | 2002-04-23 20:42:36 +1000 | [diff] [blame] | 125 | buffer_put_short(Buffer *buffer, u_short value) |
| 126 | { |
| 127 | char buf[2]; |
Ben Lindstrom | e135363 | 2002-06-23 21:29:23 +0000 | [diff] [blame] | 128 | |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 129 | put_u16(buf, value); |
Damien Miller | 3b23566 | 2002-04-23 20:42:36 +1000 | [diff] [blame] | 130 | buffer_append(buffer, buf, 2); |
| 131 | } |
| 132 | |
| 133 | void |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 134 | buffer_put_int(Buffer *buffer, u_int value) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 135 | { |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 136 | char buf[4]; |
Ben Lindstrom | e135363 | 2002-06-23 21:29:23 +0000 | [diff] [blame] | 137 | |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 138 | put_u32(buf, value); |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 139 | buffer_append(buffer, buf, 4); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 140 | } |
| 141 | |
Ben Lindstrom | 2f959b4 | 2001-01-11 06:20:23 +0000 | [diff] [blame] | 142 | void |
| 143 | buffer_put_int64(Buffer *buffer, u_int64_t value) |
| 144 | { |
| 145 | char buf[8]; |
Ben Lindstrom | e135363 | 2002-06-23 21:29:23 +0000 | [diff] [blame] | 146 | |
Damien Miller | 3f94188 | 2006-03-31 23:13:02 +1100 | [diff] [blame] | 147 | put_u64(buf, value); |
Ben Lindstrom | 2f959b4 | 2001-01-11 06:20:23 +0000 | [diff] [blame] | 148 | buffer_append(buffer, buf, 8); |
| 149 | } |
| 150 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 151 | /* |
| 152 | * Returns an arbitrary binary string from the buffer. The string cannot |
| 153 | * be longer than 256k. The returned value points to memory allocated |
| 154 | * with xmalloc; it is the responsibility of the calling function to free |
| 155 | * the data. If length_ptr is non-NULL, the length of the returned data |
| 156 | * will be stored there. A null character will be automatically appended |
| 157 | * to the returned string, and is not counted in length. |
| 158 | */ |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 159 | void * |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 160 | buffer_get_string_ret(Buffer *buffer, u_int *length_ptr) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 161 | { |
Damien Miller | 5a6b4fe | 2001-12-21 14:56:54 +1100 | [diff] [blame] | 162 | u_char *value; |
Ben Lindstrom | e135363 | 2002-06-23 21:29:23 +0000 | [diff] [blame] | 163 | u_int len; |
| 164 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 165 | /* Get the length. */ |
| 166 | len = buffer_get_int(buffer); |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 167 | if (len > 256 * 1024) { |
| 168 | error("buffer_get_string_ret: bad string length %u", len); |
| 169 | return (NULL); |
| 170 | } |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 171 | /* Allocate space for the string. Add one byte for a null character. */ |
| 172 | value = xmalloc(len + 1); |
| 173 | /* Get the string. */ |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 174 | if (buffer_get_ret(buffer, value, len) == -1) { |
| 175 | error("buffer_get_string_ret: buffer_get failed"); |
| 176 | xfree(value); |
| 177 | return (NULL); |
| 178 | } |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 179 | /* Append a null character to make processing easier. */ |
| 180 | value[len] = 0; |
| 181 | /* Optionally return the length of the string. */ |
| 182 | if (length_ptr) |
| 183 | *length_ptr = len; |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 184 | return (value); |
| 185 | } |
| 186 | |
| 187 | void * |
| 188 | buffer_get_string(Buffer *buffer, u_int *length_ptr) |
| 189 | { |
| 190 | void *ret; |
| 191 | |
| 192 | if ((ret = buffer_get_string_ret(buffer, length_ptr)) == NULL) |
| 193 | fatal("buffer_get_string: buffer error"); |
| 194 | return (ret); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 195 | } |
| 196 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 197 | /* |
| 198 | * Stores and arbitrary binary string in the buffer. |
| 199 | */ |
Damien Miller | 5f05637 | 2000-04-16 12:31:48 +1000 | [diff] [blame] | 200 | void |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 201 | buffer_put_string(Buffer *buffer, const void *buf, u_int len) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 202 | { |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 203 | buffer_put_int(buffer, len); |
| 204 | buffer_append(buffer, buf, len); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 205 | } |
Damien Miller | 5f05637 | 2000-04-16 12:31:48 +1000 | [diff] [blame] | 206 | void |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 207 | buffer_put_cstring(Buffer *buffer, const char *s) |
| 208 | { |
Ben Lindstrom | 88aa1b4 | 2002-03-22 01:47:52 +0000 | [diff] [blame] | 209 | if (s == NULL) |
| 210 | fatal("buffer_put_cstring: s == NULL"); |
Damien Miller | b38eff8 | 2000-04-01 11:09:21 +1000 | [diff] [blame] | 211 | buffer_put_string(buffer, s, strlen(s)); |
| 212 | } |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 213 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 214 | /* |
| 215 | * Returns a character from the buffer (0 - 255). |
| 216 | */ |
Damien Miller | 5f05637 | 2000-04-16 12:31:48 +1000 | [diff] [blame] | 217 | int |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 218 | buffer_get_char_ret(char *ret, Buffer *buffer) |
| 219 | { |
| 220 | if (buffer_get_ret(buffer, ret, 1) == -1) { |
| 221 | error("buffer_get_char_ret: buffer_get_ret failed"); |
| 222 | return (-1); |
| 223 | } |
| 224 | return (0); |
| 225 | } |
| 226 | |
| 227 | int |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 228 | buffer_get_char(Buffer *buffer) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 229 | { |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 230 | char ch; |
Ben Lindstrom | e135363 | 2002-06-23 21:29:23 +0000 | [diff] [blame] | 231 | |
Darren Tucker | 50dbe83 | 2004-11-05 20:41:24 +1100 | [diff] [blame] | 232 | if (buffer_get_char_ret(&ch, buffer) == -1) |
| 233 | fatal("buffer_get_char: buffer error"); |
Ben Lindstrom | 46c1622 | 2000-12-22 01:43:59 +0000 | [diff] [blame] | 234 | return (u_char) ch; |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 235 | } |
| 236 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 237 | /* |
| 238 | * Stores a character in the buffer. |
| 239 | */ |
Damien Miller | 5f05637 | 2000-04-16 12:31:48 +1000 | [diff] [blame] | 240 | void |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 241 | buffer_put_char(Buffer *buffer, int value) |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 242 | { |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 243 | char ch = value; |
Ben Lindstrom | e135363 | 2002-06-23 21:29:23 +0000 | [diff] [blame] | 244 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 245 | buffer_append(buffer, &ch, 1); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 246 | } |