bufaux.h

   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  *
   6  * As far as I am concerned, the code I have written for this software
   7  * can be used freely for any purpose.  Any derived versions of this
   8  * software must be clearly marked as such, and if the derived work is
   9  * incompatible with the protocol description in the RFC file, it must be
  10  * called by a name other than "ssh" or "Secure Shell".
  11  */
  12
  13 /* RCSID("$OpenBSD: bufaux.h,v 1.12 2001/06/26 06:32:48 itojun Exp $"); */
  14
  15 #ifndef BUFAUX_H
  16 #define BUFAUX_H
  17
  18 #include "buffer.h"
  19 #include <openssl/bn.h>
  20
  21 /*
  22  * Stores an BIGNUM in the buffer with a 2-byte msb first bit count, followed
  23  * by (bits+7)/8 bytes of binary data, msb first.
  24  */
  25 void    buffer_put_bignum(Buffer *, BIGNUM *);
  26 void    buffer_put_bignum2(Buffer *, BIGNUM *);
  27
  28 /* Retrieves an BIGNUM from the buffer. */
  29 int     buffer_get_bignum(Buffer *, BIGNUM *);
  30 int     buffer_get_bignum2(Buffer *, BIGNUM *);
  31
  32 /* Returns an integer from the buffer (4 bytes, msb first). */
  33 u_int buffer_get_int(Buffer *);
  34 #ifdef HAVE_U_INT64_T
  35 u_int64_t buffer_get_int64(Buffer *);
  36 #endif
  37
  38 /* Stores an integer in the buffer in 4 bytes, msb first. */
  39 void    buffer_put_int(Buffer *, u_int);
  40 #ifdef HAVE_U_INT64_T
  41 void    buffer_put_int64(Buffer *, u_int64_t);
  42 #endif
  43
  44 /* Returns a character from the buffer (0 - 255). */
  45 int     buffer_get_char(Buffer *);
  46
  47 /* Stores a character in the buffer. */
  48 void    buffer_put_char(Buffer *, int);
  49
  50 /*
  51  * Returns an arbitrary binary string from the buffer.  The string cannot be
  52  * longer than 256k.  The returned value points to memory allocated with
  53  * xmalloc; it is the responsibility of the calling function to free the
  54  * data.  If length_ptr is non-NULL, the length of the returned data will be
  55  * stored there.  A null character will be automatically appended to the
  56  * returned string, and is not counted in length.
  57  */
  58 char   *buffer_get_string(Buffer *, u_int *);
  59
  60 /* Stores and arbitrary binary string in the buffer. */
  61 void    buffer_put_string(Buffer *, const void *, u_int);
  62 void    buffer_put_cstring(Buffer *, const char *);
  63
  64 #endif                          /* BUFAUX_H */