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