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