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 | * |
| 3 | * packet.h |
| 4 | * |
| 5 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
| 6 | * |
| 7 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
| 8 | * All rights reserved |
| 9 | * |
| 10 | * Created: Sat Mar 18 02:02:14 1995 ylo |
| 11 | * |
| 12 | * Interface for the packet protocol functions. |
| 13 | * |
| 14 | */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 15 | |
Damien Miller | 33b1356 | 2000-04-04 14:38:59 +1000 | [diff] [blame^] | 16 | /* RCSID("$Id: packet.h,v 1.11 2000/04/04 04:39:03 damien Exp $"); */ |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 17 | |
| 18 | #ifndef PACKET_H |
| 19 | #define PACKET_H |
| 20 | |
Damien Miller | 3bd49ec | 1999-11-15 15:40:55 +1100 | [diff] [blame] | 21 | #include "config.h" |
| 22 | |
Damien Miller | 7f6ea02 | 1999-10-28 13:25:17 +1000 | [diff] [blame] | 23 | #ifdef HAVE_OPENSSL |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 24 | #include <openssl/bn.h> |
Damien Miller | 7f6ea02 | 1999-10-28 13:25:17 +1000 | [diff] [blame] | 25 | #endif |
| 26 | #ifdef HAVE_SSL |
| 27 | #include <ssl/bn.h> |
| 28 | #endif |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 29 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 30 | /* |
| 31 | * Sets the socket used for communication. Disables encryption until |
| 32 | * packet_set_encryption_key is called. It is permissible that fd_in and |
| 33 | * fd_out are the same descriptor; in that case it is assumed to be a socket. |
| 34 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 35 | void packet_set_connection(int fd_in, int fd_out); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 36 | |
| 37 | /* Puts the connection file descriptors into non-blocking mode. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 38 | void packet_set_nonblocking(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 39 | |
| 40 | /* Returns the file descriptor used for input. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 41 | int packet_get_connection_in(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 42 | |
| 43 | /* Returns the file descriptor used for output. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 44 | int packet_get_connection_out(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 45 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 46 | /* |
| 47 | * Closes the connection (both descriptors) and clears and frees internal |
| 48 | * data structures. |
| 49 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 50 | void packet_close(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 51 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 52 | /* |
| 53 | * Causes any further packets to be encrypted using the given key. The same |
| 54 | * key is used for both sending and reception. However, both directions are |
| 55 | * encrypted independently of each other. Cipher types are defined in ssh.h. |
| 56 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 57 | void |
| 58 | packet_set_encryption_key(const unsigned char *key, unsigned int keylen, |
| 59 | int cipher_type); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 60 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 61 | /* |
| 62 | * Sets remote side protocol flags for the current connection. This can be |
| 63 | * called at any time. |
| 64 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 65 | void packet_set_protocol_flags(unsigned int flags); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 66 | |
| 67 | /* Returns the remote protocol flags set earlier by the above function. */ |
| 68 | unsigned int packet_get_protocol_flags(void); |
| 69 | |
| 70 | /* Enables compression in both directions starting from the next packet. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 71 | void packet_start_compression(int level); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 72 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 73 | /* |
| 74 | * Informs that the current session is interactive. Sets IP flags for |
| 75 | * optimal performance in interactive use. |
| 76 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 77 | void packet_set_interactive(int interactive, int keepalives); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 78 | |
| 79 | /* Returns true if the current connection is interactive. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 80 | int packet_is_interactive(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 81 | |
| 82 | /* Starts constructing a packet to send. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 83 | void packet_start(int type); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 84 | |
| 85 | /* Appends a character to the packet data. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 86 | void packet_put_char(int ch); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 87 | |
| 88 | /* Appends an integer to the packet data. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 89 | void packet_put_int(unsigned int value); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 90 | |
| 91 | /* Appends an arbitrary precision integer to packet data. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 92 | void packet_put_bignum(BIGNUM * value); |
Damien Miller | 33b1356 | 2000-04-04 14:38:59 +1000 | [diff] [blame^] | 93 | void packet_put_bignum2(BIGNUM * value); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 94 | |
| 95 | /* Appends a string to packet data. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 96 | void packet_put_string(const char *buf, unsigned int len); |
Damien Miller | 33b1356 | 2000-04-04 14:38:59 +1000 | [diff] [blame^] | 97 | void packet_put_cstring(const char *str); |
| 98 | void packet_put_raw(const char *buf, unsigned int len); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 99 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 100 | /* |
| 101 | * Finalizes and sends the packet. If the encryption key has been set, |
| 102 | * encrypts the packet before sending. |
| 103 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 104 | void packet_send(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 105 | |
| 106 | /* Waits until a packet has been received, and returns its type. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 107 | int packet_read(int *payload_len_ptr); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 108 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 109 | /* |
| 110 | * Waits until a packet has been received, verifies that its type matches |
| 111 | * that given, and gives a fatal error and exits if there is a mismatch. |
| 112 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 113 | void packet_read_expect(int *payload_len_ptr, int type); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 114 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 115 | /* |
| 116 | * Checks if a full packet is available in the data received so far via |
| 117 | * packet_process_incoming. If so, reads the packet; otherwise returns |
| 118 | * SSH_MSG_NONE. This does not wait for data from the connection. |
| 119 | * SSH_MSG_DISCONNECT is handled specially here. Also, SSH_MSG_IGNORE |
| 120 | * messages are skipped by this function and are never returned to higher |
| 121 | * levels. |
| 122 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 123 | int packet_read_poll(int *packet_len_ptr); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 124 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 125 | /* |
| 126 | * Buffers the given amount of input characters. This is intended to be used |
| 127 | * together with packet_read_poll. |
| 128 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 129 | void packet_process_incoming(const char *buf, unsigned int len); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 130 | |
| 131 | /* Returns a character (0-255) from the packet data. */ |
| 132 | unsigned int packet_get_char(void); |
| 133 | |
| 134 | /* Returns an integer from the packet data. */ |
| 135 | unsigned int packet_get_int(void); |
| 136 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 137 | /* |
| 138 | * Returns an arbitrary precision integer from the packet data. The integer |
| 139 | * must have been initialized before this call. |
| 140 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 141 | void packet_get_bignum(BIGNUM * value, int *length_ptr); |
Damien Miller | 33b1356 | 2000-04-04 14:38:59 +1000 | [diff] [blame^] | 142 | void packet_get_bignum2(BIGNUM * value, int *length_ptr); |
| 143 | char *packet_get_raw(int *length_ptr); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 144 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 145 | /* |
| 146 | * Returns a string from the packet data. The string is allocated using |
| 147 | * xmalloc; it is the responsibility of the calling program to free it when |
| 148 | * no longer needed. The length_ptr argument may be NULL, or point to an |
| 149 | * integer into which the length of the string is stored. |
| 150 | */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 151 | char *packet_get_string(unsigned int *length_ptr); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 152 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 153 | /* |
| 154 | * Logs the error in syslog using LOG_INFO, constructs and sends a disconnect |
| 155 | * packet, closes the connection, and exits. This function never returns. |
| 156 | * The error message should not contain a newline. The total length of the |
| 157 | * message must not exceed 1024 bytes. |
| 158 | */ |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 159 | void packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2))); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 160 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 161 | /* |
| 162 | * Sends a diagnostic message to the other side. This message can be sent at |
| 163 | * any time (but not while constructing another message). The message is |
| 164 | * printed immediately, but only if the client is being executed in verbose |
| 165 | * mode. These messages are primarily intended to ease debugging |
| 166 | * authentication problems. The total length of the message must not exceed |
| 167 | * 1024 bytes. This will automatically call packet_write_wait. If the |
| 168 | * remote side protocol flags do not indicate that it supports SSH_MSG_DEBUG, |
| 169 | * this will do nothing. |
| 170 | */ |
Damien Miller | 7684ee1 | 2000-03-17 23:40:15 +1100 | [diff] [blame] | 171 | void packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2))); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 172 | |
Damien Miller | 5428f64 | 1999-11-25 11:54:57 +1100 | [diff] [blame] | 173 | /* Checks if there is any buffered output, and tries to write some of the output. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 174 | void packet_write_poll(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 175 | |
| 176 | /* Waits until all pending output data has been written. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 177 | void packet_write_wait(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 178 | |
| 179 | /* Returns true if there is buffered data to write to the connection. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 180 | int packet_have_data_to_write(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 181 | |
| 182 | /* Returns true if there is not too much data to write to the connection. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 183 | int packet_not_very_much_data_to_write(void); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 184 | |
Damien Miller | 6162d12 | 1999-11-21 13:23:52 +1100 | [diff] [blame] | 185 | /* maximum packet size, requested by client with SSH_CMSG_MAX_PACKET_SIZE */ |
| 186 | extern int max_packet_size; |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 187 | int packet_set_maxsize(int s); |
Damien Miller | 6162d12 | 1999-11-21 13:23:52 +1100 | [diff] [blame] | 188 | #define packet_get_maxsize() max_packet_size |
| 189 | |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 190 | /* Stores tty modes from the fd into current packet. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 191 | void tty_make_modes(int fd); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 192 | |
| 193 | /* Parses tty modes for the fd from the current packet. */ |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 194 | void tty_parse_modes(int fd, int *n_bytes_ptr); |
Damien Miller | d4a8b7e | 1999-10-27 13:42:43 +1000 | [diff] [blame] | 195 | |
| 196 | #define packet_integrity_check(payload_len, expected_len, type) \ |
| 197 | do { \ |
| 198 | int _p = (payload_len), _e = (expected_len); \ |
| 199 | if (_p != _e) { \ |
| 200 | log("Packet integrity error (%d != %d) at %s:%d", \ |
| 201 | _p, _e, __FILE__, __LINE__); \ |
| 202 | packet_disconnect("Packet integrity error. (%d)", (type)); \ |
| 203 | } \ |
| 204 | } while (0) |
| 205 | |
Damien Miller | 34132e5 | 2000-01-14 15:45:46 +1100 | [diff] [blame] | 206 | /* remote host is connected via a socket/ipv4 */ |
| 207 | int packet_connection_is_on_socket(void); |
| 208 | int packet_connection_is_ipv4(void); |
| 209 | |
Damien Miller | 33b1356 | 2000-04-04 14:38:59 +1000 | [diff] [blame^] | 210 | /* enable SSH2 packet format */ |
| 211 | void packet_set_ssh2_format(void); |
| 212 | |
Damien Miller | 95def09 | 1999-11-25 00:26:21 +1100 | [diff] [blame] | 213 | #endif /* PACKET_H */ |