crypto/openssh/bufaux.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  * Auxiliary functions for storing and retrieving various data types to/from
   6  * Buffers.
   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: bufaux.c,v 1.29 2003/04/08 20:21:28 itojun Exp $");
  41 RCSID("$FreeBSD$");
  42
  43 #include <openssl/bn.h>
  44 #include "bufaux.h"
  45 #include "xmalloc.h"
  46 #include "getput.h"
  47 #include "log.h"
  48
  49 /*
  50  * Stores an BIGNUM in the buffer with a 2-byte msb first bit count, followed
  51  * by (bits+7)/8 bytes of binary data, msb first.
  52  */
  53 void
  54 buffer_put_bignum(Buffer *buffer, BIGNUM *value)
  55 {
  56         int bits = BN_num_bits(value);
  57         int bin_size = (bits + 7) / 8;
  58         u_char *buf = xmalloc(bin_size);
  59         int oi;
  60         char msg[2];
  61
  62         /* Get the value of in binary */
  63         oi = BN_bn2bin(value, buf);
  64         if (oi != bin_size)
  65                 fatal("buffer_put_bignum: BN_bn2bin() failed: oi %d != bin_size %d",
  66                     oi, bin_size);
  67
  68         /* Store the number of bits in the buffer in two bytes, msb first. */
  69         PUT_16BIT(msg, bits);
  70         buffer_append(buffer, msg, 2);
  71         /* Store the binary data. */
  72         buffer_append(buffer, (char *)buf, oi);
  73
  74         memset(buf, 0, bin_size);
  75         xfree(buf);
  76 }
  77
  78 /*
  79  * Retrieves an BIGNUM from the buffer.
  80  */
  81 void
  82 buffer_get_bignum(Buffer *buffer, BIGNUM *value)
  83 {
  84         int bits, bytes;
  85         u_char buf[2], *bin;
  86
  87         /* Get the number for bits. */
  88         buffer_get(buffer, (char *) buf, 2);
  89         bits = GET_16BIT(buf);
  90         /* Compute the number of binary bytes that follow. */
  91         bytes = (bits + 7) / 8;
  92         if (bytes > 8 * 1024)
  93                 fatal("buffer_get_bignum: cannot handle BN of size %d", bytes);
  94         if (buffer_len(buffer) < bytes)
  95                 fatal("buffer_get_bignum: input buffer too small");
  96         bin = buffer_ptr(buffer);
  97         BN_bin2bn(bin, bytes, value);
  98         buffer_consume(buffer, bytes);
  99 }
 100
 101 /*
 102  * Stores an BIGNUM in the buffer in SSH2 format.
 103  */
 104 void
 105 buffer_put_bignum2(Buffer *buffer, BIGNUM *value)
 106 {
 107         int bytes = BN_num_bytes(value) + 1;
 108         u_char *buf = xmalloc(bytes);
 109         int oi;
 110         int hasnohigh = 0;
 111
 112         buf[0] = '\0';
 113         /* Get the value of in binary */
 114         oi = BN_bn2bin(value, buf+1);
 115         if (oi != bytes-1)
 116                 fatal("buffer_put_bignum: BN_bn2bin() failed: oi %d != bin_size %d",
 117                     oi, bytes);
 118         hasnohigh = (buf[1] & 0x80) ? 0 : 1;
 119         if (value->neg) {
 120                 /**XXX should be two's-complement */
 121                 int i, carry;
 122                 u_char *uc = buf;
 123                 logit("negativ!");
 124                 for (i = bytes-1, carry = 1; i>=0; i--) {
 125                         uc[i] ^= 0xff;
 126                         if (carry)
 127                                 carry = !++uc[i];
 128                 }
 129         }
 130         buffer_put_string(buffer, buf+hasnohigh, bytes-hasnohigh);
 131         memset(buf, 0, bytes);
 132         xfree(buf);
 133 }
 134
 135 /* XXX does not handle negative BNs */
 136 void
 137 buffer_get_bignum2(Buffer *buffer, BIGNUM *value)
 138 {
 139         u_int len;
 140         u_char *bin = buffer_get_string(buffer, &len);
 141
 142         if (len > 8 * 1024)
 143                 fatal("buffer_get_bignum2: cannot handle BN of size %d", len);
 144         BN_bin2bn(bin, len, value);
 145         xfree(bin);
 146 }
 147 /*
 148  * Returns integers from the buffer (msb first).
 149  */
 150
 151 u_short
 152 buffer_get_short(Buffer *buffer)
 153 {
 154         u_char buf[2];
 155
 156         buffer_get(buffer, (char *) buf, 2);
 157         return GET_16BIT(buf);
 158 }
 159
 160 u_int
 161 buffer_get_int(Buffer *buffer)
 162 {
 163         u_char buf[4];
 164
 165         buffer_get(buffer, (char *) buf, 4);
 166         return GET_32BIT(buf);
 167 }
 168
 169 u_int64_t
 170 buffer_get_int64(Buffer *buffer)
 171 {
 172         u_char buf[8];
 173
 174         buffer_get(buffer, (char *) buf, 8);
 175         return GET_64BIT(buf);
 176 }
 177
 178 /*
 179  * Stores integers in the buffer, msb first.
 180  */
 181 void
 182 buffer_put_short(Buffer *buffer, u_short value)
 183 {
 184         char buf[2];
 185
 186         PUT_16BIT(buf, value);
 187         buffer_append(buffer, buf, 2);
 188 }
 189
 190 void
 191 buffer_put_int(Buffer *buffer, u_int value)
 192 {
 193         char buf[4];
 194
 195         PUT_32BIT(buf, value);
 196         buffer_append(buffer, buf, 4);
 197 }
 198
 199 void
 200 buffer_put_int64(Buffer *buffer, u_int64_t value)
 201 {
 202         char buf[8];
 203
 204         PUT_64BIT(buf, value);
 205         buffer_append(buffer, buf, 8);
 206 }
 207
 208 /*
 209  * Returns an arbitrary binary string from the buffer.  The string cannot
 210  * be longer than 256k.  The returned value points to memory allocated
 211  * with xmalloc; it is the responsibility of the calling function to free
 212  * the data.  If length_ptr is non-NULL, the length of the returned data
 213  * will be stored there.  A null character will be automatically appended
 214  * to the returned string, and is not counted in length.
 215  */
 216 void *
 217 buffer_get_string(Buffer *buffer, u_int *length_ptr)
 218 {
 219         u_char *value;
 220         u_int len;
 221
 222         /* Get the length. */
 223         len = buffer_get_int(buffer);
 224         if (len > 256 * 1024)
 225                 fatal("buffer_get_string: bad string length %u", len);
 226         /* Allocate space for the string.  Add one byte for a null character. */
 227         value = xmalloc(len + 1);
 228         /* Get the string. */
 229         buffer_get(buffer, value, len);
 230         /* Append a null character to make processing easier. */
 231         value[len] = 0;
 232         /* Optionally return the length of the string. */
 233         if (length_ptr)
 234                 *length_ptr = len;
 235         return value;
 236 }
 237
 238 /*
 239  * Stores and arbitrary binary string in the buffer.
 240  */
 241 void
 242 buffer_put_string(Buffer *buffer, const void *buf, u_int len)
 243 {
 244         buffer_put_int(buffer, len);
 245         buffer_append(buffer, buf, len);
 246 }
 247 void
 248 buffer_put_cstring(Buffer *buffer, const char *s)
 249 {
 250         if (s == NULL)
 251                 fatal("buffer_put_cstring: s == NULL");
 252         buffer_put_string(buffer, s, strlen(s));
 253 }
 254
 255 /*
 256  * Returns a character from the buffer (0 - 255).
 257  */
 258 int
 259 buffer_get_char(Buffer *buffer)
 260 {
 261         char ch;
 262
 263         buffer_get(buffer, &ch, 1);
 264         return (u_char) ch;
 265 }
 266
 267 /*
 268  * Stores a character in the buffer.
 269  */
 270 void
 271 buffer_put_char(Buffer *buffer, int value)
 272 {
 273         char ch = value;
 274
 275         buffer_append(buffer, &ch, 1);
 276 }