crypto/external/bsd/openssh/dist/buffer.h

   1 /*      $NetBSD$        */
   2 /* $OpenBSD: buffer.h,v 1.17 2008/05/08 06:59:01 markus Exp $ */
   3
   4 /*
   5  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   6  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   7  *                    All rights reserved
   8  * Code for manipulating FIFO buffers.
   9  *
  10  * As far as I am concerned, the code I have written for this software
  11  * can be used freely for any purpose.  Any derived versions of this
  12  * software must be clearly marked as such, and if the derived work is
  13  * incompatible with the protocol description in the RFC file, it must be
  14  * called by a name other than "ssh" or "Secure Shell".
  15  */
  16
  17 #ifndef BUFFER_H
  18 #define BUFFER_H
  19
  20 /* move the following to a more appropriate place and name */
  21 #define BUFFER_MAX_LEN_HPN          0x4000000  /* 64MB */
  22
  23 typedef struct {
  24         u_char  *buf;           /* Buffer for data. */
  25         u_int    alloc;         /* Number of bytes allocated for data. */
  26         u_int    offset;        /* Offset of first byte containing data. */
  27         u_int    end;           /* Offset of last byte containing data. */
  28 }       Buffer;
  29
  30 void     buffer_init(Buffer *);
  31 void     buffer_clear(Buffer *);
  32 void     buffer_free(Buffer *);
  33
  34 u_int    buffer_len(Buffer *);
  35 void    *buffer_ptr(Buffer *);
  36
  37 void     buffer_append(Buffer *, const void *, u_int);
  38 void    *buffer_append_space(Buffer *, u_int);
  39
  40 int      buffer_check_alloc(Buffer *, u_int);
  41
  42 void     buffer_get(Buffer *, void *, u_int);
  43
  44 void     buffer_consume(Buffer *, u_int);
  45 void     buffer_consume_end(Buffer *, u_int);
  46
  47 void     buffer_dump(Buffer *);
  48
  49 int      buffer_get_ret(Buffer *, void *, u_int);
  50 int      buffer_consume_ret(Buffer *, u_int);
  51 int      buffer_consume_end_ret(Buffer *, u_int);
  52
  53 #include <openssl/bn.h>
  54
  55 void    buffer_put_bignum(Buffer *, const BIGNUM *);
  56 void    buffer_put_bignum2(Buffer *, const BIGNUM *);
  57 void    buffer_get_bignum(Buffer *, BIGNUM *);
  58 void    buffer_get_bignum2(Buffer *, BIGNUM *);
  59
  60 u_short buffer_get_short(Buffer *);
  61 void    buffer_put_short(Buffer *, u_short);
  62
  63 u_int   buffer_get_int(Buffer *);
  64 void    buffer_put_int(Buffer *, u_int);
  65
  66 u_int64_t buffer_get_int64(Buffer *);
  67 void    buffer_put_int64(Buffer *, u_int64_t);
  68
  69 int     buffer_get_char(Buffer *);
  70 void    buffer_put_char(Buffer *, int);
  71
  72 void   *buffer_get_string(Buffer *, u_int *);
  73 void   *buffer_get_string_ptr(Buffer *, u_int *);
  74 void    buffer_put_string(Buffer *, const void *, u_int);
  75 void    buffer_put_cstring(Buffer *, const char *);
  76
  77 #define buffer_skip_string(b) \
  78     do { u_int l = buffer_get_int(b); buffer_consume(b, l); } while (0)
  79
  80 int     buffer_put_bignum_ret(Buffer *, const BIGNUM *);
  81 int     buffer_get_bignum_ret(Buffer *, BIGNUM *);
  82 int     buffer_put_bignum2_ret(Buffer *, const BIGNUM *);
  83 int     buffer_get_bignum2_ret(Buffer *, BIGNUM *);
  84 int     buffer_get_short_ret(u_short *, Buffer *);
  85 int     buffer_get_int_ret(u_int *, Buffer *);
  86 int     buffer_get_int64_ret(u_int64_t *, Buffer *);
  87 void    *buffer_get_string_ret(Buffer *, u_int *);
  88 int     buffer_get_char_ret(char *, Buffer *);
  89
  90 #endif                          /* BUFFER_H */