crypto/openssh/packet.h

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