blob: 0b17a8ac76844ca38f07e402cce10ad43ca2a3ef [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller95def091999-11-25 00:26:21 +11002 *
3 * bufaux.h
4 *
5 * Author: Tatu Ylonen <ylo@cs.hut.fi>
6 *
7 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8 * All rights reserved
9 *
10 * Created: Wed Mar 29 02:18:23 1995 ylo
11 *
12 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100013
Damien Miller95def091999-11-25 00:26:21 +110014/* RCSID("$Id: bufaux.h,v 1.2 1999/11/24 13:26:22 damien Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
16#ifndef BUFAUX_H
17#define BUFAUX_H
18
19#include "buffer.h"
20
21/* Stores an BIGNUM in the buffer with a 2-byte msb first bit count, followed
22 by (bits+7)/8 bytes of binary data, msb first. */
Damien Miller95def091999-11-25 00:26:21 +110023void buffer_put_bignum(Buffer * buffer, BIGNUM * value);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100024
25/* Retrieves an BIGNUM from the buffer. */
Damien Miller95def091999-11-25 00:26:21 +110026int buffer_get_bignum(Buffer * buffer, BIGNUM * value);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100027
28/* Returns an integer from the buffer (4 bytes, msb first). */
Damien Miller95def091999-11-25 00:26:21 +110029unsigned int buffer_get_int(Buffer * buffer);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100030
31/* Stores an integer in the buffer in 4 bytes, msb first. */
Damien Miller95def091999-11-25 00:26:21 +110032void buffer_put_int(Buffer * buffer, unsigned int value);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100033
34/* Returns a character from the buffer (0 - 255). */
Damien Miller95def091999-11-25 00:26:21 +110035int buffer_get_char(Buffer * buffer);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100036
37/* Stores a character in the buffer. */
Damien Miller95def091999-11-25 00:26:21 +110038void buffer_put_char(Buffer * buffer, int value);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100039
40/* Returns an arbitrary binary string from the buffer. The string cannot
41 be longer than 256k. The returned value points to memory allocated
42 with xmalloc; it is the responsibility of the calling function to free
43 the data. If length_ptr is non-NULL, the length of the returned data
44 will be stored there. A null character will be automatically appended
45 to the returned string, and is not counted in length. */
Damien Miller95def091999-11-25 00:26:21 +110046char *buffer_get_string(Buffer * buffer, unsigned int *length_ptr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100047
48/* Stores and arbitrary binary string in the buffer. */
Damien Miller95def091999-11-25 00:26:21 +110049void buffer_put_string(Buffer * buffer, const void *buf, unsigned int len);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100050
Damien Miller95def091999-11-25 00:26:21 +110051#endif /* BUFAUX_H */