packet.h

   1 /*
   2  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   3  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   4  *                    All rights reserved
   5  * Interface for the packet protocol functions.
   6  *
   7  * As far as I am concerned, the code I have written for this software
   8  * can be used freely for any purpose.  Any derived versions of this
   9  * software must be clearly marked as such, and if the derived work is
  10  * incompatible with the protocol description in the RFC file, it must be
  11  * called by a name other than "ssh" or "Secure Shell".
  12  */
  13
  14 /* RCSID("$OpenBSD: packet.h,v 1.25 2001/06/26 17:27:24 markus Exp $"); */
  15
  16 #ifndef PACKET_H
  17 #define PACKET_H
  18
  19 #include <openssl/bn.h>
  20
  21 void     packet_set_connection(int, int);
  22 void     packet_set_nonblocking(void);
  23 int      packet_get_connection_in(void);
  24 int      packet_get_connection_out(void);
  25 void     packet_close(void);
  26 void     packet_set_encryption_key(const u_char *, u_int, int);
  27 void     packet_set_protocol_flags(u_int);
  28 u_int    packet_get_protocol_flags(void);
  29 void     packet_start_compression(int);
  30 void     packet_set_interactive(int);
  31 int      packet_is_interactive(void);
  32
  33 void     packet_start(u_char);
  34 void     packet_put_char(int ch);
  35 void     packet_put_int(u_int value);
  36 void     packet_put_bignum(BIGNUM * value);
  37 void     packet_put_bignum2(BIGNUM * value);
  38 void     packet_put_string(const char *buf, u_int len);
  39 void     packet_put_cstring(const char *str);
  40 void     packet_put_raw(const char *buf, u_int len);
  41 void     packet_send(void);
  42
  43 int      packet_read(int *payload_len_ptr);
  44 void     packet_read_expect(int *payload_len_ptr, int type);
  45 int      packet_read_poll(int *packet_len_ptr);
  46 void     packet_process_incoming(const char *buf, u_int len);
  47
  48 u_int    packet_get_char(void);
  49 u_int    packet_get_int(void);
  50 void     packet_get_bignum(BIGNUM * value, int *length_ptr);
  51 void     packet_get_bignum2(BIGNUM * value, int *length_ptr);
  52 char    *packet_get_raw(int *length_ptr);
  53 char    *packet_get_string(u_int *length_ptr);
  54 void     packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
  55 void     packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
  56
  57 void     packet_write_poll(void);
  58 void     packet_write_wait(void);
  59 int      packet_have_data_to_write(void);
  60 int      packet_not_very_much_data_to_write(void);
  61
  62 int      packet_connection_is_on_socket(void);
  63 int      packet_connection_is_ipv4(void);
  64 int      packet_remaining(void);
  65 void     packet_send_ignore(int);
  66 void     packet_inject_ignore(int);
  67
  68 void     tty_make_modes(int, struct termios *);
  69 void     tty_parse_modes(int, int *);
  70
  71 extern int max_packet_size;
  72 int      packet_set_maxsize(int);
  73 #define  packet_get_maxsize() max_packet_size
  74
  75 #define packet_integrity_check(payload_len, expected_len, type) \
  76 do { \
  77         int _p = (payload_len), _e = (expected_len); \
  78         if (_p != _e) { \
  79                 log("Packet integrity error (%d != %d) at %s:%d", \
  80                     _p, _e, __FILE__, __LINE__); \
  81                 packet_disconnect("Packet integrity error. (%d)", (type)); \
  82         } \
  83 } while (0)
  84
  85 #define packet_done() \
  86 do { \
  87         int _len = packet_remaining(); \
  88         if (_len > 0) { \
  89                 log("Packet integrity error (%d bytes remaining) at %s:%d", \
  90                     _len ,__FILE__, __LINE__); \
  91                 packet_disconnect("Packet integrity error."); \
  92         } \
  93 } while (0)
  94
  95 #endif                          /* PACKET_H */