packet.h

   1 /* $OpenBSD: packet.h,v 1.52 2009/06/27 09:29:06 andreas 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 <termios.h>
  20
  21 #include <openssl/bn.h>
  22
  23 void     packet_set_connection(int, int);
  24 void     packet_set_timeout(int, int);
  25 void     packet_set_nonblocking(void);
  26 int      packet_get_connection_in(void);
  27 int      packet_get_connection_out(void);
  28 void     packet_close(void);
  29 void     packet_set_encryption_key(const u_char *, u_int, int);
  30 u_int    packet_get_encryption_key(u_char *);
  31 void     packet_set_protocol_flags(u_int);
  32 u_int    packet_get_protocol_flags(void);
  33 void     packet_start_compression(int);
  34 void     packet_set_interactive(int);
  35 int      packet_is_interactive(void);
  36 void     packet_set_server(void);
  37 void     packet_set_authenticated(void);
  38
  39 void     packet_start(u_char);
  40 void     packet_put_char(int ch);
  41 void     packet_put_int(u_int value);
  42 void     packet_put_int64(u_int64_t value);
  43 void     packet_put_bignum(BIGNUM * value);
  44 void     packet_put_bignum2(BIGNUM * value);
  45 void     packet_put_string(const void *buf, u_int len);
  46 void     packet_put_cstring(const char *str);
  47 void     packet_put_raw(const void *buf, u_int len);
  48 void     packet_send(void);
  49
  50 int      packet_read(void);
  51 void     packet_read_expect(int type);
  52 int      packet_read_poll(void);
  53 void     packet_process_incoming(const char *buf, u_int len);
  54 int      packet_read_seqnr(u_int32_t *seqnr_p);
  55 int      packet_read_poll_seqnr(u_int32_t *seqnr_p);
  56
  57 u_int    packet_get_char(void);
  58 u_int    packet_get_int(void);
  59 u_int64_t packet_get_int64(void);
  60 void     packet_get_bignum(BIGNUM * value);
  61 void     packet_get_bignum2(BIGNUM * value);
  62 void    *packet_get_raw(u_int *length_ptr);
  63 void    *packet_get_string(u_int *length_ptr);
  64 void    *packet_get_string_ptr(u_int *length_ptr);
  65 void     packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2)));
  66 void     packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
  67
  68 void     set_newkeys(int mode);
  69 int      packet_get_keyiv_len(int);
  70 void     packet_get_keyiv(int, u_char *, u_int);
  71 int      packet_get_keycontext(int, u_char *);
  72 void     packet_set_keycontext(int, u_char *);
  73 void     packet_get_state(int, u_int32_t *, u_int64_t *, u_int32_t *, u_int64_t *);
  74 void     packet_set_state(int, u_int32_t, u_int64_t, u_int32_t, u_int64_t);
  75 int      packet_get_ssh1_cipher(void);
  76 void     packet_set_iv(int, u_char *);
  77 void    *packet_get_newkeys(int);
  78
  79 void     packet_write_poll(void);
  80 void     packet_write_wait(void);
  81 int      packet_have_data_to_write(void);
  82 int      packet_not_very_much_data_to_write(void);
  83
  84 int      packet_connection_is_on_socket(void);
  85 int      packet_connection_is_ipv4(void);
  86 int      packet_remaining(void);
  87 void     packet_send_ignore(int);
  88 void     packet_add_padding(u_char);
  89
  90 void     tty_make_modes(int, struct termios *);
  91 void     tty_parse_modes(int, int *);
  92
  93 void     packet_set_alive_timeouts(int);
  94 int      packet_inc_alive_timeouts(void);
  95 int      packet_set_maxsize(u_int);
  96 u_int    packet_get_maxsize(void);
  97
  98 /* don't allow remaining bytes after the end of the message */
  99 #define packet_check_eom() \
 100 do { \
 101         int _len = packet_remaining(); \
 102         if (_len > 0) { \
 103                 logit("Packet integrity error (%d bytes remaining) at %s:%d", \
 104                     _len ,__FILE__, __LINE__); \
 105                 packet_disconnect("Packet integrity error."); \
 106         } \
 107 } while (0)
 108
 109 int      packet_need_rekeying(void);
 110 void     packet_set_rekey_limit(u_int32_t);
 111
 112 void     packet_backup_state(void);
 113 void     packet_restore_state(void);
 114
 115 void    *packet_get_input(void);
 116 void    *packet_get_output(void);
 117
 118 #endif                          /* PACKET_H */