===================================================================
RCS file: /cvsrepo/anoncvs/cvs/src/usr.bin/ssh/Attic/bufaux.h,v
retrieving revision 1.11.2.4
retrieving revision 1.12
diff -u -r1.11.2.4 -r1.12
--- src/usr.bin/ssh/Attic/bufaux.h	2002/06/02 22:56:10	1.11.2.4
+++ src/usr.bin/ssh/Attic/bufaux.h	2001/06/26 06:32:48	1.12
@@ -1,5 +1,3 @@
-/*	$OpenBSD: bufaux.h,v 1.11.2.4 2002/06/02 22:56:10 miod Exp $	*/
-
 /*
  * Author: Tatu Ylonen <ylo@cs.hut.fi>
  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
@@ -12,34 +10,51 @@
  * called by a name other than "ssh" or "Secure Shell".
  */
 
+/* RCSID("$OpenBSD: bufaux.h,v 1.12 2001/06/26 06:32:48 itojun Exp $"); */
+
 #ifndef BUFAUX_H
 #define BUFAUX_H
 
 #include "buffer.h"
 #include <openssl/bn.h>
 
+/*
+ * Stores an BIGNUM in the buffer with a 2-byte msb first bit count, followed
+ * by (bits+7)/8 bytes of binary data, msb first.
+ */
 void    buffer_put_bignum(Buffer *, BIGNUM *);
 void    buffer_put_bignum2(Buffer *, 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);
+/* Retrieves an BIGNUM from the buffer. */
+int     buffer_get_bignum(Buffer *, BIGNUM *);
+int	buffer_get_bignum2(Buffer *, BIGNUM *);
 
-u_int	buffer_get_int(Buffer *);
-void    buffer_put_int(Buffer *, u_int);
-
+/* Returns an integer from the buffer (4 bytes, msb first). */
+u_int buffer_get_int(Buffer *);
 u_int64_t buffer_get_int64(Buffer *);
+
+/* Stores an integer in the buffer in 4 bytes, msb first. */
+void    buffer_put_int(Buffer *, u_int);
 void	buffer_put_int64(Buffer *, u_int64_t);
 
+/* Returns a character from the buffer (0 - 255). */
 int     buffer_get_char(Buffer *);
+
+/* Stores a character in the buffer. */
 void    buffer_put_char(Buffer *, int);
 
-void   *buffer_get_string(Buffer *, u_int *);
+/*
+ * Returns an arbitrary binary string from the buffer.  The string cannot be
+ * longer than 256k.  The returned value points to memory allocated with
+ * xmalloc; it is the responsibility of the calling function to free the
+ * data.  If length_ptr is non-NULL, the length of the returned data will be
+ * stored there.  A null character will be automatically appended to the
+ * returned string, and is not counted in length.
+ */
+char   *buffer_get_string(Buffer *, u_int *);
+
+/* Stores and arbitrary binary string in the buffer. */
 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)
 
 #endif				/* BUFAUX_H */