blob: 42df46394fd00766e834da075d2209350cb383bc [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller4af51302000-04-16 11:18:38 +10002 *
Damien Miller95def091999-11-25 00:26:21 +11003 * bufaux.h
Damien Miller4af51302000-04-16 11:18:38 +10004 *
Damien Miller95def091999-11-25 00:26:21 +11005 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller4af51302000-04-16 11:18:38 +10006 *
Damien Miller95def091999-11-25 00:26:21 +11007 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8 * All rights reserved
Damien Miller4af51302000-04-16 11:18:38 +10009 *
Damien Miller95def091999-11-25 00:26:21 +110010 * Created: Wed Mar 29 02:18:23 1995 ylo
Damien Miller4af51302000-04-16 11:18:38 +100011 *
Damien Miller95def091999-11-25 00:26:21 +110012 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100013
Damien Miller6536c7d2000-06-22 21:32:31 +100014/* RCSID("$OpenBSD: bufaux.h,v 1.7 2000/06/20 01:39:39 markus Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100015
16#ifndef BUFAUX_H
17#define BUFAUX_H
18
19#include "buffer.h"
20
Damien Miller5428f641999-11-25 11:54:57 +110021/*
22 * Stores an BIGNUM in the buffer with a 2-byte msb first bit count, followed
23 * by (bits+7)/8 bytes of binary data, msb first.
24 */
Damien Miller95def091999-11-25 00:26:21 +110025void buffer_put_bignum(Buffer * buffer, BIGNUM * value);
Damien Millerb38eff82000-04-01 11:09:21 +100026void buffer_put_bignum2(Buffer * buffer, BIGNUM * value);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100027
28/* Retrieves an BIGNUM from the buffer. */
Damien Miller95def091999-11-25 00:26:21 +110029int buffer_get_bignum(Buffer * buffer, BIGNUM * value);
Damien Millerb38eff82000-04-01 11:09:21 +100030int buffer_get_bignum2(Buffer *buffer, BIGNUM * value);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100031
32/* Returns an integer from the buffer (4 bytes, msb first). */
Damien Miller95def091999-11-25 00:26:21 +110033unsigned int buffer_get_int(Buffer * buffer);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100034
35/* Stores an integer in the buffer in 4 bytes, msb first. */
Damien Miller95def091999-11-25 00:26:21 +110036void buffer_put_int(Buffer * buffer, unsigned int value);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100037
38/* Returns a character from the buffer (0 - 255). */
Damien Miller95def091999-11-25 00:26:21 +110039int buffer_get_char(Buffer * buffer);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100040
41/* Stores a character in the buffer. */
Damien Miller95def091999-11-25 00:26:21 +110042void buffer_put_char(Buffer * buffer, int value);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100043
Damien Miller5428f641999-11-25 11:54:57 +110044/*
45 * Returns an arbitrary binary string from the buffer. The string cannot be
46 * longer than 256k. The returned value points to memory allocated with
47 * xmalloc; it is the responsibility of the calling function to free the
48 * data. If length_ptr is non-NULL, the length of the returned data will be
49 * stored there. A null character will be automatically appended to the
50 * returned string, and is not counted in length.
51 */
Damien Miller95def091999-11-25 00:26:21 +110052char *buffer_get_string(Buffer * buffer, unsigned int *length_ptr);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100053
54/* Stores and arbitrary binary string in the buffer. */
Damien Miller95def091999-11-25 00:26:21 +110055void buffer_put_string(Buffer * buffer, const void *buf, unsigned int len);
Damien Millerb38eff82000-04-01 11:09:21 +100056void buffer_put_cstring(Buffer *buffer, const char *s);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100057
Damien Miller95def091999-11-25 00:26:21 +110058#endif /* BUFAUX_H */