]>
Commit | Line | Data |
---|---|---|
8efc0c15 | 1 | /* |
5260325f | 2 | * Author: Tatu Ylonen <ylo@cs.hut.fi> |
5260325f | 3 | * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
4 | * All rights reserved | |
5260325f | 5 | * Interface for the packet protocol functions. |
6ae2364d | 6 | * |
bcbf86ec | 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". | |
5260325f | 12 | */ |
8efc0c15 | 13 | |
2a1e4639 | 14 | /* RCSID("$OpenBSD: packet.h,v 1.24 2001/06/26 06:32:57 itojun Exp $"); */ |
8efc0c15 | 15 | |
16 | #ifndef PACKET_H | |
17 | #define PACKET_H | |
18 | ||
19 | #include <openssl/bn.h> | |
20 | ||
aa3378df | 21 | /* |
22 | * Sets the socket used for communication. Disables encryption until | |
23 | * packet_set_encryption_key is called. It is permissible that fd_in and | |
24 | * fd_out are the same descriptor; in that case it is assumed to be a socket. | |
25 | */ | |
2a1e4639 | 26 | void packet_set_connection(int, int); |
8efc0c15 | 27 | |
28 | /* Puts the connection file descriptors into non-blocking mode. */ | |
5260325f | 29 | void packet_set_nonblocking(void); |
8efc0c15 | 30 | |
31 | /* Returns the file descriptor used for input. */ | |
5260325f | 32 | int packet_get_connection_in(void); |
8efc0c15 | 33 | |
34 | /* Returns the file descriptor used for output. */ | |
5260325f | 35 | int packet_get_connection_out(void); |
8efc0c15 | 36 | |
aa3378df | 37 | /* |
38 | * Closes the connection (both descriptors) and clears and frees internal | |
39 | * data structures. | |
40 | */ | |
5260325f | 41 | void packet_close(void); |
8efc0c15 | 42 | |
aa3378df | 43 | /* |
44 | * Causes any further packets to be encrypted using the given key. The same | |
45 | * key is used for both sending and reception. However, both directions are | |
46 | * encrypted independently of each other. Cipher types are defined in ssh.h. | |
47 | */ | |
6ae2364d | 48 | void |
2a1e4639 | 49 | packet_set_encryption_key(const u_char *, u_int, int); |
8efc0c15 | 50 | |
aa3378df | 51 | /* |
52 | * Sets remote side protocol flags for the current connection. This can be | |
53 | * called at any time. | |
54 | */ | |
2a1e4639 | 55 | void packet_set_protocol_flags(u_int); |
8efc0c15 | 56 | |
57 | /* Returns the remote protocol flags set earlier by the above function. */ | |
1e3b8b07 | 58 | u_int packet_get_protocol_flags(void); |
8efc0c15 | 59 | |
60 | /* Enables compression in both directions starting from the next packet. */ | |
2a1e4639 | 61 | void packet_start_compression(int); |
8efc0c15 | 62 | |
aa3378df | 63 | /* |
64 | * Informs that the current session is interactive. Sets IP flags for | |
65 | * optimal performance in interactive use. | |
66 | */ | |
2a1e4639 | 67 | void packet_set_interactive(int); |
8efc0c15 | 68 | |
69 | /* Returns true if the current connection is interactive. */ | |
5260325f | 70 | int packet_is_interactive(void); |
8efc0c15 | 71 | |
72 | /* Starts constructing a packet to send. */ | |
2a1e4639 | 73 | void packet_start(u_char); |
8efc0c15 | 74 | |
75 | /* Appends a character to the packet data. */ | |
5260325f | 76 | void packet_put_char(int ch); |
8efc0c15 | 77 | |
78 | /* Appends an integer to the packet data. */ | |
1e3b8b07 | 79 | void packet_put_int(u_int value); |
8efc0c15 | 80 | |
81 | /* Appends an arbitrary precision integer to packet data. */ | |
5260325f | 82 | void packet_put_bignum(BIGNUM * value); |
7e7327a1 | 83 | void packet_put_bignum2(BIGNUM * value); |
8efc0c15 | 84 | |
85 | /* Appends a string to packet data. */ | |
1e3b8b07 | 86 | void packet_put_string(const char *buf, u_int len); |
7e7327a1 | 87 | void packet_put_cstring(const char *str); |
1e3b8b07 | 88 | void packet_put_raw(const char *buf, u_int len); |
8efc0c15 | 89 | |
aa3378df | 90 | /* |
91 | * Finalizes and sends the packet. If the encryption key has been set, | |
92 | * encrypts the packet before sending. | |
93 | */ | |
5260325f | 94 | void packet_send(void); |
8efc0c15 | 95 | |
96 | /* Waits until a packet has been received, and returns its type. */ | |
5260325f | 97 | int packet_read(int *payload_len_ptr); |
8efc0c15 | 98 | |
aa3378df | 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 | */ | |
5260325f | 103 | void packet_read_expect(int *payload_len_ptr, int type); |
8efc0c15 | 104 | |
aa3378df | 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 | */ | |
5260325f | 113 | int packet_read_poll(int *packet_len_ptr); |
8efc0c15 | 114 | |
aa3378df | 115 | /* |
116 | * Buffers the given amount of input characters. This is intended to be used | |
117 | * together with packet_read_poll. | |
118 | */ | |
1e3b8b07 | 119 | void packet_process_incoming(const char *buf, u_int len); |
8efc0c15 | 120 | |
121 | /* Returns a character (0-255) from the packet data. */ | |
1e3b8b07 | 122 | u_int packet_get_char(void); |
8efc0c15 | 123 | |
124 | /* Returns an integer from the packet data. */ | |
1e3b8b07 | 125 | u_int packet_get_int(void); |
8efc0c15 | 126 | |
aa3378df | 127 | /* |
128 | * Returns an arbitrary precision integer from the packet data. The integer | |
129 | * must have been initialized before this call. | |
130 | */ | |
5260325f | 131 | void packet_get_bignum(BIGNUM * value, int *length_ptr); |
7e7327a1 | 132 | void packet_get_bignum2(BIGNUM * value, int *length_ptr); |
133 | char *packet_get_raw(int *length_ptr); | |
8efc0c15 | 134 | |
aa3378df | 135 | /* |
136 | * Returns a string from the packet data. The string is allocated using | |
137 | * xmalloc; it is the responsibility of the calling program to free it when | |
138 | * no longer needed. The length_ptr argument may be NULL, or point to an | |
139 | * integer into which the length of the string is stored. | |
140 | */ | |
1e3b8b07 | 141 | char *packet_get_string(u_int *length_ptr); |
8efc0c15 | 142 | |
aa3378df | 143 | /* |
144 | * Logs the error in syslog using LOG_INFO, constructs and sends a disconnect | |
145 | * packet, closes the connection, and exits. This function never returns. | |
146 | * The error message should not contain a newline. The total length of the | |
147 | * message must not exceed 1024 bytes. | |
148 | */ | |
610cd5c6 | 149 | void packet_disconnect(const char *fmt,...) __attribute__((format(printf, 1, 2))); |
8efc0c15 | 150 | |
aa3378df | 151 | /* |
152 | * Sends a diagnostic message to the other side. This message can be sent at | |
153 | * any time (but not while constructing another message). The message is | |
154 | * printed immediately, but only if the client is being executed in verbose | |
155 | * mode. These messages are primarily intended to ease debugging | |
156 | * authentication problems. The total length of the message must not exceed | |
157 | * 1024 bytes. This will automatically call packet_write_wait. If the | |
158 | * remote side protocol flags do not indicate that it supports SSH_MSG_DEBUG, | |
159 | * this will do nothing. | |
160 | */ | |
610cd5c6 | 161 | void packet_send_debug(const char *fmt,...) __attribute__((format(printf, 1, 2))); |
8efc0c15 | 162 | |
aa3378df | 163 | /* Checks if there is any buffered output, and tries to write some of the output. */ |
5260325f | 164 | void packet_write_poll(void); |
8efc0c15 | 165 | |
166 | /* Waits until all pending output data has been written. */ | |
5260325f | 167 | void packet_write_wait(void); |
8efc0c15 | 168 | |
169 | /* Returns true if there is buffered data to write to the connection. */ | |
5260325f | 170 | int packet_have_data_to_write(void); |
8efc0c15 | 171 | |
172 | /* Returns true if there is not too much data to write to the connection. */ | |
5260325f | 173 | int packet_not_very_much_data_to_write(void); |
8efc0c15 | 174 | |
9d6b7add | 175 | /* maximum packet size, requested by client with SSH_CMSG_MAX_PACKET_SIZE */ |
176 | extern int max_packet_size; | |
2a1e4639 | 177 | int packet_set_maxsize(int); |
9d6b7add | 178 | #define packet_get_maxsize() max_packet_size |
179 | ||
30dcc918 | 180 | /* Stores tty modes from the fd or tiop into current packet. */ |
2a1e4639 | 181 | void tty_make_modes(int, struct termios *); |
8efc0c15 | 182 | |
183 | /* Parses tty modes for the fd from the current packet. */ | |
2a1e4639 | 184 | void tty_parse_modes(int, int *); |
8efc0c15 | 185 | |
186 | #define packet_integrity_check(payload_len, expected_len, type) \ | |
187 | do { \ | |
188 | int _p = (payload_len), _e = (expected_len); \ | |
189 | if (_p != _e) { \ | |
190 | log("Packet integrity error (%d != %d) at %s:%d", \ | |
191 | _p, _e, __FILE__, __LINE__); \ | |
192 | packet_disconnect("Packet integrity error. (%d)", (type)); \ | |
193 | } \ | |
194 | } while (0) | |
195 | ||
6ae2364d | 196 | #define packet_done() \ |
197 | do { \ | |
198 | int _len = packet_remaining(); \ | |
199 | if (_len > 0) { \ | |
200 | log("Packet integrity error (%d bytes remaining) at %s:%d", \ | |
201 | _len ,__FILE__, __LINE__); \ | |
202 | packet_disconnect("Packet integrity error."); \ | |
203 | } \ | |
204 | } while (0) | |
205 | ||
48e671d5 | 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 | ||
6ae2364d | 210 | /* returns remaining payload bytes */ |
211 | int packet_remaining(void); | |
212 | ||
a6215e53 | 213 | /* append an ignore message */ |
2a1e4639 | 214 | void packet_send_ignore(int); |
95ce5599 | 215 | |
216 | /* add an ignore message and make sure size (current+ignore) = n*sumlen */ | |
2a1e4639 | 217 | void packet_inject_ignore(int); |
a6215e53 | 218 | |
5260325f | 219 | #endif /* PACKET_H */ |