[gssapi-openssh.git] / openssh / buffer.h

/* $OpenBSD: buffer.h,v 1.16 2006/08/03 03:34:41 deraadt 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
#define BUFFER_MAX_LEN_HPN      0x4000000 /* 64MB */

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_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 *);
int	buffer_get_char_ret(char *, Buffer *);

#endif				/* BUFFER_H */
Commit	Line	Data
30460aeb	1	/* $OpenBSD: buffer.h,v 1.16 2006/08/03 03:34:41 deraadt Exp $ */
473db5ab	2
3c0ef626	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
3c0ef626	16	#ifndef BUFFER_H
3c0ef626	17	#define BUFFER_H
f713db99	18	#define BUFFER_MAX_LEN_HPN 0x4000000 /* 64MB */
3c0ef626	19
3c0ef626	20	typedef struct {
473db5ab	21	u_char buf; / Buffer for data. */
3c0ef626	22	u_int alloc; /* Number of bytes allocated for data. */
	23	u_int offset; /* Offset of first byte containing data. */
	24	u_int end; /* Offset of last byte containing data. */
	25	} Buffer;
	26
	27	void buffer_init(Buffer *);
	28	void buffer_clear(Buffer *);
	29	void buffer_free(Buffer *);
	30
	31	u_int buffer_len(Buffer *);
473db5ab	32	void buffer_ptr(Buffer );
3c0ef626	33
473db5ab	34	void buffer_append(Buffer , const void , u_int);
473db5ab	35	void buffer_append_space(Buffer , u_int);
3c0ef626	36
30460aeb	37	int buffer_check_alloc(Buffer *, u_int);
30460aeb	38
473db5ab	39	void buffer_get(Buffer , void , u_int);
3c0ef626	40
	41	void buffer_consume(Buffer *, u_int);
	42	void buffer_consume_end(Buffer *, u_int);
	43
	44	void buffer_dump(Buffer *);
	45
473db5ab	46	int buffer_get_ret(Buffer , void , u_int);
	47	int buffer_consume_ret(Buffer *, u_int);
	48	int buffer_consume_end_ret(Buffer *, u_int);
	49
30460aeb	50	#include <openssl/bn.h>
	51
	52	void buffer_put_bignum(Buffer , const BIGNUM );
	53	void buffer_put_bignum2(Buffer , const BIGNUM );
	54	void buffer_get_bignum(Buffer , BIGNUM );
	55	void buffer_get_bignum2(Buffer , BIGNUM );
	56
	57	u_short buffer_get_short(Buffer *);
	58	void buffer_put_short(Buffer *, u_short);
	59
	60	u_int buffer_get_int(Buffer *);
	61	void buffer_put_int(Buffer *, u_int);
	62
	63	u_int64_t buffer_get_int64(Buffer *);
	64	void buffer_put_int64(Buffer *, u_int64_t);
	65
	66	int buffer_get_char(Buffer *);
	67	void buffer_put_char(Buffer *, int);
	68
	69	void buffer_get_string(Buffer , u_int *);
	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 *);
	84	int buffer_get_char_ret(char , Buffer );
	85
3c0ef626	86	#endif /* BUFFER_H */