[BACK]Return to packet.h CVS log [TXT][DIR] Up to [local] / src / usr.bin / ssh

Diff for /src/usr.bin/ssh/packet.h between version 1.17.2.7 and 1.18

version 1.17.2.7, 2002/03/08 17:04:42 version 1.18, 2000/12/19 23:17:57
Line 1 
Line 1 
 /*      $OpenBSD$       */  
   
 /*  /*
  * Author: Tatu Ylonen <ylo@cs.hut.fi>   * Author: Tatu Ylonen <ylo@cs.hut.fi>
  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland   * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
Line 13 
Line 11 
  * called by a name other than "ssh" or "Secure Shell".   * called by a name other than "ssh" or "Secure Shell".
  */   */
   
   /* RCSID("$OpenBSD$"); */
   
 #ifndef PACKET_H  #ifndef PACKET_H
 #define PACKET_H  #define PACKET_H
   
 #include <openssl/bn.h>  #include <openssl/bn.h>
   
 void     packet_set_connection(int, int);  /*
 void     packet_set_nonblocking(void);   * Sets the socket used for communication.  Disables encryption until
 int      packet_get_connection_in(void);   * packet_set_encryption_key is called.  It is permissible that fd_in and
 int      packet_get_connection_out(void);   * fd_out are the same descriptor; in that case it is assumed to be a socket.
 void     packet_close(void);   */
 void     packet_set_encryption_key(const u_char *, u_int, int);  void    packet_set_connection(int fd_in, int fd_out);
 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);  /* Puts the connection file descriptors into non-blocking mode. */
 void     packet_put_char(int ch);  void    packet_set_nonblocking(void);
 void     packet_put_int(u_int value);  
 void     packet_put_bignum(BIGNUM * value);  
 void     packet_put_bignum2(BIGNUM * value);  
 void     packet_put_string(const void *buf, u_int len);  
 void     packet_put_cstring(const char *str);  
 void     packet_put_raw(const void *buf, u_int len);  
 void     packet_send(void);  
   
 int      packet_read(void);  /* Returns the file descriptor used for input. */
 void     packet_read_expect(int type);  int     packet_get_connection_in(void);
 int      packet_read_poll(void);  
 void     packet_process_incoming(const char *buf, u_int len);  
 int      packet_read_seqnr(u_int32_t *seqnr_p);  
 int      packet_read_poll_seqnr(u_int32_t *seqnr_p);  
   
 u_int    packet_get_char(void);  /* Returns the file descriptor used for output. */
 u_int    packet_get_int(void);  int     packet_get_connection_out(void);
 void     packet_get_bignum(BIGNUM * value);  
 void     packet_get_bignum2(BIGNUM * value);  
 void    *packet_get_raw(int *length_ptr);  
 void    *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)));  
   
 void     packet_write_poll(void);  /*
 void     packet_write_wait(void);   * Closes the connection (both descriptors) and clears and frees internal
 int      packet_have_data_to_write(void);   * data structures.
 int      packet_not_very_much_data_to_write(void);   */
   void    packet_close(void);
   
 int      packet_connection_is_on_socket(void);  /*
 int      packet_connection_is_ipv4(void);   * Causes any further packets to be encrypted using the given key.  The same
 int      packet_remaining(void);   * key is used for both sending and reception.  However, both directions are
 void     packet_send_ignore(int);   * encrypted independently of each other.  Cipher types are defined in ssh.h.
 void     packet_add_padding(u_char);   */
   void
   packet_set_encryption_key(const u_char *key, u_int keylen,
       int cipher_type);
   
 void     tty_make_modes(int, struct termios *);  /*
 void     tty_parse_modes(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 flags);
   
   /* 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 level);
   
   /*
    * Informs that the current session is interactive.  Sets IP flags for
    * optimal performance in interactive use.
    */
   void    packet_set_interactive(int interactive, int keepalives);
   
   /* Returns true if the current connection is interactive. */
   int     packet_is_interactive(void);
   
   /* Starts constructing a packet to send. */
   void    packet_start(int type);
   
   /* 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);
   char    *packet_get_raw(int *length_ptr);
   
   /*
    * 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);
   
   /* Returns true if there is buffered data to write to the connection. */
   int     packet_have_data_to_write(void);
   
   /* Returns true if there is not too much data to write to the connection. */
   int     packet_not_very_much_data_to_write(void);
   
   /* maximum packet size, requested by client with SSH_CMSG_MAX_PACKET_SIZE */
 extern int max_packet_size;  extern int max_packet_size;
 int      packet_set_maxsize(int);  int     packet_set_maxsize(int s);
 #define  packet_get_maxsize() max_packet_size  #define packet_get_maxsize() max_packet_size
   
 /* don't allow remaining bytes after the end of the message */  /* Stores tty modes from the fd into current packet. */
 #define packet_check_eom() \  void    tty_make_modes(int fd);
   
   /* Parses tty modes for the fd from the current packet. */
   void    tty_parse_modes(int fd, int *n_bytes_ptr);
   
   #define packet_integrity_check(payload_len, expected_len, type) \
 do { \  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)); \
     } \
   } while (0)
   
   #define packet_done() \
   do { \
         int _len = packet_remaining(); \          int _len = packet_remaining(); \
         if (_len > 0) { \          if (_len > 0) { \
                 log("Packet integrity error (%d bytes remaining) at %s:%d", \                  log("Packet integrity error (%d bytes remaining) at %s:%d", \
Line 84 
Line 203 
                 packet_disconnect("Packet integrity error."); \                  packet_disconnect("Packet integrity error."); \
         } \          } \
 } while (0)  } while (0)
   
   /* remote host is connected via a socket/ipv4 */
   int     packet_connection_is_on_socket(void);
   int     packet_connection_is_ipv4(void);
   
   /* enable SSH2 packet format */
   void    packet_set_ssh2_format(void);
   
   /* returns remaining payload bytes */
   int     packet_remaining(void);
   
 #endif                          /* PACKET_H */  #endif                          /* PACKET_H */
Legend:
Removed from v.1.17.2.7  
changed lines
  Added in v.1.18