crypto/openssh/packet.h

   1 /* $OpenBSD: packet.h,v 1.59 2013/07/12 00:19:59 djm Exp $ */
   2 /* $FreeBSD$ */
   3
   4 /*
   5  * Author: Tatu Ylonen <ylo@cs.hut.fi>
   6  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   7  *                    All rights reserved
   8  * Interface for the packet protocol functions.
   9  *
  10  * As far as I am concerned, the code I have written for this software
  11  * can be used freely for any purpose.  Any derived versions of this
  12  * software must be clearly marked as such, and if the derived work is
  13  * incompatible with the protocol description in the RFC file, it must be
  14  * called by a name other than "ssh" or "Secure Shell".
  15  */
  16
  17 #ifndef PACKET_H
  18 #define PACKET_H
  19
  20 #include <termios.h>
  21
  22 #include <openssl/bn.h>
  23 #ifdef OPENSSL_HAS_ECC
  24 #include <openssl/ec.h>
  25 #endif
  26
  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 #ifdef  NONE_CIPHER_ENABLED
  43 int      packet_get_authentication_state(void);
  44 #endif
  45
  46 void     packet_start(u_char);
  47 void     packet_put_char(int ch);
  48 void     packet_put_int(u_int value);
  49 void     packet_put_int64(u_int64_t value);
  50 void     packet_put_bignum(BIGNUM * value);
  51 void     packet_put_bignum2(BIGNUM * value);
  52 #ifdef OPENSSL_HAS_ECC
  53 void     packet_put_ecpoint(const EC_GROUP *, const EC_POINT *);
  54 #endif
  55 void     packet_put_string(const void *buf, u_int len);
  56 void     packet_put_cstring(const char *str);
  57 void     packet_put_raw(const void *buf, u_int len);
  58 void     packet_send(void);
  59
  60 int      packet_read(void);
  61 void     packet_read_expect(int type);
  62 void     packet_process_incoming(const char *buf, u_int len);
  63 int      packet_read_seqnr(u_int32_t *seqnr_p);
  64 int      packet_read_poll_seqnr(u_int32_t *seqnr_p);
  65
  66 u_int    packet_get_char(void);
  67 u_int    packet_get_int(void);
  68 u_int64_t packet_get_int64(void);
  69 void     packet_get_bignum(BIGNUM * value);
  70 void     packet_get_bignum2(BIGNUM * value);
  71 #ifdef OPENSSL_HAS_ECC
  72 void     packet_get_ecpoint(const EC_GROUP *, EC_POINT *);
  73 #endif
  74 void    *packet_get_raw(u_int *length_ptr);
  75 void    *packet_get_string(u_int *length_ptr);
  76 char    *packet_get_cstring(u_int *length_ptr);
  77 void    *packet_get_string_ptr(u_int *length_ptr);
  78 void     packet_disconnect(const char *fmt,...) __attribute__((noreturn)) __attribute__((format(printf, 1, 2)));
  79 void     packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2)));
  80
  81 void     set_newkeys(int mode);
  82 int      packet_get_keyiv_len(int);
  83 void     packet_get_keyiv(int, u_char *, u_int);
  84 int      packet_get_keycontext(int, u_char *);
  85 void     packet_set_keycontext(int, u_char *);
  86 void     packet_get_state(int, u_int32_t *, u_int64_t *, u_int32_t *, u_int64_t *);
  87 void     packet_set_state(int, u_int32_t, u_int64_t, u_int32_t, u_int64_t);
  88 int      packet_get_ssh1_cipher(void);
  89 void     packet_set_iv(int, u_char *);
  90 void    *packet_get_newkeys(int);
  91
  92 void     packet_write_poll(void);
  93 void     packet_write_wait(void);
  94 int      packet_have_data_to_write(void);
  95 int      packet_not_very_much_data_to_write(void);
  96
  97 int      packet_connection_is_on_socket(void);
  98 int      packet_remaining(void);
  99 void     packet_send_ignore(int);
 100 void     packet_add_padding(u_char);
 101
 102 void     tty_make_modes(int, struct termios *);
 103 void     tty_parse_modes(int, int *);
 104
 105 void     packet_set_alive_timeouts(int);
 106 int      packet_inc_alive_timeouts(void);
 107 int      packet_set_maxsize(u_int);
 108 u_int    packet_get_maxsize(void);
 109
 110 /* don't allow remaining bytes after the end of the message */
 111 #define packet_check_eom() \
 112 do { \
 113         int _len = packet_remaining(); \
 114         if (_len > 0) { \
 115                 logit("Packet integrity error (%d bytes remaining) at %s:%d", \
 116                     _len ,__FILE__, __LINE__); \
 117                 packet_disconnect("Packet integrity error."); \
 118         } \
 119 } while (0)
 120
 121 int      packet_need_rekeying(void);
 122 #ifdef  NONE_CIPHER_ENABLED
 123 void     packet_request_rekeying(void);
 124 #endif
 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
 131 void    *packet_get_input(void);
 132 void    *packet_get_output(void);
 133
 134 #endif                          /* PACKET_H */