buffer.h revision 181097
1/* $OpenBSD: buffer.h,v 1.16 2006/08/03 03:34:41 deraadt Exp $ */ 2 3/* 4 * Author: Tatu Ylonen <ylo@cs.hut.fi> 5 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 6 * All rights reserved 7 * Code for manipulating FIFO buffers. 8 * 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". 14 */ 15 16#ifndef BUFFER_H 17#define BUFFER_H 18 19typedef struct { 20 u_char *buf; /* Buffer for data. */ 21 u_int alloc; /* Number of bytes allocated for data. */ 22 u_int offset; /* Offset of first byte containing data. */ 23 u_int end; /* Offset of last byte containing data. */ 24} Buffer; 25 26void buffer_init(Buffer *); 27void buffer_clear(Buffer *); 28void buffer_free(Buffer *); 29 30u_int buffer_len(Buffer *); 31void *buffer_ptr(Buffer *); 32 33void buffer_append(Buffer *, const void *, u_int); 34void *buffer_append_space(Buffer *, u_int); 35 36int buffer_check_alloc(Buffer *, u_int); 37 38void buffer_get(Buffer *, void *, u_int); 39 40void buffer_consume(Buffer *, u_int); 41void buffer_consume_end(Buffer *, u_int); 42 43void buffer_dump(Buffer *); 44 45int buffer_get_ret(Buffer *, void *, u_int); 46int buffer_consume_ret(Buffer *, u_int); 47int buffer_consume_end_ret(Buffer *, u_int); 48 49#include <openssl/bn.h> 50 51void buffer_put_bignum(Buffer *, const BIGNUM *); 52void buffer_put_bignum2(Buffer *, const BIGNUM *); 53void buffer_get_bignum(Buffer *, BIGNUM *); 54void buffer_get_bignum2(Buffer *, BIGNUM *); 55 56u_short buffer_get_short(Buffer *); 57void buffer_put_short(Buffer *, u_short); 58 59u_int buffer_get_int(Buffer *); 60void buffer_put_int(Buffer *, u_int); 61 62u_int64_t buffer_get_int64(Buffer *); 63void buffer_put_int64(Buffer *, u_int64_t); 64 65int buffer_get_char(Buffer *); 66void buffer_put_char(Buffer *, int); 67 68void *buffer_get_string(Buffer *, u_int *); 69void buffer_put_string(Buffer *, const void *, u_int); 70void buffer_put_cstring(Buffer *, const char *); 71 72#define buffer_skip_string(b) \ 73 do { u_int l = buffer_get_int(b); buffer_consume(b, l); } while (0) 74 75int buffer_put_bignum_ret(Buffer *, const BIGNUM *); 76int buffer_get_bignum_ret(Buffer *, BIGNUM *); 77int buffer_put_bignum2_ret(Buffer *, const BIGNUM *); 78int buffer_get_bignum2_ret(Buffer *, BIGNUM *); 79int buffer_get_short_ret(u_short *, Buffer *); 80int buffer_get_int_ret(u_int *, Buffer *); 81int buffer_get_int64_ret(u_int64_t *, Buffer *); 82void *buffer_get_string_ret(Buffer *, u_int *); 83int buffer_get_char_ret(char *, Buffer *); 84 85#endif /* BUFFER_H */ 86