packet.h

   1 /*      $OpenBSD: packet.h,v 1.33 2002/03/04 17:27:39 stevesk Exp $     */
   2
   3 /*
   4  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   5  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   6  *                    All rights reserved
   7  * Interface for the packet protocol functions.
   8  *
   9  * As far as I am concerned, the code I have written for this software
  10  * can be used freely for any purpose.  Any derived versions of this
  11  * software must be clearly marked as such, and if the derived work is
  12  * incompatible with the protocol description in the RFC file, it must be
  13  * called by a name other than "ssh" or "Secure Shell".
  14  */
  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 void *buf, u_int len);
  39 void     packet_put_cstring(const char *str);
  40 void     packet_put_raw(const void *buf, u_int len);
  41 void     packet_send(void);
  42
  43 int      packet_read(void);
  44 void     packet_read_expect(int type);
  45 int      packet_read_poll(void);
  46 void     packet_process_incoming(const char *buf, u_int len);
  47 int      packet_read_seqnr(u_int32_t *seqnr_p);
  48 int      packet_read_poll_seqnr(u_int32_t *seqnr_p);
  49
  50 u_int    packet_get_char(void);
  51 u_int    packet_get_int(void);
  52 void     packet_get_bignum(BIGNUM * value);
  53 void     packet_get_bignum2(BIGNUM * value);
  54 void    *packet_get_raw(int *length_ptr);
  55 void    *packet_get_string(u_int *length_ptr);
  56 void     packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
  57 void     packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
  58
  59 void     set_newkeys(int mode);
  60 void     packet_get_keyiv(int, u_char *, u_int);
  61 int      packet_get_keycontext(int, u_char *);
  62 void     packet_set_keycontext(int, u_char *);
  63 u_int32_t packet_get_seqnr(int);
  64 void     packet_set_seqnr(int, u_int32_t);
  65
  66 void     packet_write_poll(void);
  67 void     packet_write_wait(void);
  68 int      packet_have_data_to_write(void);
  69 int      packet_not_very_much_data_to_write(void);
  70
  71 int      packet_connection_is_on_socket(void);
  72 int      packet_connection_is_ipv4(void);
  73 int      packet_remaining(void);
  74 void     packet_send_ignore(int);
  75 void     packet_add_padding(u_char);
  76
  77 void     tty_make_modes(int, struct termios *);
  78 void     tty_parse_modes(int, int *);
  79
  80 extern int max_packet_size;
  81 int      packet_set_maxsize(int);
  82 #define  packet_get_maxsize() max_packet_size
  83
  84 /* don't allow remaining bytes after the end of the message */
  85 #define packet_check_eom() \
  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 */