Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 1 | /* |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 2 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 3 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 4 | * All rights reserved |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 5 | * Interface for the packet protocol functions. |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 6 | * |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 7 | * As far as I am concerned, the code I have written for this software |
| 8 | * can be used freely for any purpose. Any derived versions of this |
| 9 | * software must be clearly marked as such, and if the derived work is |
| 10 | * incompatible with the protocol description in the RFC file, it must be |
| 11 | * called by a name other than "ssh" or "Secure Shell". |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 12 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 13 | |
Damien Miller | 9f64390 | 2001-11-12 11:02:52 +1100 | [diff] [blame] | 14 | /* RCSID("$OpenBSD: packet.h,v 1.26 2001/11/07 16:03:17 markus Exp $"); */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 15 | |
| 16 | #ifndef PACKET_H |
| 17 | #define PACKET_H |
| 18 | |
| 19 | #include <openssl/bn.h> |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 20 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 21 | void packet_set_connection(int, int); |
| 22 | void packet_set_nonblocking(void); |
| 23 | int packet_get_connection_in(void); |
| 24 | int packet_get_connection_out(void); |
| 25 | void packet_close(void); |
| 26 | void packet_set_encryption_key(const u_char *, u_int, int); |
| 27 | void packet_set_protocol_flags(u_int); |
| 28 | u_int packet_get_protocol_flags(void); |
| 29 | void packet_start_compression(int); |
| 30 | void packet_set_interactive(int); |
| 31 | int packet_is_interactive(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 32 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 33 | void packet_start(u_char); |
| 34 | void packet_put_char(int ch); |
| 35 | void packet_put_int(u_int value); |
| 36 | void packet_put_bignum(BIGNUM * value); |
| 37 | void packet_put_bignum2(BIGNUM * value); |
| 38 | void packet_put_string(const char *buf, u_int len); |
| 39 | void packet_put_cstring(const char *str); |
| 40 | void packet_put_raw(const char *buf, u_int len); |
| 41 | void packet_send(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 42 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 43 | int packet_read(int *payload_len_ptr); |
| 44 | void packet_read_expect(int *payload_len_ptr, int type); |
| 45 | int packet_read_poll(int *packet_len_ptr); |
| 46 | void packet_process_incoming(const char *buf, u_int len); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 47 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 48 | u_int packet_get_char(void); |
| 49 | u_int packet_get_int(void); |
| 50 | void packet_get_bignum(BIGNUM * value, int *length_ptr); |
| 51 | void packet_get_bignum2(BIGNUM * value, int *length_ptr); |
Damien Miller | 33b1356 | 2000-04-04 14:38:59 +1000 | [diff] [blame] | 52 | char *packet_get_raw(int *length_ptr); |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 53 | char *packet_get_string(u_int *length_ptr); |
| 54 | void packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2))); |
| 55 | void packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2))); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 56 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 57 | void packet_write_poll(void); |
| 58 | void packet_write_wait(void); |
| 59 | int packet_have_data_to_write(void); |
| 60 | int packet_not_very_much_data_to_write(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 61 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 62 | int packet_connection_is_on_socket(void); |
| 63 | int packet_connection_is_ipv4(void); |
| 64 | int packet_remaining(void); |
| 65 | void packet_send_ignore(int); |
Damien Miller | 9f64390 | 2001-11-12 11:02:52 +1100 | [diff] [blame] | 66 | void packet_add_padding(u_char); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 67 | |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 68 | void tty_make_modes(int, struct termios *); |
| 69 | void tty_parse_modes(int, int *); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 70 | |
Damien Miller | 6162d12 | 1999-11-21 13:23:52 +1100 | [diff] [blame] | 71 | extern int max_packet_size; |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 72 | int packet_set_maxsize(int); |
| 73 | #define packet_get_maxsize() max_packet_size |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 74 | |
| 75 | #define packet_integrity_check(payload_len, expected_len, type) \ |
| 76 | do { \ |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 77 | int _p = (payload_len), _e = (expected_len); \ |
| 78 | if (_p != _e) { \ |
| 79 | log("Packet integrity error (%d != %d) at %s:%d", \ |
| 80 | _p, _e, __FILE__, __LINE__); \ |
| 81 | packet_disconnect("Packet integrity error. (%d)", (type)); \ |
| 82 | } \ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 83 | } while (0) |
| 84 | |
Damien Miller | 4af5130 | 2000-04-16 11:18:38 +1000 | [diff] [blame] | 85 | #define packet_done() \ |
| 86 | do { \ |
| 87 | int _len = packet_remaining(); \ |
| 88 | if (_len > 0) { \ |
| 89 | log("Packet integrity error (%d bytes remaining) at %s:%d", \ |
| 90 | _len ,__FILE__, __LINE__); \ |
| 91 | packet_disconnect("Packet integrity error."); \ |
| 92 | } \ |
| 93 | } while (0) |
| 94 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 95 | #endif /* PACKET_H */ |