version 1.32.4.3, 2005/09/02 03:44:59 |
version 1.60, 2014/04/30 05:29:56 |
|
|
|
/* $OpenBSD$ */ |
/* |
/* |
* Author: Tatu Ylonen <ylo@cs.hut.fi> |
* Copyright (c) 2012 Damien Miller <djm@mindrot.org> |
* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
|
* All rights reserved |
|
* Auxiliary functions for storing and retrieving various data types to/from |
|
* Buffers. |
|
* |
* |
* As far as I am concerned, the code I have written for this software |
* Permission to use, copy, modify, and distribute this software for any |
* can be used freely for any purpose. Any derived versions of this |
* purpose with or without fee is hereby granted, provided that the above |
* software must be clearly marked as such, and if the derived work is |
* copyright notice and this permission notice appear in all copies. |
* incompatible with the protocol description in the RFC file, it must be |
|
* called by a name other than "ssh" or "Secure Shell". |
|
* |
* |
* |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
* SSH2 packet format added by Markus Friedl |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* Copyright (c) 2000 Markus Friedl. All rights reserved. |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
* |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* Redistribution and use in source and binary forms, with or without |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* modification, are permitted provided that the following conditions |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* are met: |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* 1. Redistributions of source code must retain the above copyright |
|
* notice, this list of conditions and the following disclaimer. |
|
* 2. Redistributions in binary form must reproduce the above copyright |
|
* notice, this list of conditions and the following disclaimer in the |
|
* documentation and/or other materials provided with the distribution. |
|
* |
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
|
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
|
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
*/ |
*/ |
|
|
#include "includes.h" |
/* Emulation wrappers for legacy OpenSSH buffer API atop sshbuf */ |
RCSID("$OpenBSD$"); |
|
|
|
#include <openssl/bn.h> |
#include <sys/types.h> |
#include "bufaux.h" |
|
#include "xmalloc.h" |
#include "buffer.h" |
#include "getput.h" |
|
#include "log.h" |
#include "log.h" |
|
#include "ssherr.h" |
|
|
/* |
|
* Stores an BIGNUM in the buffer with a 2-byte msb first bit count, followed |
|
* by (bits+7)/8 bytes of binary data, msb first. |
|
*/ |
|
int |
int |
buffer_put_bignum_ret(Buffer *buffer, const BIGNUM *value) |
buffer_get_short_ret(u_short *v, Buffer *buffer) |
{ |
{ |
int bits = BN_num_bits(value); |
int ret; |
int bin_size = (bits + 7) / 8; |
|
u_char *buf = xmalloc(bin_size); |
|
int oi; |
|
char msg[2]; |
|
|
|
/* Get the value of in binary */ |
if ((ret = sshbuf_get_u16(buffer, v)) != 0) { |
oi = BN_bn2bin(value, buf); |
error("%s: %s", __func__, ssh_err(ret)); |
if (oi != bin_size) { |
return -1; |
error("buffer_put_bignum_ret: BN_bn2bin() failed: oi %d != bin_size %d", |
|
oi, bin_size); |
|
return (-1); |
|
} |
} |
|
return 0; |
/* Store the number of bits in the buffer in two bytes, msb first. */ |
|
PUT_16BIT(msg, bits); |
|
buffer_append(buffer, msg, 2); |
|
/* Store the binary data. */ |
|
buffer_append(buffer, (char *)buf, oi); |
|
|
|
memset(buf, 0, bin_size); |
|
xfree(buf); |
|
|
|
return (0); |
|
} |
} |
|
|
void |
|
buffer_put_bignum(Buffer *buffer, const BIGNUM *value) |
|
{ |
|
if (buffer_put_bignum_ret(buffer, value) == -1) |
|
fatal("buffer_put_bignum: buffer error"); |
|
} |
|
|
|
/* |
|
* Retrieves an BIGNUM from the buffer. |
|
*/ |
|
int |
|
buffer_get_bignum_ret(Buffer *buffer, BIGNUM *value) |
|
{ |
|
u_int bits, bytes; |
|
u_char buf[2], *bin; |
|
|
|
/* Get the number for bits. */ |
|
if (buffer_get_ret(buffer, (char *) buf, 2) == -1) { |
|
error("buffer_get_bignum_ret: invalid length"); |
|
return (-1); |
|
} |
|
bits = GET_16BIT(buf); |
|
/* Compute the number of binary bytes that follow. */ |
|
bytes = (bits + 7) / 8; |
|
if (bytes > 8 * 1024) { |
|
error("buffer_get_bignum_ret: cannot handle BN of size %d", bytes); |
|
return (-1); |
|
} |
|
if (buffer_len(buffer) < bytes) { |
|
error("buffer_get_bignum_ret: input buffer too small"); |
|
return (-1); |
|
} |
|
bin = buffer_ptr(buffer); |
|
BN_bin2bn(bin, bytes, value); |
|
if (buffer_consume_ret(buffer, bytes) == -1) { |
|
error("buffer_get_bignum_ret: buffer_consume failed"); |
|
return (-1); |
|
} |
|
return (0); |
|
} |
|
|
|
void |
|
buffer_get_bignum(Buffer *buffer, BIGNUM *value) |
|
{ |
|
if (buffer_get_bignum_ret(buffer, value) == -1) |
|
fatal("buffer_get_bignum: buffer error"); |
|
} |
|
|
|
/* |
|
* Stores an BIGNUM in the buffer in SSH2 format. |
|
*/ |
|
int |
|
buffer_put_bignum2_ret(Buffer *buffer, const BIGNUM *value) |
|
{ |
|
u_int bytes; |
|
u_char *buf; |
|
int oi; |
|
u_int hasnohigh = 0; |
|
|
|
if (BN_is_zero(value)) { |
|
buffer_put_int(buffer, 0); |
|
return 0; |
|
} |
|
if (value->neg) { |
|
error("buffer_put_bignum2_ret: negative numbers not supported"); |
|
return (-1); |
|
} |
|
bytes = BN_num_bytes(value) + 1; /* extra padding byte */ |
|
if (bytes < 2) { |
|
error("buffer_put_bignum2_ret: BN too small"); |
|
return (-1); |
|
} |
|
buf = xmalloc(bytes); |
|
buf[0] = 0x00; |
|
/* Get the value of in binary */ |
|
oi = BN_bn2bin(value, buf+1); |
|
if (oi < 0 || (u_int)oi != bytes - 1) { |
|
error("buffer_put_bignum2_ret: BN_bn2bin() failed: " |
|
"oi %d != bin_size %d", oi, bytes); |
|
xfree(buf); |
|
return (-1); |
|
} |
|
hasnohigh = (buf[1] & 0x80) ? 0 : 1; |
|
buffer_put_string(buffer, buf+hasnohigh, bytes-hasnohigh); |
|
memset(buf, 0, bytes); |
|
xfree(buf); |
|
return (0); |
|
} |
|
|
|
void |
|
buffer_put_bignum2(Buffer *buffer, const BIGNUM *value) |
|
{ |
|
if (buffer_put_bignum2_ret(buffer, value) == -1) |
|
fatal("buffer_put_bignum2: buffer error"); |
|
} |
|
|
|
int |
|
buffer_get_bignum2_ret(Buffer *buffer, BIGNUM *value) |
|
{ |
|
u_int len; |
|
u_char *bin; |
|
|
|
if ((bin = buffer_get_string_ret(buffer, &len)) == NULL) { |
|
error("buffer_get_bignum2_ret: invalid bignum"); |
|
return (-1); |
|
} |
|
|
|
if (len > 0 && (bin[0] & 0x80)) { |
|
error("buffer_get_bignum2_ret: negative numbers not supported"); |
|
return (-1); |
|
} |
|
if (len > 8 * 1024) { |
|
error("buffer_get_bignum2_ret: cannot handle BN of size %d", len); |
|
return (-1); |
|
} |
|
BN_bin2bn(bin, len, value); |
|
xfree(bin); |
|
return (0); |
|
} |
|
|
|
void |
|
buffer_get_bignum2(Buffer *buffer, BIGNUM *value) |
|
{ |
|
if (buffer_get_bignum2_ret(buffer, value) == -1) |
|
fatal("buffer_get_bignum2: buffer error"); |
|
} |
|
|
|
/* |
|
* Returns integers from the buffer (msb first). |
|
*/ |
|
|
|
int |
|
buffer_get_short_ret(u_short *ret, Buffer *buffer) |
|
{ |
|
u_char buf[2]; |
|
|
|
if (buffer_get_ret(buffer, (char *) buf, 2) == -1) |
|
return (-1); |
|
*ret = GET_16BIT(buf); |
|
return (0); |
|
} |
|
|
|
u_short |
u_short |
buffer_get_short(Buffer *buffer) |
buffer_get_short(Buffer *buffer) |
{ |
{ |
u_short ret; |
u_short ret; |
|
|
if (buffer_get_short_ret(&ret, buffer) == -1) |
if (buffer_get_short_ret(&ret, buffer) == -1) |
fatal("buffer_get_short: buffer error"); |
fatal("%s: buffer error", __func__); |
|
|
return (ret); |
return (ret); |
} |
} |
|
|
int |
int |
buffer_get_int_ret(u_int *ret, Buffer *buffer) |
buffer_get_int_ret(u_int *v, Buffer *buffer) |
{ |
{ |
u_char buf[4]; |
int ret; |
|
|
if (buffer_get_ret(buffer, (char *) buf, 4) == -1) |
if ((ret = sshbuf_get_u32(buffer, v)) != 0) { |
return (-1); |
error("%s: %s", __func__, ssh_err(ret)); |
*ret = GET_32BIT(buf); |
return -1; |
return (0); |
} |
|
return 0; |
} |
} |
|
|
u_int |
u_int |
|
|
u_int ret; |
u_int ret; |
|
|
if (buffer_get_int_ret(&ret, buffer) == -1) |
if (buffer_get_int_ret(&ret, buffer) == -1) |
fatal("buffer_get_int: buffer error"); |
fatal("%s: buffer error", __func__); |
|
|
return (ret); |
return (ret); |
} |
} |
|
|
int |
int |
buffer_get_int64_ret(u_int64_t *ret, Buffer *buffer) |
buffer_get_int64_ret(u_int64_t *v, Buffer *buffer) |
{ |
{ |
u_char buf[8]; |
int ret; |
|
|
if (buffer_get_ret(buffer, (char *) buf, 8) == -1) |
if ((ret = sshbuf_get_u64(buffer, v)) != 0) { |
return (-1); |
error("%s: %s", __func__, ssh_err(ret)); |
*ret = GET_64BIT(buf); |
return -1; |
return (0); |
} |
|
return 0; |
} |
} |
|
|
u_int64_t |
u_int64_t |
|
|
u_int64_t ret; |
u_int64_t ret; |
|
|
if (buffer_get_int64_ret(&ret, buffer) == -1) |
if (buffer_get_int64_ret(&ret, buffer) == -1) |
fatal("buffer_get_int: buffer error"); |
fatal("%s: buffer error", __func__); |
|
|
return (ret); |
return (ret); |
} |
} |
|
|
/* |
|
* Stores integers in the buffer, msb first. |
|
*/ |
|
void |
void |
buffer_put_short(Buffer *buffer, u_short value) |
buffer_put_short(Buffer *buffer, u_short value) |
{ |
{ |
char buf[2]; |
int ret; |
|
|
PUT_16BIT(buf, value); |
if ((ret = sshbuf_put_u16(buffer, value)) != 0) |
buffer_append(buffer, buf, 2); |
fatal("%s: %s", __func__, ssh_err(ret)); |
} |
} |
|
|
void |
void |
buffer_put_int(Buffer *buffer, u_int value) |
buffer_put_int(Buffer *buffer, u_int value) |
{ |
{ |
char buf[4]; |
int ret; |
|
|
PUT_32BIT(buf, value); |
if ((ret = sshbuf_put_u32(buffer, value)) != 0) |
buffer_append(buffer, buf, 4); |
fatal("%s: %s", __func__, ssh_err(ret)); |
} |
} |
|
|
void |
void |
buffer_put_int64(Buffer *buffer, u_int64_t value) |
buffer_put_int64(Buffer *buffer, u_int64_t value) |
{ |
{ |
char buf[8]; |
int ret; |
|
|
PUT_64BIT(buf, value); |
if ((ret = sshbuf_put_u64(buffer, value)) != 0) |
buffer_append(buffer, buf, 8); |
fatal("%s: %s", __func__, ssh_err(ret)); |
} |
} |
|
|
/* |
|
* Returns an arbitrary binary string from the buffer. The string cannot |
|
* be longer than 256k. The returned value points to memory allocated |
|
* with xmalloc; it is the responsibility of the calling function to free |
|
* the data. If length_ptr is non-NULL, the length of the returned data |
|
* will be stored there. A null character will be automatically appended |
|
* to the returned string, and is not counted in length. |
|
*/ |
|
void * |
void * |
buffer_get_string_ret(Buffer *buffer, u_int *length_ptr) |
buffer_get_string_ret(Buffer *buffer, u_int *length_ptr) |
{ |
{ |
|
size_t len; |
|
int ret; |
u_char *value; |
u_char *value; |
u_int len; |
|
|
|
/* Get the length. */ |
if ((ret = sshbuf_get_string(buffer, &value, &len)) != 0) { |
len = buffer_get_int(buffer); |
error("%s: %s", __func__, ssh_err(ret)); |
if (len > 256 * 1024) { |
return NULL; |
error("buffer_get_string_ret: bad string length %u", len); |
|
return (NULL); |
|
} |
} |
/* Allocate space for the string. Add one byte for a null character. */ |
if (length_ptr != NULL) |
value = xmalloc(len + 1); |
*length_ptr = len; /* Safe: sshbuf never stores len > 2^31 */ |
/* Get the string. */ |
return value; |
if (buffer_get_ret(buffer, value, len) == -1) { |
|
error("buffer_get_string_ret: buffer_get failed"); |
|
xfree(value); |
|
return (NULL); |
|
} |
|
/* Append a null character to make processing easier. */ |
|
value[len] = 0; |
|
/* Optionally return the length of the string. */ |
|
if (length_ptr) |
|
*length_ptr = len; |
|
return (value); |
|
} |
} |
|
|
void * |
void * |
|
|
void *ret; |
void *ret; |
|
|
if ((ret = buffer_get_string_ret(buffer, length_ptr)) == NULL) |
if ((ret = buffer_get_string_ret(buffer, length_ptr)) == NULL) |
fatal("buffer_get_string: buffer error"); |
fatal("%s: buffer error", __func__); |
return (ret); |
return (ret); |
} |
} |
|
|
/* |
char * |
* Stores and arbitrary binary string in the buffer. |
buffer_get_cstring_ret(Buffer *buffer, u_int *length_ptr) |
*/ |
{ |
|
size_t len; |
|
int ret; |
|
char *value; |
|
|
|
if ((ret = sshbuf_get_cstring(buffer, &value, &len)) != 0) { |
|
error("%s: %s", __func__, ssh_err(ret)); |
|
return NULL; |
|
} |
|
if (length_ptr != NULL) |
|
*length_ptr = len; /* Safe: sshbuf never stores len > 2^31 */ |
|
return value; |
|
} |
|
|
|
char * |
|
buffer_get_cstring(Buffer *buffer, u_int *length_ptr) |
|
{ |
|
char *ret; |
|
|
|
if ((ret = buffer_get_cstring_ret(buffer, length_ptr)) == NULL) |
|
fatal("%s: buffer error", __func__); |
|
return ret; |
|
} |
|
|
|
const void * |
|
buffer_get_string_ptr_ret(Buffer *buffer, u_int *length_ptr) |
|
{ |
|
size_t len; |
|
int ret; |
|
const u_char *value; |
|
|
|
if ((ret = sshbuf_get_string_direct(buffer, &value, &len)) != 0) { |
|
error("%s: %s", __func__, ssh_err(ret)); |
|
return NULL; |
|
} |
|
if (length_ptr != NULL) |
|
*length_ptr = len; /* Safe: sshbuf never stores len > 2^31 */ |
|
return value; |
|
} |
|
|
|
const void * |
|
buffer_get_string_ptr(Buffer *buffer, u_int *length_ptr) |
|
{ |
|
const void *ret; |
|
|
|
if ((ret = buffer_get_string_ptr_ret(buffer, length_ptr)) == NULL) |
|
fatal("%s: buffer error", __func__); |
|
return (ret); |
|
} |
|
|
void |
void |
buffer_put_string(Buffer *buffer, const void *buf, u_int len) |
buffer_put_string(Buffer *buffer, const void *buf, u_int len) |
{ |
{ |
buffer_put_int(buffer, len); |
int ret; |
buffer_append(buffer, buf, len); |
|
|
if ((ret = sshbuf_put_string(buffer, buf, len)) != 0) |
|
fatal("%s: %s", __func__, ssh_err(ret)); |
} |
} |
|
|
void |
void |
buffer_put_cstring(Buffer *buffer, const char *s) |
buffer_put_cstring(Buffer *buffer, const char *s) |
{ |
{ |
if (s == NULL) |
int ret; |
fatal("buffer_put_cstring: s == NULL"); |
|
buffer_put_string(buffer, s, strlen(s)); |
if ((ret = sshbuf_put_cstring(buffer, s)) != 0) |
|
fatal("%s: %s", __func__, ssh_err(ret)); |
} |
} |
|
|
/* |
|
* Returns a character from the buffer (0 - 255). |
|
*/ |
|
int |
int |
buffer_get_char_ret(char *ret, Buffer *buffer) |
buffer_get_char_ret(char *v, Buffer *buffer) |
{ |
{ |
if (buffer_get_ret(buffer, ret, 1) == -1) { |
int ret; |
error("buffer_get_char_ret: buffer_get_ret failed"); |
|
return (-1); |
if ((ret = sshbuf_get_u8(buffer, (u_char *)v)) != 0) { |
|
error("%s: %s", __func__, ssh_err(ret)); |
|
return -1; |
} |
} |
return (0); |
return 0; |
} |
} |
|
|
int |
int |
|
|
char ch; |
char ch; |
|
|
if (buffer_get_char_ret(&ch, buffer) == -1) |
if (buffer_get_char_ret(&ch, buffer) == -1) |
fatal("buffer_get_char: buffer error"); |
fatal("%s: buffer error", __func__); |
return (u_char) ch; |
return (u_char) ch; |
} |
} |
|
|
/* |
|
* Stores a character in the buffer. |
|
*/ |
|
void |
void |
buffer_put_char(Buffer *buffer, int value) |
buffer_put_char(Buffer *buffer, int value) |
{ |
{ |
char ch = value; |
int ret; |
|
|
buffer_append(buffer, &ch, 1); |
if ((ret = sshbuf_put_u8(buffer, value)) != 0) |
|
fatal("%s: %s", __func__, ssh_err(ret)); |
} |
} |
|
|
|
void |
|
buffer_put_bignum2_from_string(Buffer *buffer, const u_char *s, u_int l) |
|
{ |
|
int ret; |
|
|
|
if ((ret = sshbuf_put_bignum2_bytes(buffer, s, l)) != 0) |
|
fatal("%s: %s", __func__, ssh_err(ret)); |
|
} |
|
|