bufaux.c

   1 /*
   2
   3 bufaux.c
   4
   5 Author: Tatu Ylonen <ylo@cs.hut.fi>
   6
   7 Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   8                    All rights reserved
   9
  10 Created: Wed Mar 29 02:24:47 1995 ylo
  11
  12 Auxiliary functions for storing and retrieving various data types to/from
  13 Buffers.
  14
  15 */
  16
  17 #include "includes.h"
  18 RCSID("$Id$");
  19
  20 #include "ssh.h"
  21
  22 #ifdef HAVE_OPENSSL
  23 #include <openssl/bn.h>
  24 #endif
  25 #ifdef HAVE_SSL
  26 #include <ssl/bn.h>
  27 #endif
  28
  29 #include "bufaux.h"
  30 #include "xmalloc.h"
  31 #include "getput.h"
  32
  33 /* Stores an BIGNUM in the buffer with a 2-byte msb first bit count, followed
  34    by (bits+7)/8 bytes of binary data, msb first. */
  35
  36 void
  37 buffer_put_bignum(Buffer *buffer, BIGNUM *value)
  38 {
  39   int bits = BN_num_bits(value);
  40   int bin_size = (bits + 7) / 8;
  41   char *buf = xmalloc(bin_size);
  42   int oi;
  43   char msg[2];
  44
  45   /* Get the value of in binary */
  46   oi = BN_bn2bin(value, buf);
  47   if (oi != bin_size)
  48     fatal("buffer_put_bignum: BN_bn2bin() failed: oi %d != bin_size %d",
  49           oi, bin_size);
  50
  51   /* Store the number of bits in the buffer in two bytes, msb first. */
  52   PUT_16BIT(msg, bits);
  53   buffer_append(buffer, msg, 2);
  54   /* Store the binary data. */
  55   buffer_append(buffer, buf, oi);
  56   /* Clear the temporary data. */
  57   memset(buf, 0, bin_size);
  58   xfree(buf);
  59 }
  60
  61 /* Retrieves an BIGNUM from the buffer. */
  62
  63 int
  64 buffer_get_bignum(Buffer *buffer, BIGNUM *value)
  65 {
  66   int bits, bytes;
  67   unsigned char buf[2], *bin;
  68
  69   /* Get the number for bits. */
  70   buffer_get(buffer, (char *)buf, 2);
  71   bits = GET_16BIT(buf);
  72   /* Compute the number of binary bytes that follow. */
  73   bytes = (bits + 7) / 8;
  74   bin = xmalloc(bytes);
  75   buffer_get(buffer, bin, bytes);
  76   BN_bin2bn(bin, bytes, value);
  77   xfree(bin);
  78
  79   return 2 + bytes;
  80 }
  81
  82 /* Returns an integer from the buffer (4 bytes, msb first). */
  83
  84 unsigned int buffer_get_int(Buffer *buffer)
  85 {
  86   unsigned char buf[4];
  87   buffer_get(buffer, (char *)buf, 4);
  88   return GET_32BIT(buf);
  89 }
  90
  91 /* Stores an integer in the buffer in 4 bytes, msb first. */
  92
  93 void buffer_put_int(Buffer *buffer, unsigned int value)
  94 {
  95   char buf[4];
  96   PUT_32BIT(buf, value);
  97   buffer_append(buffer, buf, 4);
  98 }
  99
 100 /* Returns an arbitrary binary string from the buffer.  The string cannot
 101    be longer than 256k.  The returned value points to memory allocated
 102    with xmalloc; it is the responsibility of the calling function to free
 103    the data.  If length_ptr is non-NULL, the length of the returned data
 104    will be stored there.  A null character will be automatically appended
 105    to the returned string, and is not counted in length. */
 106
 107 char *buffer_get_string(Buffer *buffer, unsigned int *length_ptr)
 108 {
 109   unsigned int len;
 110   char *value;
 111   /* Get the length. */
 112   len = buffer_get_int(buffer);
 113   if (len > 256*1024)
 114     fatal("Received packet with bad string length %d", len);
 115   /* Allocate space for the string.  Add one byte for a null character. */
 116   value = xmalloc(len + 1);
 117   /* Get the string. */
 118   buffer_get(buffer, value, len);
 119   /* Append a null character to make processing easier. */
 120   value[len] = 0;
 121   /* Optionally return the length of the string. */
 122   if (length_ptr)
 123     *length_ptr = len;
 124   return value;
 125 }
 126
 127 /* Stores and arbitrary binary string in the buffer. */
 128
 129 void buffer_put_string(Buffer *buffer, const void *buf, unsigned int len)
 130 {
 131   buffer_put_int(buffer, len);
 132   buffer_append(buffer, buf, len);
 133 }
 134
 135 /* Returns a character from the buffer (0 - 255). */
 136
 137 int buffer_get_char(Buffer *buffer)
 138 {
 139   char ch;
 140   buffer_get(buffer, &ch, 1);
 141   return (unsigned char)ch;
 142 }
 143
 144 /* Stores a character in the buffer. */
 145
 146 void buffer_put_char(Buffer *buffer, int value)
 147 {
 148   char ch = value;
 149   buffer_append(buffer, &ch, 1);
 150 }