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.9 2000/12/19 23:17:55 markus Exp $"); */
  14
  15 #ifndef BUFAUX_H
  16 #define BUFAUX_H
  17
  18 #include "buffer.h"
  19
  20 /*
  21  * Stores an BIGNUM in the buffer with a 2-byte msb first bit count, followed
  22  * by (bits+7)/8 bytes of binary data, msb first.
  23  */
  24 void    buffer_put_bignum(Buffer * buffer, BIGNUM * value);
  25 void    buffer_put_bignum2(Buffer * buffer, BIGNUM * value);
  26
  27 /* Retrieves an BIGNUM from the buffer. */
  28 int     buffer_get_bignum(Buffer * buffer, BIGNUM * value);
  29 int     buffer_get_bignum2(Buffer *buffer, BIGNUM * value);
  30
  31 /* Returns an integer from the buffer (4 bytes, msb first). */
  32 u_int buffer_get_int(Buffer * buffer);
  33
  34 /* Stores an integer in the buffer in 4 bytes, msb first. */
  35 void    buffer_put_int(Buffer * buffer, u_int value);
  36
  37 /* Returns a character from the buffer (0 - 255). */
  38 int     buffer_get_char(Buffer * buffer);
  39
  40 /* Stores a character in the buffer. */
  41 void    buffer_put_char(Buffer * buffer, int value);
  42
  43 /*
  44  * Returns an arbitrary binary string from the buffer.  The string cannot be
  45  * longer than 256k.  The returned value points to memory allocated with
  46  * xmalloc; it is the responsibility of the calling function to free the
  47  * data.  If length_ptr is non-NULL, the length of the returned data will be
  48  * stored there.  A null character will be automatically appended to the
  49  * returned string, and is not counted in length.
  50  */
  51 char   *buffer_get_string(Buffer * buffer, u_int *length_ptr);
  52
  53 /* Stores and arbitrary binary string in the buffer. */
  54 void    buffer_put_string(Buffer * buffer, const void *buf, u_int len);
  55 void    buffer_put_cstring(Buffer *buffer, const char *s);
  56
  57 #endif                          /* BUFAUX_H */