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