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