- markus@cvs.openbsd.org 2001/06/26 17:27:25

     [authfd.h authfile.h auth.h auth-options.h bufaux.h buffer.h
      canohost.h channels.h cipher.h clientloop.h compat.h compress.h
      crc32.h deattack.h dh.h dispatch.h groupaccess.c groupaccess.h
      hostfile.h kex.h key.h log.c log.h mac.h misc.c misc.h mpaux.h
      packet.h radix.h readconf.h readpass.h rsa.h servconf.h serverloop.h
      session.h sftp-common.c sftp-common.h sftp-glob.h sftp-int.h
      sshconnect.h ssh-dss.h sshlogin.h sshpty.h ssh-rsa.h sshtty.h
      tildexpand.h uidswap.h uuencode.h xmalloc.h]
     remove comments from .h, since they are cut&paste from the .c files
     and out of sync

1 files changed, 54 insertions, 178 deletions

diff --git a/packet.h b/packet.h
index 97afbdf60..ffae736d6 100644
--- a/packet.h
+++ b/packet.h
@@ -11,186 +11,75 @@
  * called by a name other than "ssh" or "Secure Shell".
  */
 
-/* RCSID("$OpenBSD: packet.h,v 1.24 2001/06/26 06:32:57 itojun Exp $"); */
+/* RCSID("$OpenBSD: packet.h,v 1.25 2001/06/26 17:27:24 markus Exp $"); */
 
 #ifndef PACKET_H
 #define PACKET_H
 
 #include <openssl/bn.h>
 
-/*
- * Sets the socket used for communication.  Disables encryption until
- * packet_set_encryption_key is called.  It is permissible that fd_in and
- * fd_out are the same descriptor; in that case it is assumed to be a socket.
- */
-void    packet_set_connection(int, int);
-
-/* Puts the connection file descriptors into non-blocking mode. */
-void    packet_set_nonblocking(void);
-
-/* Returns the file descriptor used for input. */
-int     packet_get_connection_in(void);
-
-/* Returns the file descriptor used for output. */
-int     packet_get_connection_out(void);
-
-/*
- * Closes the connection (both descriptors) and clears and frees internal
- * data structures.
- */
-void    packet_close(void);
-
-/*
- * Causes any further packets to be encrypted using the given key.  The same
- * key is used for both sending and reception.  However, both directions are
- * encrypted independently of each other.  Cipher types are defined in ssh.h.
- */
-void
-packet_set_encryption_key(const u_char *, u_int, int);
-
-/*
- * Sets remote side protocol flags for the current connection.  This can be
- * called at any time.
- */
-void    packet_set_protocol_flags(u_int);
-
-/* Returns the remote protocol flags set earlier by the above function. */
-u_int packet_get_protocol_flags(void);
-
-/* Enables compression in both directions starting from the next packet. */
-void    packet_start_compression(int);
-
-/*
- * Informs that the current session is interactive.  Sets IP flags for
- * optimal performance in interactive use.
- */
-void    packet_set_interactive(int);
-
-/* Returns true if the current connection is interactive. */
-int     packet_is_interactive(void);
-
-/* Starts constructing a packet to send. */
-void    packet_start(u_char);
-
-/* Appends a character to the packet data. */
-void    packet_put_char(int ch);
-
-/* Appends an integer to the packet data. */
-void    packet_put_int(u_int value);
-
-/* Appends an arbitrary precision integer to packet data. */
-void    packet_put_bignum(BIGNUM * value);
-void    packet_put_bignum2(BIGNUM * value);
-
-/* Appends a string to packet data. */
-void    packet_put_string(const char *buf, u_int len);
-void    packet_put_cstring(const char *str);
-void    packet_put_raw(const char *buf, u_int len);
-
-/*
- * Finalizes and sends the packet.  If the encryption key has been set,
- * encrypts the packet before sending.
- */
-void    packet_send(void);
-
-/* Waits until a packet has been received, and returns its type. */
-int     packet_read(int *payload_len_ptr);
-
-/*
- * Waits until a packet has been received, verifies that its type matches
- * that given, and gives a fatal error and exits if there is a mismatch.
- */
-void    packet_read_expect(int *payload_len_ptr, int type);
-
-/*
- * Checks if a full packet is available in the data received so far via
- * packet_process_incoming.  If so, reads the packet; otherwise returns
- * SSH_MSG_NONE.  This does not wait for data from the connection.
- * SSH_MSG_DISCONNECT is handled specially here.  Also, SSH_MSG_IGNORE
- * messages are skipped by this function and are never returned to higher
- * levels.
- */
-int     packet_read_poll(int *packet_len_ptr);
-
-/*
- * Buffers the given amount of input characters.  This is intended to be used
- * together with packet_read_poll.
- */
-void    packet_process_incoming(const char *buf, u_int len);
-
-/* Returns a character (0-255) from the packet data. */
-u_int packet_get_char(void);
-
-/* Returns an integer from the packet data. */
-u_int packet_get_int(void);
-
-/*
- * Returns an arbitrary precision integer from the packet data.  The integer
- * must have been initialized before this call.
- */
-void    packet_get_bignum(BIGNUM * value, int *length_ptr);
-void    packet_get_bignum2(BIGNUM * value, int *length_ptr);
+void     packet_set_connection(int, int);
+void     packet_set_nonblocking(void);
+int      packet_get_connection_in(void);
+int      packet_get_connection_out(void);
+void     packet_close(void);
+void     packet_set_encryption_key(const u_char *, u_int, int);
+void     packet_set_protocol_flags(u_int);
+u_int    packet_get_protocol_flags(void);
+void     packet_start_compression(int);
+void     packet_set_interactive(int);
+int      packet_is_interactive(void);
+
+void     packet_start(u_char);
+void     packet_put_char(int ch);
+void     packet_put_int(u_int value);
+void     packet_put_bignum(BIGNUM * value);
+void     packet_put_bignum2(BIGNUM * value);
+void     packet_put_string(const char *buf, u_int len);
+void     packet_put_cstring(const char *str);
+void     packet_put_raw(const char *buf, u_int len);
+void     packet_send(void);
+
+int      packet_read(int *payload_len_ptr);
+void     packet_read_expect(int *payload_len_ptr, int type);
+int      packet_read_poll(int *packet_len_ptr);
+void     packet_process_incoming(const char *buf, u_int len);
+
+u_int    packet_get_char(void);
+u_int    packet_get_int(void);
+void     packet_get_bignum(BIGNUM * value, int *length_ptr);
+void     packet_get_bignum2(BIGNUM * value, int *length_ptr);
 char    *packet_get_raw(int *length_ptr);
+char    *packet_get_string(u_int *length_ptr);
+void     packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
+void     packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
 
-/*
- * Returns a string from the packet data.  The string is allocated using
- * xmalloc; it is the responsibility of the calling program to free it when
- * no longer needed.  The length_ptr argument may be NULL, or point to an
- * integer into which the length of the string is stored.
- */
-char   *packet_get_string(u_int *length_ptr);
-
-/*
- * Logs the error in syslog using LOG_INFO, constructs and sends a disconnect
- * packet, closes the connection, and exits.  This function never returns.
- * The error message should not contain a newline.  The total length of the
- * message must not exceed 1024 bytes.
- */
-void    packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
-
-/*
- * Sends a diagnostic message to the other side.  This message can be sent at
- * any time (but not while constructing another message). The message is
- * printed immediately, but only if the client is being executed in verbose
- * mode.  These messages are primarily intended to ease debugging
- * authentication problems.  The total length of the message must not exceed
- * 1024 bytes.  This will automatically call packet_write_wait.  If the
- * remote side protocol flags do not indicate that it supports SSH_MSG_DEBUG,
- * this will do nothing.
- */
-void    packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
-
-/* Checks if there is any buffered output, and tries to write some of the output. */
-void    packet_write_poll(void);
-
-/* Waits until all pending output data has been written. */
-void    packet_write_wait(void);
+void     packet_write_poll(void);
+void     packet_write_wait(void);
+int      packet_have_data_to_write(void);
+int      packet_not_very_much_data_to_write(void);
 
-/* Returns true if there is buffered data to write to the connection. */
-int     packet_have_data_to_write(void);
+int      packet_connection_is_on_socket(void);
+int      packet_connection_is_ipv4(void);
+int      packet_remaining(void);
+void     packet_send_ignore(int);
+void     packet_inject_ignore(int);
 
-/* Returns true if there is not too much data to write to the connection. */
-int     packet_not_very_much_data_to_write(void);
+void     tty_make_modes(int, struct termios *);
+void     tty_parse_modes(int, int *);
 
-/* maximum packet size, requested by client with SSH_CMSG_MAX_PACKET_SIZE */
 extern int max_packet_size;
-int     packet_set_maxsize(int);
-#define packet_get_maxsize() max_packet_size
-
-/* Stores tty modes from the fd or tiop into current packet. */
-void    tty_make_modes(int, struct termios *);
-
-/* Parses tty modes for the fd from the current packet. */
-void    tty_parse_modes(int, int *);
+int      packet_set_maxsize(int);
+#define  packet_get_maxsize() max_packet_size
 
 #define packet_integrity_check(payload_len, expected_len, type) \
 do { \
-  int _p = (payload_len), _e = (expected_len); \
-  if (_p != _e) { \
-    log("Packet integrity error (%d != %d) at %s:%d", \
-        _p, _e, __FILE__, __LINE__); \
-    packet_disconnect("Packet integrity error. (%d)", (type)); \
-  } \
+        int _p = (payload_len), _e = (expected_len); \
+        if (_p != _e) { \
+                log("Packet integrity error (%d != %d) at %s:%d", \
+                    _p, _e, __FILE__, __LINE__); \
+                packet_disconnect("Packet integrity error. (%d)", (type)); \
+        } \
 } while (0)
 
 #define packet_done() \
@@ -203,17 +92,4 @@ do { \
         } \
 } while (0)
 
-/* remote host is connected via a socket/ipv4 */
-int     packet_connection_is_on_socket(void);
-int     packet_connection_is_ipv4(void);
-
-/* returns remaining payload bytes */
-int     packet_remaining(void);
-
-/* append an ignore message */
-void    packet_send_ignore(int);
-
-/* add an ignore message and make sure size (current+ignore) = n*sumlen */
-void    packet_inject_ignore(int);
-
 #endif                          /* PACKET_H */