1 /* $OpenBSD: packet.h,v 1.56 2011/05/06 21:14:05 djm 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 27 packet_request_rekeying(void); 28 29 void packet_set_connection(int, int); 30 void packet_set_timeout(int, int); 31 void packet_set_nonblocking(void); 32 int packet_get_connection_in(void); 33 int packet_get_connection_out(void); 34 void packet_close(void); 35 void packet_set_encryption_key(const u_char *, u_int, int); 36 u_int packet_get_encryption_key(u_char *); 37 void packet_set_protocol_flags(u_int); 38 u_int packet_get_protocol_flags(void); 39 void packet_start_compression(int); 40 void packet_set_interactive(int, int, int); 41 int packet_is_interactive(void); 42 void packet_set_server(void); 43 void packet_set_authenticated(void); 44 int packet_authentication_state(void); 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 int packet_send(void); 59 60 int packet_read(void); 61 void packet_read_expect(int type); 62 int packet_read_poll(void); 63 void packet_process_incoming(const char *buf, u_int len); 64 int packet_read_seqnr(u_int32_t *seqnr_p); 65 int packet_read_poll_seqnr(u_int32_t *seqnr_p); 66 67 u_int packet_get_char(void); 68 u_int packet_get_int(void); 69 u_int64_t packet_get_int64(void); 70 void packet_get_bignum(BIGNUM * value); 71 void packet_get_bignum2(BIGNUM * value); 72 #ifdef OPENSSL_HAS_ECC 73 void packet_get_ecpoint(const EC_GROUP *, EC_POINT *); 74 #endif 75 void *packet_get_raw(u_int *length_ptr); 76 void *packet_get_string(u_int *length_ptr); 77 char *packet_get_cstring(u_int *length_ptr); 78 void *packet_get_string_ptr(u_int *length_ptr); 79 void packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2))); 80 void packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2))); 81 82 void set_newkeys(int mode); 83 int packet_get_keyiv_len(int); 84 void packet_get_keyiv(int, u_char *, u_int); 85 int packet_get_keycontext(int, u_char *); 86 void packet_set_keycontext(int, u_char *); 87 void packet_get_state(int, u_int32_t *, u_int64_t *, u_int32_t *, u_int64_t *); 88 void packet_set_state(int, u_int32_t, u_int64_t, u_int32_t, u_int64_t); 89 int packet_get_ssh1_cipher(void); 90 void packet_set_iv(int, u_char *); 91 void *packet_get_newkeys(int); 92 93 int packet_write_poll(void); 94 void packet_write_wait(void); 95 int packet_have_data_to_write(void); 96 int packet_not_very_much_data_to_write(void); 97 98 int packet_connection_is_on_socket(void); 99 int packet_remaining(void); 100 void packet_send_ignore(int); 101 void packet_add_padding(u_char); 102 103 void tty_make_modes(int, struct termios *); 104 void tty_parse_modes(int, int *); 105 106 void packet_set_alive_timeouts(int); 107 int packet_inc_alive_timeouts(void); 108 int packet_set_maxsize(u_int); 109 u_int packet_get_maxsize(void); 110 111 /* don't allow remaining bytes after the end of the message */ 112 #define packet_check_eom() \ 113 do { \ 114 int _len = packet_remaining(); \ 115 if (_len > 0) { \ 116 logit("Packet integrity error (%d bytes remaining) at %s:%d", \ 117 _len ,__FILE__, __LINE__); \ 118 packet_disconnect("Packet integrity error."); \ 119 } \ 120 } while (0) 121 122 int packet_need_rekeying(void); 123 void packet_set_rekey_limit(u_int32_t); 124 125 void packet_backup_state(void); 126 void packet_restore_state(void); 127 128 void *packet_get_input(void); 129 void *packet_get_output(void); 130 131 #endif /* PACKET_H */ 132