[openssh.git] / buffer.h

/* $OpenBSD: buffer.h,v 1.18 2010/01/12 01:36:08 djm Exp $ */

/*
 * Author: Tatu Ylonen <ylo@cs.hut.fi>
 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
 *                    All rights reserved
 * Code for manipulating FIFO buffers.
 *
 * As far as I am concerned, the code I have written for this software
 * can be used freely for any purpose.  Any derived versions of this
 * software must be clearly marked as such, and if the derived work is
 * incompatible with the protocol description in the RFC file, it must be
 * called by a name other than "ssh" or "Secure Shell".
 */

#ifndef BUFFER_H
#define BUFFER_H

typedef struct {
	u_char	*buf;		/* Buffer for data. */
	u_int	 alloc;		/* Number of bytes allocated for data. */
	u_int	 offset;	/* Offset of first byte containing data. */
	u_int	 end;		/* Offset of last byte containing data. */
}       Buffer;

void	 buffer_init(Buffer *);
void	 buffer_clear(Buffer *);
void	 buffer_free(Buffer *);

u_int	 buffer_len(Buffer *);
void	*buffer_ptr(Buffer *);

void	 buffer_append(Buffer *, const void *, u_int);
void	*buffer_append_space(Buffer *, u_int);

int	 buffer_check_alloc(Buffer *, u_int);

void	 buffer_get(Buffer *, void *, u_int);

void	 buffer_consume(Buffer *, u_int);
void	 buffer_consume_end(Buffer *, u_int);

void     buffer_dump(Buffer *);

int	 buffer_get_ret(Buffer *, void *, u_int);
int	 buffer_consume_ret(Buffer *, u_int);
int	 buffer_consume_end_ret(Buffer *, u_int);

#include <openssl/bn.h>

void    buffer_put_bignum(Buffer *, const BIGNUM *);
void    buffer_put_bignum2(Buffer *, const BIGNUM *);
void	buffer_get_bignum(Buffer *, BIGNUM *);
void	buffer_get_bignum2(Buffer *, BIGNUM *);

u_short	buffer_get_short(Buffer *);
void	buffer_put_short(Buffer *, u_short);

u_int	buffer_get_int(Buffer *);
void    buffer_put_int(Buffer *, u_int);

u_int64_t buffer_get_int64(Buffer *);
void	buffer_put_int64(Buffer *, u_int64_t);

int     buffer_get_char(Buffer *);
void    buffer_put_char(Buffer *, int);

void   *buffer_get_string(Buffer *, u_int *);
void   *buffer_get_string_ptr(Buffer *, u_int *);
void    buffer_put_string(Buffer *, const void *, u_int);
void	buffer_put_cstring(Buffer *, const char *);

#define buffer_skip_string(b) \
    do { u_int l = buffer_get_int(b); buffer_consume(b, l); } while (0)

int	buffer_put_bignum_ret(Buffer *, const BIGNUM *);
int	buffer_get_bignum_ret(Buffer *, BIGNUM *);
int	buffer_put_bignum2_ret(Buffer *, const BIGNUM *);
int	buffer_get_bignum2_ret(Buffer *, BIGNUM *);
int	buffer_get_short_ret(u_short *, Buffer *);
int	buffer_get_int_ret(u_int *, Buffer *);
int	buffer_get_int64_ret(u_int64_t *, Buffer *);
void	*buffer_get_string_ret(Buffer *, u_int *);
void	*buffer_get_string_ptr_ret(Buffer *, u_int *);
int	buffer_get_char_ret(char *, Buffer *);

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