X-Git-Url: https://git.distorted.org.uk/u/mdw/catacomb/blobdiff_plain/6b80b6c48a47fd4f9f8329e2e56a228fa3e2c7f4..025c5f4aa5ffbf8948482a4233318db81c2df5d2:/buf.h diff --git a/buf.h b/buf.h index ae5d993..84c4121 100644 --- a/buf.h +++ b/buf.h @@ -1,8 +1,9 @@ /* -*-c-*- * - * $Id: buf.h,v 1.1 2003/10/11 21:02:33 mdw Exp $ + * $Id$ + * + * Reading and writing packet buffers * - * [Reading and writing packet buffers * * (c) 2001 Straylight/Edgeware */ @@ -26,19 +27,8 @@ * MA 02111-1307, USA. */ -/*----- Revision history --------------------------------------------------* - * - * $Log: buf.h,v $ - * Revision 1.1 2003/10/11 21:02:33 mdw - * Import buf stuff from tripe. - * - * Revision 1.1 2001/06/19 22:09:54 mdw - * Expose interface, for use in the proxy. - * - */ - -#ifndef BUF_H -#define BUF_H +#ifndef CATACOMB_BUF_H +#define CATACOMB_BUF_H #ifdef __cplusplus extern "C" { @@ -50,7 +40,13 @@ #include -#include +#ifndef CATACOMB_MP_H +# include "mp.h" +#endif + +#ifndef CATACOMB_EC_H +# include "ec.h" +#endif /*----- Data structures ---------------------------------------------------*/ @@ -229,6 +225,107 @@ extern int buf_getu32(buf */*b*/, uint32 */*w*/); extern int buf_putu32(buf */*b*/, uint32 /*w*/); +/* --- @buf_getmem{8,16,32,z} --- * + * + * Arguments: @buf *b@ = pointer to a buffer block + * @size_t *nn@ = where to put the length + * + * Returns: Pointer to the buffer data, or null. + * + * Use: Gets a chunk of memory from a buffer. The number, @16@ or + * @32@, is the width of the length; @z@ means null-terminated. + */ + +extern void *buf_getmem8(buf */*b*/, size_t */*nn*/); +extern void *buf_getmem16(buf */*b*/, size_t */*nn*/); +extern void *buf_getmem32(buf */*b*/, size_t */*nn*/); +extern void *buf_getmemz(buf */*b*/, size_t */*nn*/); + +/* --- @buf_putmem{8,16,32,z} --- * + * + * Arguments: @buf *b@ = pointer to a buffer block + * @const void *p@ = pointer to data to write + * @size_t n@ = length to write + * + * Returns: Zero if OK, nonzero if there wasn't enough space. + * + * Use: Writes a chunk of data to a buffer. The number, @16@ or + * @32@, is the width of the length; @z@ means null-terminated. + */ + +extern int buf_putmem8(buf */*b*/, const void */*p*/, size_t /*n*/); +extern int buf_putmem16(buf */*b*/, const void */*p*/, size_t /*n*/); +extern int buf_putmem32(buf */*b*/, const void */*p*/, size_t /*n*/); +extern int buf_putmemz(buf */*b*/, const void */*p*/, size_t /*n*/); + +/* --- @buf_getbuf{8,16,32,z}@ --- * + * + * Arguments: @buf *b@ = pointer to a buffer block + * @buf *bb@ = where to put the result + * + * Returns: Zero if it worked, nonzero if there wasn't enough space. + * + * Use: Gets a block of data from a buffer, and writes its bounds to + * another buffer. The number, @16@ or @32@, is the width of + * the length; @z@ means null-terminated. + */ + +extern int buf_getbuf8(buf */*b*/, buf */*bb*/); +extern int buf_getbuf16(buf */*b*/, buf */*bb*/); +extern int buf_getbuf32(buf */*b*/, buf */*bb*/); +extern int buf_getbufz(buf */*b*/, buf */*bb*/); + +/* --- @buf_putbuf{8,16,32,z}@ --- * + * + * Arguments: @buf *b@ = pointer to a buffer block + * @buf *bb@ = buffer to write + * + * Returns: Zero if it worked, nonzero if there wasn't enough space. + * + * Use: Puts the contents of a buffer to a buffer. The number, @16@ + * or @32@, is the width of the length; @z@ means null- + * terminated. + */ + +extern int buf_putbuf8(buf */*b*/, buf */*bb*/); +extern int buf_putbuf16(buf */*b*/, buf */*bb*/); +extern int buf_putbuf32(buf */*b*/, buf */*bb*/); +extern int buf_putbufz(buf */*b*/, buf */*bb*/); + +/* --- @buf_getstr{8,16,32,z}@ --- * + * + * Arguments: @buf *b@ = pointer to a buffer block + * @dstr *d@ = where to put the result + * + * Returns: Zero if it worked, nonzero if there wasn't enough space. + * + * Use: Gets a block of data from a buffer, and writes its contents + * to a string. The number, @16@ or @32@, is the width of the + * length; @z@ means null-terminated. + */ + +extern int buf_getstr8(buf */*b*/, dstr */*d*/); +extern int buf_getstr16(buf */*b*/, dstr */*d*/); +extern int buf_getstr32(buf */*b*/, dstr */*d*/); +extern int buf_getstrz(buf */*b*/, dstr */*d*/); + +/* --- @buf_putstr{8,16,32,z}@ --- * + * + * Arguments: @buf *b@ = pointer to a buffer block + * @dstr *d@ = string to write + * + * Returns: Zero if it worked, nonzero if there wasn't enough space. + * + * Use: Puts a string to a buffer, and writes its bounds to + * another buffer. The number, @16@ or @32@, is the width of + * the length; @z@ means null-terminated. + */ + +extern int buf_putstr8(buf */*b*/, dstr */*d*/); +extern int buf_putstr16(buf */*b*/, dstr */*d*/); +extern int buf_putstr32(buf */*b*/, dstr */*d*/); +extern int buf_putstrz(buf */*b*/, dstr */*d*/); + /* --- @buf_getmp@ --- * * * Arguments: @buf *b@ = pointer to a buffer block @@ -252,6 +349,31 @@ extern mp *buf_getmp(buf */*b*/); extern int buf_putmp(buf */*b*/, mp */*m*/); +/* --- @buf_getec@ --- * + * + * Arguments: @buf *b@ = pointer to a buffer block + * @ec *p@ = where to put the point + * + * Returns: Zero if it worked, nonzero if it failed. + * + * Use: Gets a multiprecision integer from a buffer. The point must + * be initialized. + */ + +extern int buf_getec(buf */*b*/, ec */*p*/); + +/* --- @buf_putec@ --- * + * + * Arguments: @buf *b@ = pointer to a buffer block + * @ec *p@ = an elliptic curve point + * + * Returns: Zero if it worked, nonzero if there wasn't enough space. + * + * Use: Puts an elliptic curve point to a buffer. + */ + +extern int buf_putec(buf */*b*/, ec */*p*/); + /*----- That's all, folks -------------------------------------------------*/ #ifdef __cplusplus