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