1 /* $OpenBSD: bufaux.c,v 1.57 2014/04/16 23:22:45 djm Exp $ */
3 * Author: Tatu Ylonen <ylo@cs.hut.fi>
4 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * Auxiliary functions for storing and retrieving various data types to/from
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".
16 * SSH2 packet format added by Markus Friedl
17 * Copyright (c) 2000 Markus Friedl. All rights reserved.
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
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.
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.
42 #include <sys/types.h>
44 #include <openssl/bn.h>
56 * Returns integers from the buffer (msb first).
60 buffer_get_short_ret(u_short *ret, Buffer *buffer)
64 if (buffer_get_ret(buffer, (char *) buf, 2) == -1)
71 buffer_get_short(Buffer *buffer)
75 if (buffer_get_short_ret(&ret, buffer) == -1)
76 fatal("buffer_get_short: buffer error");
82 buffer_get_int_ret(u_int *ret, Buffer *buffer)
86 if (buffer_get_ret(buffer, (char *) buf, 4) == -1)
94 buffer_get_int(Buffer *buffer)
98 if (buffer_get_int_ret(&ret, buffer) == -1)
99 fatal("buffer_get_int: buffer error");
105 buffer_get_int64_ret(u_int64_t *ret, Buffer *buffer)
109 if (buffer_get_ret(buffer, (char *) buf, 8) == -1)
117 buffer_get_int64(Buffer *buffer)
121 if (buffer_get_int64_ret(&ret, buffer) == -1)
122 fatal("buffer_get_int: buffer error");
128 * Stores integers in the buffer, msb first.
131 buffer_put_short(Buffer *buffer, u_short value)
136 buffer_append(buffer, buf, 2);
140 buffer_put_int(Buffer *buffer, u_int value)
145 buffer_append(buffer, buf, 4);
149 buffer_put_int64(Buffer *buffer, u_int64_t value)
154 buffer_append(buffer, buf, 8);
158 * Returns an arbitrary binary string from the buffer. The string cannot
159 * be longer than 256k. The returned value points to memory allocated
160 * with xmalloc; it is the responsibility of the calling function to free
161 * the data. If length_ptr is non-NULL, the length of the returned data
162 * will be stored there. A null character will be automatically appended
163 * to the returned string, and is not counted in length.
166 buffer_get_string_ret(Buffer *buffer, u_int *length_ptr)
171 /* Get the length. */
172 if (buffer_get_int_ret(&len, buffer) != 0) {
173 error("buffer_get_string_ret: cannot extract length");
176 if (len > 256 * 1024) {
177 error("buffer_get_string_ret: bad string length %u", len);
180 /* Allocate space for the string. Add one byte for a null character. */
181 value = xmalloc(len + 1);
182 /* Get the string. */
183 if (buffer_get_ret(buffer, value, len) == -1) {
184 error("buffer_get_string_ret: buffer_get failed");
188 /* Append a null character to make processing easier. */
190 /* Optionally return the length of the string. */
197 buffer_get_string(Buffer *buffer, u_int *length_ptr)
201 if ((ret = buffer_get_string_ret(buffer, length_ptr)) == NULL)
202 fatal("buffer_get_string: buffer error");
207 buffer_get_cstring_ret(Buffer *buffer, u_int *length_ptr)
210 char *cp, *ret = buffer_get_string_ret(buffer, &length);
214 if ((cp = memchr(ret, '\0', length)) != NULL) {
215 /* XXX allow \0 at end-of-string for a while, remove later */
216 if (cp == ret + length - 1)
217 error("buffer_get_cstring_ret: string contains \\0");
219 explicit_bzero(ret, length);
224 if (length_ptr != NULL)
225 *length_ptr = length;
230 buffer_get_cstring(Buffer *buffer, u_int *length_ptr)
234 if ((ret = buffer_get_cstring_ret(buffer, length_ptr)) == NULL)
235 fatal("buffer_get_cstring: buffer error");
240 buffer_get_string_ptr_ret(Buffer *buffer, u_int *length_ptr)
245 if (buffer_get_int_ret(&len, buffer) != 0)
247 if (len > 256 * 1024) {
248 error("buffer_get_string_ptr: bad string length %u", len);
251 ptr = buffer_ptr(buffer);
252 buffer_consume(buffer, len);
259 buffer_get_string_ptr(Buffer *buffer, u_int *length_ptr)
263 if ((ret = buffer_get_string_ptr_ret(buffer, length_ptr)) == NULL)
264 fatal("buffer_get_string_ptr: buffer error");
269 * Stores and arbitrary binary string in the buffer.
272 buffer_put_string(Buffer *buffer, const void *buf, u_int len)
274 buffer_put_int(buffer, len);
275 buffer_append(buffer, buf, len);
278 buffer_put_cstring(Buffer *buffer, const char *s)
281 fatal("buffer_put_cstring: s == NULL");
282 buffer_put_string(buffer, s, strlen(s));
286 * Returns a character from the buffer (0 - 255).
289 buffer_get_char_ret(u_char *ret, Buffer *buffer)
291 if (buffer_get_ret(buffer, ret, 1) == -1) {
292 error("buffer_get_char_ret: buffer_get_ret failed");
299 buffer_get_char(Buffer *buffer)
303 if (buffer_get_char_ret(&ch, buffer) == -1)
304 fatal("buffer_get_char: buffer error");
309 * Stores a character in the buffer.
312 buffer_put_char(Buffer *buffer, int value)
316 buffer_append(buffer, &ch, 1);
319 /* Pseudo bignum functions */
322 buffer_get_bignum2_as_string_ret(Buffer *buffer, u_int *length_ptr)
325 u_char *bin, *p, *ret;
327 if ((p = bin = buffer_get_string_ret(buffer, &len)) == NULL) {
328 error("%s: invalid bignum", __func__);
332 if (len > 0 && (bin[0] & 0x80)) {
333 error("%s: negative numbers not supported", __func__);
337 if (len > 8 * 1024) {
338 error("%s: cannot handle BN of size %d", __func__, len);
342 /* Skip zero prefix on numbers with the MSB set */
343 if (len > 1 && bin[0] == 0x00 && (bin[1] & 0x80) != 0) {
349 explicit_bzero(p, len);
355 buffer_get_bignum2_as_string(Buffer *buffer, u_int *l)
357 void *ret = buffer_get_bignum2_as_string_ret(buffer, l);
360 fatal("%s: buffer error", __func__);
365 * Stores a string using the bignum encoding rules (\0 pad if MSB set).
368 buffer_put_bignum2_from_string(Buffer *buffer, const u_char *s, u_int l)
374 fatal("%s: length %u too long", __func__, l);
375 /* Skip leading zero bytes */
376 for (; l > 0 && *s == 0; l--, s++)
378 p = buf = xmalloc(l + 1);
380 * If most significant bit is set then prepend a zero byte to
381 * avoid interpretation as a negative number.
383 if (l > 0 && (s[0] & 0x80) != 0) {
388 buffer_put_string(buffer, buf, l + pad);
389 explicit_bzero(buf, l + pad);